representable 1.8.2 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c404fc7cc88d164d5e03512e8d112ad44b5b1b1d
-  data.tar.gz: bfef2af61a347c39153f41f62bddf8324bf87026
+  metadata.gz: 05194fa7a0112822aaa674c38ab7240c59280756
+  data.tar.gz: 811cede2542e2e7e6dc47b0a42b918c70869d5d1
 SHA512:
-  metadata.gz: 9a45dbbd0995024eedb480cc1c42fe976a7e654275cd93161b3f78745e0701fce278efd5e7a998dac9b6c81cc31d8587f7ac034581e6f21687802103de963bdb
-  data.tar.gz: 5be6553990c8e27590d39f83ca171cb8fb96983f028d5a8d8a28817218ab05d7309da0295f8d188a4f579930d3fb52bcd596b6b9288ba71d26333682933bfb5b
+  metadata.gz: 3fe6b508f4a7ff32c7487f470f0e1821ca05f5e1ef920e164b551650f4d5616b4c134f75059606587afffce207a4a88a8ce0f2be1a7c03d7548a5f35dbe70005
+  data.tar.gz: 74efd603ec9dbe0e08ab4e3b118c06049b4b987450b6f68de014971df7599057b00dba2f61f33023a47928a289fbc88fdee1d2cafcb12800ad1138c39c51dabe

data/CHANGES.md

@@ -1,5 +1,7 @@
-# 1.8.2
+# 1.8.3
 
+* Fix `JSON::Collection` and `JSON::Hash` (lonely arrays and hashes), they can now use inline representers. Thanks to @jandudulski for reporting.
+* Added `:render_empty` option to suppress rendering of empty collections. This will default to true in 2.0.
 * Remove Virtus deprecations.
 * Add support for Rubinius.
 * `Definition#default` is public now, please don't use it anyway, it's a private concept.

data/README.md

@@ -984,7 +984,7 @@ your `:if` may process the options.
 property :track, if: lambda { |opts| track > opts[:minimum_track] }
 ```
 
-### False and Nil Values
+### False And Nil Values
 
 Since representable-1.2 `false` values _are_ considered when parsing and rendering. That particularly means properties that used to be unset (i.e. `nil`) after parsing might be `false` now. Vice versa, `false` properties that weren't included in the rendered document will be visible now.
 
@@ -994,6 +994,16 @@ If you want `nil` values to be included when rendering, use the `:render_nil` op
 property :track, render_nil: true
 ```
 
