disposable 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3ede9bea8a77d3c3ca49a1d8d30e4d85174064b
-  data.tar.gz: bc8db041e0b26ce6520db6c0d647ad04f3fdffb4
+  metadata.gz: f0f85e8b618ecd45ecb2a9fcaca32ab1e28d8377
+  data.tar.gz: fb2f9474bd6f8aeca1f2ab5bd808825a62a00ff0
 SHA512:
-  metadata.gz: 241f8a98b1db05b79d6df1a725081648317c9eb913fca3bef48d487c8b8214d3089913285a1b6a0c581a8c7f778528924cf60ca8cc675143a3130603c959b13e
-  data.tar.gz: bb406f4d2550786497c0d3dc80b77ec69b97643f68adcba6ad2a9c78ef54121206a882edcf8363357ee5f325b0f8b60d70310efce9f829433d12de85a8f1c2b5
+  metadata.gz: 447222f485c8c0b950f5916ecf6a36f5337fab008e33beaedd3462c761d6c733a41c0c9bb6bfeb1aefd9bc2d74c1fa253a287a824d5234aa4eca486c6f58d2aa
+  data.tar.gz: 3f1daef9a44efbd2946fc4013529d9d272883b7d46ebda0108685e33640a4a3585a6e337b8006663b965fb84d241262e5f8b9403383b3f6fd81a93a7c5d2307f

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 0.1.5
+
+* Correctly merge options from constructor into `@fields`.
+* Add `:virtual` which is an alias for `readable: false, writeable: false`.
+* Do not use getters with `SkipGetter` in `#sync{}`.
+
 # 0.1.4
 
 * Add `Twin::Coercion`.

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in disposable.gemspec
 gemspec
 
-# gem 'representable', path: '../representable'
+ # gem 'representable', path: '../representable'

data/README.md

