Unreadable examples.yml

[johanneswuerbach]

I generating the examples using:

APIPIE_RECORD=examples bundle exec rspec --order default

Sometimes this produces an unloadable yaml file. If I try to load the file manually it says

undefined method `first' for nil:NilClass

[johanneswuerbach]

2013-05-31T04:05:15.419125+00:00 app[web.1]: /app/vendor/bundle/ruby/2.0.0/gems/json-1.8.0/lib/json/common.rb:285:in `encode': "\xEF" from ASCII-8BIT to UTF-8 (Encoding::UndefinedConversionError)
2013-05-31T04:05:15.419125+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/gems/json-1.8.0/lib/json/common.rb:285:in `generate'
2013-05-31T04:05:15.419125+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/gems/json-1.8.0/lib/json/common.rb:285:in `pretty_generate'
2013-05-31T04:05:15.419125+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/method_description.rb:165:in `format_example_data'
2013-05-31T04:05:15.419125+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/method_description.rb:174:in `format_example'
2013-05-31T04:05:15.419125+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/method_description.rb:159:in `block in load_recorded_examples'
2013-05-31T04:05:15.419125+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/method_description.rb:159:in `map'
2013-05-31T04:05:15.419125+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/method_description.rb:159:in `load_recorded_examples'
2013-05-31T04:05:15.419125+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/method_description.rb:42:in `initialize'
2013-05-31T04:05:15.419125+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/application.rb:46:in `new'
2013-05-31T04:05:15.419456+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/application.rb:46:in `block in define_method_description'
2013-05-31T04:05:15.419456+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/application.rb:38:in `each'
2013-05-31T04:05:15.419456+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/application.rb:38:in `define_method_description'
2013-05-31T04:05:15.419456+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/apipie_module.rb:18:in `method_missing'
2013-05-31T04:05:15.419456+00:00 app[web.1]:    from /app/vendor/bundle/ruby/2.0.0/bundler/gems/apipie-rails-eb1b6d3a2da3/lib/apipie/dsl_definition.rb:305:in `method_added'

Another unreadable record.

[johanneswuerbach]

After disabling code coverage for APIPIE_RECORD rspec the yml file looks fine. We have some tests covering binary & base64 uploads, after disabling them the file is parseable again.

Our CI system is now trying to load and stringify the examples file before every deploy, so an invalid file can't break the server anymore.

JSON.pretty_generate(YAML.load_file("doc/apipie_examples.yml"))

@Pajk what do you think of changing the overall file format to json instead of serializing a hash to yml, to parse it and serialize to json again?

[iNecas]

I remember a discussion about breaking the examples into smaller files, structured by controllers and actions (man I can't find it now :(, This was the first cat of the format, we have now much more input on how this could be improved.

Moving to json seems like a way to go.

[kikonen-fiksu]

I've been hitting this error for a long time at

ruby-1.9.3-p484/lib/ruby/1.9.1/psych/visitors/to_ruby.rb:124:in `block in visit_Psych_Nodes_Sequence': undefined method `first' for nil:NilClass (NoMethodError)
    from ruby-1.9.3-p484/lib/ruby/1.9.1/psych/visitors/to_ruby.rb:123:in `each'

Causing re-generation of examples to fail (until old file is removed) and of course also display fails. And this seems to happen in random manner.

I quickly tested this "json-record" branch, and it seemed to fix issue. So is this fix going to get merged to master someday?