disposable 0.0.9 → 0.1.0

data/test/twin/sync_test.rb

@@ -0,0 +1,128 @@
+require "test_helper"
+
+class TwinSyncTest < MiniTest::Spec
+  module Model
+    Song  = Struct.new(:title, :composer)
+    Album = Struct.new(:name, :songs, :artist)
+    Artist = Struct.new(:name)
+  end
+
+
+  module Twin
+    class Album < Disposable::Twin
+      feature Setup
+      feature Sync
+
+      property :name
+
+      collection :songs do
+        property :title
+
+        property :composer do
+          property :name
+        end
+      end
+
+      property :artist do
+        property :name
+      end
+    end
+  end
+
+
+  let (:song) { Model::Song.new() }
+  let (:composer) { Model::Artist.new(nil) }
+  let (:song_with_composer) { Model::Song.new(nil, composer) }
+  let (:artist) { Model::Artist.new(nil) }
+
+
+  describe "#sync" do
+    let (:album) { Model::Album.new(nil, [song, song_with_composer], artist) }
+
+    # with populated model.
+    it do
+      twin = Twin::Album.new(album)
+
+      # this usually happens in Contract::Validate or in from_* in a representer
+      fill_out!(twin)
+
+      # not written to model, yet.
+      album.name.must_equal nil
+      album.songs[0].title.must_equal nil
+      album.songs[1].title.must_equal nil
+      album.songs[1].composer.name.must_equal nil
+      album.artist.name.must_equal nil
+
+      twin.sync
+
+      album.name.must_equal "Live And Dangerous"
+      album.songs[0].must_be_instance_of Model::Song
+      album.songs[1].must_be_instance_of Model::Song
+      album.songs[0].title.must_equal "Southbound"
+      album.songs[1].title.must_equal "The Boys Are Back In Town"
+      album.songs[1].composer.must_be_instance_of Model::Artist
+      album.songs[1].composer.name.must_equal "Lynott"
+      album.artist.must_be_instance_of Model::Artist
+      album.artist.name.must_equal "Thin Lizzy"
+    end
+
+    # with empty, not populated model.
+    it do
+      album = Model::Album.new(nil, [])
+      twin  = Twin::Album.new(album)
+
+      # this usually happens in Contract::Validate or in from_* in a representer
+      twin.name = "Live And Dangerous"
+
+      twin.songs.insert(0, song)
+      twin.songs.insert(1, song_with_composer)
+
+      twin.songs[0].title = "Southbound"
+      twin.songs[1].title = "The Boys Are Back In Town"
+      twin.songs[1].composer.name = "Lynott"
+
+      # not written to model, yet.
+      album.name.must_equal nil
+      album.songs.must_equal []
+      album.artist.must_equal nil
+
+      twin.sync # this assigns a new collection via #songs=.
+
+      album.name.must_equal "Live And Dangerous"
+      album.songs[0].title.must_equal "Southbound"
+      album.songs[1].title.must_equal "The Boys Are Back In Town"
+      album.songs[1].composer.name.must_equal "Lynott"
+    end
+
+    # save with block creates nested_hash and doesn't sync.
+    it do
+      twin = Twin::Album.new(album)
+
+      # this usually happens in Contract::Validate or in from_* in a representer
+      fill_out!(twin)
+
+      nested_hash = nil
+      twin.sync do |hash|
+        nested_hash = hash
+      end
+
+      nested_hash.must_equal({"name"=>"Live And Dangerous", "songs"=>[{"title"=>"Southbound"}, {"title"=>"The Boys Are Back In Town", "composer"=>{"name"=>"Lynott"}}], "artist"=>{"name"=>"Thin Lizzy"}})
+
+      # nothing written to model.
+      album.name.must_equal nil
+      album.songs[0].title.must_equal nil
+      album.songs[1].title.must_equal nil
+      album.songs[1].composer.name.must_equal nil
+      album.artist.name.must_equal nil
+    end
+
+
+    def fill_out!(twin)
+      twin.name = "Live And Dangerous"
+      twin.songs[0].title = "Southbound"
+      twin.songs[1].title = "The Boys Are Back In Town"
+      twin.songs[1].composer.name = "Lynott"
+      twin.artist.name = "Thin Lizzy"
+    end
+  end
+end

