representable 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81be665d8491efad3044c31114917a6b42e4dc36
-  data.tar.gz: dd49b35a842ac30a57f40d2b2a63784712c846ba
+  metadata.gz: 3ac8f58fd73f1e9aa9e35f3298490086dfb93d54
+  data.tar.gz: 054dcc8fdcf9cc7ce6f223747af5914457d19e90
 SHA512:
-  metadata.gz: a9dffbcdc7dcac66ee881278b55944ecc3ceda2b8ed5ddabae71bfc748bc59251e954e23bd2508e046a96ecaa448bc4895a19f8908e3bada0f4fef5315336eac
-  data.tar.gz: 273e167fe08c19f9b069ee9bcf4d9f81165fb64c892cb662e90dbe58e2b714ccfde39cfb2555f2e5520a0ea4e9865e3e8595542133816ef5f6f9a8e37d02c935
+  metadata.gz: af903f251a75b3d57899b4a0b428a84ff5436885939a8b59b6fb42b9fa4f517efca96ccb9b01bee969d9602a542b2b58a81171be8f4175204090a0e6c8f292c2
+  data.tar.gz: 58b9716576c0d790d1b4584ac480760c9539ca61cea4618574fec0e7cb9f415fe2b35d156839f1b2d1c531433fa652160faea4bb14b6d2299341e62c094ec426

data/.travis.yml

@@ -1,7 +1,10 @@
+language: ruby
+cache: bundler
+sudo: false
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.1
-  - 2.2.3
+  - 2.3.1
 before_install:
-  - gem install bundler
+  - gem install bundler

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 3.0.2
+
+* Initialize `Config@wrap` to avoid Ruby's warning.
+* Add `#render` and `#parse` alias methods to all format modules as a generic entry point.
+* In `GetValue`, use `public_send` now.
+
 # 3.0.1
 
 * Loosen `uber` dependency.

data/Gemfile

@@ -2,19 +2,11 @@ source 'https://rubygems.org'
 
 gemspec
 
-platform :rbx do
-  gem "psych"
-  gem "rubysl-irb"
-  gem "json_pure"
-end
-
 group :test do
   gem "nokogiri", require: false
   gem "multi_json", require: false
   gem "minitest-line"
-  gem "pry"
 end
 
 # gem "declarative", path: "../declarative"
 # gem "declarative", github: "apotonick/declarative"
-gem "uber", path: "../uber"

data/README.md

