representable 2.4.1 → 3.0.0

data/lib/representable.rb

@@ -73,11 +73,9 @@ private
     representable_attrs.collect {|definition| format.build(definition) }
   end
 
-  module NormalizeOptions
-    def normalize_options(options)
-      return options if options.any?
-      {user_options: {}}.merge(options) # TODO: use keyword args once we drop 2.0.
-    end
+  def normalize_options(options)
+    return options if options.any?
+    {user_options: {}}.merge(options) # TODO: use keyword args once we drop 2.0.
   end
 
   # Prepares options for a particular nested representer.
@@ -120,15 +118,7 @@ private
     end
   end
 
-  require "representable/deprecations"
-  def self.deprecations=(value)
-    evaluator = value==false ? Binding::EvaluateOption : Binding::Deprecation::EvaluateOption
-    ::Representable::Binding.send :include, evaluator
-
-    evaluator = value==false ? NormalizeOptions : Deprecation::NormalizeOptions
-    ::Representable.send :include, evaluator
-  end
-  self.deprecations = true # TODO: change to false in 2.5 or remove entirely.
+  # require "representable/deprecations"
 end
 
 require 'representable/autoload'

data/lib/representable/binding.rb

@@ -6,13 +6,9 @@ module Representable
     class FragmentNotFound
     end
 
-    module ClassDeprecatable
-      def build(definition)
-        return definition.create_binding if definition[:binding]
-        build_for(definition)
-      end
+    def self.build(definition)
+      build_for(definition)
     end
-    extend ClassDeprecatable
 
     def initialize(definition)
       @definition       = definition
@@ -50,7 +46,7 @@ module Representable
         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.
       end
     end
-    # include EvaluateOption
+    include EvaluateOption
 
     def [](name)
       @definition[name]

data/lib/representable/definition.rb

@@ -1,5 +1,5 @@
 require "uber/options"
-require "representable/parse_strategies"
+require "representable/populator"
 
 module Representable
   # Created at class compile time. Keeps configuration options for one property.
@@ -88,7 +88,6 @@ module Representable
       handle_as!(options)
 
       # DISCUSS: we could call more macros here (e.g. for :nested).
-      Representable::ParseStrategy.apply!(options)
       Representable::Populator.apply!(options)
 
       yield options if block_given?

data/lib/representable/populator.rb

@@ -0,0 +1,35 @@
+module Representable
+  class Populator
+    FindOrInstantiate = ->(input, options) {
+      binding = options[:binding]
+
+      object_class = binding[:class].(input, options)
+      object       = object_class.find_by(id: input["id"]) || object_class.new
+      if options[:binding].array?
+        # represented.songs[i] = model
+        options[:represented].send(binding.getter)[options[:index]] = object
+      else
+        # represented.song = model
+        options[:represented].send(binding.setter, object)
+      end
+
+      object
+     }
+
+    # pipeline: [StopOnExcluded, AssignName, ReadFragment, StopOnNotFound, OverwriteOnNil, AssignFragment, #<Representable::Function::CreateObject:0x9805a44>, #<Representable::Function::Decorate:0x9805a1c>, Deserialize, Set]
+
+    def self.apply!(options)
+      return unless populator = options[:populator]
+
+      options[:parse_pipeline] = ->(input, options) 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.
+        # puts pipeline.extend(Representable::Pipeline::Debug).inspect
+        pipeline
+      end
+    end
+  end
+
+  FindOrInstantiate = Populator::FindOrInstantiate
+end

data/lib/representable/version.rb

@@ -1,3 +1,3 @@
 module Representable
-  VERSION = "2.4.1"
+  VERSION = "3.0.0"
 end

data/test/definition_test.rb

@@ -43,13 +43,6 @@ class DefinitionTest < MiniTest::Spec
     # override original when passed in #merge!.
     it { definition.merge!({:whatever => false})[:whatever].must_equal false }
 
-
-    it "runs macros" do
-      definition[:setter].must_equal nil
-      definition.merge!(:parse_strategy => :sync)
-      definition[:setter].must_respond_to :evaluate
-    end
-
     # with block
     it do
       definition = Definition.new(:song, :extend => Module).merge!({:something => true}) do |options|

data/test/exec_context_test.rb

@@ -36,7 +36,7 @@ class ExecContextTest < MiniTest::Spec
         property :name,
           :as           => lambda { |*| self.class }, # to actually test
           :exec_context => :binding,
