disposable 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abc930b3fee06aab580e516948996aff0e05ec45
-  data.tar.gz: 4902d414b02e4fc94ad30ad360d99671f099b3fc
+  metadata.gz: 9b938f2252d58d5182b64346aa82ec1f16567837
+  data.tar.gz: bf6f9fcbd1cb340498f2764036b3dc9d738b4a28
 SHA512:
-  metadata.gz: aa8ef4dae7775e779bb22de5bff27b7d503a7c9af92fef70b43ff3f679baecdbbacf9a53805882ee8368e7780adb9e5ac75a0f13bf9a4f70202f22ee75b09e1e
-  data.tar.gz: c6c45cfcbd947aeb2a7c2cab6ea9b6d7157a2daba38e59c756f73dcb8ce7a534391c6355207e404aeb11dd89999db6703c12ba4f409f231c4668cf922d8956f0
+  metadata.gz: d974e955ee6f3d0d39c6c83868c67c2c817a41ac5771e913e4311ec9b3933a6ce17e75dfe4493fc1fe6d15e91aba36e054a68305fde740d833520c2bda305ce2
+  data.tar.gz: 41485aeda7974a7986c350b47c7bfec88cf4de551929c68931b8fdfe6af17e974a25df74e28427dae20e49fdea8789eb77c623f69428f8b07981091aab7ac316

data/CHANGES.md

@@ -1,3 +1,8 @@
+# 0.2.4
+
+* Add `Twin::Parent` to access a nested's parent twin.
+* Introduce `Twin#build_for` and `Twin#build_twin`. This is a private API change.
+
 # 0.2.3
 
 * Add `Collection#find_by` for easier traversal/querying of twin collections: `album.songs.find_by(id: 1)`.

data/README.md

@@ -581,9 +581,51 @@ Properties can have various access settings.
 * `writeable: false` won't write to model in `Sync`.
 * `virtual: true` is both settings above combined.
 
