disposable 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 980c3ca068019abe74214a9e095fc98f50bf23aa
-  data.tar.gz: e175303be9fafaf0c1aa6076026b85e803186716
+  metadata.gz: 0961ea267a9adeeb55f33da903f0bd85e21070f4
+  data.tar.gz: f3ff1a24210acaaa96a933d3889ccee74c4db7b2
 SHA512:
-  metadata.gz: bdbc328efa3c93b553ad2cc7587ba52a002841fce3773048a5cd1cac7dfb36975d4f090106a66c3b06b19c1e8f645ad7ae37ee080e2746cdaf2e20253f0dd9d6
-  data.tar.gz: a1ac3f15b89b7d5276711d0f84ee5c722fecdccc5e225b899e61bb30b13ef044c0bf5f4f1082df9e19eb8da3550f922eed2cbbd5b43ec442d93e0ce21d784939
+  metadata.gz: bb3cbf404ad41a23dd6b25aa6fc49029a5d0e1ec75d657eed33440c1acb8ee5c2915048ecf1b2bf3c2737d5abf8c285ded7770cff552f3c5205a73e897a307b0
+  data.tar.gz: c96c0291615cfe64633d8a155b417fcf506eb306b14e968fe36c6001166f2acecce25f9b1f60bc51f1206f71264e75907186c2eb6719e3a09768a96568f82f85

data/CHANGES.md

@@ -1,3 +1,7 @@
+# 0.0.7
+
+* Make disposable require representable 2.x.
+
 # 0.0.6
 
 * Add Twin::Option.

data/README.md

@@ -1,6 +1,6 @@
 # Disposable
 
-_Provides domain objects on top of your ORM layer._
+_Decorators on top of your ORM layer._
 
 ## Introduction
 
@@ -14,101 +14,87 @@ They give you an encapsulated alternative to delegators that many projects use t
 
 ## Why?
 
-The goal is to have business logic sitting in twin classes, while your models (ideally) contain persistence configuration, only.
-
-Beyond that, twins can be used in form objects, cells view models, representers, contracts, and actually any Ruby code :)
+The goal is to have one object that delegates reading and writing to underlying object(s). This is a fundamental concept for cells view models, representers, and reform form objects.
 
 Twins may contain validations, nevertheless, in Trailblazer, validations (or "Contracts") sit one layer above. They still can be part of your domain, though.
 
 ## Twin
 
-Twins implement light-weight domain objects that contain business logic - no persistance logic. They have read- and write access to a persistent object (or a composition of those) and expose a sub-set of accessors to that persistent "brother", making it a "data mapper-like phantom".
+Twins implement light-weight decorators objects with a unified interface. They map objects, hashes, and compositions of objects, along with optional hashes to inject additional options.
 
-Being designed to wrap persistent objects, a typical "brother" class could be an ActiveRecord one.
+Let me show you what I mean.
 
 ```ruby
-class Song < ActiveRecord::Base
-  belongs_to :album
-end
+song = Song.create(title: "Savior", length: 242)
 ```
 
-You don't wanna work with that persistent brother directly anymore. A twin will wrap it and indirect domain from persistance.
+## Definition
 
-The twin itself has a _ridiculous_ simple API.
+Twins need to define every field they expose.
 
 ```ruby
-class Twin::Song < Disposable::Twin
-  model ::Song                  # the persistent ActiveRecord brother class
-
+class Song::Twin < Disposable::Twin
   property :title
-  property :album, twin: Album  # a nested twin.
+  property :length
+  option   :good?
+end
 ```
 
+## Creation
 
-### Creation
-
-You can create fresh, blank-slate twins yourself. They will create a new persistent object automatically.
+You need to pass model and the optional options to the twin constructor.
 
 ```ruby
-song = Twin::Song.new(title: "Justified Black Eye")
-
-#=> #<Twin::Song title: "Justified Black Eye">
+twin = Song::Twin.new(song, good?: true)
 ```
 
-This doesn't involve any database operations at all.
+## Reading
 
-
-### Finders
-
-You can use any finder/scope defined in your model to create twins.
-
-Since `::find` is pretty common, it is defined directly on the twin class.
+This will create a composition object of the actual model and the hash.
 
 ```ruby
-song = Twin::Song.find(1)
-
-#=> #<Twin::Song title: "Already Won" album: #<Twin::Album>>
+twin.title #=> "Savior"
+twin.good? #=> true
 ```
 
-This invokes the actual finder method on the model class. Every found model will simply be wrapped in its twin.
-
-
-Any other scope or finder can be called on `finders`.
+You can also override `property` values in the constructor:
 
 ```ruby
-song = Twin::Song.finders.where(name: "3 O'Clock Shot")
-
-#=> [#<Twin::Song title: "3 O'Clock Shot" album: #<Twin::Album>>]
+twin = Song::Twin.new(song, title: "Plasticash")
+twin.title #=> "Plasticash"
 ```
 