@@ -539,6 +539,14 @@ collection :songs do
 end
 ```
 
+## Readable, Writeable, Virtual
+
+Properties can have various access settings.
+
+* `readable: false` won't read from the model in `Setup`.
+* `writeable: false` won't write to model in `Sync`.
+* `virtual: true` is both settings above combined.
+
 ## Builders
 
 ## Used In

data/lib/disposable/twin.rb

@@ -47,6 +47,10 @@ module Disposable
       options[:private_name] = options.delete(:from) || name
       options[:pass_options] = true
 
+      if options.delete(:virtual)
+        options[:writeable] = options[:readable] = false
+      end
+
       representer_class.property(name, options, &block).tap do |definition|
         mod = Module.new do
           define_method(name)       { @fields[name.to_s] }

data/lib/disposable/twin/setup.rb

@@ -30,7 +30,7 @@ module Disposable
           setup_write!(dfn, value)
         end
 
-        @fields.merge!(options) # FIXME: hash/string. # FIXME: call writer!!!!!!!!!!
+        merge_options!(options) # FIXME: call writer!!!!!!!!!!
         # from_hash(options) # assigns known properties from options.
       end
 
@@ -38,6 +38,11 @@ module Disposable
         send(dfn.setter, value)
       end
 
+      def merge_options!(options)
+        # TODO: ask charliesome if that is faster with return unless options.size.
+        options.each { |k, v| @fields[k.to_s] = v } # TODO: this merges every option, not only defined ones.
+      end
+
 
       # Including this will _not_ use the property's setter in Setup and allow you to override it.
       module SkipSetter

data/lib/disposable/twin/sync.rb

@@ -48,7 +48,11 @@ class Disposable::Twin
 
     module ToNestedHash
       def to_nested_hash(*)
-        self.class.nested_hash_representer.new(self).to_hash
+        self.class.nested_hash_representer.new(nested_hash_source).to_hash
+      end
+
+      def nested_hash_source
+        self
       end
 
       module ClassMethods
@@ -58,8 +62,10 @@ class Disposable::Twin
             include Representable::Hash
 
             representable_attrs.each do |dfn|
-              dfn.merge!(readable: true) # the nested hash contains all fields.
-              dfn.merge!(as: dfn[:private_name]) # nested hash keys by model property names.
+              dfn.merge!(
+                readable: true, # the nested hash contains all fields.
+                as:       dfn[:private_name] # nested hash keys by model property names.
+              )
 
               dfn.merge!(
                 prepare:       lambda { |model, *| model }, # TODO: why do we need that here?
@@ -122,6 +128,10 @@ class Disposable::Twin
       def sync_read(dfn)
         @fields[dfn.name]
       end
+
+      def nested_hash_source
+        OpenStruct.new(@fields)
+      end
     end
   end
 end

data/lib/disposable/version.rb

@@ -1,3 +1,3 @@
 module Disposable
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/test/skip_getter_test.rb

@@ -33,6 +33,13 @@ class SkipGetterTest < MiniTest::Spec
 
     album.title.must_equal "Wild Frontier"
     album.artist.name.must_equal "Gary Moore"
+
+    # nested hash.
+    nested_hash = nil
+    twin.sync do |hash|
+      nested_hash = hash
+    end
+    nested_hash.must_equal({"title"=>"Wild Frontier", "artist"=>{"name"=>"Gary Moore"}})
   end
 end
 

data/test/twin/changed_test.rb

@@ -10,7 +10,6 @@ class ChangedWithSetupTest < MiniTest::Spec
 
   module Twin
     class Album < Disposable::Twin
-      feature Setup
       feature Changed
       # include Coercion
       property :name
@@ -25,7 +24,6 @@ class ChangedWithSetupTest < MiniTest::Spec
       end
 
       property :artist do
-        include Setup
         property :name
       end
     end
@@ -105,4 +103,35 @@ class ChangedWithSetupTest < MiniTest::Spec
     twin.name = "The Rest Is Silence"
     twin.changed?.must_equal false
   end
+end
+
+
+require "disposable/twin/coercion"
+class ChangedWithCoercionTest < MiniTest::Spec
+  Song = Struct.new(:released)
+
+  class SongTwin < Disposable::Twin
+    include Changed
+    include Coercion
+
+    property :released, type: Virtus::Attribute::Boolean
+  end
+
+  it do
+    twin = SongTwin.new(Song.new)
+    twin.changed?(:released).must_equal false
+    twin.released = 1
+    twin.released.must_equal true
+    twin.changed?(:released).must_equal true
+  end
+
+  it do
+    twin = SongTwin.new(Song.new(true))
+    twin.released = true
+    twin.changed?(:released).must_equal false
+    twin.released = 1 # it coerces, then assigns, then compares, which makes this NOT changed.
+    twin.changed?(:released).must_equal false
+    twin.released = false
+    twin.changed?(:released).must_equal true
+  end
 end

data/test/twin/setup_test.rb

@@ -136,4 +136,20 @@ class TwinSetupWithInlineTwinsTest < MiniTest::Spec
     twin.songs[1].composer.must_be_kind_of Disposable::Twin
     twin.songs[1].composer.id.must_equal 2
   end
+end
+
+# Twin.new(model, is_online: true)
+class TwinWithVirtualSetupTest < MiniTest::Spec
+  Song = Struct.new(:id)
+
+  class AlbumTwin < Disposable::Twin
+    property :id
+    property :is_online, readable: false, writeable: false
+  end
+
+  it do
+    twin = AlbumTwin.new(Song.new(1), is_online: true)
+    twin.id.must_equal 1
+    twin.is_online.must_equal true
+  end
 end

data/test/twin/skip_unchanged_test.rb

@@ -46,9 +46,9 @@ class SkipUnchangedTest < MiniTest::Spec
     twin.songs[0].title = "Resist Stance"
 
     # raises exceptions when setters are called.
-    album.instance_eval { def name=; end }
-    artist.instance_eval { def name=; end }
-    song_with_composer.instance_eval { def title=; end }
+    album.instance_eval { def name=; raise; end }
+    artist.instance_eval { def name=; raise; end }
+    song_with_composer.instance_eval { def title=; raise; end }
 
     twin.sync
 

data/test/twin/virtual_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class VirtualTest < MiniTest::Spec
+  class CreditCardTwin < Disposable::Twin
+    include Sync
+    property :credit_card_number, virtual: true # no read, no write, it's virtual.
+  end
+
+  let (:twin) { CreditCardTwin.new(Object.new) }
+
+  it {
+    twin.credit_card_number = "123"
+
+    twin.credit_card_number.must_equal "123"  # this is still readable in the UI.
+
+    twin.sync
+
+    hash = {}
+    twin.sync do |nested|
+      hash = nested
+    end
+
+    hash.must_equal("credit_card_number"=> "123")
+  }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: disposable
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -202,6 +202,7 @@ files:
 - test/twin/sync_option_test.rb
 - test/twin/sync_test.rb
 - test/twin/twin_test.rb
+- test/twin/virtual_test.rb
 - test/twin/writeable_test.rb
 homepage: https://github.com/apotonick/disposable
 licenses:
@@ -257,4 +258,5 @@ test_files:
 - test/twin/sync_option_test.rb
 - test/twin/sync_test.rb
 - test/twin/twin_test.rb
+- test/twin/virtual_test.rb
 - test/twin/writeable_test.rb