data/test/twin/twin_test.rb

@@ -1,10 +1,10 @@
 require 'test_helper'
 
-
 class TwinTest < MiniTest::Spec
   module Model
     Song  = Struct.new(:id, :title, :album)
-    Album = Struct.new(:id, :name, :songs)
+    Album = Struct.new(:id, :name, :songs, :artist)
+    Artist = Struct.new(:id)
   end
 
 
@@ -13,16 +13,19 @@ class TwinTest < MiniTest::Spec
       property :id # DISCUSS: needed for #save.
       property :name
       collection :songs, :twin => lambda { |*| Song }
-
-      # model Model::Album
+      property :artist, :twin => lambda { |*| Artist }
     end
 
     class Song < Disposable::Twin
       property :id # DISCUSS: needed for #save.
-      property :name, :from => :title
+      property :title
       property :album, :twin => Album
+    end
 
-      # model Model::Song
+    class Artist < Disposable::Twin
+      property :id
+
+      include Setup
     end
   end
 
@@ -33,14 +36,14 @@ class TwinTest < MiniTest::Spec
       twin = Twin::Song.new(song)
       song.id = 2
       # :from maps public name
-      twin.name.must_equal "Broken" # public: #name
-      twin.id.must_equal 2
+      twin.title.must_equal "Broken" # public: #record_name
+      twin.id.must_equal 1
     end
 
-    # override property with public name in constructor.
+    # allows passing options.
     it do
       # override twin's value...
-      Twin::Song.new(song, :name => "Kenny").name.must_equal "Kenny"
+      Twin::Song.new(song, :title => "Kenny").title.must_equal "Kenny"
 
       # .. but do not write to the model!
       song.title.must_equal "Broken"
@@ -49,19 +52,47 @@ class TwinTest < MiniTest::Spec
 
   describe "setter" do
     let (:twin) { Twin::Song.new(song) }
+    let (:album) { Model::Album.new(1, "The Stories Are True") }
 
-    before do
+    it do
       twin.id = 3
-      twin.name = "Lucky"
+      twin.title = "Lucky"
+      twin.album = album # this is a model, not a twin.
+
+      # updates twin
+      twin.id.must_equal 3
+      twin.title.must_equal "Lucky"
+
+      # setter for nested property will twin value.
+      twin.album.extend(Disposable::Comparable)
+      assert twin.album == Twin::Album.new(album) # FIXME: why does must_equal not call #== ?
+
+      # setter for nested collection.
+
+      # DOES NOT update model
+      song.id.must_equal 1
+      song.title.must_equal "Broken"
     end
 
-    # updates twin
-    it { twin.id.must_equal 3 }
-    it { twin.name.must_equal "Lucky" }
+    # setters for twin properties return the twin, not the model
+    # it do
+    #   result = twin.album = album
+    #   result.must_equal twin.album
+    # end
+  end
+
+  # FIXME: experimental.
+  describe "#to_s" do
+    class HitTwin < Disposable::Twin
+      include Setup
 
-    # DOES NOT update model
-    it { song.id.must_equal 1 }
-    it { song.title.must_equal "Broken" }
+      property :song do
+      end
+    end
+
+    let (:hit) { OpenStruct.new(song: song) }
+    it { HitTwin.new(hit).to_s.must_match "#<TwinTest::HitTwin:" }
+    it { HitTwin.new(hit).song.to_s.must_match "#<Twin (inline):" }
   end
 end
 
@@ -80,36 +111,6 @@ class OverridingAccessorsTest < TwinTest
 end
 
 
-class TwinDecoratorTest < MiniTest::Spec
-  subject { TwinTest::Twin::Song.representer_class.new(nil) }
-
-  it { subject.twin_names.must_equal [:album] }
-end
-
-
-require 'disposable/twin/struct'
-class TwinStructTest < MiniTest::Spec
-  class Song < Disposable::Twin
-    include Struct
-    property :number, :default => 1 # FIXME: this should be :default_if_nil so it becomes clear with a model.
-    option   :cool?
-  end
-
-  # empty hash
-  it { Song.new({}).number.must_equal 1 }
-  # model hash
-  it { Song.new(number: 2).number.must_equal 2 }
-
-  # with hash and options as one hash.
-  it { Song.new(number: 3, cool?: true).cool?.must_equal true }
-  it { Song.new(number: 3, cool?: true).number.must_equal 3 }
-
-  # with model hash and options hash separated.
-  it { Song.new({number: 3}, {cool?: true}).cool?.must_equal true }
-  it { Song.new({number: 3}, {cool?: true}).number.must_equal 3 }
-end
-
-
 class TwinAsTest < MiniTest::Spec
   module Model
     Song  = Struct.new(:title, :album)
