representable 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5caccf4a60cbe2ca6066a047755a13a741b488b1
-  data.tar.gz: aa57e2ec29209f936b58642ac84cfdf223e6d09b
+SHA256:
+  metadata.gz: 434f6b67a146dfc89f329264bbb7db7ef99c80d83c46c440e5f62cebe4b8e374
+  data.tar.gz: ea7e31233c1df043a16debdf7830c6418865b73a2f109f2b6fe355f74d4794f7
 SHA512:
-  metadata.gz: 9c5047e0c91d61a43677bd92cc64fbee0e34292b3b24ea59d10e2962075626c8c6dddd4b64c21092f65ed4d3abcfa1458f318bfd4d179085052c53565eb1d8ec
-  data.tar.gz: be1d272ce967973dbac844beb02f7d1418adb9f1c59b02ca9472a912bde994ffa7543158c3f8543ae5a172dda49c1f838ce963e5413e5c83b204bddd8aa9366c
+  metadata.gz: 9573431c3894f9ad750101b6a776be465a17a7ee9a5744d5da4917c133fbdec766ce2fcc321d3592eaf27db4bdc5df9f38bd794f100a047be1aa6cf5648b0914
+  data.tar.gz: '0185e5bde9a8f185ac586f3eb254d8422c55435191a4ff0badae632e12be9b6f5952d35dff9639576ca725c53b2098b87281497a8bd9021034fd0643b838ad40'

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.5, 2.6, 2.7, '3.0', head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/CHANGES.md

@@ -1,3 +1,28 @@
+# 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

@@ -3,8 +3,9 @@
 Representable maps Ruby objects to documents and back.
 
 [![Gitter Chat](https://badges.gitter.im/trailblazer/chat.svg)](https://gitter.im/trailblazer/chat)
+[![TRB Newsletter](https://img.shields.io/badge/TRB-newsletter-lightgrey.svg)](http://trailblazer.to/newsletter/)
 [![Build
-Status](https://travis-ci.org/apotonick/representable.svg)](https://travis-ci.org/apotonick/representable)
+Status](https://travis-ci.org/trailblazer/representable.svg)](https://travis-ci.org/trailblazer/representable)
 [![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.
@@ -34,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
 
@@ -131,6 +130,7 @@ class AlbumRepresenter < Representable::Decorator
     property :track
     collection :composers
   end
+end
 ```
 
 ## More
@@ -142,8 +142,8 @@ Please check the [official documentation for more](http://trailblazer.to/gems/re
 
 ## 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 +169,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).

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.rb

@@ -1,7 +1,8 @@
 require "uber/delegates"
-
+require "uber/callable"
 require "declarative/schema"
 
+require "representable/option"
 require "representable/config"
 require "representable/definition"
 require "representable/declarative"
@@ -15,6 +16,17 @@ require "representable/for_collection"
 require "representable/represent"
 
 module Representable
+  autoload :Binding, 'representable/binding'
+  autoload :HashMethods, 'representable/hash_methods'
+  autoload :Decorator, 'representable/decorator'
+
+  autoload :Hash, 'representable/hash'
+  autoload :JSON, 'representable/json'
+  autoload :Object, 'representable/object'
+  autoload :YAML, 'representable/yaml'
+  autoload :XML, 'representable/xml'
+
+
   attr_writer :representable_attrs
 
   def self.included(base)
@@ -31,7 +43,7 @@ module Representable
 private
   # Reads values from +doc+ and sets properties accordingly.
   def update_properties_from(doc, options, format)
-    propagated_options = normalize_options(options)
+    propagated_options = normalize_options(**options)
 
     representable_map!(doc, propagated_options, format, :uncompile_fragment)
     represented
@@ -39,25 +51,12 @@ private
 
   # Compiles the document going through all properties.
   def create_representation_with(doc, options, format)
-    propagated_options = normalize_options(options)
+    propagated_options = normalize_options(**options)
 
     representable_map!(doc, propagated_options, format, :compile_fragment)
     doc
   end
 
-  class Binding::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
 
   def representable_map(options, format)
     Binding::Map.new(representable_bindings_for(format, options))
@@ -73,9 +72,8 @@ private
     representable_attrs.collect {|definition| format.build(definition) }
   end
 
-  def normalize_options(options)
-    return options if options.any?
-    {user_options: {}}.merge(options) # TODO: use keyword args once we drop 2.0.
+  def normalize_options(user_options: {}, **options)
+    { user_options: user_options }.merge(options)
   end
 
   # Prepares options for a particular nested representer.
@@ -95,8 +93,8 @@ private
     @representable_attrs ||= self.class.definitions
   end
 
-  def representation_wrap(*args)
-    representable_attrs.wrap_for(represented, *args)
+  def representation_wrap(options = {})
+    representable_attrs.wrap_for(represented, options)
   end
 
   def represented
@@ -117,8 +115,4 @@ private
       represented.extend(self)
     end
   end
-
-  # require "representable/deprecations"
 end
-
-require 'representable/autoload'

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