+Let's talk about what happens to the actual model when setting values?
 
+## Writing
 
-### Read And Write Access
+It doesn't happen. The model is only queried when _reading_ values. Writing only happens in additional modules: Syncing and Saving is where the values held in the twin are written to the model.
 
-All attributes declared with `property` are exposed on the twin.
+## Renaming
 
-```ruby
-song.title #=> "Already Won"
+## Structs
 
-song.album.name #=> "The Songs of Tony Sly: A Tribute"
+If you don't have a model but a simple hash, use `Struct`.
+
+```ruby
+class Song::Twin < Disposable::Twin
+  include Struct
+  property :title
+  property :length
+end
 ```
 
-Note that writing to the twin **does not** change any state on the persistent brother.
+Note that a hash goes into the constructor now.
 
 ```ruby
-song.title = "Still Winning" # no change on Song, no write to DB.
+twin = Song::Twin.new(title: "Savior", good?: true)
 ```
 
 
-### Saving
-
-Calling `#save` will sync all properties to the brother object and advice the persistent brother to save. This works recursively, meaning that nested twins will do the same with their pendant.
+## Compositions
 
-```ruby
-song.save # write to DB.
-```
+## Overriding Accessors
 
-## Notes
+super
 
-* Twins don't know anything about the underlying persistance layer.
-* Lazy-loading TBI
+## Used In

data/disposable.gemspec

@@ -19,12 +19,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "uber"
-  spec.add_dependency "representable", "~> 2.0.3"
+  spec.add_dependency "representable", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "minitest", "5.4.1"
+  # spec.add_development_dependency "activerecord"
+  # spec.add_development_dependency "sqlite3"
+  # spec.add_development_dependency "database_cleaner"
 end

data/gemfiles/Gemfile.rails-3.0.lock

@@ -31,13 +31,12 @@ GEM
     activesupport (3.0.20)
     arel (2.0.10)
     builder (2.1.2)
-    database_cleaner (1.3.0)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    i18n (0.5.0)
-    json (1.8.0)
+    i18n (0.5.4)
+    json (1.8.1)
     mini_portile (0.6.0)
-    minitest (5.0.8)
+    minitest (5.4.1)
     multi_json (1.10.1)
     nokogiri (1.6.3.1)
       mini_portile (= 0.6.0)
@@ -52,17 +51,16 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.4)
-    rake (10.1.0)
+    rake (10.3.2)
     rdoc (3.12.2)
       json (~> 1.4)
-    representable (2.0.3)
+    representable (2.0.4)
       multi_json
       nokogiri
       uber (~> 0.0.7)
-    sqlite3 (1.3.8)
     thor (0.14.6)
-    tzinfo (0.3.38)
-    uber (0.0.7)
+    tzinfo (0.3.41)
+    uber (0.0.8)
 
 PLATFORMS
   ruby
@@ -70,9 +68,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 3.0.11)
   bundler (~> 1.3)
-  database_cleaner
   disposable!
-  minitest
+  minitest (= 5.4.1)
   railties (~> 3.0.11)
   rake
-  sqlite3

data/gemfiles/Gemfile.rails-3.2.lock

@@ -31,14 +31,13 @@ GEM
       multi_json (~> 1.0)
     arel (3.0.3)
     builder (3.0.4)
-    database_cleaner (1.3.0)
     erubis (2.7.0)
     hike (1.2.3)
     i18n (0.6.11)
     journey (1.0.4)
     json (1.8.1)
     mini_portile (0.6.0)
-    minitest (5.4.0)
+    minitest (5.4.1)
     multi_json (1.10.1)
     nokogiri (1.6.3.1)
       mini_portile (= 0.6.0)
@@ -59,7 +58,7 @@ GEM
     rake (10.3.2)
     rdoc (3.12.2)
       json (~> 1.4)
-    representable (2.0.3)
+    representable (2.0.4)
       multi_json
       nokogiri
       uber (~> 0.0.7)
@@ -68,11 +67,10 @@ GEM
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.9)
     thor (0.19.1)
     tilt (1.4.1)
-    tzinfo (0.3.40)
-    uber (0.0.7)
+    tzinfo (0.3.41)
+    uber (0.0.8)
 
 PLATFORMS
   ruby
@@ -80,9 +78,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 3.2.0)
   bundler (~> 1.3)
-  database_cleaner
   disposable!
-  minitest
+  minitest (= 5.4.1)
   railties (~> 3.2.0)
   rake
-  sqlite3

data/gemfiles/Gemfile.rails-4.0

@@ -5,3 +5,4 @@ gemspec :path => '../'
 
 gem 'railties', '~> 4.0.0'
 gem 'activerecord', '~> 4.0.0'
