representable 2.3.0 → 2.4.0.rc1

data/test/nested_test.rb

@@ -27,10 +27,16 @@ class NestedTest < MiniTest::Spec
           # self.representation_wrap = :album if format == :xml
         end
 
-        let (:album) { representer.prepare(Album.new("Epitaph", "Brett Gurewitz", 19)) }
+        let (:album) { Album.new("Epitaph", "Brett Gurewitz", 19) }
+        let (:decorator) { representer.prepare(album) }
 
         it "renders nested Album-properties in separate section" do
-          render(album).must_equal_document output
+          render(decorator).must_equal_document output
+
+          # do not use extend on the nested object. # FIXME: make this a proper test with two describes instead of this pseudo-meta stuff.
+          if is_decorator==true
+            album.wont_be_kind_of(Representable::Hash)
+          end
         end
 
         it "parses nested properties to Album instance" do

data/test/pipeline_test.rb

@@ -0,0 +1,259 @@
+require "test_helper"
+
+class PipelineTest < MiniTest::Spec
+  Song   = Struct.new(:title, :artist)
+  Artist = Struct.new(:name)
+  Album  = Struct.new(:ratings, :artists)
+
+  R = Representable
+  P = R::Pipeline
+
+  Getter        = ->(input, options) { "Yo" }
+  StopOnNil     = ->(input, options) { input }
+  SkipRender    = ->(input, *) { input == "Yo" ? input : P::Stop }
+
+  Prepare       = ->(input, options) { "Prepare(#{input})" }
+  Deserialize   = ->(input, options) { "Deserialize(#{input}, #{options[:fragment]})" }
+
+  SkipParse     = ->(input, options) { input }
+  CreateObject  = ->(input, options) { OpenStruct.new }
+
+
+  Setter        = ->(input, options) { "Setter(#{input})" }
+
+  AssignFragment = ->(input, options) { options[:fragment] = input }
+
+  it "linear" do
+    P[SkipParse, Setter].("doc", {fragment: 1}).must_equal "Setter(doc)"
+
+
+    # parse style.
+    P[AssignFragment, SkipParse, CreateObject, Prepare].("Bla", {}).must_equal "Prepare(#<OpenStruct>)"
+
+
+    # render style.
+    P[Getter, StopOnNil, SkipRender, Prepare, Setter].(nil, {}).
+      must_equal "Setter(Prepare(Yo))"
+
+    # pipeline = Representable::Pipeline[SkipParse  , SetResult, ModifyResult]
+    # pipeline.(fragment: "yo!").must_equal "modified object from yo!"
+  end
+
+  Stopping      = ->(input, options) { return P::Stop if options[:fragment] == "stop!"; input }
+
+
+  it "stopping" do
+
+
+    pipeline = Representable::Pipeline[SkipParse, Stopping, Prepare]
+    pipeline.(nil, fragment: "oy!").must_equal "Prepare()"
+    pipeline.(nil, fragment: "stop!").must_equal Representable::Pipeline::Stop
+  end
+
+  describe "Collect" do
+    Reverse = ->(input, options) { input.reverse }
+    Add = ->(input, options) { "#{input}+" }
+    let(:pipeline) { R::Collect[Reverse, Add] }
+
+    it { pipeline.(["yo!", "oy!"], {}).must_equal ["!oy+", "!yo+"] }
+
+    describe "Pipeline with Collect" do
+      let(:pipeline) { P[Reverse, R::Collect[Reverse, Add]] }
+      it { pipeline.(["yo!", "oy!"], {}).must_equal ["!yo+", "!oy+"] }
+    end
+  end
+
+
+
+
+  ######### scalar property
+
+  let (:title) {
+    dfn = R::Definition.new(:title)
+
+    R::Hash::Binding.new(dfn)
+  }
+
+  it "rendering scalar property" do
+    doc = {}
+    P[
+      R::Get,
+      R::StopOnSkipable,
+      R::AssignName,
+      R::WriteFragment
+    ].(nil, {represented: Song.new("Lime Green"), binding: title, doc: doc}).must_equal "Lime Green"
+
+    doc.must_equal({"title"=>"Lime Green"})
+  end
+
+  it "parsing scalar property" do
+    P[
+      R::AssignName,
+      R::ReadFragment,
+      R::StopOnNotFound,
+      R::OverwriteOnNil,
+      # R::SkipParse,
+      R::Set,
+    ].extend(P::Debug).(doc={"title"=>"Eruption"}, {represented: song=Song.new("Lime Green"), binding: title, doc: doc}).must_equal "Eruption"
+    song.title.must_equal "Eruption"
+  end
+
+
+
+  module ArtistRepresenter
+    include Representable::Hash
+    property :name
+  end
+
+  let (:artist) {
+    dfn = R::Definition.new(:artist, extend: ArtistRepresenter, class: Artist)
+
+    R::Hash::Binding.new(dfn)
+  }
+
+  let (:song_model) { Song.new("Lime Green", Artist.new("Diesel Boy")) }
+
+  it "rendering typed property" do
+    doc = {}
+    P[
+      R::Get,
+      R::StopOnSkipable,
+      R::StopOnNil,
+      R::SkipRender,
+      R::Decorate,
+      R::Serialize,
+      R::AssignName,
+      R::WriteFragment
+    ].extend(P::Debug).(nil, {represented: song_model, binding: artist, doc: doc, user_options: {}}).must_equal({"name" => "Diesel Boy"})
+
+    doc.must_equal({"artist"=>{"name"=>"Diesel Boy"}})
+  end
+
+  it "parsing typed property" do
+    P[
+      R::AssignName,
+      R::ReadFragment,
+      R::StopOnNotFound,
+      R::OverwriteOnNil,
+      # R::SkipParse,
+      R::CreateObject,
+      R::Decorate,
+      R::Deserialize,
+      R::Set,
+    ].extend(P::Debug).(doc={"artist"=>{"name"=>"Doobie Brothers"}}, {represented: song_model, binding: artist, doc: doc, user_options: {}}).must_equal model=Artist.new("Doobie Brothers")
+    song_model.artist.must_equal model
+  end
+
+
+  ######### collection :ratings
+
+  let (:ratings) {
+    dfn = R::Definition.new(:ratings, collection: true)
+
+    R::Hash::Binding::Collection.new(dfn)
+  }
+  it "render scalar collection" do
+    doc = {}
+    P[
+      R::Get,
+      R::StopOnSkipable,
+      R::Collect[
+        R::SkipRender,
+      ],
+      R::AssignName,
+      R::WriteFragment
+    ].extend(P::Debug).(nil, {represented: Album.new([1,2,3]), binding: ratings, doc: doc}).must_equal([1,2,3])
+
+    doc.must_equal({"ratings"=>[1,2,3]})
+  end
+
+######### collection :songs, extend: SongRepresenter
+  let (:artists) {
+    dfn = R::Definition.new(:artists, collection: true, extend: ArtistRepresenter, class: Artist)
+
+    R::Hash::Binding::Collection.new(dfn)
+  }
+  it "render typed collection" do
+    doc = {}
+    P[
+      R::Get,
+      R::StopOnSkipable,
+      R::Collect[
+        R::SkipRender,
+        R::Decorate,
+        R::Serialize,
+      ],
+      R::AssignName,
+      R::WriteFragment
+    ].extend(P::Debug).(nil, {represented: Album.new(nil, [Artist.new("Diesel Boy"), Artist.new("Van Halen")]), binding: artists, doc: doc, user_options: {}}).must_equal([{"name"=>"Diesel Boy"}, {"name"=>"Van Halen"}])
+
+    doc.must_equal({"artists"=>[{"name"=>"Diesel Boy"}, {"name"=>"Van Halen"}]})
+  end
+
+let (:album_model) { Album.new(nil, [Artist.new("Diesel Boy"), Artist.new("Van Halen")]) }
+
+  it "parse typed collection" do
+    doc = {"artists"=>[{"name"=>"Diesel Boy"}, {"name"=>"Van Halen"}]}
+    P[
+      R::AssignName,
+      R::ReadFragment,
+      R::StopOnNotFound,
+      R::OverwriteOnNil,
+      # R::SkipParse,
+      R::Collect[
+        R::SkipRender,
+        R::CreateObject,
+        R::Decorate,
+        R::Deserialize,
+      ],
+      R::Set,
+    ].extend(P::Debug).(doc, {represented: album_model, binding: artists, doc: doc, user_options: {}}).must_equal([Artist.new("Diesel Boy"), Artist.new("Van Halen")])
+
+    album_model.artists.must_equal([Artist.new("Diesel Boy"), Artist.new("Van Halen")])
+  end
+
+  # TODO: test with arrays, too, not "only" Pipeline instances.
+  describe "#Insert Pipeline[], Function, replace: OldFunction" do
+    let (:pipeline) { P[R::Get, R::StopOnSkipable, R::StopOnNil] }
+
+    it "returns Pipeline instance when passing in Pipeline instance" do
+      P::Insert.(pipeline, R::Default, replace: R::StopOnSkipable).must_be_instance_of(R::Pipeline)
+    end
+
+    it "replaces if exists" do
+      # pipeline.insert!(R::Default, replace: R::StopOnSkipable)
+      P::Insert.(pipeline, R::Default, replace: R::StopOnSkipable).must_equal P[R::Get, R::Default, R::StopOnNil]
+      pipeline.must_equal P[R::Get, R::StopOnSkipable, R::StopOnNil]
+    end
+
+    it "replaces Function instance" do
+      pipeline = P[R::Prepare, R::StopOnSkipable, R::StopOnNil]
+      P::Insert.(pipeline, R::Default, replace: R::Prepare).must_equal P[R::Default, R::StopOnSkipable, R::StopOnNil]
+      pipeline.must_equal P[R::Prepare, R::StopOnSkipable, R::StopOnNil]
+    end
+
+    it "does not replace when not existing" do
+      P::Insert.(pipeline, R::Default, replace: R::Prepare)
+      pipeline.must_equal P[R::Get, R::StopOnSkipable, R::StopOnNil]
+    end
+
+    it "applies on nested Collect" do
+      pipeline = P[R::Get, R::Collect[R::Get, R::StopOnSkipable], R::StopOnNil]
+
+      P::Insert.(pipeline, R::Default, replace: R::StopOnSkipable).extend(P::Debug).inspect.must_equal "Pipeline[Get, Collect[Get, Default], StopOnNil]"
+      pipeline.must_equal P[R::Get, R::Collect[R::Get, R::StopOnSkipable], R::StopOnNil]
+
+
+      P::Insert.(pipeline, R::Default, replace: R::StopOnNil).extend(P::Debug).inspect.must_equal "Pipeline[Get, Collect[Get, StopOnSkipable], Default]"
+    end
+  end
+
+  describe "Insert delete: true" do
+    let(:pipeline) { P[R::Get, R::Collect[R::Get, R::StopOnSkipable], R::StopOnNil] }
+
+    it do
+      P::Insert.(pipeline, R::Get, delete: true).extend(P::Debug).inspect.must_equal "Pipeline[Collect[Get, StopOnSkipable], StopOnNil]"
+      pipeline.extend(P::Debug).inspect.must_equal "Pipeline[Get, Collect[Get, StopOnSkipable], StopOnNil]"
+    end
+  end
+end

data/test/populator_test.rb

@@ -0,0 +1,76 @@
+require "test_helper"
+
+class PopulatorFindOrInstantiateTest < MiniTest::Spec
+  Song = Struct.new(:id, :title, :uid) do
+    def self.find_by(attributes={})
+      return new(1, "Resist Stan", "abcd") if attributes[:id]==1# we should return the same object here
+      new
+    end
+  end
+
+  Composer = Struct.new(:song)
+  Composer.class_eval do
+    def song=(v)
+      @song = v
+      "Absolute nonsense" # this tests that the populator always returns the correct object.
+    end
+
+    attr_reader :song
+  end
+
+  describe "FindOrInstantiate with property" do
+    representer! do
+      property :song, populator: Representable::FindOrInstantiate, class: Song do
+        property :id
+        property :title
+      end
+    end
+
+    let (:album) { Composer.new.extend(representer) }
+
+    it "finds by :id and creates new without :id" do
+      album.from_hash({"song"=>{"id" => 1, "title"=>"Resist Stance"}})
+
+      album.song.title.must_equal "Resist Stance" # note how title is updated from "Resist Stan"
+      album.song.id.must_equal 1
+      album.song.uid.must_equal "abcd" # not changed via populator, indicating this is a formerly "persisted" object.
+    end
+
+    it "creates new without :id" do
+      album.from_hash({"song"=>{"title"=>"Lower"}})
+
+      album.song.title.must_equal "Lower"
+      album.song.id.must_equal nil
+      album.song.uid.must_equal nil
+    end
+  end
+
+  describe "FindOrInstantiate with collection" do
+    representer! do
+      collection :songs, populator: Representable::FindOrInstantiate, class: Song do
+        property :id
+        property :title
+      end
+    end
+
+    let (:album) { Struct.new(:songs).new([]).extend(representer) }
+
+    it "finds by :id and creates new without :id" do
+      album.from_hash({"songs"=>[
+        {"id" => 1, "title"=>"Resist Stance"},
+        {"title"=>"Suffer"}
+      ]})
+
+      album.songs[0].title.must_equal "Resist Stance" # note how title is updated from "Resist Stan"
+      album.songs[0].id.must_equal 1
+      album.songs[0].uid.must_equal "abcd" # not changed via populator, indicating this is a formerly "persisted" object.
+
+      album.songs[1].title.must_equal "Suffer"
+      album.songs[1].id.must_equal nil
+      album.songs[1].uid.must_equal nil
+    end
+
+    # TODO: test with existing collection
+  end
+
+end

data/test/realistic_benchmark.rb

@@ -1,8 +1,21 @@
 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|
-  "property_#{i}"
+  "song_property_#{i}"
 end
 
 
@@ -12,37 +25,56 @@ module SongRepresenter
   SONG_PROPERTIES.each { |p| property p }
 end
 
-class SongDecorator < Representable::Decorator
+class NestedProperty < Representable::Decorator
   include Representable::JSON
 
   SONG_PROPERTIES.each { |p| property p }
 end
 
-module AlbumRepresenter
+
+class SongDecorator < Representable::Decorator
+  include Representable::JSON
+
+  SONG_PROPERTIES.each { |p| property p, extend: NestedProperty }
+end
+
+class AlbumRepresenter < Representable::Decorator
   include Representable::JSON
 
   # collection :songs, extend: SongRepresenter
   collection :songs, extend: SongDecorator
 end
 
+Song  = Struct.new(*SONG_PROPERTIES.map(&:to_sym))
+Album = Struct.new(:songs)
+
 def random_song
-  attrs = Hash[SONG_PROPERTIES.collect { |n| [n,n] }]
-  OpenStruct.new(attrs)
+  Song.new(*SONG_PROPERTIES.collect { |p| Song.new(*SONG_PROPERTIES) })
 end
 
 times = []
 
 3.times.each do
-  album = OpenStruct.new(songs: 50.times.collect { random_song })
+  album = Album.new(100.times.collect { random_song })
 
   times << Benchmark.measure do
     puts "================ next!"
-    album.extend(AlbumRepresenter).to_json
+    AlbumRepresenter.new(album).to_json
   end
 end
 
 puts times.join("")
 
+album = Album.new(100.times.collect { random_song })
+require 'ruby-prof'
+RubyProf.start
+AlbumRepresenter.new(album).to_hash
+res = RubyProf.stop
+printer = RubyProf::FlatPrinter.new(res)
+printer.print(array = [])
+
+array[0..60].each { |a| puts a }
+
 # 100 songs, 100 attrs
 #  0.050000   0.000000   0.050000 (  0.093157)
 

data/test/render_nil_test.rb

@@ -0,0 +1,21 @@
+require "test_helper"
+
+class RenderNilTest < MiniTest::Spec
+  Song = Struct.new(:title)
+
+  describe "render_nil: true" do
+    representer! do
+      property :title, render_nil: true
+    end
+
+    it { Song.new.extend(representer).to_hash.must_equal({"title"=>nil}) }
+  end
+
+  describe "with :extend it shouldn't extend nil" do
+    representer! do
+      property :title, render_nil: true, extend: Class
+    end
+
+    it { Song.new.extend(representer).to_hash.must_equal({"title"=>nil}) }
+  end
+end