representable 3.0.0 → 3.1.0

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

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,15 +37,19 @@ 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
 
+    alias_method :render, :to_hash
+    alias_method :parse, :from_hash
+
   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
 
@@ -43,5 +41,8 @@ module Representable
     def to_json(*args)
       MultiJson.dump to_hash(*args)
     end
+
+    alias_method :render, :to_json
+    alias_method :parse, :from_json
   end
 end

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/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