@@ -133,84 +134,4 @@ class TwinAsTest < MiniTest::Spec
   end
 
 end
-
-
-class TwinOptionTest < TwinTest
-  class Song < Disposable::Twin
-    property :id # DISCUSS: needed for #save.
-    property :title
-
-    option :preview?
-    option :highlight?
-  end
-
-  let (:song) { Model::Song.new(1, "Broken") }
-  let (:twin) { Song.new(song, :preview? => false) }
-
-
-  # properties are read from model.
-  it { twin.id.must_equal 1 }
-  it { twin.title.must_equal "Broken" }
-
-  # option is not delegated to model.
-  it { twin.preview?.must_equal false }
-  # not passing option means zero.
-  it { twin.highlight?.must_equal nil }
-
-  # passing both options.
-  it { Song.new(song, preview?: true, highlight?: false).preview?.must_equal true }
-end
-
-
-class TwinBuilderTest < MiniTest::Spec
-  class Twin < Disposable::Twin
-    property :id
-    property :title
-    option   :is_released
-  end
-
-  describe "without property setup" do
-    class Host
-      include Disposable::Twin::Builder
-
-      twin Twin
-
-      def initialize(*args)
-        @model = build_twin(*args)
-      end
-
-      attr_reader :model
-    end
-
-    subject { Host.new(TwinTest::Model::Song.new(1, "Saturday Night"), is_released: true) }
-
-    # model is simply the twin.
-    it { subject.respond_to?(:title).must_equal false }
-    it { subject.model.id.must_equal 1 }
-    it { subject.model.title.must_equal "Saturday Night" }
-    it { subject.model.is_released.must_equal true }
-  end
-
-
-  describe "without property setup" do
-    class HostWithReaders
-      include Disposable::Twin::Builder
-
-      extend Forwardable
-      twin(Twin) { |dfn| def_delegator :@model, dfn.name }
-
-      def initialize(*args)
-        @model = build_twin(*args)
-      end
-    end
-
-    subject { HostWithReaders.new(TwinTest::Model::Song.new(1, "Saturday Night"), is_released: true) }
-
-    # both twin gets created and reader method defined.
-    it { subject.id.must_equal 1 }
-    it { subject.title.must_equal "Saturday Night" }
-    it { subject.is_released.must_equal true }
-  end
-end
-
 # TODO: test coercion!

data/test/twin/writeable_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+class WriteableTest < MiniTest::Spec
+  Credentials = Struct.new(:password, :credit_card) do
+    def password=(v)
+      raise "don't call me!"
+    end
+  end
+
+  CreditCard = Struct.new(:name, :number) do
+    def number=(v)
+      raise "don't call me!"
+    end
+  end
+
+  class PasswordForm < Disposable::Twin
+    feature Setup
+    feature Sync
+
+    property :password, writeable: false
+
+    property :credit_card do
+      property :name
+      property :number, writeable: false
+    end
+  end
+
+  let (:cred) { Credentials.new("secret", CreditCard.new("Jonny", "0987654321")) }
+
+  let (:twin) { PasswordForm.new(cred) }
+
+  it {
+    twin.password.must_equal "secret"
+    twin.credit_card.name.must_equal "Jonny"
+    twin.credit_card.number.must_equal "0987654321"
+
+    # manual setting on the twin works.
+    twin.password = "123"
+    twin.password.must_equal "123"
+
+    twin.credit_card.number = "456"
+    twin.credit_card.number.must_equal "456"
+
+    twin.sync
+
+    cred.inspect.must_equal '#<struct WriteableTest::Credentials password="secret", credit_card=#<struct WriteableTest::CreditCard name="Jonny", number="0987654321">>'
+
+    # test sync{}.
+    hash = {}
+    twin.sync do |nested|
+      hash = nested
+    end
+
+    hash.must_equal("password"=> "123", "credit_card"=>{"name"=>"Jonny", "number"=>"456"})
+  }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: disposable
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -28,16 +28,22 @@ dependencies:
   name: representable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.2.3
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,17 +76,45 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.4.1
-description: Domain-Oriented Refactoring Framework.
+        version: '0'
+description: Decorators on top of your ORM layer.
 email:
 - apotonick@gmail.com
 executables: []
