representable 2.0.0.rc2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2acf392fadc7e81f961fa72ccee559b56bbac22
-  data.tar.gz: 8c27f1a11cb756c4d906d751231a26574e06bc87
+  metadata.gz: c087dd37e5b99234457b7af5b0982c4238f1059e
+  data.tar.gz: 36e96f16f6a45cd22d5b1e281e0883027cd18c79
 SHA512:
-  metadata.gz: 482ed2034b6a2a09783be9b0aae1ee39ddb70f33cbdf5c60a459e90c6074c93ebf54f419535129f79804a7d524b690028ac308e8edcefc5eccb132032e6920a3
-  data.tar.gz: 1e3b78b78639a4c1c3955cb191f98a8b5e63002c76b274b6fa44b2d2179a76e26f685193f1d23e7dfc1bba6108e46510052e89e10667149eea8611ce36b67320
+  metadata.gz: 2712084960fe0e91579c9bd7a11a33c8ad1ad1512517810ee05b751b5d8dccc302fec8eb195b39b18c0283e62de3285dc972f15f4f9a2c6073f89829f3b8780b
+  data.tar.gz: 7de91a94a2264f81010610094d1ab81657dc4c4ac0376393e3bb6e717b9f844dd189ca921a6d397384f490253858e21e419931632f47cc074f48cd9580b38783

data/README.md

@@ -527,6 +527,8 @@ Here's a list of all dynamic options and their argument signature.
 * `instance: lambda { |fragment, [i], args| }` ([see Object Creation](#polymorphic-object-creation))
 * `reader: lambda { |document, args| }` ([see Read And Write](#overriding-read-and-write))
 * `writer: lambda { |document, args| }` ([see Read And Write](#overriding-read-and-write))
+* `parse_filter:  lambda { |fragment, document, args| }` ([see Filters](#filters)))
+* `render_filter: lambda { |value, document, args| }` ([see Filters](#filters))
 * `if: lambda { |args| }` ([see Conditions](#conditions))
 * `prepare: lambda { |object, args| }` ([see docs](#rendering-and-parsing-without-extend))
 * `serialize: lambda { |object, args| }` ([see docs](#overriding-serialize-and-deserialize))
@@ -550,6 +552,48 @@ The `Options` instance exposes the following readers: `#binding`, `#represented`
 Option-specific arguments (e.g. `fragment`, [see here](#available-options)) are still prepended, making the `Options` object always the *last* argument.
 
 
+## Filters
+
+Representabe offers you `:render_filter` and `:parse_filter` to modify the value to be rendered or parsed.
+
+Filters are implemented using `Pipeline`, which means you can add as many as you want. The result from the former filter will be passed to the next.
+
+```ruby
+property :title, render_filter: lambda { |value, doc, *args| value.html_safe }
+```
+
+This will be executed right before the fragment gets rendered into the document.
+
+```ruby
+property :title, parse_filter: lambda { |fragment, doc, *args| Sanitizer.call(fragment) }
+```
+
+Just before setting the fragment to the object via the `:setter`, the `:parse_filter` is called.
+
+
+## Callable Options
+
+While lambdas are one option for dynamic options, you might also pass a "callable" object to a directive.
+
+```ruby
+class Sanitizer
+  include Uber::Callable
+
+  def call(represented, fragment, doc, *args)
+    fragment.sanitize
+  end
+end
+```
+
+Note how including `Uber::Callable` marks instances of this class as callable. No `respond_to?` or other magic takes place here.
+
+```ruby
+property :title, parse_filter: Santizer.new
+```
+
+This is enough to have the `Sanitizer` class run with all the arguments that are usually passed to the lambda (preceded by the represented object as first argument).
+
+
 ## XML Support
 
 While representable does a great job with JSON, it also features support for XML, YAML and pure ruby hashes.

data/lib/representable/declarative.rb

@@ -49,10 +49,18 @@ module Representable
     end
 
   private
-    # NOTE: this will soon be extracted to separate class, use at your own risk.
+    # This method is meant to be overridden if you want to add or change DSL options.
+    # The options hash is already initialized, add or change elements as you need.
+    #
+    # Example:
+    #
+    # def build_definition(name, options, &block)
+    #   options[:pass_options] = true
+    #   options[:render_filter] << Sanitizer.new if options[:sanitize]
+    #   options[:setter] << lambda { |fragment, options| send("set_#{options.binding.name}=", fragment) }
+    #   super # don't forget to call super
+    # end
     def build_definition(name, options, &block)
-      # change options[..]= here.
-
       base = nil
 
       if options[:inherit] # TODO: move this to Definition.

data/lib/representable/version.rb

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

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.0.0
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-07-30 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,14 +250,14 @@ 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: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -265,46 +265,4 @@ 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/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
+test_files: []