representable 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c087dd37e5b99234457b7af5b0982c4238f1059e
-  data.tar.gz: 36e96f16f6a45cd22d5b1e281e0883027cd18c79
+  metadata.gz: 02b8c14c0fc4d4cd99d4906ce14f5ffc87d7add8
+  data.tar.gz: 8c378c85716d5bf817fc1a4659cf45b3f375d8c1
 SHA512:
-  metadata.gz: 2712084960fe0e91579c9bd7a11a33c8ad1ad1512517810ee05b751b5d8dccc302fec8eb195b39b18c0283e62de3285dc972f15f4f9a2c6073f89829f3b8780b
-  data.tar.gz: 7de91a94a2264f81010610094d1ab81657dc4c4ac0376393e3bb6e717b9f844dd189ca921a6d397384f490253858e21e419931632f47cc074f48cd9580b38783
+  metadata.gz: 09f69957eeed18fe92b93813b6dcff20dd08416260c50437a070f244b8f10ac3647264cbce5754b5da60395165b3bf37a2dd1e6cdea7c031dd0153c3b82f4895
+  data.tar.gz: b81e550bce5ad004793e25b1de50faa19b946560e754cdfc361b38661cce5e21bc8851c4f4b73b7868b9cdc00a2cee016544c794ef82fb8c9adec25e6ccc152e

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 2.0.1
+
+* Made is simpler to define your own `Definition` class by passing it to `Config.new(Definition)` in `Representer::build_config`.
+
 # 2.0.0
 
 ## Relevant
@@ -6,8 +10,8 @@
 * Inline representers in `Decorator` do *no longer inherit from `self`*. When defining an inline representer, they are always derived from `Representable::Decorator`. The base class can be changed by overriding `Decorator::default_inline_class` in the decorator class that defines an inline representer block.
 If you need to inherit common methods to all inline decorators, include the module using `::feature`: `Representer.feature(BetterProperty)`.
 * You can now define methods in inline representers! The block is now `module_eval`ed and not `instance_exec`ed anymore. Same goes for Decorators, note that you need to `exec_context: :decorator`, though. Here, the block is `class_eval`ed.
-* Removed behaviour for `instance: lambda { |*| nil }` which used to return `binding.get`. Simply do it yourself: `instance: lambda { |fragment, options| options.binding.get }` if you need this behaviour. If you use `:instance` and it returns `nil` it throws a `DeserializeError` now, which is way more understandable than `NoMethodError: undefined method `title=' for {"title"=>"Perpetual"}:Hash`.
-* Remove behaviour for `class: lambda { nil }` which used to return the fragment. This now throws a `DeserializeError`. Do it yourself with class: lambda { |fragment,*| fragment }.
+* Removed behaviour for `instance: lambda { |*| nil }` which used to return `binding.get`. Simply do it yourself: `instance: lambda { |fragment, options| options.binding.get }` if you need this behaviour. If you use `:instance` and it returns `nil` it throws a `DeserializeError` now, which is way more understandable than `NoMethodError: undefined method 'title=' for {"title"=>"Perpetual"}:Hash`.
+* Remove behaviour for `class: lambda { nil }` which used to return the fragment. This now throws a `DeserializeError`. Do it yourself with `class: lambda { |fragment,*| fragment }`.
 * Coercion now happens inside `:render_filter` and `:parse_filter` (new!) and doesn't block `:getter` and `:setter` anymore. Also, we require virtus >=1.0 now.
 * `::representation_wrap=` in now properly inherited.
 * Including modules with representable `property .., inherit: true` into a `Decorator` crashed. This works fine now.
@@ -16,8 +20,8 @@ If you need to inherit common methods to all inline decorators, include the modu
 
 * Added `::for_collection` to automatically generate a collection representer for singular one. Thanks to @timoschilling for inspiring this years ago.
 * Added `::represent` that will detect collections and render the singular/collection with the respective representer.
-* Callable options
-* :parse_filter, :render_filter
+* Added `Callable` options.
+* Added `:parse_filter` and `:render_filter`.
 
 ## Internals
 

data/lib/representable/config.rb

@@ -14,13 +14,21 @@ module Representable
 
     # Stores Definitions from ::property. It preserves the adding order (1.9+).
     # Same-named properties get overridden, just like in a Hash.
+    #
+    # Overwrite definition_class if you need a custom Definition object (helpful when using
+    # representable in other gems).
     class Definitions < Inheritable::Hash
+      def initialize(definition_class)
+        @definition_class = definition_class
+        super()
+      end
+
       def add(name, options, &block)
         if options[:inherit] # i like that: the :inherit shouldn't be handled outside.
           return get(name).merge!(options, &block)
         end
 
-        self[name.to_s] = Definition.new(name, options, &block)
+        self[name.to_s] = definition_class.new(name, options, &block)
       end
 
       def get(name)
@@ -29,14 +37,17 @@ module Representable
 
       extend Forwardable
       def_delegators :values, :each # so we look like an array. this is only used in Mapper. we could change that so we don't need to hide the hash.
+
+    private
+      attr_reader :definition_class
     end
 
 
-    def initialize
+    def initialize(definition_class=Definition)
       super
       merge!(
         :features    => @features     = Inheritable::Hash.new,
-        :definitions => @definitions  = Definitions.new,
+        :definitions => @definitions  = Definitions.new(definition_class),
         :options     => @options      = Inheritable::Hash.new,
         :wrap        => nil )
     end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/test/representable_test.rb

@@ -520,4 +520,38 @@ class RepresentableTest < MiniTest::Spec
       inner.wont_be_kind_of Representable::Hash
     end
   end
+
+
+  # using your own Definition class
+  class StaticDefinition < Representable::Definition
+    def initialize(name, options)
+      options[:as] = :Name
+      super
+    end
+  end
+
+
+  module StaticRepresenter
+    def self.build_config
+      Representable::Config.new(StaticDefinition)
+    end
+    include Representable::Hash
+
+    property :title
+  end
+
+  # we currently need an intermediate decorator to inherit ::build_config properly.
+  class BaseDecorator < Representable::Decorator
+    include Representable::Hash
+    def self.build_config
+      Representable::Config.new(StaticDefinition)
+    end
+  end
+
+  class StaticDecorator < BaseDecorator
+    property :title
+  end
+
+  it { OpenStruct.new(:title => "Tarutiri").extend(StaticRepresenter).to_hash.must_equal({"Name"=>"Tarutiri"}) }
+  it { StaticDecorator.new(OpenStruct.new(:title => "Tarutiri")).to_hash.must_equal({"Name"=>"Tarutiri"}) }
 end

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-30 00:00:00.000000000 Z
+date: 2014-07-31 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.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.7
 - !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'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !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
 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
@@ -250,12 +250,12 @@ 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: []
@@ -265,4 +265,46 @@ 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_files:
+- test/as_test.rb
+- test/class_test.rb
+- test/coercion_test.rb
+- test/config/inherit_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/features_test.rb
+- test/filter_test.rb
+- test/for_collection_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/inheritable_test.rb
+- test/inline_test.rb
+- 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
+- test/pass_options_test.rb
+- test/prepare_test.rb
+- test/reader_writer_test.rb
+- test/represent_test.rb
+- test/representable_test.rb
+- test/schema_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