@@ -94,7 +128,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- STUFF
 - database.sqlite3
 - disposable.gemspec
 - gemfiles/Gemfile.rails-2.3
@@ -108,23 +141,52 @@ files:
 - gemfiles/Gemfile.rails-4.1
 - gemfiles/Gemfile.rails-4.1.lock
 - lib/disposable.rb
+- lib/disposable/callback.rb
 - lib/disposable/composition.rb
+- lib/disposable/expose.rb
 - lib/disposable/twin.rb
 - lib/disposable/twin/builder.rb
+- lib/disposable/twin/changed.rb
+- lib/disposable/twin/collection.rb
 - lib/disposable/twin/composition.rb
-- lib/disposable/twin/finders.rb
-- lib/disposable/twin/new.rb
 - lib/disposable/twin/option.rb
+- lib/disposable/twin/persisted.rb
+- lib/disposable/twin/property_processor.rb
 - lib/disposable/twin/representer.rb
 - lib/disposable/twin/save.rb
-- lib/disposable/twin/save_.rb
+- lib/disposable/twin/schema.rb
+- lib/disposable/twin/setup.rb
 - lib/disposable/twin/struct.rb
+- lib/disposable/twin/sync.rb
 - lib/disposable/version.rb
-- test/composition_test.rb
+- test/api_semantics_test.rb
+- test/callback_group_test.rb
+- test/callbacks_test.rb
+- test/example.rb
+- test/expose_test.rb
+- test/persisted_test.rb
 - test/test_helper.rb
+- test/twin/benchmarking.rb
+- test/twin/builder_test.rb
+- test/twin/changed_test.rb
+- test/twin/collection_test.rb
 - test/twin/composition_test.rb
+- test/twin/expose_test.rb
+- test/twin/feature_test.rb
+- test/twin/from_test.rb
+- test/twin/inherit_test.rb
+- test/twin/option_test.rb
+- test/twin/readable_test.rb
+- test/twin/save_test.rb
+- test/twin/schema_test.rb
+- test/twin/setup_test.rb
+- test/twin/skip_unchanged_test.rb
+- test/twin/struct_test.rb
+- test/twin/sync_option_test.rb
+- test/twin/sync_test.rb
 - test/twin/twin_test.rb
-homepage: ''
+- test/twin/writeable_test.rb
+homepage: https://github.com/apotonick/disposable
 licenses:
 - MIT
 metadata: {}
@@ -144,12 +206,36 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Domain-Oriented Refactoring Framework.
+summary: Decorators on top of your ORM layer with change tracking, collection semantics
+  and nesting.
 test_files:
-- test/composition_test.rb
+- test/api_semantics_test.rb
+- test/callback_group_test.rb
+- test/callbacks_test.rb
+- test/example.rb
+- test/expose_test.rb
+- test/persisted_test.rb
 - test/test_helper.rb
+- test/twin/benchmarking.rb
+- test/twin/builder_test.rb
+- test/twin/changed_test.rb
+- test/twin/collection_test.rb
 - test/twin/composition_test.rb
+- test/twin/expose_test.rb
+- test/twin/feature_test.rb
+- test/twin/from_test.rb
+- test/twin/inherit_test.rb
+- test/twin/option_test.rb
+- test/twin/readable_test.rb
+- test/twin/save_test.rb
+- test/twin/schema_test.rb
+- test/twin/setup_test.rb
+- test/twin/skip_unchanged_test.rb
+- test/twin/struct_test.rb
+- test/twin/sync_option_test.rb
+- test/twin/sync_test.rb
 - test/twin/twin_test.rb
+- test/twin/writeable_test.rb