@@ -35,8 +35,6 @@ Representations are defined using representer classes, called _decorator, or mod
 In these examples, let's use decorators
 
 ```ruby
-require 'representable/json'
-
 class SongRepresenter < Representable::Decorator
   include Representable::JSON
 

data/lib/representable/autoload.rb

@@ -1,5 +1,9 @@
 module Representable
   autoload :Hash, 'representable/hash'
+  autoload :JSON, 'representable/json'
+  autoload :Object, 'representable/object'
+  autoload :YAML, 'representable/yaml'
+  autoload :XML, 'representable/xml'
 
   module Hash
     autoload :AllowSymbols, 'representable/hash/allow_symbols'

data/lib/representable/config.rb

@@ -5,6 +5,11 @@ module Representable
   # Overwrite definition_class if you need a custom Definition object (helpful when using
   # representable in other gems).
   class Config < ::Declarative::Definitions
+    def initialize(*)
+      super
+      @wrap = nil
+    end
+
     def remove(name)
       delete(name.to_s)
     end

data/lib/representable/declarative.rb

@@ -21,9 +21,9 @@ module Representable
     # them to the original object.
     def nested(name, options={}, &block)
       options = options.merge(
-        getter:   ->(options) { self },
-        setter:   ->(options) { },
-        instance: ->(options) { self },
+        getter:   ->(opts) { self },
+        setter:   ->(opts) { },
+        instance: ->(opts) { self },
       )
 
       if block

data/lib/representable/hash.rb

@@ -39,6 +39,9 @@ module Representable
       {wrap => hash}
     end
 
+    alias_method :render, :to_hash
+    alias_method :parse, :from_hash
+
   private
     def filter_wrap(data, options)
       return data if options[:wrap] == false

data/lib/representable/json.rb

@@ -43,5 +43,8 @@ module Representable
     def to_json(*args)
       MultiJson.dump to_hash(*args)
     end
+
+    alias_method :render, :to_json
+    alias_method :parse, :from_json
   end
 end

data/lib/representable/json/hash.rb

@@ -1,4 +1,3 @@
-require 'representable/json'
 require 'representable/hash_methods'
 
 module Representable::JSON

data/lib/representable/populator.rb

@@ -21,7 +21,7 @@ module Representable
     def self.apply!(options)
       return unless populator = options[:populator]
 
-      options[:parse_pipeline] = ->(input, options) do
+      options[:parse_pipeline] = ->(input, opts) do
         pipeline = Pipeline[*parse_functions] # TODO: AssignFragment
         pipeline = Pipeline::Insert.(pipeline, SetValue, delete: true) # remove the setter function.
         pipeline = Pipeline::Insert.(pipeline, populator, replace: CreateObject::Populator) # let the actual populator do the job.

data/lib/representable/serializer.rb

@@ -3,7 +3,7 @@ module Representable
     options[:binding].evaluate_option(:getter, input, options)
   end
 
-  GetValue = ->(input, options) { options[:binding].send(:exec_context, options).send(options[:binding].getter) }
+  GetValue = ->(input, options) { options[:binding].send(:exec_context, options).public_send(options[:binding].getter) }
 
   Writer = ->(input, options) do
     options[:binding].evaluate_option(:writer, input, options)

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "3.0.1"
+  VERSION = "3.0.2"
 end

data/lib/representable/xml.rb

@@ -56,6 +56,9 @@ module Representable
       to_node(*args).to_s
     end
 
+    alias_method :render, :to_xml
+    alias_method :parse, :from_xml
+
   private
     def remove_namespaces?
       # TODO: make local Config easily extendable so you get Config#remove_ns? etc.

data/lib/representable/yaml.rb

@@ -38,5 +38,8 @@ module Representable
       doc.children << to_ast(*args)
       stream.to_yaml
     end
+
+     alias_method :render, :to_yaml
+    alias_method :parse, :from_yaml
   end
 end

data/representable.gemspec

@@ -27,9 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "test_xml", "0.1.6"
   spec.add_development_dependency "minitest"
-  spec.add_development_dependency "mongoid"
   spec.add_development_dependency "virtus"
-  spec.add_development_dependency "json", '>= 1.7.7'
-
   spec.add_development_dependency "ruby-prof"
 end

data/test/decorator_test.rb

@@ -12,9 +12,18 @@ class DecoratorTest < MiniTest::Spec
     collection :songs, :class => Song, :extend => SongRepresentation
   end
 
+  class RatingRepresentation < Representable::Decorator
+    include Representable::JSON
+
+    property :system
+    property :value
+  end
+
   let (:song) { Song.new("Mama, I'm Coming Home") }
   let (:album) { Album.new([song]) }
 
+  let (:rating) { OpenStruct.new(system: 'MPAA', value: 'R') }
+
   describe "inheritance" do
     let (:inherited_decorator) do
       Class.new(AlbumRepresentation) do
@@ -27,12 +36,16 @@ class DecoratorTest < MiniTest::Spec
 
   let (:decorator) { AlbumRepresentation.new(album) }
 
+  let(:rating_decorator) { RatingRepresentation.new(rating) }
+
   it "renders" do
     decorator.to_hash.must_equal({"songs"=>[{"name"=>"Mama, I'm Coming Home"}]})
     album.wont_respond_to :to_hash
     song.wont_respond_to :to_hash # DISCUSS: weak test, how to assert blank slate?
     # no @representable_attrs in decorated objects
     song.instance_variable_get(:@representable_attrs).must_equal nil
+
+    rating_decorator.to_hash.must_equal({"system" => "MPAA", "value" => "R"})
   end
 
   describe "#from_hash" do

data/test/example.rb

@@ -17,7 +17,6 @@ end
 
 song = Song.new(:title => "Fallout", :track => 1)
 
-require 'representable/json'
 module SongRepresenter
   include Representable::JSON
 

data/test/hash_test.rb

@@ -1,5 +1,27 @@
 require 'test_helper'
 
+class HashPublicMethodsTest < Minitest::Spec
+  #---
+  # from_hash
+  class BandRepresenter < Representable::Decorator
+    include Representable::Hash
+    property :id
+    property :name
+  end
+
+  let (:data) { {"id"=>1,"name"=>"Rancid"} }
+
+  it { BandRepresenter.new(Band.new).from_hash(data)[:id, :name].must_equal [1, "Rancid"] }
+  it { BandRepresenter.new(Band.new).parse(data)[:id, :name].must_equal [1, "Rancid"] }
+
+  #---
+  # to_hash
+  let (:band) { Band.new(1, "Rancid") }
+
+  it { BandRepresenter.new(band).to_hash.must_equal data }
+  it { BandRepresenter.new(band).render.must_equal data }
+end
+
 class HashWithScalarPropertyTest < MiniTest::Spec
   Album = Struct.new(:title)
 
@@ -157,4 +179,4 @@ class HashWithScalarCollectionTest < MiniTest::Spec
       album.extend(representer).from_hash("songs" => ["Off Key Melody", "Sinking"]).must_equal Album.new(["Off Key Melody", "Sinking"])
     end
   end
-end
+end

data/test/json_test.rb

@@ -1,10 +1,33 @@
 require 'test_helper'
 
 module JsonTest
+class JSONPublicMethodsTest < Minitest::Spec
+  #---
+  # from_json
+  class BandRepresenter < Representable::Decorator
+    include Representable::JSON
+    property :id
+    property :name
+  end
+
+  let (:json) { '{"id":1,"name":"Rancid"}' }
+
+  it { BandRepresenter.new(Band.new).from_json(json)[:id, :name].must_equal [1, "Rancid"] }
+  it { BandRepresenter.new(Band.new).parse(json)[:id, :name].must_equal [1, "Rancid"] }
+
+  #---
+  # to_json
+  let (:band) { Band.new(1, "Rancid") }
+
+  it { BandRepresenter.new(band).to_json.must_equal json }
+  it { BandRepresenter.new(band).render.must_equal json }
+end
+
   class APITest < MiniTest::Spec
     Json = Representable::JSON
     Def = Representable::Definition
 
+
     describe "JSON module" do
       before do
         @Band = Class.new do

data/test/mongoid_test.rb

@@ -1,31 +1,31 @@
-require 'test_helper'
-require 'mongoid'
-require 'mongoid/document'
+# require 'test_helper'
+# require 'mongoid'
+# require 'mongoid/document'
 
-class MongoidTest < MiniTest::Spec
-  describe "Mongoid compatibility" do
-    it "allows #to_json" do
-      class Profile
-        include Mongoid::Document
-        field :name
-      end
-      
-      class Dude
-        include Mongoid::Document
-        embeds_one :profile, :class_name => "MongoidTest::Profile"
-      end
-      
-      module ProfileRepresenter
-       include Representable::JSON
+# class MongoidTest < MiniTest::Spec
+#   describe "Mongoid compatibility" do
+#     it "allows #to_json" do
+#       class Profile
+#         include Mongoid::Document
+#         field :name
+#       end
 
-       property :name
-      end
+#       class Dude
+#         include Mongoid::Document
+#         embeds_one :profile, :class_name => "MongoidTest::Profile"
+#       end
 
-      dude = Dude.new
-      dude.profile = Profile.new
-      dude.profile.name = "Kofi"
-      
-      assert_equal "{\"name\":\"Kofi\"}", dude.profile.extend(ProfileRepresenter).to_json
-    end      
-  end
-end
+#       module ProfileRepresenter
+#        include Representable::JSON
+
+#        property :name
+#       end
+
+#       dude = Dude.new
+#       dude.profile = Profile.new
+#       dude.profile.name = "Kofi"
+
+#       assert_equal "{\"name\":\"Kofi\"}", dude.profile.extend(ProfileRepresenter).to_json
+#     end
+#   end
+# end

data/test/representable_test.rb

@@ -76,8 +76,6 @@ class RepresentableTest < MiniTest::Spec
     end
 
     it "allows mixing in multiple representers" do
-      require 'representable/json'
-      require 'representable/xml'
       class Bodyjar
         include Representable::XML
         include Representable::JSON

data/test/test_helper.rb

@@ -1,11 +1,7 @@
 require 'representable'
 
-require "json"
 require "psych"
 
-require 'representable/json'
-require 'representable/xml'
-require 'representable/yaml'
 require 'minitest/autorun'
 require 'test_xml/mini_test'
 
@@ -132,4 +128,10 @@ class BaseTest < MiniTest::Spec
   let (:song) { OpenStruct.new(:title => "Resist Stance") }
   let (:song_representer) { Module.new do include Representable::Hash; property :title end  }
 
-end
+end
+
+Band = Struct.new(:id, :name) do
+  def [](*attrs)
+    attrs.collect { |attr| send(attr) }
+  end
+end

data/test/xml_bindings_test.rb

@@ -1,10 +1,6 @@
 require 'test_helper'
-require 'representable/json'  # FIXME.
-require 'representable/xml/collection'
 require 'representable/xml/hash'
 
-require 'representable/xml'
-
 class XMLBindingTest < MiniTest::Spec
   module SongRepresenter
     include Representable::XML

data/test/xml_test.rb

@@ -1,22 +1,41 @@
 require 'test_helper'
-require 'representable/xml'
 
-class Band
-  include Representable::XML
-  property :name
-  attr_accessor :name
 
-  def initialize(name=nil)
-    name and self.name = name
+class XmlPublicMethodsTest < Minitest::Spec
+  #---
+  # from_hash
+  class BandRepresenter < Representable::Decorator
+    include Representable::XML
+    property :id
+    property :name
   end
-end
 
-class Album
-  attr_accessor :songs
-end
+  let (:data) { %{<data><id>1</id><name>Rancid</name></data>} }
+
+  it { BandRepresenter.new(Band.new).from_xml(data)[:id, :name].must_equal ["1", "Rancid"] }
+  it { BandRepresenter.new(Band.new).parse(data)[:id, :name].must_equal ["1", "Rancid"] }
 
+  #---
+  # to_hash
+  let (:band) { Band.new("1", "Rancid") }
+
+  it { BandRepresenter.new(band).to_xml.must_equal_xml data }
+  it { BandRepresenter.new(band).render.must_equal_xml data }
+end
 
 class XmlTest < MiniTest::Spec
+
+  class Band
+    include Representable::XML
+    property :name
+    attr_accessor :name
+
+    def initialize(name=nil)
+      name and self.name = name
+    end
+  end
+
+
   XML = Representable::XML
   Def = Representable::Definition
 
@@ -156,7 +175,8 @@ class XmlTest < MiniTest::Spec
       end
 
       it "extends contained models when serializing" do
-        @album = Album.new([Song.new("I Hate My Brain"), mr=Song.new("Mr. Charisma")], mr)
+        @album = Album.new(
+          [Song.new("I Hate My Brain"), mr=Song.new("Mr. Charisma")], mr)
         @album.extend(AlbumRepresenter)
 
         assert_xml_equal "<album>
@@ -222,6 +242,16 @@ class CDataBand
 end
 
 class TypedPropertyTest < MiniTest::Spec
+  class Band
+    include Representable::XML
+    property :name
+    attr_accessor :name
+
+    def initialize(name=nil)
+      name and self.name = name
+    end
+  end
+
   module AlbumRepresenter
     include Representable::XML
     property :band, :class => Band
@@ -288,6 +318,17 @@ end
 
 
 class CollectionTest < MiniTest::Spec
+  class Band
+    include Representable::XML
+    property :name
+    attr_accessor :name
+
+    def initialize(name=nil)
+      name and self.name = name
+    end
+  end
+
+
   describe ":class => Band, :as => :band, :collection => true" do
     class Compilation
       include Representable::XML
@@ -500,4 +541,4 @@ class XmlHashTest < MiniTest::Spec
     # FIXME: this NEVER worked!
     # it { OpenStruct.new.extend(representer).from_xml(doc).songs.must_equal({"first" => "The Gargoyle", "second" => "Bronx"}) }
   end
-end
+end

data/test/yaml_test.rb

@@ -1,5 +1,30 @@
 require 'test_helper'
 
+class YamlPublicMethodsTest < Minitest::Spec
+  #---
+  # from_yaml
+  class BandRepresenter < Representable::Decorator
+    include Representable::YAML
+    property :id
+    property :name
+  end
+
+  let (:data) { %{---
+id: 1
+name: Rancid
+} }
+
+  it { BandRepresenter.new(Band.new).from_yaml(data)[:id, :name].must_equal [1, "Rancid"] }
+  it { BandRepresenter.new(Band.new).parse(data)[:id, :name].must_equal [1, "Rancid"] }
+
+  #---
+  # to_yaml
+  let (:band) { Band.new("1", "Rancid") }
+
+  it { BandRepresenter.new(band).to_yaml.must_equal data }
+  it { BandRepresenter.new(band).render.must_equal data }
+end
+
 class YamlTest < MiniTest::Spec
   def self.yaml_representer(&block)
     Module.new do
@@ -159,4 +184,4 @@ songs:
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2016-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -86,20 +86,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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
@@ -114,20 +100,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '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
 - !ruby/object:Gem::Dependency
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement