disposable 0.0.9 → 0.1.0

data/test/callback_group_test.rb

@@ -0,0 +1,222 @@
+require "test_helper"
+require "disposable/callback"
+require "pp"
+
+class CallbackGroupTest < MiniTest::Spec
+  class Group < Disposable::Callback::Group
+    attr_reader :output
+
+    on_change :change!
+
+    collection :songs do
+      on_add :notify_album!
+      on_add :reset_song!
+
+      # on_delete :notify_deleted_author! # in Update!
+
+      def notify_album!(twin)
+        @output = "added to songs"
+      end
+
+      def reset_song!(twin)
+        @output << "added to songs, reseting"
+      end
+    end
+
+    on_change :rehash_name!, property: :title
+
+
+    on_create :expire_cache! # on_change
+    on_update :expire_cache!
+
+    def change!(twin)
+      @output = "Album has changed!"
+    end
+  end
+
+
+  class AlbumTwin < Disposable::Twin
+    feature Sync, Save
+    feature Persisted, Changed
+
+    property :name
+
+    property :artist do
+      property :name
+    end
+
+    collection :songs do
+      property :title
+    end
+  end
+
+
+  # empty.
+  it do
+    album = Album.new(songs: [Song.new(title: "Dead To Me"), Song.new(title: "Diesel Boy")])
+    twin  = AlbumTwin.new(album)
+
+    Group.new(twin).().invocations.must_equal [
+      [:on_change, :change!, []],
+      [:on_add, :notify_album!, []],
+      [:on_add, :reset_song!, []],
+      [:on_change, :rehash_name!, []],
+      [:on_create, :expire_cache!, []],
+      [:on_update, :expire_cache!, []],
+    ]
+  end
+
+  it do
+    twin = AlbumTwin.new(Album.new)
+    twin.songs << Song.new(title: "Dead To Me")
+    twin.songs << Song.new(title: "Diesel Boy")
+
+    twin.name = "Dear Landlord"
+
+    group = Group.new(twin).()
+    # Disposable::Callback::Dispatch.new(twin).on_change{ |twin| puts twin;puts }
+
+    # pp group.invocations
+
+    group.invocations.must_equal [
+      [:on_change, :change!, [twin]],
+      [:on_add, :notify_album!, [twin.songs[0], twin.songs[1]]],
+      [:on_add, :reset_song!,   [twin.songs[0], twin.songs[1]]],
+      [:on_change, :rehash_name!, []],
+      [:on_create, :expire_cache!, []],
+      [:on_update, :expire_cache!, []],
+    ]
+
+    group.output.must_equal "Album has changed!"
+  end
+
+  # context.
+  class Operation
+    attr_reader :output
+
+    def change!(twin)
+      @output = "changed!"
+    end
+
+    def notify_album!(twin)
+      @output << "notify_album!"
+    end
+
+    def reset_song!(twin)
+      @output << "reset_song!"
+    end
+  end
+
+  it do
+    twin = AlbumTwin.new(Album.new)
+    twin.songs << Song.new(title: "Dead To Me")
+
+    twin.name = "Dear Landlord"
+
+    group = Group.new(twin).(context: context = Operation.new)
+    # Disposable::Callback::Dispatch.new(twin).on_change{ |twin| puts twin;puts }
+
+    # pp group.invocations
+
+    group.invocations.must_equal [
+      [:on_change, :change!, [twin]],
+      [:on_add, :notify_album!, [twin.songs[0]]],
+      [:on_add, :reset_song!,   [twin.songs[0]]],
+      [:on_change, :rehash_name!, []],
+      [:on_create, :expire_cache!, []],
+      [:on_update, :expire_cache!, []],
+    ]
+
+    context.output.must_equal "changed!notify_album!reset_song!"
+  end
+end
+
+
+class CallbackGroupInheritanceTest < MiniTest::Spec
+  class Group < Disposable::Callback::Group
+    on_change :change!
+    collection :songs do
+      on_add :notify_album!
+      on_add :reset_song!
+    end
+    on_change :rehash_name!, property: :title
+    property :artist do
+      on_change :sing!
+    end
+  end
+
+  it do
+    Group.hooks.size.must_equal 4
+    Group.hooks[0].to_s.must_equal "[:on_change, [:change!]]"
+    # Group.hooks[1][1].representer_module.hooks.to_s.must_equal "[[:on_add, [:notify_album!]],[:on_add, [:reset_song!]]]"
+    Group.hooks[2].to_s.must_equal "[:on_change, [:rehash_name!, {:property=>:title}]]"
+
+    Group.representer_class.representable_attrs.get(Group.hooks[3][1]).representer_module.hooks.to_s.must_equal "[[:on_change, [:sing!]]]"
+  end
+
+  class EmptyGroup < Group
+  end
+
+
+
+  it do
+    EmptyGroup.hooks.size.must_equal 4
+    # TODO:
+  end
+
+  class EnhancedGroup < Group
+    on_change :redo!
+    collection :songs do
+      on_add :rewind!
+    end
+  end
+
+  it do
+    Group.hooks.size.must_equal 4
+    EnhancedGroup.hooks.size.must_equal 6
+    EnhancedGroup.representer_class.representable_attrs.get(EnhancedGroup.hooks[5][1]).representer_module.hooks.to_s.must_equal "[[:on_add, [:rewind!]]]"
+  end
+
+  class EnhancedWithInheritGroup < EnhancedGroup
+    collection :songs, inherit: true do # finds first.
+      on_add :eat!
+    end
+    property :artist, inherit: true do
+      on_delete :yell!
+    end
+  end
+
+  it do
+    Group.hooks.size.must_equal 4
+    EnhancedGroup.hooks.size.must_equal 6
+
+    EnhancedGroup.representer_class.representable_attrs.get(EnhancedGroup.hooks[5][1]).representer_module.hooks.to_s.must_equal "[[:on_add, [:rewind!]]]"
+    EnhancedWithInheritGroup.hooks.size.must_equal 6
+    EnhancedWithInheritGroup.representer_class.representable_attrs.get(EnhancedWithInheritGroup.hooks[1][1]).representer_module.hooks.to_s.must_equal "[[:on_add, [:rewind!]], [:on_add, [:eat!]]]"
+    EnhancedWithInheritGroup.representer_class.representable_attrs.get(EnhancedWithInheritGroup.hooks[3][1]).representer_module.hooks.to_s.must_equal "[[:on_change, [:sing!]], [:on_delete, [:yell!]]]"
+  end
+
+  class RemovingInheritGroup < Group
+    remove! :on_change, :change!
+    collection :songs, inherit: true do # this will not change position
+      remove! :on_add, :notify_album!
+    end
+  end
+
+# # puts "@@@@@ #{Group.hooks.object_id.inspect}"
+# # puts "@@@@@ #{EmptyGroup.hooks.object_id.inspect}"
+# puts "@@@@@ Group:         #{Group.representer_class.representable_attrs.get(:songs).representer_module.hooks.inspect}"
+# puts "@@@@@ EnhancedGroup: #{EnhancedGroup.representer_class.representable_attrs.get(:songs).representer_module.hooks.inspect}"
+# puts "@@@@@ InheritGroup:  #{EnhancedWithInheritGroup.representer_class.representable_attrs.get(:songs).representer_module.hooks.inspect}"
+# puts "@@@@@ RemovingGroup: #{RemovingInheritGroup.representer_class.representable_attrs.get(:songs).representer_module.hooks.inspect}"
+# # puts "@@@@@ #{EnhancedWithInheritGroup.representer_class.representable_attrs.get(:songs).representer_module.hooks.object_id.inspect}"
+
+  # TODO: object_id tests for all nested representers.
+
+  it do
+    Group.hooks.size.must_equal 4
+    RemovingInheritGroup.hooks.size.must_equal 3
+    RemovingInheritGroup.representer_class.representable_attrs.get(RemovingInheritGroup.hooks[0][1]).representer_module.hooks.to_s.must_equal "[[:on_add, [:reset_song!]]]"
+    RemovingInheritGroup.representer_class.representable_attrs.get(RemovingInheritGroup.hooks[2][1]).representer_module.hooks.to_s.must_equal "[[:on_change, [:sing!]]]"
+  end
+end

