representable 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5caccf4a60cbe2ca6066a047755a13a741b488b1
-  data.tar.gz: aa57e2ec29209f936b58642ac84cfdf223e6d09b
+SHA256:
+  metadata.gz: f3a1388b7570e31d62c555a87d6165793e9d095cf1bed18c04cb8cbe86bc2ba2
+  data.tar.gz: 43e418db52478d3d4fc33f505ce86d840fcb666a8abc83e20269bbfab4c53a3a
 SHA512:
-  metadata.gz: 9c5047e0c91d61a43677bd92cc64fbee0e34292b3b24ea59d10e2962075626c8c6dddd4b64c21092f65ed4d3abcfa1458f318bfd4d179085052c53565eb1d8ec
-  data.tar.gz: be1d272ce967973dbac844beb02f7d1418adb9f1c59b02ca9472a912bde994ffa7543158c3f8543ae5a172dda49c1f838ce963e5413e5c83b204bddd8aa9366c
+  metadata.gz: 39e957975d24f76894ef9a7186fff69155525e5f777c120a77e2ecee8a7dcdccee62b2140ed8ab34ebc9de916a9098d9da846e0befda2c90fa32e4a9ff470ecc
+  data.tar.gz: cf309756f2470854283c09bbca25b3200b26ba1702b75e533573382dabd2f33a6f3eeaee963c2cc2bb0ddb9d3bdf026bf7dacba6da3f22f44dc805bc8d1ca505

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, '3.0', "3.1"]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/CHANGES.md

