disposable 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac8377b25f70507f4f8864eeb8305ece5340f560
-  data.tar.gz: 14c1b2c3dfd514fb4d0fdd26e827dfea2cecfb83
+  metadata.gz: 3da86b891ceddbf906a835e6a9ef6a697b56f367
+  data.tar.gz: ae72874647302013e6f5ce630ed2966db1aceb79
 SHA512:
-  metadata.gz: 5102f0279af1bed8b3a614833dc066b2e29e1ddff062896dfa2519bf31c67709119461399b8a6d03bf27b277428e503290e5e7f58d70d645e3c2ea14803a3af7
-  data.tar.gz: 3a752d1130a9f3b391534d968bdffe5661d362ca40db1e1b3adf018948003c805b56b6b5ef34efb29c874ee9b559ba5af501f446f3eb74e43126ac60ef7a8a6e
+  metadata.gz: 2742ca894ddafed28b2f3ca3206d9d1e318ebbd023013ccb1677d5e0b31bce388c4b5d903c3c1dd44c0b7183fde9d6f28c8587b64b0942d72a5398a30f039a05
+  data.tar.gz: 7457ab52dce3383eb1cb4946bf7e163c8259f1ca44c1135aaa37a0345a153c1ec17d10b4715beedfb45c5a19b4d85bb113a5da83ae0dfb998f834e34f630ac1e

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.3.1
+
+* Introduce `Twin::JSONB` for easy access to hash fields using `Struct`.
+
 # 0.3.0
 
 * Use [dry-types](https://github.com/dry-rb/dry-types) as a replacement for the deprecated virtus. You have to change to dry-types' constants.

data/Gemfile

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 gemspec
 
 # gem "representable", path: "../representable"
-gem "representable", "2.4.0"
+gem "representable", "3.0.0"
 # gem "representable", github: "apotonick/representable"
 # gem "declarative", path: "../declarative"
 # gem "declarative", github: "apotonick/declarative"

data/disposable.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "uber"
-  spec.add_dependency "declarative", "~> 0.0.6"
+  spec.add_dependency "declarative", ">= 0.0.8", "< 1.0.0"
   spec.add_dependency "representable", ">= 2.4.0", "<= 3.1.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/lib/disposable/twin/jsonb.rb

@@ -0,0 +1,45 @@
+require "disposable/twin/struct"
+
+class Disposable::Twin
+  module JSONB
+    def self.included(includer)
+      # jsonb: true top-level properties need :default support.
+      includer.feature Default
+
+      # Recursively include Struct in :jsonb and nested properties.
+      # defaults is applied to all ::property calls.
+      includer.defaults do |name, options|
+        if options[:jsonb] # only apply to `jsonb: true`.
+          jsonb_options
+        else
+          {}
+        end
+      end
+    end
+
+  private
+    # Note that :_features `include`s modules in this order, first to last.
+    def self.jsonb_options
+      { _features: [NestedDefaults, Struct, JSONB::Sync], default: ->(*) { Hash.new } }
+    end
+
+    # NestedDefaults for properties nested in the top :jsonb column.
+    module NestedDefaults
+      def self.included(includer)
+        includer.defaults do |name, options|
+          if options[:_nested_builder] # DISCUSS: any other way to figure out we're nested?
+            JSONB.jsonb_options
+          else
+            { }
+          end
+        end
+      end
+    end
+
+    module Sync
+      def sync!(options={})
+        @model.merge(super)
+      end
+    end
+  end
+end

data/lib/disposable/twin/sync.rb

@@ -51,10 +51,11 @@ class Disposable::Twin
           next
         end
 
+        # First, call sync! on nested model(s).
         nested_model = PropertyProcessor.new(dfn, self, property_value).() { |twin| twin.sync!({}) }
-
         next if nested_model.nil?
 
+        # Then, write nested model to parent model, e.g. model.songs = [<Song>]
         mapper.send(dfn.setter, nested_model) # @model.artist = <Artist>
       end
 

data/lib/disposable/version.rb

@@ -1,3 +1,3 @@
 module Disposable
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/twin/default_test.rb

@@ -63,42 +63,3 @@ class DefaultAndVirtualTest < Minitest::Spec
   end
 end
 
-
-require "disposable/twin/struct"
-class DefaultWithStructTest < Minitest::Spec
-  Song     = Struct.new(:settings)
-
-  class Twin < Disposable::Twin
-    feature Default
-    feature Sync
-
-    property :settings, default: Hash.new do
-      include Struct
-
-      property :enabled, default: "yes"
-      property :roles, default: Hash.new do
-        include Struct
-        property :admin, default: "maybe"
-      end
-    end
-  end
-
-  # all given.
-  it do
-    twin = Twin.new(Song.new({enabled: true, roles: {admin: false}}))
-    twin.settings.enabled.must_equal true
-    twin.settings.roles.admin.must_equal false
-  end
-
-  # defaults, please.
-  it do
-    song = Song.new
-    twin = Twin.new(song)
-    twin.settings.enabled.must_equal "yes"
-    twin.settings.roles.admin.must_equal "maybe"
-
-    twin.sync
-
-    song.settings.must_equal({"enabled"=>"yes", "roles"=>{"admin"=>"maybe"}})
-  end
-end

data/test/twin/jsonb_test.rb

@@ -0,0 +1,118 @@
+require "test_helper"
+require "disposable/twin/jsonb"
+
+class JSONBTest < MiniTest::Spec
+  Model = Struct.new(:id, :content)
+
+  class Song < Disposable::Twin
+    feature Sync
+    include JSONB
+
+    property :id
+    property :content, jsonb: true do
+      property :title
+      property :band do
+        property :name
+
+        property :label do
+          property :location
+        end
+      end
+    end
+  end
+
+  # puts Song.definitions.get(:content)[:nested].definitions.get(:band).inspect
+
+  it "allows reading from existing hash" do
+    model = Model.new(1, {})
+    model.inspect.must_equal "#<struct JSONBTest::Model id=1, content={}>"
+
+    song = Song.new(model)
+    song.id.must_equal 1
+    song.content.title.must_equal nil
+    song.content.band.name.must_equal nil
+    song.content.band.label.location.must_equal nil
+
+    # model's hash hasn't changed.
+    model.inspect.must_equal "#<struct JSONBTest::Model id=1, content={}>"
+  end
+
+  it "defaults to hash when value is nil" do
+    model = Model.new(1)
+    model.inspect.must_equal "#<struct JSONBTest::Model id=1, content=nil>"
+
+    song = Song.new(model)
+    song.id.must_equal 1
+    song.content.title.must_equal nil
+    song.content.band.name.must_equal nil
+    song.content.band.label.location.must_equal nil
+
+    # model's hash hasn't changed.
+    model.inspect.must_equal "#<struct JSONBTest::Model id=1, content=nil>"
+  end
+
+  it "#sync writes to model" do
+    model = Model.new
+
+    song = Song.new(model)
+    song.content.band.label.location = "San Francisco"
+
+    song.sync
+
+    model.inspect.must_equal "#<struct JSONBTest::Model id=nil, content={\"band\"=>{\"label\"=>{\"location\"=>\"San Francisco\"}}}>"
+  end
+
+  it "doesn't erase existing, undeclared content" do
+    model = Model.new(nil, {"artist"=>{}})
+
+    song = Song.new(model)
+    song.content.band.label.location = "San Francisco"
+
+    # puts song.content.class.ancestors
+    song.sync
+
+    model.inspect.must_equal "#<struct JSONBTest::Model id=nil, content={\"artist\"=>{}, \"band\"=>{\"label\"=>{\"location\"=>\"San Francisco\"}}}>"
+  end
+
+  it "doesn't erase existing, undeclared content in existing content" do
+    model = Model.new(nil, {"band"=>{ "label" => { "owner" => "Brett Gurewitz" }, "genre" => "Punkrock" }})
+
+    song = Song.new(model)
+    song.content.band.label.location = "San Francisco"
+
+    song.sync
+
+    model.inspect.must_equal "#<struct JSONBTest::Model id=nil, content={\"band\"=>{\"label\"=>{\"owner\"=>\"Brett Gurewitz\", \"location\"=>\"San Francisco\"}, \"genre\"=>\"Punkrock\"}}>"
+  end
+
+
+  describe "features propagation" do
+    module UUID
+      def uuid
+        "1224"
+      end
+    end
+
+    class Hit < Disposable::Twin
+      include JSONB
+      feature UUID
+
+      property :id
+      property :content, jsonb: true do
+        property :title
+        property :band do
+          property :name
+        end
+      end
+    end
+
+    it "includes features into all nested twins" do
+      song = Hit.new(Model.new)
+      song.uuid.must_equal "1224"
+      song.content.uuid.must_equal "1224"
+      song.content.band.uuid.must_equal "1224"
+    end
+  end
+end
+
+# fixme: make sure default hash is different for every invocation, and not created at compile time.

data/test/twin/struct_test.rb

@@ -66,18 +66,23 @@ class TwinWithNestedStructTest < MiniTest::Spec
         property :show_image
         property :play_teaser
       end
+
+      collection :roles do
+        include Struct
+        property :name
+      end
     end
   end
 
   # FIXME: test with missing hash properties, e.g. without released and with released:false.
   let (:model) { OpenStruct.new(title: "Seed of Fear and Anger", options: {recorded: true, released: 1,
-    preferences: {show_image: true, play_teaser: 2}}) }
+    preferences: {show_image: true, play_teaser: 2}, roles: [{name: "user"}]}) }
 
   # public "hash" reader
   it { Song.new(model).options.recorded.must_equal true }
 
   # public "hash" writer
