representable 3.0.4 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 04ca3309b8af78dd1eaa8b4d47c457323180a881
-  data.tar.gz: c7d43dc372fc53576a6b64f22d3fc0bd1bff5a4e
+SHA256:
+  metadata.gz: 7fac946d38143671ea43e0a6981d35dc7e8e8a0026af631fe53bb67d30f413c0
+  data.tar.gz: 3f98fb8a4ff2ea929ecd3afd9c97bc32fa7b7959d696a5c4ea4d5c9aecfac4d4
 SHA512:
-  metadata.gz: 528696ff8d8eae7b409566d9831a0117a90a361fdabe5a0345d0e5accac5cfbb2f3bfae5a34589000b5bdbf2632f7951356861215d210172c602b581694e68dc
-  data.tar.gz: 4d7409a62a9a25d31fc1c67d20e2b32b9cd0a1d8e9987b2cbe118bd4e069fe271dd82127f3e7656b92f01e8f1266524965def4089e439b4a1eac370e13a06bff
+  metadata.gz: 781a63fe0c5a650bc54d007dd6c16b20dec422b8312fa831b938ad0b78a1ffe5c6cbf640de1406574943035cbbc03925446e9ddd0cc640c1a0c9e9212b75d71e
+  data.tar.gz: fbedd21d3373cca798829c164357cc8c6d1470c9fe16b4d404b67a1df0f9eeebdb13a1ae262f585d54c4a2c4209573b23f211b4ca1430e801c21dca4c9451b4f

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,13 @@
+# 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.

data/Gemfile

@@ -1,14 +1,11 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
 group :test do
-  gem 'nokogiri', '~> 1.6.8', require: false
-  gem "multi_json", require: false
   gem "minitest-line"
+  gem "multi_json", require: false
+  gem "nokogiri", require: false
 end
+gem 'pry-byebug'
 
-# gem "declarative", path: "../declarative"
-# gem "declarative", github: "apotonick/declarative"
-
-# gem "uber","0.0.15" #, path: "../uber"

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

@@ -130,6 +130,7 @@ class AlbumRepresenter < Representable::Decorator
     property :track
     collection :composers
   end
+end
 ```
 
 ## More
@@ -141,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'
 ```
@@ -168,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/lib/representable.rb

@@ -1,8 +1,8 @@
 require "uber/delegates"
 require "uber/callable"
-require "declarative/option"
 require "declarative/schema"
 
+require "representable/option"
 require "representable/config"
 require "representable/definition"
 require "representable/declarative"
@@ -16,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)
@@ -32,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
@@ -40,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))
@@ -74,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.
@@ -96,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
@@ -118,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

data/lib/representable/config.rb

@@ -1,4 +1,8 @@
+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.
   #
@@ -20,16 +24,17 @@ module Representable
 
     def wrap=(value)
       value = value.to_s if value.is_a?(Symbol)
-      @wrap = ::Declarative::Option(value, instance_exec: true, callable: Uber::Callable)
+      @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.(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
-