@@ -1,3 +1,36 @@
+# 3.2.0
+* Drop support for Virtus Coercion
+* Fix deprecation warning with Nokogiri 1.13.0
+
+# 3.1.1
+
+* Upgrade `trailblazer-option` to `0.1.1` which supports passing an empty `keyword_arguments`.
+
+# 3.1.0
+* Remove circular require
+* Use Dry-types 1.0.0+ as coercion library
+* Renamed Coercion to VirtusCoercion to support old codebases
+* Replace `declarative-option` with [`trailblazer-option`](https://github.com/trailblazer/trailblazer-option)
+
+# 3.0.4
+
+* Add proper XML namespace support.
+* [internal] Replace `XML::Binding#node_for` with function `XML::Node`.
+
+# 3.0.3
+
+* Replace `Uber::Option` with the new [`Declarative::Option`](https://github.com/apotonick/declarative-option). This should result in a significant performance boost.
+
+# 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.
+
 # 3.0.0
 
 * Removed deprecations from 2.4.

data/Gemfile

@@ -1,19 +1,11 @@
-source 'https://rubygems.org'
+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"
+  gem "multi_json", require: false
+  gem "nokogiri", require: false
 end
+gem 'pry-byebug'
 
-# gem "declarative", path: "../declarative"
-# gem "declarative", github: "apotonick/declarative"

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 - 2013 Nick Sutterer and the roar contributors
+Copyright (c) 2011 - 2021 Nick Sutterer and the roar contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,19 +2,19 @@
 
 Representable maps Ruby objects to documents and back.
 
-[![Gitter Chat](https://badges.gitter.im/trailblazer/chat.svg)](https://gitter.im/trailblazer/chat)
-[![Build
-Status](https://travis-ci.org/apotonick/representable.svg)](https://travis-ci.org/apotonick/representable)
+![Build
+Status](https://github.com/trailblazer/representable/actions/workflows/ci.yml/badge.svg?branch=master)
 [![Gem Version](https://badge.fury.io/rb/representable.svg)](http://badge.fury.io/rb/representable)
 
+
 In other words: Take an object and decorate it with a representer module. This will allow you to render a JSON, XML or YAML document from that object. But that's only half of it! You can also use representers to parse a document and create or populate an object.
 
-Representable is helpful for all kind of mappings, rendering and parsing workflows. However, it is mostly useful in API code. Are you planning to write a real REST API with representable? Then check out the [Roar](http://github.com/apotonick/roar) gem first, save work and time and make the world a better place instead.
+Representable is helpful for all kind of mappings, rendering and parsing workflows. However, it is mostly useful in API code. Are you planning to write a real REST API with representable? Then check out the [Roar](https://github.com/trailblazer/roar) gem first, save work and time and make the world a better place instead.
 
 
 ## Full Documentation
 
-Representable comes with a rich set of options and semantics for parsing and rendering documents. Its [full documentation](http://trailblazer.to/gems/representable/3.0/api.html) can be found on the Trailblazer site.
+Representable comes with a rich set of options and semantics for parsing and rendering documents. Its [full documentation](https://trailblazer.to/2.1/docs/representable.html) can be found on the Trailblazer site.
 
 ## Example
 
@@ -34,8 +34,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
 
@@ -65,7 +63,7 @@ song = SongRepresenter.new(song).from_json(%{ {"title":"Roxanne"} })
 #=> #<Song title="Roxanne", track=nil>
 ```
 
-Note that parsing hashes per default does [require string keys](http://trailblazer.to/gems/representable/3.0/api.html#symbol-keys) and does _not_ pick up symbol keys.
+Note that parsing hashes per default does [require string keys](https://trailblazer.to/2.1/docs/representable.html#representable-api-symbol-keys) and does _not_ pick up symbol keys.
 
 
 ## Collections
@@ -131,19 +129,20 @@ class AlbumRepresenter < Representable::Decorator
     property :track
     collection :composers
   end
+end
 ```
 
 ## More
 
 Representable has many more features and can literally parse and render any kind of document to an arbitrary Ruby object graph.
 
-Please check the [official documentation for more](http://trailblazer.to/gems/representable/).
+Please check the [official documentation for more](https://trailblazer.to/2.1/docs/representable.html#representable-api).
 
 
 ## Installation
 
-The representable gem runs with all Ruby versions >= 1.9.3.
-
+The representable gem runs with all Ruby versions >= 2.4.0.
+t
 ```ruby
 gem 'representable'
 ```
@@ -169,7 +168,7 @@ gem 'nokogiri'
 
 Representable started as a heavily simplified fork of the ROXML gem. Big thanks to Ben Woosley for his extremely inspiring work.
 
-* Copyright (c) 2011-2016 Nick Sutterer <apotonick@gmail.com>
+* Copyright (c) 2011-2020 Nick Sutterer <apotonick@gmail.com>
 * ROXML is Copyright (c) 2004-2009 Ben Woosley, Zak Mandhro and Anders Engstrom.
 
-Representable is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+Representable is released under the [MIT License](https://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -1,3 +1,4 @@
+require "bundler/gem_tasks"
 require 'bundler/setup'
 require 'rake/testtask'
 
@@ -9,9 +10,3 @@ Rake::TestTask.new(:test) do |test|
   test.test_files = FileList['test/**/*_test.rb']
   test.verbose = true
 end
-
-Rake::TestTask.new(:dtest) do |test|
-  test.libs << 'test-with-deprecations'
-  test.test_files = FileList['test-with-deprecations/**/*_test.rb']
-  test.verbose = true
-end

data/TODO

@@ -1,8 +1,6 @@
 * Pass key/index as first block arg to :class and :extend
 class: |key, hsh|
 
-* Allow passing options to Binding#serialize.
-	serialize(.., options{:exclude => ..})
 
 document `XML::AttributeHash` etc
 
@@ -37,4 +35,4 @@ module ReaderWriter
 * DISCUSS: should inline representers be created at runtime, so we don't need ::representer_engine?
 * deprecate `Decorator::Coercion`.
 
-* cleanup XML so it matches the current #serialize standard.
+* cleanup XML so it matches the current #serialize standard.

data/TODO-4.0.md

@@ -0,0 +1,72 @@
+# Decorator
+
+  XML::Binding::Collection.to_xml(represented)
+    bindings.each bin.to_xml
+
+
+  # hat vorteil: [].each{ Collection.to_xml(item) }
+
+* make all properties "Object-like", even arrays of strings etc. This saves us from having `extend ObjectBinding if typed?` and we could just call to_hash/from_hash on all attributes. performance issues here? otherwise: implement!
+
+
+# how to?
+
+class CH
+  wrap :character
+  prpoerty :a
+
+
+class
+  proerty :author, dec: CH
+
+# how to?
+
+* override specific bindings and their logic? e.g. `Namespace#read`
+* Extend nested representers, e.g. the namespace prefix, when it gets plugged into composition
+* Easier polymorphic representer
+
+# XML
+
+* ditch annoying nokogiri in favor of https://github.com/YorickPeterse/oga
+
+# Parsing
+
+* Let bindings have any "xpath"
+* Allow to parse "wildcard" sections where you have no idea about the property names (and attribute names, eg. with links)
+
+# Options
+
+* There should be an easier way to pass a set of options to all nested #to_node decorators.
+
+```ruby
+representable_attrs.keys.each do |property|
+  options[property.to_sym] = { show_definition: false, namespaces: options[:namespaces] }
+end
+```
+
+* Allow passing options to Binding#serialize.
+  serialize(.., options{:exclude => ..})
+
+
+# wrap, as
+
+AsWithNamespace( Binding )
+   BUT NOT FOR AsWithNamespace( Binding::Attribute )
+  => selectively wrap bindings at compile- and runtime
+
+
+
+
+
+
+* Cleanup the manifest part in Decorator.
+
+* all property objects should be extended/wrapped so we don't need the switch.
+
+# Deprecations
+
+* deprecate instance: { nil } which is superseded by parse_strategy: :sync
+
+
+
+from_hash, property :band, class: vergessen

data/lib/representable/binding.rb

@@ -1,8 +1,26 @@
+# frozen_string_literal: true
+
+require 'uber/delegates'
+
 module Representable
   # The Binding provides methods to read/write the fragment for one property.
   #
   # Actually parsing the fragment from the document happens in Binding#read, everything after that is generic.
   class Binding
+    class Map < Array
+      def call(method, options)
+        each do |bin|
+          options[:binding] = bin # this is so much faster than options.merge().
+          bin.send(method, options)
+        end
+      end
+
+      # TODO: Merge with Definitions.
+      def <<(binding) # can be slow. this is compile time code.
+        (existing = find { |bin| bin.name == binding.name }) ? self[index(existing)] = binding : super(binding)
+      end
+    end
+
     class FragmentNotFound
     end
 
@@ -29,12 +47,12 @@ module Representable
     module Deprecatable
       # Retrieve value and write fragment to the doc.
       def compile_fragment(options)
-        render_pipeline(nil, options).(nil, options)
+        render_pipeline(nil, options).call(nil, options)
       end
 
       # Parse value from doc and update the model property.
       def uncompile_fragment(options)
-        parse_pipeline(options[:doc], options).(options[:doc], options)
+        parse_pipeline(options[:doc], options).call(options[:doc], options)
       end
     end
     include Deprecatable
@@ -43,7 +61,7 @@ module Representable
       def evaluate_option(name, input, options)
         proc = self[name]
         # puts "@@@@@ #{self.inspect}, #{name}...... #{self[name]}"
-        proc.(send(:exec_context, options), options.merge(user_options: options[:options][:user_options], input: input)) # from Uber::Options::Value. # NOTE: this can also be the Proc object if it's not wrapped by Uber:::Value.
+        proc.call(exec_context: send(:exec_context, options), keyword_arguments: options.merge(user_options: options[:options][:user_options], input: input)) # from Uber::Options::Value. # NOTE: this can also be the Proc object if it's not wrapped by Uber:::Value.
       end
     end
     include EvaluateOption
@@ -53,29 +71,30 @@ module Representable
     end
 
     def skipable_empty_value?(value)
-      value.nil? and not self[:render_nil]
+      value.nil? and !(self[:render_nil])
     end
 
     def default_for(value)
       return self[:default] if skipable_empty_value?(value)
+
       value
     end
 
     attr_accessor :cached_representer
 
-    require "representable/pipeline_factories"
+    require 'representable/pipeline_factories'
     include Factories
 
-  private
+    private
 
     def setup_exec_context!
-      @exec_context = ->(options) { options[:represented] }     unless self[:exec_context]
-      @exec_context = ->(options) { self }                      if self[:exec_context] == :binding
-      @exec_context = ->(options) { options[:decorator] }       if self[:exec_context] == :decorator
+      @exec_context = ->(options) { options[:represented] } unless self[:exec_context]
+      @exec_context = ->(_options) { self } if self[:exec_context] == :binding
+      @exec_context = ->(options) { options[:decorator] } if self[:exec_context] == :decorator
     end
 
     def exec_context(options)
-      @exec_context.(options)
+      @exec_context.call(options)
     end
 
     def parse_pipeline(input, options)
@@ -90,8 +109,9 @@ module Representable
     module Collection
       def skipable_empty_value?(value)
         # TODO: this can be optimized, again.
-        return true if value.nil? and not self[:render_nil] # FIXME: test this without the "and"
-        return true if self[:render_empty] == false and value and value.size == 0  # TODO: change in 2.0, don't render emtpy.
+        return true if value.nil? && !(self[:render_nil]) # FIXME: test this without the "and"
+
+        true if (self[:render_empty] == false) && value && value.empty? # TODO: change in 2.0, don't render emtpy.
       end
     end
   end

data/lib/representable/cached.rb

@@ -19,4 +19,4 @@ module Representable
       self.class.map
     end
   end
-end
+end

data/lib/representable/coercion.rb

@@ -1,16 +1,18 @@
-require "virtus"
+gem 'dry-types', '>= 1.0.0'
+require "dry-types"
 
 module Representable
   module Coercion
+    module Types
+      include Dry::Types()
+    end
     class Coercer
       def initialize(type)
         @type = type
       end
 
-      # This gets called when the :render_filter or :parse_filter option is evaluated.
-      # Usually the Coercer instance is an element in a Pipeline to allow >1 filters per property.
-      def call(input, options)
-        Virtus::Attribute.build(@type).coerce(input)
+      def call(input, _options)
+        @type.call(input)
       end
     end
 
@@ -34,4 +36,4 @@ module Representable
       end
     end
   end
-end
+end

data/lib/representable/config.rb

@@ -1,10 +1,19 @@
+require 'declarative/definitions'
+
 module Representable
+  autoload :Option, 'representable/option'
+
   # 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 Config < ::Declarative::Definitions
+    def initialize(*)
+      super
+      @wrap = nil
+    end
+
     def remove(name)
       delete(name.to_s)
     end
@@ -15,16 +24,17 @@ module Representable
 
     def wrap=(value)
       value = value.to_s if value.is_a?(Symbol)
-      @wrap = Uber::Options::Value.new(value)
+      @wrap = ::Representable::Option(value)
     end
 
     # Computes the wrap string or returns false.
-    def wrap_for(represented, *args, &block)
+    def wrap_for(represented, options = {}, &block)
       return unless @wrap
 
-      value = @wrap.evaluate(represented, *args)
+      value = @wrap.(exec_context: represented, keyword_arguments: options.to_hash)
 
       return value if value != true
+
       infer_name_for(represented.class.name)
     end
 

data/lib/representable/debug.rb

@@ -1,16 +1,24 @@
+require 'logger'
+
 module Representable
   module Debug
+    module_function def _representable_logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    module_function def representable_log(message)
+      _representable_logger.debug { message }
+    end
+
     def update_properties_from(doc, options, format)
-      puts
-      puts "[Deserialize]........."
-      puts "[Deserialize] document #{doc.inspect}"
+      representable_log "[Deserialize]........."
+      representable_log "[Deserialize] document #{doc.inspect}"
       super
     end
 
     def create_representation_with(doc, options, format)
-      puts
-      puts "[Serialize]........."
-      puts "[Serialize]"
+      representable_log "[Serialize]........."
+      representable_log "[Serialize]"
       super
     end
 
@@ -22,13 +30,13 @@ module Representable
 
     module Binding
       def evaluate_option(name, *args, &block)
-        puts "=====#{self[name]}" if name ==:prepare
-        puts (evaled = self[name]) ?
+        Debug.representable_log "=====#{self[name]}" if name ==:prepare
+        Debug.representable_log (evaled = self[name]) ?
           "                #evaluate_option [#{name}]: eval!!!" :
           "                #evaluate_option [#{name}]: skipping"
         value = super
-        puts "                #evaluate_option [#{name}]: --> #{value}" if evaled
-        puts "                #evaluate_option [#{name}]: -->= #{args.first}" if name == :setter
+        Debug.representable_log "                #evaluate_option [#{name}]: --> #{value}" if evaled
+        Debug.representable_log "                #evaluate_option [#{name}]: -->= #{args.first}" if name == :setter
         value
       end
 
@@ -45,17 +53,17 @@ module Representable
 
   module Pipeline::Debug
     def call(input, options)
-      puts "Pipeline#call: #{inspect}"
-      puts "               input: #{input.inspect}"
+      Debug.representable_log "Pipeline#call: #{inspect}"
+      Debug.representable_log "               input: #{input.inspect}"
       super
     end
 
     def evaluate(block, memo, options)
       block.extend(Pipeline::Debug) if block.is_a?(Collect)
 
-      puts "  Pipeline   :   -> #{_inspect_function(block)} "
+      Debug.representable_log "  Pipeline   :   -> #{_inspect_function(block)} "
       super.tap do |res|
-        puts "  Pipeline   :     result: #{res.inspect}"
+        Debug.representable_log "  Pipeline   :     result: #{res.inspect}"
       end
     end
 
@@ -70,8 +78,8 @@ module Representable
     def _inspect_function(func)
       return func.extend(Pipeline::Debug).inspect if func.is_a?(Collect)
       return func unless func.is_a?(Proc)
+
       File.readlines(func.source_location[0])[func.source_location[1]-1].match(/^\s+(\w+)/)[1]
     end
   end
 end
-

data/lib/representable/declarative.rb

@@ -1,4 +1,9 @@
+require "declarative/schema"
+
 module Representable
+  autoload :Decorator, "representation/decorator"
+  autoload :Definition, "representation/definition"
+
   module Declarative
     def representation_wrap=(name)
       heritage.record(:representation_wrap=, name)
@@ -21,9 +26,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
@@ -47,10 +52,10 @@ module Representable
     NestedBuilder = ->(options) do
       Module.new do
         include Representable # FIXME: do we really need this?
-        feature *options[:_features]
-        include *options[:_base] # base when :inherit, or in decorator.
+        feature(*options[:_features])
+        include(*options[:_base]) # base when :inherit, or in decorator.
 
-        module_eval &options[:_block]
+        module_eval(&options[:_block])
       end
     end
 
@@ -64,4 +69,4 @@ module Representable
 
     alias_method :representable_attrs, :definitions
   end
-end
+end

data/lib/representable/decorator.rb

@@ -1,5 +1,5 @@
-require "representable"
 require "uber/inheritable_attr"
+require "representable"
 
 module Representable
   class Decorator

data/lib/representable/definition.rb

@@ -1,7 +1,10 @@
-require "uber/options"
-require "representable/populator"
+require 'declarative/definitions'
 
 module Representable
+  autoload :Pipeline, "representable/pipeline"
+  autoload :Populator, "representable/populator"
+  autoload :Option, "representable/option"
+
   # Created at class compile time. Keeps configuration options for one property.
   class Definition < ::Declarative::Definitions::Definition
 
@@ -54,6 +57,7 @@ module Representable
 
     def representable?
       return if self[:representable] == false
+
       self[:representable] or typed?
     end
 
@@ -102,7 +106,7 @@ module Representable
       @runtime_options = {}
 
       for name, value in options
-        value = Uber::Options::Value.new(value) if dynamic_options.include?(name)
+        value = ::Representable::Option(value) if dynamic_options.include?(name)
         @runtime_options[name] = value
       end
     end

data/lib/representable/deserializer.rb

@@ -11,11 +11,11 @@ module Representable
   ReadFragment = ->(input, options) { options[:binding].read(input, options[:as]) }
   Reader = ->(input, options) { options[:binding].evaluate_option(:reader, input, options) }
 
-  StopOnNotFound = ->(input, options) do
+  StopOnNotFound = ->(input, _options) do
     Binding::FragmentNotFound == input ? Pipeline::Stop : input
   end
 
-  StopOnNil = ->(input, options) do # DISCUSS: Not tested/used, yet.
+  StopOnNil = ->(input, _options) do # DISCUSS: Not tested/used, yet.
     input.nil? ? Pipeline::Stop : input
   end
 
@@ -96,13 +96,14 @@ module Representable
   If = ->(input, options) { options[:binding].evaluate_option(:if, nil, options) ? input : Pipeline::Stop }
 
   StopOnExcluded = ->(input, options) do
-    return input unless private = options[:options]
+    return input unless options[:options]
     return input unless props = (options[:options][:exclude] || options[:options][:include])
 
     res = props.include?(options[:binding].name.to_sym) # false with include: Stop. false with exclude: go!
 
     return input if options[:options][:include]&&res
     return input if options[:options][:exclude]&&!res
+
     Pipeline::Stop
   end
-end
+end

data/lib/representable/for_collection.rb

@@ -24,4 +24,4 @@ module Representable
       @collection_representer = collection_representer!(options)
     end
   end
-end
+end