+### Empty Collections
+
+Per default, empty collections are rendered (unless they're `nil`). You can suppress rendering.
+
+```ruby
+collection :songs, render_empty: false
+```
+
+This will be the default behaviour in 2.0.
+
 
 ### Overriding Serialize And Deserialize
 

data/lib/representable.rb

@@ -109,11 +109,11 @@ private
         property(name, options, &block)
       end
 
-      def hash(name=nil, options={})
+      def hash(name=nil, options={}, &block)
         return super() unless name  # allow Object.hash.
 
         options[:hash] = true
-        property(name, options)
+        property(name, options, &block)
       end
 
     private

data/lib/representable/binding.rb

@@ -52,7 +52,7 @@ module Representable
     end
 
     def write_fragment_for(value, doc)
-      return if skipable_nil_value?(value)
+      return if skipable_empty_value?(value)
       write(doc, value)
     end
 

data/lib/representable/definition.rb

@@ -67,9 +67,11 @@ module Representable
       self[:extend]
     end
 
-    def skipable_nil_value?(value)
+    def skipable_empty_value?(value)
+      return true if array? and self[:render_empty] == false and value and value.size == 0  # TODO: change in 2.0, don't render emtpy.
       value.nil? and not self[:render_nil]
     end
+    alias_method :skipable_nil_value?, :skipable_empty_value? # TODO: remove in 1.9 .
 
     def create_binding(*args)
       self[:binding].call(self, *args)

data/lib/representable/hash/collection.rb

@@ -6,13 +6,14 @@ module Representable::Hash
       base.class_eval do
         include Representable
         extend ClassMethods
+        extend Representable::Hash::ClassMethods # ::representer_engine.
       end
     end
 
 
     module ClassMethods
-      def items(options)
-        collection :_self, options.merge(:getter => lambda { |*| self })
+      def items(options, &block)
+        collection(:_self, options.merge(:getter => lambda { |*| self }), &block)
       end
     end
 

data/lib/representable/json/hash.rb

@@ -10,13 +10,14 @@ module Representable::JSON
       base.class_eval do
         include Representable
         extend ClassMethods
+        extend Representable::Hash::ClassMethods # ::representer_engine.
       end
     end
 
 
     module ClassMethods
-      def values(options)
-        hash :_self, options
+      def values(options, &block)
+        hash(:_self, options, &block)
       end
     end
 

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "1.8.2"
+  VERSION = "1.8.3"
 end

data/test/generic_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
-class GenericTest < MiniTest::Spec
-# one day, this file will contain all engine-independent test cases. one day...
+class GenericTest < MiniTest::Spec # TODO: rename/restructure to CollectionTest.
   let (:new_album)  { OpenStruct.new.extend(representer) }
   let (:album)      { OpenStruct.new(:songs => ["Fuck Armageddon"]).extend(representer) }
   let (:song) { OpenStruct.new(:title => "Resist Stance") }
@@ -70,6 +69,28 @@ class GenericTest < MiniTest::Spec
         end
       end
     end
+
+
+    # when collection is [], suppress rendering when render_empty: false.
+    for_formats(
+      :hash => [Representable::Hash, {}],
+      #:xml  => [Representable::XML, "<open_struct><songs/></open_struct>"],
+      :yaml => [Representable::YAML, "--- {}\n"],
+    ) do |format, mod, output, input|
+
+      describe "render_empty [#{format}]" do
+        let (:format) { format }
+
+        representer!(:module => mod) do
+          collection :songs, :render_empty => false
+          self.representation_wrap = :album if format == :xml
+        end
+
+        let (:album) { OpenStruct.new(:songs => []).extend(representer) }
+
+        it { render(album).must_equal_document output }
+      end
+    end
   end
 
 

data/test/json_test.rb

@@ -443,129 +443,4 @@ end
       end
     end
   end
-
-
-  require 'representable/json/collection'
-  require 'representable/json/hash'
-  class LonelyRepresenterTest < MiniTest::Spec
-    module SongRepresenter
-      include Representable::JSON
-      property :name
-    end
-
-    let (:decorator) { rpr = representer; Class.new(Representable::Decorator) { include rpr } }
-
-    describe "JSON::Collection" do
-      describe "with contained objects" do
-        let (:representer) {
-          Module.new do
-            include Representable::JSON::Collection
-            items :class => Song, :extend => SongRepresenter
-          end
-        }
-        let (:songs) { [Song.new("Days Go By"), Song.new("Can't Take Them All")] }
-        let (:json)  { "[{\"name\":\"Days Go By\"},{\"name\":\"Can't Take Them All\"}]" }
-
-        it "renders array" do
-          assert_json json, songs.extend(representer).to_json
-        end
-
-        it "renders array with decorator" do
-          assert_json json, decorator.new(songs).to_json
-        end
-
-        it "parses array" do
-          [].extend(representer).from_json(json).must_equal songs
-        end
-
-        it "parses array with decorator" do
-          decorator.new([]).from_json(json).must_equal songs
-        end
-      end
-
-      describe "with contained text" do
-        let (:representer) {
-          Module.new do
-            include Representable::JSON::Collection
-          end
-        }
-        let (:songs) { ["Days Go By", "Can't Take Them All"] }
-        let (:json)  { "[\"Days Go By\",\"Can't Take Them All\"]" }
-
-        it "renders contained items #to_json" do
-          assert_json json, songs.extend(representer).to_json
-        end
-
-        it "returns objects array from #from_json" do
-          [].extend(representer).from_json(json).must_equal songs
-        end
-      end
-    end
-
-
-    describe "JSON::Hash" do  # TODO: move to HashTest.
-      describe "with contained objects" do
-        let (:representer) {
-          Module.new do
-            include Representable::JSON::Hash
-            values :class => Song, :extend => SongRepresenter
-          end
-        }
-        let (:json)  { "{\"one\":{\"name\":\"Days Go By\"},\"two\":{\"name\":\"Can't Take Them All\"}}" }
-        let (:songs) { {"one" => Song.new("Days Go By"), "two" => Song.new("Can't Take Them All")} }
-
-        describe "#to_json" do
-          it "renders hash" do
-            songs.extend(representer).to_json.must_equal json
-          end
-
-          it "renders hash with decorator" do
-            decorator.new(songs).to_json.must_equal json
-          end
-
-          it "respects :exclude" do
-            assert_json "{\"two\":{\"name\":\"Can't Take Them All\"}}", {:one => Song.new("Days Go By"), :two => Song.new("Can't Take Them All")}.extend(representer).to_json(:exclude => [:one])
-          end
-
-          it "respects :include" do
-            assert_json "{\"two\":{\"name\":\"Can't Take Them All\"}}", {:one => Song.new("Days Go By"), :two => Song.new("Can't Take Them All")}.extend(representer).to_json(:include => [:two])
-          end
-        end
-
-        describe "#from_json" do
-          it "returns objects array" do
-            {}.extend(representer).from_json(json).must_equal songs
-          end
-
-          it "parses hash with decorator" do
-            decorator.new({}).from_json(json).must_equal songs
-          end
-
-          it "respects :exclude" do
-            assert_equal({"two" => Song.new("Can't Take Them All")}, {}.extend(representer).from_json(json, :exclude => [:one]))
-          end
-
-          it "respects :include" do
-            assert_equal({"one" => Song.new("Days Go By")}, {}.extend(representer).from_json(json, :include => [:one]))
-          end
-        end
-      end
-
-      describe "with contained text" do
-        before do
-          @songs_representer = Module.new do
-            include Representable::JSON::Collection
-          end
-        end
-
-        it "renders contained items #to_json" do
-          assert_json "[\"Days Go By\",\"Can't Take Them All\"]", ["Days Go By", "Can't Take Them All"].extend(@songs_representer).to_json
-        end
-
-        it "returns objects array from #from_json" do
-          assert_equal ["Days Go By", "Can't Take Them All"], [].extend(@songs_representer).from_json("[\"Days Go By\",\"Can't Take Them All\"]")
-        end
-      end
-    end
-  end
 end

data/test/lonely_test.rb

@@ -0,0 +1,152 @@
+require 'test_helper'
+
+require 'representable/json/collection'
+require 'representable/json/hash'
+
+class LonelyRepresenterTest < MiniTest::Spec
+  module SongRepresenter
+    include Representable::JSON
+    property :name
+  end
+
+  let (:decorator) { rpr = representer; Class.new(Representable::Decorator) { include rpr } }
+
+  describe "JSON::Collection" do
+    let (:songs) { [Song.new("Days Go By"), Song.new("Can't Take Them All")] }
+    let (:json)  { "[{\"name\":\"Days Go By\"},{\"name\":\"Can't Take Them All\"}]" }
+
+    describe "with contained objects" do
+      let (:representer) {
+        Module.new do
+          include Representable::JSON::Collection
+          items :class => Song, :extend => SongRepresenter
+        end
+      }
+
+
+      it "renders array" do
+        assert_json json, songs.extend(representer).to_json
+      end
+
+      it "renders array with decorator" do
+        assert_json json, decorator.new(songs).to_json
+      end
+
+      it "parses array" do
+        [].extend(representer).from_json(json).must_equal songs
+      end
+
+      it "parses array with decorator" do
+        decorator.new([]).from_json(json).must_equal songs
+      end
+    end
+
+    describe "with inline representer" do
+      representer!(:module => Representable::JSON::Collection) do
+        items :class => Song do
+          property :name
+        end
+      end
+
+      it { songs.extend(representer).to_json.must_equal json }
+      it { [].extend(representer).from_json(json).must_equal songs }
+    end
+
+    describe "with contained text" do
+      let (:representer) {
+        Module.new do
+          include Representable::JSON::Collection
+        end
+      }
+      let (:songs) { ["Days Go By", "Can't Take Them All"] }
+      let (:json)  { "[\"Days Go By\",\"Can't Take Them All\"]" }
+
+      it "renders contained items #to_json" do
+        assert_json json, songs.extend(representer).to_json
+      end
+
+      it "returns objects array from #from_json" do
+        [].extend(representer).from_json(json).must_equal songs
+      end
+    end
+  end
+
+
+  describe "JSON::Hash" do  # TODO: move to HashTest.
+    describe "with contained objects" do
+      let (:representer) {
+        Module.new do
+          include Representable::JSON::Hash
+          values :class => Song, :extend => SongRepresenter
+        end
+      }
+      let (:json)  { "{\"one\":{\"name\":\"Days Go By\"},\"two\":{\"name\":\"Can't Take Them All\"}}" }
+      let (:songs) { {"one" => Song.new("Days Go By"), "two" => Song.new("Can't Take Them All")} }
+
+      describe "#to_json" do
+        it "renders hash" do
+          songs.extend(representer).to_json.must_equal json
+        end
+
+        it "renders hash with decorator" do
+          decorator.new(songs).to_json.must_equal json
+        end
+
+        it "respects :exclude" do
+          assert_json "{\"two\":{\"name\":\"Can't Take Them All\"}}", {:one => Song.new("Days Go By"), :two => Song.new("Can't Take Them All")}.extend(representer).to_json(:exclude => [:one])
+        end
+
+        it "respects :include" do
+          assert_json "{\"two\":{\"name\":\"Can't Take Them All\"}}", {:one => Song.new("Days Go By"), :two => Song.new("Can't Take Them All")}.extend(representer).to_json(:include => [:two])
+        end
+      end
+
+      describe "#from_json" do
+        it "returns objects array" do
+          {}.extend(representer).from_json(json).must_equal songs
+        end
+
+        it "parses hash with decorator" do
+          decorator.new({}).from_json(json).must_equal songs
+        end
+
+        it "respects :exclude" do
+          assert_equal({"two" => Song.new("Can't Take Them All")}, {}.extend(representer).from_json(json, :exclude => [:one]))
+        end
+
+        it "respects :include" do
+          assert_equal({"one" => Song.new("Days Go By")}, {}.extend(representer).from_json(json, :include => [:one]))
+        end
+      end
+
+
+      describe "with inline representer" do
+        representer!(:module => Representable::JSON::Hash) do
+          values :class => Song do
+            property :name
+          end
+        end
+
+        it { songs.extend(representer).to_json.must_equal json }
+        it { {}.extend(representer).from_json(json).must_equal songs }
+      end
+    end
+
+
+    describe "with contained text" do
+      before do
+        @songs_representer = Module.new do
+          include Representable::JSON::Collection
+        end
+      end
+
+      it "renders contained items #to_json" do
+        assert_json "[\"Days Go By\",\"Can't Take Them All\"]", ["Days Go By", "Can't Take Them All"].extend(@songs_representer).to_json
+      end
+
+      it "returns objects array from #from_json" do
+        assert_equal ["Days Go By", "Can't Take Them All"], [].extend(@songs_representer).from_json("[\"Days Go By\",\"Can't Take Them All\"]")
+      end
+    end
+  end
+end

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.3
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-16 00:00:00.000000000 Z
+date: 2014-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: uber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test_xml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.7.7
 description: Renders and parses JSON/XML/YAML documents from and to Ruby objects.
@@ -158,8 +158,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
+- .gitignore
+- .travis.yml
 - CHANGES.md
 - Gemfile
 - LICENSE
@@ -215,6 +215,7 @@ files:
 - test/instance_test.rb
 - test/is_representable_test.rb
 - test/json_test.rb
+- test/lonely_test.rb
 - test/mongoid_test.rb
 - test/nested_test.rb
 - test/parse_strategy_test.rb
@@ -239,55 +240,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Renders and parses JSON/XML/YAML documents from and to Ruby objects. Includes
   plain properties, collections, nesting, coercion and more.
-test_files:
-- test/as_test.rb
-- test/class_test.rb
-- test/coercion_test.rb
-- test/config_test.rb
-- test/decorator_scope_test.rb
-- test/decorator_test.rb
-- test/definition_test.rb
-- test/example.rb
-- test/exec_context_test.rb
-- test/generic_test.rb
-- test/getter_setter_test.rb
-- test/hash_bindings_test.rb
-- test/hash_test.rb
-- test/if_test.rb
-- test/inherit_test.rb
-- test/inheritance_test.rb
-- test/inline_test.rb
-- test/instance_test.rb
-- test/is_representable_test.rb
-- test/json_test.rb
-- test/mongoid_test.rb
-- test/nested_test.rb
-- test/parse_strategy_test.rb
-- test/pass_options_test.rb
-- test/prepare_test.rb
-- test/reader_writer_test.rb
-- test/representable_test.rb
-- test/serialize_deserialize_test.rb
-- test/stringify_hash_test.rb
-- test/test_helper.rb
-- test/test_helper_test.rb
-- test/wrap_test.rb
-- test/xml_bindings_test.rb
-- test/xml_test.rb
-- test/yaml_test.rb
-has_rdoc: 
+test_files: []