-  it ("xxx") {
+  it {
     song = Song.new(model)
 
     song.options.recorded = "yo"
@@ -96,8 +101,231 @@ class TwinWithNestedStructTest < MiniTest::Spec
     model.options["preferences"].must_equal({"show_image" => 9, "play_teaser"=>2})
   }
 
+  describe "nested writes" do
+    let (:song) { Song.new(model) }
+
+    # adding to collection.
+    it do
+      # note that Struct-twin's public API wants a hash!
+      # it kinda sucks that the user has to know there's a hash model in place. is that what we want?
+      role = song.options.roles.append({}) # add empty "model" to hash collection.
+      role.name = "admin"
+
+      song.options.roles.size.must_equal 2
+      song.options.roles[0].name.must_equal "user"
+      song.options.roles[1].name.must_equal "admin"
+      model.options[:roles].must_equal([{:name=>"user"}]) # model hasn't changed, of course.
+
+      song.sync
+
+      model.options.must_equal({"recorded"=>true, "released"=>1, "preferences"=>{"show_image"=>true, "play_teaser"=>2}, "roles"=>[{"name"=>"user"}, {"name"=>"admin"}]})
+    end
+
+    # overwriting nested property via #preferences=.
+    it do
+      song.options.preferences = {play_teaser: :maybe}
+      song.sync
+
+      model.options.must_equal({"recorded"=>true, "released"=>1, "preferences"=>{"play_teaser"=>:maybe}, "roles"=>[{"name"=>"user"}]})
+    end
+
+    # overwriting collection via #roles=.
+    it do
+      song.options.roles = [{name: "wizard"}]
+      song.sync
+
+      model.options.must_equal({"recorded"=>true, "released"=>1, "preferences"=>{"show_image"=>true, "play_teaser"=>2}, "roles"=>[{"name"=>"wizard"}]})
+    end
+  end
+
+  # break dance
+  # it do
+  #   song = Song.new(model)
+
+  #   song.options.roles<<({name: "admin"})
+
+  #   song.sync
+
+  #   model[:options][:roles].must_equal({    })
+
+  #   pp song
+
+
+  #   song.options.preferences.sync!
+  #   song.options.model.must_be_instance_of Hash
+  #   song.options.preferences.model.must_be_instance_of Hash
+
+
+  #   # this must break!
+  #   # song.options.preferences = OpenStruct.new(play_teaser: true) # write property object to hash fragment.
+  #   # this must break!
+  #   song.options.roles = [Struct.new(:name)]
+  #   song.options.sync!
+  # end
+
 
   describe "#save" do
     it { Song.new(model).extend(Disposable::Twin::Save).save }
   end
 end
+
+class StructReadableWriteableTest < Minitest::Spec
+  class Song < Disposable::Twin
+    include Struct
+    property :length
+    property :id, readable: false
+  end
+
+  it "ignores readable: false" do
+    song = Song.new(length: 123, id: 1)
+    song.length.must_equal 123
+    song.id.must_equal nil
+  end
+
+  it "ignores writeable: false" do
+    skip
+  end
+end
+
+# Default has to be included.
+class DefaultWithStructTest < Minitest::Spec
+  Song = Struct.new(:settings)
+
+  class Twin < Disposable::Twin
+    feature Default
+    feature Sync
+
+    property :settings, default: Hash.new do
+      include Struct
+
+      property :enabled, default: "yes"
+      property :roles, default: Hash.new do
+        include Struct
+        property :admin, default: "maybe"
+      end
+    end
+  end
+
+  # all given.
+  it do
+    twin = Twin.new(Song.new({enabled: true, roles: {admin: false}}))
+    twin.settings.enabled.must_equal true
+    twin.settings.roles.admin.must_equal false
+  end
+
+  # defaults, please.
+  it do
+    song = Song.new
+    twin = Twin.new(song)
+    twin.settings.enabled.must_equal "yes"
+    twin.settings.roles.admin.must_equal "maybe"
+
+    twin.sync
+
+    song.settings.must_equal({"enabled"=>"yes", "roles"=>{"admin"=>"maybe"}})
+  end
+end
+
+class CompositionWithStructTest < Minitest::Spec
+  class PersistedSheet < Disposable::Twin
+    feature Sync
+
+    property :content do
+      feature Struct
+
+      property :tags
+      collection :notes do
+        property :text
+        property :index
+      end
+    end
+
+    def tags=(*args)
+      content.tags=*args
+    end
+
+    def notes
+      content.notes
+    end
+  end
+
+  it "use nested twin but delegate" do
+    twin = PersistedSheet.new(model)
+
+    twin.tags = "history"
+
+    twin.notes.append text: "Canberra trip", index: 2
+
+    twin.sync
+
+    model.content.must_equal({"tags"=>["history"], "notes"=>[{"text"=>"Freedom", "index"=>0}, {"text"=>"Like", "index"=>1}, {"text"=>"Canberra trip", "index"=>2}]})
+  end
+
+  class Sheet < Disposable::Twin
+    include Composition
+    feature Sync
+
+    property   :tags,  on: :content #, twin: PersistedSheet.definitions.get[:content].definitions.get(:tags)
+    collection :notes, on: :content do
+      property :text
+      property :index
+    end#, twin: PersistedSheet.definitions.get(:content)[:nested].definitions.get(:notes)[:nested]
+
+
+  end
+
+  class Sheeeeeeet < Disposable::Twin
+    feature Sync
+    property :content do
+      property :tags
+      collection :notes do
+        property :text
+        property :index
+      end
+    end
+  end
+
+  let (:model) do
+    OpenStruct.new(
+      content: {
+        tags:  "#hashtag",
+        notes: [
+          { text: "Freedom", created_at: nil, index: 0 },
+          { text: "Like", created_at: nil, index: 1 },
+        ]
+      }
+    )
+  end
+
+
+  let (:persisted_sheet) { PersistedSheet.new(model) }
+  let (:sheet) { Sheet.new(content: persisted_sheet.content) }
+
+  it do
+    skip
+    # this fails because the Sheet wants to write PersistedSheet.options.notes twins to the persisted sheet in #sync,
+    # instead of an array of hashes.
+
+
+
+#     sheeet= Sheeeeeeet.new(p= PersistedSheet.new(model))
+
+#     p.content = sheeet.content
+
+# raise
+#     sheeet.sync
+#     raise
+
+
+
+
+    sheet.tags.must_equal "#hashtag"
+    sheet.notes[0].text.must_equal "Freedom"
+    sheet.notes[0].index.must_equal 0
+
+    sheet.notes[0].index = 2
+
+    sheet.sync
+
+  end
+end

data/test/twin/twin_test.rb

@@ -97,13 +97,20 @@ class OverridingAccessorsTest < TwinTest
   # overriding accessors in Twin
   class Song < Disposable::Twin
     property :title
+    property :id
 
     def title
       super.downcase
     end
+
+    def id=(v)
+      super(v+1)
+    end
   end
 
-  it { Song.new(Model::Song.new(1, "A Tale That Wasn't Right")).title.must_equal "a tale that wasn't right" }
+  let (:model) { Model::Song.new(1, "A Tale That Wasn't Right") }
+  it { Song.new(model).title.must_equal "a tale that wasn't right" }
+  it { Song.new(model).id.must_equal 2 }
 end
 
 
@@ -130,4 +137,4 @@ class TwinAsTest < MiniTest::Spec
   end
 
 end
-# TODO: test coercion!
+# TODO: test coercion!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: disposable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-02 00:00:00.000000000 Z
+date: 2016-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber
@@ -28,16 +28,22 @@ dependencies:
   name: declarative
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.0.6
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: representable
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +181,7 @@ files:
 - lib/disposable/twin/composition.rb
 - lib/disposable/twin/default.rb
 - lib/disposable/twin/definitions.rb
+- lib/disposable/twin/jsonb.rb
 - lib/disposable/twin/parent.rb
 - lib/disposable/twin/persisted.rb
 - lib/disposable/twin/property_processor.rb
@@ -205,6 +212,7 @@ files:
 - test/twin/from_test.rb
 - test/twin/inherit_test.rb
 - test/twin/inheritance_test.rb
+- test/twin/jsonb_test.rb
 - test/twin/option_test.rb
 - test/twin/parent_test.rb
 - test/twin/process_inline_test.rb
@@ -266,6 +274,7 @@ test_files:
 - test/twin/from_test.rb
 - test/twin/inherit_test.rb
 - test/twin/inheritance_test.rb
+- test/twin/jsonb_test.rb
 - test/twin/option_test.rb
 - test/twin/parent_test.rb
 - test/twin/process_inline_test.rb