+## Options
+
+To inject context data into a twin that is not part of any model, you can simply use `:virtual` properties.
+
+```ruby
+class AlbumTwin < Disposable::Twin
+  property :title
+  property :current_user, virtual: true
+end
+```
+
+You can now pass the `current_user` as an option into the constructor and then access it via the reader.
+
+```ruby
+twin = AlbumTwin.new(album, current_user: User.find(1))
+twin.current_user #=> <User id:1>
+```
+
+## Parent
+
+By using the `Parent` feature you can access the parent twin of a nested one.
+
+```ruby
+class AlbumTwin < Disposable::Twin
+  feature Parent
+
+  property :artist do
+    property :name
+  end
+end
+```
+
+Use `parent` to grab the nested's container twin.
+
+```ruby
+twin = AlbumTwin.new(Album.new(artist: Artist.new))
+
+twin.artist.parent #=> twin
+```
+
+Note that this will internally add a `parent` property.
+
 ## Builders
 
 ## Used In
 
 * [Reform](https://github.com/apotonick/reform) forms are based on twins and add a little bit of form decoration on top. Every nested form is a twin.
-* [Trailblazer](https://github.com/apotonick/trailblazer) uses twins as decorators and callbacks in operations to structure business logic.
+* [Trailblazer](https://github.com/apotonick/trailblazer) uses twins as decorators and callbacks in operations to structure business logic.

data/lib/disposable/twin.rb

@@ -53,11 +53,13 @@ module Disposable
         property(name, options.merge(collection: true), &block)
       end
 
+      # TODO: remove.
       def from_collection(collection)
         collection.collect { |model| new(model) }
       end
 
     private
+
       def create_accessors(name, definition)
         mod = Module.new do
           define_method(name)       { @fields[name.to_s] }
@@ -75,9 +77,7 @@ module Disposable
     private
       # assumption: collections are always initialized from Setup since we assume an empty [] for "nil"/uninitialized collections.
       def write_property(name, value, dfn)
-        if dfn[:nested] and value
-          value = dfn[:collection] ? wrap_collection(dfn, value) : wrap_scalar(dfn, value)
-        end
+        value = build_for(dfn, value) if dfn[:nested] and value
 
         field_write(name, value)
       end
@@ -92,27 +92,33 @@ module Disposable
         @fields[name.to_s]
       end
 
-      def wrap_scalar(dfn, value)
-        Twinner.new(dfn).(value)
+      # Build a twin or a Twin::Collection for the value (which is a model or array of).
+      def build_for(dfn, *args)
+        dfn[:collection] ? build_collection(dfn, *args) : build_twin(dfn, *args)
       end
 
-      def wrap_collection(dfn, value)
-        Collection.for_models(Twinner.new(dfn), value)
+      def build_twin(dfn, *args)
+        dfn[:nested].new(*args) # Twin.new(model, options={})
+      end
+
+      def build_collection(dfn, *args)
+        Collection.for_models(Twinner.new(self, dfn), *args)
       end
     end
     include Accessors
 
+    # TODO: make this a function so it's faster at run-time.
     class Twinner
-      def initialize(dfn)
-        @dfn = dfn
+      def initialize(twin, dfn)
+        @twin = twin
+        @dfn  = dfn
       end
 
-      def call(value)
-        @dfn[:nested].new(value)
+      def call(*args)
+        @twin.send(:build_twin, @dfn, *args)
       end
     end
 
-
   private
     module ModelReaders
       attr_reader :model # #model is a private concept.

data/lib/disposable/twin/collection.rb

@@ -3,8 +3,8 @@ module Disposable
     # Provides collection semantics like add, delete, and more for twin collections.
     # Tracks additions and deletions in #added and #deleted.
     class Collection < Array
-      def self.for_models(twinner, models)
-        new(twinner, models.collect { |model| twinner.(model) })
+      def self.for_models(twinner, models, *options)
+        new(twinner, models.collect { |model| twinner.(model, *options) })
       end
 
       def initialize(twinner, items)

data/lib/disposable/twin/parent.rb

@@ -0,0 +1,10 @@
+module Disposable::Twin::Parent
+  def self.included(includer)
+    includer.property(:parent, virtual: true)
+  end
+
+  # FIXME: for collections, this will merge options for every element.
+  def build_twin(dfn, value, options={})
+    super(dfn, value, options.merge(parent: self))
+  end
+end

data/lib/disposable/version.rb

@@ -1,3 +1,3 @@
 module Disposable
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/test/twin/benchmarking.rb

@@ -1,26 +1,21 @@
 require "disposable/twin"
-require 'reform'
 require 'ostruct'
 require 'benchmark'
 
-class BandForm < Reform::Form
-  property :name, validates: {presence: true}
+class Band < Disposable::Twin
+  property :name
 
   collection :songs do
-    property :title, validates: {presence: true}
+    property :title
   end
 end
 
-songs = 50.times.collect { OpenStruct.new(title: "Be Stag") }
-band = OpenStruct.new(name: "Teenage Bottlerock", songs: songs)
-
-songs_params = 50.times.collect { {title: "Commando"} }
+songs = 50.times.collect { Struct.new(:title).new("Be Stag") }
+band = Struct.new(:name, :songs).new("Teenage Bottlerock", songs)
 
 time = Benchmark.measure do
-  100.times.each do
-    form = BandForm.new(band)
-    form.validate("name" => "Ramones", "songs" => songs_params)
-    form.save
+  1000.times do
+    Band.new(band)
   end
 end
 
@@ -30,4 +25,8 @@ puts time
 #   4.200000
 # 20%
 # with setup and new(fields).from_object(twin) instead of Fields.new(to_hash)
-#   3.680000   0.000000   3.680000 (  3.685796)
+#   3.680000   0.000000   3.680000 (  3.685796)
+
+
+# 06/01
+# 0.300000   0.000000   0.300000 (  0.298956)

data/test/twin/collection_test.rb

@@ -218,7 +218,8 @@ class CollectionUnitTest < MiniTest::Spec
     Album = Struct.new(:id, :name, :songs, :artist)
   end
 
-  let(:collection) { Disposable::Twin::Collection.new(Disposable::Twin::Twinner.new(Twin::Song.definitions.get(:album)), []) }
+  # THIS is why private tests suck!
+  let(:collection) { Disposable::Twin::Collection.new(Disposable::Twin::Twinner.new(Twin::Song.new(OpenStruct.new), Twin::Song.definitions.get(:album)), []) }
 
   # #insert(index, model)
   it do

data/test/twin/option_test.rb

@@ -1,12 +1,20 @@
 # require "test_helper"
 
-# class TwinOptionTest < TwinTest
+# class TwinOptionTest < Minitest::Spec
+#   module Model
+#     Song  = Struct.new(:id, :title, :album)
+#   end
+
 #   class Song < Disposable::Twin
-#     property :id # DISCUSS: needed for #save.
+#     property :id
 #     property :title
 
+#     def self.option(name, options={})
+#       property(name, options.merge(virtual: true))
+#     end
+
 #     option :preview?
-#     option :highlight?
+#     option :current_user
 #   end
 
 #   let (:song) { Model::Song.new(1, "Broken") }
@@ -20,8 +28,12 @@
 #   # option is not delegated to model.
 #   it { twin.preview?.must_equal false }
 #   # not passing option means zero.
-#   it { twin.highlight?.must_equal nil }
+#   it { twin.current_user.must_equal nil }
 
-#   # passing both options.
-#   it { Song.new(song, preview?: true, highlight?: false).preview?.must_equal true }
+#   describe "passing all options" do
+#     let (:twin) { Song.new(song, :preview? => false, current_user: Object) }
+
+#     it { twin.preview?.must_equal false }
+#     it { twin.current_user.must_equal Object }
+#   end
 # end

data/test/twin/parent_test.rb

@@ -0,0 +1,41 @@
+require "test_helper"
+require "disposable/twin/parent.rb"
+
+class TwinParentTest < MiniTest::Spec
+  module Model
+    Album = Struct.new(:id, :artist, :songs)
+    Artist = Struct.new(:name)
+    Song  = Struct.new(:title, :composer)
+  end
+
+  class Album < Disposable::Twin
+    feature Parent
+
+    property :id
+
+    property :artist do
+      property :name
+    end
+
+    collection :songs do
+      property :title
+      property :composer do
+        property :name
+      end
+    end
+  end
+
+  let (:album) { Album.new(Model::Album.new(1, Model::Artist.new("Helloween"), [Model::Song.new("I'm Alive", Model::Artist.new("Kai Hansen"))])) }
+
+  it { album.parent.must_equal nil }
+  it { album.artist.parent.must_equal album }
+  it { album.songs[0].parent.must_equal album }
+  it { album.songs[0].composer.parent.must_equal album.songs[0] }
+
+  describe "Collection#append" do
+    it do
+      album.songs.append(song = Model::Song.new)
+      album.songs[1].parent.must_equal album
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: disposable
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-27 00:00:00.000000000 Z
+date: 2016-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -175,6 +175,7 @@ files:
 - lib/disposable/twin/composition.rb
 - lib/disposable/twin/default.rb
 - lib/disposable/twin/definitions.rb
+- lib/disposable/twin/parent.rb
 - lib/disposable/twin/persisted.rb
 - lib/disposable/twin/property_processor.rb
 - lib/disposable/twin/save.rb
@@ -204,6 +205,7 @@ files:
 - test/twin/from_test.rb
 - test/twin/inherit_test.rb
 - test/twin/option_test.rb
+- test/twin/parent_test.rb
 - test/twin/process_inline_test.rb
 - test/twin/readable_test.rb
 - test/twin/save_test.rb
@@ -263,6 +265,7 @@ test_files:
 - test/twin/from_test.rb
 - test/twin/inherit_test.rb
 - test/twin/option_test.rb
+- test/twin/parent_test.rb
 - test/twin/process_inline_test.rb
 - test/twin/readable_test.rb
 - test/twin/save_test.rb