+gem 'minitest', '~> 4.2.0'

data/gemfiles/Gemfile.rails-4.0.lock

@@ -8,22 +8,22 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (4.0.5)
-      activesupport (= 4.0.5)
+    actionpack (4.0.9)
+      activesupport (= 4.0.9)
       builder (~> 3.1.0)
       erubis (~> 2.7.0)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    activemodel (4.0.5)
-      activesupport (= 4.0.5)
+    activemodel (4.0.9)
+      activesupport (= 4.0.9)
       builder (~> 3.1.0)
-    activerecord (4.0.5)
-      activemodel (= 4.0.5)
+    activerecord (4.0.9)
+      activemodel (= 4.0.9)
       activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.5)
+      activesupport (= 4.0.9)
       arel (~> 4.0.0)
     activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.5)
+    activesupport (4.0.9)
       i18n (~> 0.6, >= 0.6.9)
       minitest (~> 4.2)
       multi_json (~> 1.3)
@@ -31,32 +31,30 @@ GEM
       tzinfo (~> 0.3.37)
     arel (4.0.2)
     builder (3.1.4)
-    database_cleaner (1.3.0)
     erubis (2.7.0)
     i18n (0.6.11)
     mini_portile (0.6.0)
-    minitest (4.7.5)
+    minitest (4.2.0)
     multi_json (1.10.1)
     nokogiri (1.6.3.1)
       mini_portile (= 0.6.0)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    railties (4.0.5)
-      actionpack (= 4.0.5)
-      activesupport (= 4.0.5)
+    railties (4.0.9)
+      actionpack (= 4.0.9)
+      activesupport (= 4.0.9)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.3.2)
-    representable (2.0.3)
+    representable (2.0.4)
       multi_json
       nokogiri
       uber (~> 0.0.7)
-    sqlite3 (1.3.9)
     thor (0.19.1)
     thread_safe (0.3.4)
-    tzinfo (0.3.39)
-    uber (0.0.7)
+    tzinfo (0.3.41)
+    uber (0.0.8)
 
 PLATFORMS
   ruby
@@ -64,9 +62,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 4.0.0)
   bundler (~> 1.3)
-  database_cleaner
   disposable!
-  minitest
+  minitest (~> 4.2.0)
   railties (~> 4.0.0)
   rake
-  sqlite3

data/gemfiles/Gemfile.rails-4.1.lock

@@ -8,23 +8,23 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (4.1.1)
-      actionview (= 4.1.1)
-      activesupport (= 4.1.1)
+    actionpack (4.1.5)
+      actionview (= 4.1.5)
+      activesupport (= 4.1.5)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    actionview (4.1.1)
-      activesupport (= 4.1.1)
+    actionview (4.1.5)
+      activesupport (= 4.1.5)
       builder (~> 3.1)
       erubis (~> 2.7.0)
-    activemodel (4.1.1)
-      activesupport (= 4.1.1)
+    activemodel (4.1.5)
+      activesupport (= 4.1.5)
       builder (~> 3.1)
-    activerecord (4.1.1)
-      activemodel (= 4.1.1)
-      activesupport (= 4.1.1)
+    activerecord (4.1.5)
+      activemodel (= 4.1.5)
+      activesupport (= 4.1.5)
       arel (~> 5.0.0)
-    activesupport (4.1.1)
+    activesupport (4.1.5)
       i18n (~> 0.6, >= 0.6.9)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -32,34 +32,32 @@ GEM
       tzinfo (~> 1.1)
     arel (5.0.1.20140414130214)
     builder (3.2.2)
-    database_cleaner (1.3.0)
     erubis (2.7.0)
     i18n (0.6.11)
     json (1.8.1)
     mini_portile (0.6.0)
-    minitest (5.4.0)
+    minitest (5.4.1)
     multi_json (1.10.1)
     nokogiri (1.6.3.1)
       mini_portile (= 0.6.0)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    railties (4.1.1)
-      actionpack (= 4.1.1)
-      activesupport (= 4.1.1)
+    railties (4.1.5)
+      actionpack (= 4.1.5)
+      activesupport (= 4.1.5)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.3.2)
-    representable (2.0.3)
+    representable (2.0.4)
       multi_json
       nokogiri
       uber (~> 0.0.7)
-    sqlite3 (1.3.9)
     thor (0.19.1)
     thread_safe (0.3.4)
-    tzinfo (1.2.1)
+    tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    uber (0.0.7)
+    uber (0.0.8)
 
 PLATFORMS
   ruby
@@ -67,9 +65,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord (~> 4.1.0)
   bundler (~> 1.3)
-  database_cleaner
   disposable!
-  minitest
+  minitest (= 5.4.1)
   railties (~> 4.1.0)
   rake
-  sqlite3