-          :setter        => lambda { |options| represented.name = options[:fragment] # to make parsing work.
+          :setter        => lambda { |options| options[:represented].name = options[:fragment] # to make parsing work.
         }
       end
 
@@ -81,7 +81,7 @@ class ExecContextTest < MiniTest::Spec
           property :name,
             :as           => lambda { |*| self.class }, # to actually test
             :exec_context => :binding,
-            :setter        => lambda { |options| represented.name = options[:fragment ] # to make parsing work.
+            :setter        => lambda { |options| options[:represented].name = options[:fragment ] # to make parsing work.
           }
         end
 

data/test/instance_test.rb

@@ -244,23 +244,4 @@ class InstanceTest < BaseTest
       songs.object_id.wont_equal album.songs.object_id
     }
   end
-
-
-  describe "new syntax for instance: true" do
-    representer!(:inject => :song_representer) do
-      property :song, :pass_options => true,
-        :extend => song_representer, :instance => lambda { |options| options[:binding].get(represented: options[:represented]) }
-    end
-
-    it "uses Binding#get instead of creating an instance, but deprecates" do
-      album= Struct.new(:song).new(song = Song.new(1, "The Answer Is Still No"))
-
-      album.
-        extend(representer).
-        from_hash("song" => {"title" => "Invincible"}).
-        song.must_equal Song.new(1, "Invincible")
-
-      album.song.object_id.must_equal song.object_id
-    end
-  end
 end

data/test/realistic_benchmark.rb

@@ -1,19 +1,6 @@
 require 'test_helper'
 require 'benchmark'
 
-Kernel.class_eval do
-  # def respond_to_missing?
-  #   raise
-  # end
-#   alias_method :orig_hash, :hash
-#   def hash
-#     puts "hash in #{self.class}"
-#     raise self.inspect if self.class == Symbol
-#     orig_hash
-#   end
-end
-Representable.deprecations = false
-
 SONG_PROPERTIES = 50.times.collect do |i|
   "song_property_#{i}"
 end

data/test/representable_test.rb

@@ -460,22 +460,6 @@ class RepresentableTest < MiniTest::Spec
       end
     end
 
-    describe ":binding" do
-      representer! do
-        class MyBinding < Representable::Binding
-          def write(doc, *args)
-            doc[:title] = represented.title
-          end
-        end
-        property :title, :binding => lambda { |*args| MyBinding.new(*args) }
-      end
-
-      it "uses the specified binding instance" do
-        OpenStruct.new(:title => "Affliction").extend(representer).to_hash.must_equal({:title => "Affliction"})
-      end
-    end
-
-
     # TODO: Move to global place since it's used twice.
     class SongRepresentation < Representable::Decorator
       include Representable::JSON

data/test/skip_test.rb

@@ -36,7 +36,7 @@ class SkipParseTest < MiniTest::Spec
     song.from_hash({
       "title"    => "skip me",
       "band"     => {},
-      "airplays" => [{"station" => "JJJ"}, {}],
+      "airplays" => [{}, {"station" => "JJJ"}, {}],
     }, user_options: { skip?: true })
 
     song.title.must_equal nil

data/test/test_helper.rb

@@ -11,8 +11,6 @@ require 'test_xml/mini_test'
 
 require "representable/debug"
 
-Representable.deprecations = false
-
 class Album
   attr_accessor :songs, :best_song
   def initialize(songs=nil, best_song=nil)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: representable
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -163,7 +163,6 @@ files:
 - lib/representable/declarative.rb
 - lib/representable/decorator.rb
 - lib/representable/definition.rb
-- lib/representable/deprecations.rb
 - lib/representable/deserializer.rb
 - lib/representable/for_collection.rb
 - lib/representable/hash.rb
@@ -177,9 +176,9 @@ files:
 - lib/representable/json/hash.rb
 - lib/representable/object.rb
 - lib/representable/object/binding.rb
-- lib/representable/parse_strategies.rb
 - lib/representable/pipeline.rb
 - lib/representable/pipeline_factories.rb
+- lib/representable/populator.rb
 - lib/representable/represent.rb
 - lib/representable/serializer.rb
 - lib/representable/version.rb
@@ -190,66 +189,6 @@ files:
 - lib/representable/yaml.rb
 - lib/representable/yaml/binding.rb
 - representable.gemspec
-- test-with-deprecations/as_test.rb
-- test-with-deprecations/benchmarking.rb
-- test-with-deprecations/binding_test.rb
-- test-with-deprecations/blaaaaaaaa_test.rb
-- test-with-deprecations/cached_test.rb
-- test-with-deprecations/class_test.rb
-- test-with-deprecations/coercion_test.rb
-- test-with-deprecations/config/inherit_test.rb
-- test-with-deprecations/config_test.rb
-- test-with-deprecations/decorator_scope_test.rb
-- test-with-deprecations/decorator_test.rb
-- test-with-deprecations/default_test.rb
-- test-with-deprecations/defaults_options_test.rb
-- test-with-deprecations/definition_test.rb
-- test-with-deprecations/example.rb
-- test-with-deprecations/examples/object.rb
-- test-with-deprecations/exec_context_test.rb
-- test-with-deprecations/features_test.rb
-- test-with-deprecations/filter_test.rb
-- test-with-deprecations/for_collection_test.rb
-- test-with-deprecations/generic_test.rb
-- test-with-deprecations/getter_setter_test.rb
-- test-with-deprecations/hash_bindings_test.rb
-- test-with-deprecations/hash_test.rb
-- test-with-deprecations/heritage_test.rb
-- test-with-deprecations/if_test.rb
-- test-with-deprecations/include_exclude_test.rb
-- test-with-deprecations/inherit_test.rb
-- test-with-deprecations/inline_test.rb
-- test-with-deprecations/instance_test.rb
-- test-with-deprecations/is_representable_test.rb
-- test-with-deprecations/json_test.rb
-- test-with-deprecations/lonely_test.rb
-- test-with-deprecations/mongoid_test.rb
-- test-with-deprecations/nested_test.rb
-- test-with-deprecations/object_test.rb
-- test-with-deprecations/parse_pipeline_test.rb
-- test-with-deprecations/parse_strategy_test.rb
-- test-with-deprecations/pass_options_test.rb
-- test-with-deprecations/pipeline_test.rb
-- test-with-deprecations/populator_test.rb
-- test-with-deprecations/prepare_test.rb
-- test-with-deprecations/private_options_test.rb
-- test-with-deprecations/reader_writer_test.rb
-- test-with-deprecations/realistic_benchmark.rb
-- test-with-deprecations/render_nil_test.rb
-- test-with-deprecations/represent_test.rb
-- test-with-deprecations/representable_test.rb
-- test-with-deprecations/schema_test.rb
-- test-with-deprecations/serialize_deserialize_test.rb
-- test-with-deprecations/skip_test.rb
-- test-with-deprecations/stringify_hash_test.rb
-- test-with-deprecations/test_helper.rb
-- test-with-deprecations/test_helper_test.rb
-- test-with-deprecations/uncategorized_test.rb
-- test-with-deprecations/user_options_test.rb
-- test-with-deprecations/wrap_test.rb
-- test-with-deprecations/xml_bindings_test.rb
-- test-with-deprecations/xml_test.rb
-- test-with-deprecations/yaml_test.rb
 - test/as_test.rb
 - test/benchmarking.rb
 - test/binding_test.rb
@@ -286,7 +225,6 @@ files:
 - test/nested_test.rb
 - test/object_test.rb
 - test/parse_pipeline_test.rb
-- test/parse_strategy_test.rb
 - test/pipeline_test.rb
 - test/populator_test.rb
 - test/prepare_test.rb

data/lib/representable/deprecations.rb

@@ -1,127 +0,0 @@
-# WARNING: this will be removed in 3.0.
-module Representable::Deprecation
-  module NormalizeOptions
-    def normalize_options(options)
-
-      unless options.any?
-        options[:user_options] = {}
-        return options
-      end
-
-      options      = options.dup
-
-      user_option_keys = options.keys - [:doc, :exclude, :include, :wrap, :user_options, * representable_attrs.keys.map(&:to_sym)]
-      if user_option_keys.any?
-        user_options = {}
-        warn "[Representable] Mixing user and representable options is deprecated. Please provide your options via :user_options."
-        user_option_keys.each { |key| user_options[key] = options.delete(key) }
-        options[:user_options] = user_options
-      end
-
-      options # {user_options: {..}, include: [], wrap: "song", artist: {..}}
-    end
-  end
-end
-
-module Representable::Binding::Deprecation
-  module Build
-    def build(definition)
-      warn "[Representable] The :binding option is deprecated and will be removed in 3.0. Please use your own pipeline instead." if definition[:binding]
-      super
-    end
-  end
-
-  Options = Struct.new(:binding, :user_options, :represented, :decorator)
-
-  module EvaluateOption
-      def self.included(includer)
-        super
-        includer.extend(Build)
-      end
-
-    def evaluate_option(name, input=nil, options={})
-      return evaluate_option_with_deprecation(name, input, options, :user_options) if name==:as
-      return evaluate_option_with_deprecation(name, input, options, :user_options) if name==:if
-      return evaluate_option_with_deprecation(name, input, options, :user_options) if name==:getter
-      return evaluate_option_with_deprecation(name, input, options, :doc, :user_options) if name==:writer
-      return evaluate_option_with_deprecation(name, input, options, :input, :user_options) if name==:skip_render
-      return evaluate_option_with_deprecation(name, input, options, :input, :user_options) if name==:skip_parse
-      return evaluate_option_with_deprecation(name, input, options, :input, :user_options) if name==:serialize
-      return evaluate_option_with_deprecation(name, input, options, :doc, :user_options) if name==:reader
-      return evaluate_option_with_deprecation(name, input, options, :input, :index, :user_options) if name==:instance
-      return evaluate_option_with_deprecation(name, input, options, :input, :index, :user_options) if name==:class
-      return evaluate_option_with_deprecation(name, input, options, :input, :fragment, :user_options) if name==:deserialize
-      return evaluate_option_with_deprecation(name, input, options, :input, :user_options) if name==:prepare
-      return evaluate_option_with_deprecation(name, input, options, :input, :user_options) if name==:extend
-      return evaluate_option_with_deprecation(name, input, options, :input, :user_options) if name==:setter
-    end
-
-
-    def evaluate_option_with_deprecation(name, input, options, *positional_arguments)
-      unless proc = self[name]
-        return # FIXME: why do we need this?
-      end
-
-      options[:input] = input
-
-
-      __options = if self[:pass_options]
-        warn %{[Representable] The :pass_options option is deprecated. Please access environment objects via options[:binding].
-  Learn more here: http://trailblazerb.org/gems/representable/upgrading-guide.html#pass-options}
-
-
-        options[:options] ||= {}
-        Options.new(self, options[:options][:user_options], options[:represented], options[:decorator])
-      else
-        # user_options
-        options[:options][:user_options] || {}
-      end
-
-      if proc.send(:proc?) or proc.send(:method?)
-        arity = proc.instance_variable_get(:@value).arity if proc.send(:proc?)
-        arity = send(:exec_context, options).method(proc.instance_variable_get(:@value)).arity if proc.send(:method?)
-        if arity  != 1 or name==:getter or name==:if or name==:as
-          warn %{[Representable] Positional arguments for `:#{name}` are deprecated. Please use options or keyword arguments.
-  #{name}: ->(options) { options[:#{positional_arguments.join(" | :")}] } or
-  #{name}: ->(#{positional_arguments.join(":, ")}:) {  }
-  Learn more here: http://trailblazerb.org/gems/representable/upgrading-guide.html#positional-arguments
-  }
-          deprecated_args = []
-          positional_arguments.each do |arg|
-            next if arg == :index && options[:index].nil?
-            deprecated_args << __options  and next if arg == :user_options# either hash or Options object.
-            deprecated_args << options[arg]
-          end
-          return proc.(send(:exec_context, options), *deprecated_args)
-        end
-      end
-
-      proc.(send(:exec_context, options), options.merge(user_options: options[:options][:user_options]))
-    end
-    private :evaluate_option_with_deprecation
-
-
-    def represented
-      warn "[Representable] Binding#represented is deprecated. Use options[:represented] instead."
-      @represented
-    end
-
-    def compile_fragment(options)
-      @represented = options[:represented]
-      @parent_decorator = options[:decorator]
-      super
-    end
-
-    # Parse value from doc and update the model property.
-    def uncompile_fragment(options)
-      @represented = options[:represented]
-      @parent_decorator = options[:decorator]
-      super
-    end
-
-    def get(options={}) # DISCUSS: evluate if we really need this.
-      warn "[Representable] Binding#get is deprecated."
-      self[:getter] ? Representable::Getter.(nil, options.merge(binding: self)) : Representable::GetValue.(nil, options.merge(binding: self))
-    end
-  end
-end