representable 3.0.4 → 3.1.0

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:   ->(opts) { self },
+        getter:   ->(_opts) { self },
         setter:   ->(opts) { },
-        instance: ->(opts) { self },
+        instance: ->(_opts) { self },
       )
 
       if block
@@ -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,6 +1,10 @@
-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
 
@@ -53,6 +57,7 @@ module Representable
 
     def representable?
       return if self[:representable] == false
+
       self[:representable] or typed?
     end
 
@@ -101,7 +106,7 @@ module Representable
       @runtime_options = {}
 
       for name, value in options
-        value = ::Declarative::Option(value, instance_exec: true, callable: Uber::Callable) 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
 
@@ -103,6 +103,7 @@ module Representable
 
     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

data/lib/representable/hash.rb

@@ -6,6 +6,9 @@ module Representable
   # If you plan to write your own representer for a new media type, try to use this module (e.g., check how JSON reuses Hash's internal
   # architecture).
   module Hash
+    autoload :Collection, 'representable/hash/collection'
+    autoload :AllowSymbols, 'representable/hash/allow_symbols'
+
     def self.included(base)
       base.class_eval do
         include Representable # either in Hero or HeroRepresentation.
@@ -34,7 +37,7 @@ module Representable
       hash = create_representation_with({}, options, binding_builder)
 
       return hash if options[:wrap] == false
-      return hash unless wrap = options[:wrap] || representation_wrap(options)
+      return hash unless (wrap = options[:wrap] || representation_wrap(options))
 
       {wrap => hash}
     end
@@ -45,7 +48,8 @@ module Representable
   private
     def filter_wrap(data, options)
       return data if options[:wrap] == false
-      return data unless wrap = options[:wrap] || representation_wrap(options)
+      return data unless (wrap = options[:wrap] || representation_wrap(options))
+
       filter_wrap_for(data, wrap)
     end
 

data/lib/representable/hash/allow_symbols.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module Representable
   module Hash
     module AllowSymbols
-    private
+      private
+
       def filter_wrap_for(data, *args)
         super(Conversion.stringify_keys(data), *args)
       end
@@ -11,17 +14,12 @@ module Representable
       end
     end
 
-    class Conversion
-      # DISCUSS: we could think about mixin in IndifferentAccess here (either hashie or ActiveSupport).
-      # or decorating the hash.
+    module Conversion
       def self.stringify_keys(hash)
-        hash = hash.dup
-
-        hash.keys.each do |k|
-          hash[k.to_s] = hash.delete(k)
-        end
-        hash
+        hash.keys.collect do |key|
+          [ key.to_s, hash[key] ]
+        end.to_h
       end
     end
   end
-end
+end

data/lib/representable/hash/binding.rb

@@ -5,6 +5,7 @@ module Representable
     class Binding < Representable::Binding
       def self.build_for(definition)
         return Collection.new(definition) if definition.array?
+
         new(definition)
       end
 

data/lib/representable/hash/collection.rb

@@ -1,3 +1,5 @@
+require 'representable/hash'
+
 module Representable::Hash
   module Collection
     include Representable::Hash
@@ -20,7 +22,7 @@ module Representable::Hash
     # TODO: revise lonely collection and build separate pipeline where we just use Serialize, etc.
 
     def create_representation_with(doc, options, format)
-      options = normalize_options(options)
+      options = normalize_options(**options)
       options[:_self] = options
 
       bin   = representable_bindings_for(format, options).first
@@ -30,7 +32,7 @@ module Representable::Hash
     end
 
     def update_properties_from(doc, options, format)
-      options = normalize_options(options)
+      options = normalize_options(**options)
       options[:_self] = options
 
       bin   = representable_bindings_for(format, options).first

data/lib/representable/hash_methods.rb

@@ -20,8 +20,9 @@ module Representable
     def filter_keys_for!(hash, options)
       excluding = options[:exclude]
       # TODO: use same filtering method as in normal representer in Representable#create_representation_with.
-      return hash unless props = options.delete(:exclude) || options.delete(:include)
-      hash.reject { |k,v| excluding ? props.include?(k.to_sym) : !props.include?(k.to_sym) }
+      return hash unless (props = (options.delete(:exclude) || options.delete(:include)))
+
+      hash.select { |k, _v| excluding ? !props.include?(k.to_sym) : props.include?(k.to_sym) }
     end
   end
 end

data/lib/representable/insert.rb

@@ -35,4 +35,4 @@ module Representable
 
     Insert = Pipeline::Function::Insert.new
   end # Pipeline
-end
+end

data/lib/representable/json.rb

@@ -1,15 +1,13 @@
-require "representable/hash"
-require "representable/json/collection"
+gem "multi_json", '>= 1.14.1'
+require "multi_json"
 
-begin
-  require "multi_json"
-rescue LoadError => _
-  abort "Missing dependency 'multi_json' for Representable::JSON. See dependencies section in README.md for details."
-end
+require "representable"
 
 module Representable
   # Brings #to_json and #from_json to your object.
   module JSON
+    autoload :Collection, "representable/json/collection"
+
     extend Hash::ClassMethods
     include Hash
 

data/lib/representable/json/collection.rb

@@ -1,3 +1,6 @@
+require 'representable/json'
+require 'representable/hash/collection'
+
 module Representable::JSON
   module Collection
     include Representable::JSON

data/lib/representable/json/hash.rb

@@ -1,3 +1,4 @@
+require 'representable/json'
 require 'representable/hash_methods'
 
 module Representable::JSON

data/lib/representable/object.rb