data/test/callbacks_test.rb

@@ -0,0 +1,450 @@
+require "test_helper"
+require "disposable/callback"
+
+class CallbacksTest < MiniTest::Spec
+  before do
+    @invokes = []
+  end
+
+  attr_reader :invokes
+
+  class AlbumTwin < Disposable::Twin
+    feature Sync, Save
+    feature Persisted, Changed
+
+    property :name
+
+    property :artist do
+      # on_added
+      # on_removed
+      property :name
+    end
+
+    collection :songs do
+      # after_add: could also be existing user
+      # after_remove
+      # after_create: this means added+changed?(:persisted): song created and added.
+      # after_update
+      property :title
+    end
+  end
+
+  # - Callbacks don't have before and after. This is up to the caller.
+  Callback = Disposable::Callback::Dispatch
+    # collection :songs do
+    #   after_add    :song_added! # , context: :operation
+    #   after_create :notify_album!
+    #   after_remove :notify_artist!
+    # end
+
+  let (:twin) { AlbumTwin.new(album) }
+
+  describe "#on_create" do
+    let (:album) { Album.new }
+
+    # after initialization
+    it do
+      invokes = []
+      Callback.new(twin).on_create { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # save, without any attributes changed.
+    it do
+      twin.save
+
+      invokes = []
+      Callback.new(twin).on_create { |t| invokes << t }
+      invokes.must_equal [twin]
+    end
+
+    # before and after save, with attributes changed
+    it do
+      # state change, but not persisted, yet.
+      twin.name = "Run For Cover"
+      invokes = []
+      Callback.new(twin).on_create { |t| invokes << t }
+      invokes.must_equal []
+
+      twin.save
+
+      Callback.new(twin).on_create { |t| invokes << t }
+      invokes.must_equal [twin]
+    end
+
+    # for collections.
+    it do
+      album.songs << song1 = Song.new
+      album.songs << Song.create(title: "Run For Cover")
+      album.songs << song2 = Song.new
+      invokes = []
+
+      Callback.new(twin.songs).on_create { |t| invokes << t }
+      invokes.must_equal []
+
+      twin.save
+
+      Callback.new(twin.songs).on_create { |t| invokes << t }
+      invokes.must_equal [twin.songs[0], twin.songs[2]]
+    end
+  end
+
+  describe "#on_update" do
+    let (:album) { Album.new }
+
+    # after initialization.
+    it do
+      invokes = []
+      Callback.new(twin).on_update { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # single twin.
+    # on_update only works on persisted objects.
+    it do
+      twin.name = "After The War" # change but not persisted
+
+      invokes = []
+      Callback.new(twin).on_update { |t| invokes << t }
+      invokes.must_equal []
+
+      invokes = []
+      twin.save
+
+      Callback.new(twin).on_update { |t| invokes << t }
+      invokes.must_equal []
+
+
+      # now with the persisted album.
+      twin = AlbumTwin.new(album) # Album is persisted now.
+
+      Callback.new(twin).on_update { |t| invokes << t }
+      invokes.must_equal []
+
+      invokes = []
+      twin.save
+
+      # nothing has changed, yet.
+      Callback.new(twin).on_update { |t| invokes << t }
+      invokes.must_equal []
+
+      twin.name= "Corridors Of Power"
+
+      # this will even trigger on_update before saving.
+      Callback.new(twin).on_update { |t| invokes << t }
+      invokes.must_equal [twin]
+
+      invokes = []
+      twin.save
+
+      # name changed.
+      Callback.new(twin).on_update { |t| invokes << t }
+      invokes.must_equal [twin]
+    end
+
+    # for collections.
+    it do
+      album.songs << song1 = Song.new
+      album.songs << Song.create(title: "Run For Cover")
+      album.songs << song2 = Song.new
+
+      invokes = []
+      Callback.new(twin.songs).on_update { |t| invokes << t }
+      invokes.must_equal []
+
+      invokes = []
+      twin.save
+
+      # initial save is no update.
+      Callback.new(twin.songs).on_update { |t| invokes << t }
+      invokes.must_equal []
+
+
+      # now with the persisted album.
+      twin = AlbumTwin.new(album) # Album is persisted now.
+
+      Callback.new(twin.songs).on_update { |t| invokes << t }
+      invokes.must_equal []
+
+      invokes = []
+      twin.save
+
+      # nothing has changed, yet.
+      Callback.new(twin.songs).on_update { |t| invokes << t }
+      invokes.must_equal []
+
+      twin.songs[1].title= "After The War"
+      twin.songs[2].title= "Run For Cover"
+
+      # # this will even trigger on_update before saving.
+      Callback.new(twin.songs).on_update { |t| invokes << t }
+      invokes.must_equal [twin.songs[1], twin.songs[2]]
+
+      invokes = []
+      twin.save
+
+      Callback.new(twin.songs).on_update { |t| invokes << t }
+      invokes.must_equal [twin.songs[1], twin.songs[2]]
+    end
+    # it do
+    #   album.songs << song1 = Song.new
+    #   album.songs << Song.create(title: "Run For Cover")
+    #   album.songs << song2 = Song.new
+    #   invokes = []
+
+    #   Callback.new(twin.songs).on_create { |t| invokes << t }
+    #   invokes.must_equal []
+
+    #   twin.save
+
+    #   Callback.new(twin.songs).on_create { |t| invokes << t }
+    #   invokes.must_equal [twin.songs[0], twin.songs[2]]
+    # end
+  end
+
+
+  describe "#on_add" do
+    let (:album) { Album.new }
+
+    # empty collection.
+    it do
+      invokes = []
+      Callback.new(twin.songs).on_add { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # collection present on initialize are not added.
+    it do
+      ex_song = Song.create(title: "Run For Cover")
+      song    = Song.new
+      album.songs = [ex_song, song]
+
+      Callback.new(twin.songs).on_add { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # items added after initialization are added.
+    it do
+      ex_song = Song.create(title: "Run For Cover")
+      song    = Song.new
+      album.songs = [ex_song]
+
+      twin.songs << song
+
+      Callback.new(twin.songs).on_add { |t| invokes << t }
+      invokes.must_equal [twin.songs[1]]
+
+      twin.save
+
+      # still shows the added after save.
+      invokes = []
+      Callback.new(twin.songs).on_add { |t| invokes << t }
+      invokes.must_equal [twin.songs[1]]
+    end
+  end
+
+  describe "#on_add(:created)" do
+    let (:album) { Album.new }
+
+    # empty collection.
+    it do
+      invokes = []
+      Callback.new(twin.songs).on_add(:created) { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # collection present on initialize are not added.
+    it do
+      ex_song = Song.create(title: "Run For Cover")
+      song    = Song.new
+      album.songs = [ex_song, song]
+
+      Callback.new(twin.songs).on_add(:created) { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # items added after initialization are added.
+    it do
+      ex_song = Song.create(title: "Run For Cover")
+      song    = Song.new
+      album.songs = [ex_song]
+
+      twin.songs << song
+      twin.songs << ex_song # already created.
+
+      Callback.new(twin.songs).on_add(:created) { |t| invokes << t }
+      invokes.must_equal []
+
+      twin.save
+
+      # still shows the added after save.
+      invokes = []
+      Callback.new(twin.songs).on_add(:created) { |t| invokes << t }
+      invokes.must_equal [twin.songs[1]] # only the created is invoked.
+    end
+  end
+
+  describe "#on_delete" do
+    let (:album) { Album.new }
+
+    # empty collection.
+    it do
+      invokes = []
+      Callback.new(twin.songs).on_delete { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # collection present but nothing deleted.
+    it do
+      ex_song = Song.create(title: "Run For Cover")
+      song    = Song.new
+      album.songs = [ex_song, song]
+
+      Callback.new(twin.songs).on_delete { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # items deleted.
+    it do
+      ex_song = Song.create(title: "Run For Cover")
+      song    = Song.new
+      album.songs = [ex_song, song]
+
+      twin.songs.delete(deleted = twin.songs[0])
+
+      Callback.new(twin.songs).on_delete { |t| invokes << t }
+      invokes.must_equal [deleted]
+
+      twin.save
+
+      # still shows the deleted after save.
+      invokes = []
+      Callback.new(twin.songs).on_delete { |t| invokes << t }
+      invokes.must_equal [deleted]
+    end
+  end
+
+  describe "#on_destroy" do
+    let (:album) { Album.new }
+
+    # empty collection.
+    it do
+      invokes = []
+      Callback.new(twin.songs).on_destroy { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # collection present but nothing deleted.
+    it do
+      ex_song = Song.create(title: "Run For Cover")
+      song    = Song.new
+      album.songs = [ex_song, song]
+
+      Callback.new(twin.songs).on_destroy { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # items deleted, doesn't trigger on_destroy.
+    it do
+      ex_song = Song.create(title: "Run For Cover")
+      song    = Song.new
+      album.songs = [ex_song, song]
+
+      twin.songs.delete(deleted = twin.songs[0])
+
+      Callback.new(twin.songs).on_destroy { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # items destroyed.
+    it do
+      ex_song = Song.create(title: "Run For Cover")
+      song    = Song.new
+      album.songs = [ex_song, song]
+
+      twin.songs.destroy(deleted = twin.songs[0])
+
+      Callback.new(twin.songs).on_destroy { |t| invokes << t }
+      invokes.must_equal []
+
+      twin.extend(Disposable::Twin::Collection::Semantics) # now #save will destroy.
+      twin.save
+
+      # still shows the deleted after save.
+      invokes = []
+      Callback.new(twin.songs).on_destroy { |t| invokes << t }
+      invokes.must_equal [deleted]
+    end
+  end
+
+
+  describe "#on_change" do
+    let (:album) { Album.new }
+
+    # after initialization
+    it do
+      Callback.new(twin).on_change { |t| invokes << t }
+      invokes.must_equal []
+    end
+
+    # save, without any attributes changed. unpersisted before.
+    it do
+      twin = AlbumTwin.new(Album.create)
+
+      twin.save
+
+      Callback.new(twin).on_change { |t| invokes << t }
+      invokes.must_equal [] # nothing has changed, not even persisted?.
+    end
+
+    # save, without any attributes changed. persisted before.
+    it do
+      twin.save
+
+      Callback.new(twin).on_change { |t| invokes << t }
+      invokes.must_equal [twin]
+    end
+
+    # before and after save, with attributes changed
+    it do
+      # state change, but not persisted, yet.
+      twin.name = "Run For Cover"
+      invokes = []
+      Callback.new(twin).on_change { |t| invokes << t }
+      invokes.must_equal [twin]
+
+      twin.save
+
+      invokes = []
+      Callback.new(twin).on_change { |t| invokes << t }
+      invokes.must_equal [twin]
+    end
+
+    # for scalars: on_change(:email).
+    it do
+      Callback.new(twin).on_change(property: :name) { |t| invokes << t }
+      invokes.must_equal []
+
+      twin.name = "Unforgiven"
+
+      Callback.new(twin).on_change(property: :name) { |t| invokes << t }
+      invokes.must_equal [twin]
+    end
+
+    # for collections.
+    # it do
+    #   album.songs << song1 = Song.new
+    #   album.songs << Song.create(title: "Run For Cover")
+    #   album.songs << song2 = Song.new
+    #   invokes = []
+
+    #   Callback.new(twin.songs).on_change { |t| invokes << t }
+    #   invokes.must_equal []
+
+    #   twin.save
+
+    #   Callback.new(twin.songs).on_change { |t| invokes << t }
+    #   invokes.must_equal [twin.songs[0], twin.songs[2]]
+    # end
+  end
+end