@@ -26,4 +26,4 @@ module Representable
       create_representation_with(nil, options, binding_builder)
     end
   end
-end
+end

data/lib/representable/object/binding.rb

@@ -1,8 +1,11 @@
+require 'representable/binding'
+
 module Representable
   module Object
     class Binding < Representable::Binding
       def self.build_for(definition)  # TODO: remove default arg.
         return Collection.new(definition)  if definition.array?
+
         new(definition)
       end
 
@@ -10,6 +13,7 @@ module Representable
         fragment = hash.send(as) # :getter? no, that's for parsing!
 
         return FragmentNotFound if fragment.nil? and typed?
+
         fragment
       end
 
@@ -31,4 +35,4 @@ module Representable
       end
     end
   end
-end
+end

data/lib/representable/option.rb

@@ -0,0 +1,19 @@
+require "trailblazer/option"
+
+module Representable
+  # Extend `Trailblazer::Option` to support static values as callables too.
+  class Option < ::Trailblazer::Option
+    def self.callable?(value)
+      [Proc, Symbol, Uber::Callable].any?{ |kind| value.is_a?(kind) }
+    end
+
+    def self.build(value)
+      return ->(*) { value } unless callable?(value) # Wrap static `value` into a proc. 
+      super
+    end
+  end
+
+  def self.Option(value)
+    ::Representable::Option.build(value)
+  end
+end

data/lib/representable/pipeline.rb

@@ -4,11 +4,12 @@ module Representable
   class Pipeline < Array
     Stop = Class.new
 
-    # options is mutuable.
+    # options is mutable.
     def call(input, options)
       inject(input) do |memo, block|
         res = evaluate(block, memo, options)
-        return(Stop)if Stop == res
+        return(Stop) if Stop == res
+
         res
       end
     end

data/lib/representable/pipeline_factories.rb

@@ -2,7 +2,8 @@
 module Representable
   module Binding::Factories
     def pipeline_for(name, input, options)
-      return yield unless proc = @definition[name]
+      return yield unless (proc = @definition[name])
+
       # proc.(self, options)
       instance_exec(input, options, &proc)
     end
@@ -11,6 +12,7 @@ module Representable
     def collect_for(item_functions)
       return [Collect[*item_functions]] if array?
       return [Collect::Hash[*item_functions]] if self[:hash]
+
       item_functions
     end
 
@@ -92,4 +94,4 @@ module Representable
       funcs << (self[:setter] ? Setter : SetValue)
     end
   end
-end
+end

data/lib/representable/populator.rb

@@ -21,7 +21,7 @@ module Representable
     def self.apply!(options)
       return unless populator = options[:populator]
 
-      options[:parse_pipeline] = ->(input, opts) do
+      options[:parse_pipeline] = ->(_input, _opts) do
         pipeline = Pipeline[*parse_functions] # TODO: AssignFragment
         pipeline = Pipeline::Insert.(pipeline, SetValue, delete: true) # remove the setter function.
         pipeline = Pipeline::Insert.(pipeline, populator, replace: CreateObject::Populator) # let the actual populator do the job.

data/lib/representable/represent.rb

@@ -1,6 +1,7 @@
 module Representable::Represent
   def represent(represented, array_class=Array)
     return for_collection.prepare(represented) if represented.is_a?(array_class)
+
     prepare(represented)
   end
 end

data/lib/representable/serializer.rb

@@ -3,7 +3,7 @@ module Representable
     options[:binding].evaluate_option(:getter, input, options)
   end
 
-  GetValue = ->(input, options) { options[:binding].send(:exec_context, options).public_send(options[:binding].getter) }
+  GetValue = ->(_input, options) { options[:binding].send(:exec_context, options).public_send(options[:binding].getter) }
 
   Writer = ->(input, options) do
     options[:binding].evaluate_option(:writer, input, options)
@@ -37,6 +37,7 @@ module Representable
 
   Serialize = ->(input, options) do
     return if input.nil? # DISCUSS: how can we prevent that?
+
     binding, options = options[:binding], options[:options] # FIXME: rename to :local_options.
 
     options_for_nested = OptionsForNested.(options, binding)

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "3.0.4"
+  VERSION = "3.1.0"
 end

data/lib/representable/virtus_coercion.rb

@@ -0,0 +1,38 @@
+gem 'virtus'
+require "virtus"
+
+module Representable
+  module VirtusCoercion
+    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)
+      end
+    end
+
+
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        register_feature VirtusCoercion
+      end
+    end
+
+
+    module ClassMethods
+      def property(name, options={}, &block)
+        super.tap do |definition|
+          return definition unless type = options[:type]
+
+          definition.merge!(render_filter: coercer = Coercer.new(type))
+          definition.merge!(parse_filter: coercer)
+        end
+      end
+    end
+  end
+end

data/lib/representable/xml.rb

@@ -1,13 +1,14 @@
-require 'representable'
+gem 'nokogiri', '> 1.10.8'
+require 'nokogiri'
 
-begin
-  require 'nokogiri'
-rescue LoadError => _
-  abort "Missing dependency 'nokogiri' for Representable::XML. See dependencies section in README.md for details."
-end
+require 'representable'
 
 module Representable
   module XML
+    autoload :Binding, 'representable/xml/binding'
+    autoload :Collection, 'representable/xml/collection'
+    autoload :Namespace, 'representable/xml/namespace'
+
     def self.included(base)
       base.class_eval do
         include Representable
@@ -71,7 +72,3 @@ module Representable
     end
   end
 end
-
-require "representable/xml/binding"
-require "representable/xml/collection"
-require "representable/xml/namespace"