composable_decorator 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2135a3c4a581123c60cddd695143272d269214a3
-  data.tar.gz: 19fdc6f5d95b0a2ecc601edd12020a533c7b21e4
+  metadata.gz: 339be8c69b309eb18dfa6fce7c507ac267378f2f
+  data.tar.gz: 90efef0f24844e535c44f6001855492e16a3d5bd
 SHA512:
-  metadata.gz: 3964c582e98ba1a5b2a233369580c2f0102b3b12f7d7cbd4afa57bfc5f087bd94b9ecd3bc374fe1cb9aeaa907154949d01486b7593a1591551d62430e4c1d981
-  data.tar.gz: 70e9f2e657000046f24523c3ff68fc93bd4bc6ab4fad230159628a68152ef2bcd452eaab2ddad5cc06d6d5f8d5af1f0f51c8c0698f88150f39de9508234d0b9e
+  metadata.gz: c87d91aacc84de01256031ab4ac45b3293d36596048d1ede50e4b5b57ab08284670052f702f64807b34f84a5488d3e6ddbe30e78c883f3d4ca18c31fbe4920b6
+  data.tar.gz: 17cf2b556842084a8c9a153bc02fe9d69b07bece72ce0c6389e255f41428eaad9d07f70a40d01185fd2e0ad733131ff6150d7fb801d644b0a4f9867a579ae9ba

data/README.md

@@ -7,6 +7,9 @@ A simple, composable decorator for Rails models.
 class User < ActiveRecord::Base
   decorate_with NameDecorator, PhoneNumberDecorator
 end
+
+@user = User.find(1).decorate
+@user.full_name # => "Jane Smith"
 ```
 
 ## Installation
@@ -27,40 +30,37 @@ Or install it yourself as:
 
 ## Usage
 
+Decorators are declared as modules.
+
 ```ruby
-# Decorators are declared in the /decorators folder
-#
-# app/decorators/name.rb
-module Name
+module NameDecorator
   def full_name
     "#{first_Name} #{last_name}"
   end
 end
+```
 
-module PhoneNumber
-  def full_phone_number
-    "(#{area_code}) #{phone_number}"
-  end
-end
+A `#decorate_with` method is called in the model that lists the order of decorators to be added to the instance.
 
-# a #decorate method is declared in the model, that lists the order of decorators
-# to be called on the instance. The name of this method must be the same across
-# multiple models in order to decorate the AR relationships
-#
+```ruby
 # /app/models/user.rb
 class User < ActiveRecord::Base
-  decorate_with Name, PhoneNumber
+  decorate_with NameDecorator, PhoneNumberDecorator
 end
+```
+
+This is roughly the equivalent of wrapping the instance in first the Name decorator, then the PhoneNumber decorator, i.e.:
 
-# this is roughly the equivalent of wrapping the instance in first the Name decorator,
-# then the PhoneNumber decorator, i.e.
+```ruby
 class User < ActiveRecord::Base
-  extend Name
-  extend PhoneNumber
+  extend NameDecorator
+  extend PhoneNumberDecorator
 end
+```
+
+We can then decorate the model in the controller and access the decorated methods in the view.
 
-# we can then decorate the model in the controller
-#
+```ruby
 # /app/controllers/users_controller.rb
 class UsersController
   def show
@@ -69,15 +69,15 @@ class UsersController
   end
 end
 
-# and we can access the decorated methods in the view
-#
 # /app/views/users/show.html.slim
 @user.full_name
 @user.full_phone_number
 
-# decorators are inherited
-#
-#
+```
+
+Decorators are inherited
+
+```ruby
 module HatDecorator
   def hat_decorated_method
     "hat decorator method"
@@ -92,10 +92,20 @@ class Stetson < Hat
 end
 
 Stetson.new.decorate.hat_decorator_method #=> "hat decorator method"
+```
+
+
+### Delegating an association's decorated methods
+
+We can delegate the association's decorated methods to the instance all at once.
+
+```ruby
+module AddressDecorator
+  def simple_format
+    "#{street}, #{city}"
+  end
+end
 
-# DELEGATIONS
-#
-# We can delegate the association's decorated methods to the model
 class Address < ActiveRecord::Base
   decorate_with AddressDecorator
 end
@@ -104,10 +114,8 @@ class User
   delegate_decorated_to :address
 end
 
-# which delegates all the decorated methods created in Address#decorate to User
-#
 # /app/views/users/show.html.slim
-@user.address_simple_format
+User.find(1).decorate.address_simple_format
 ```
 
 ## Contributing

data/lib/composable_decorator/active_record/base.rb

@@ -6,14 +6,13 @@ module ComposableDecorator
       def self.included(mod)
         mod.extend DSL
 
-        mod.__define_delegation
-        mod.__initialize_decorators
+        mod.__initialize
       end
 
       def decorate
         __add_decorators
         __decorate_associations
-        __delegate_decorated_association_methods
+        __delegate_decorated_associations
 
         self
       end
@@ -30,15 +29,21 @@ module ComposableDecorator
         end
       end
 
-      private def __delegate_decorated_association_methods
-        __associations.each do |assoc|
+      private def __delegate_decorated_associations
+        __delegations.each do |delegation|
+          __delegate_decorated_association_group(delegation)
+        end
+      end
+
+      private def __delegate_decorated_association_group(delegation)
+        delegation[:associations].each do |assoc|
           methods = __decorator_methods(assoc)
 
           self.class.delegate(
             *methods,
             to: assoc,
-            prefix: __prefix,
-            allow_nil: __allow_nil)
+            prefix: delegation[:prefix],
+            allow_nil: delegation[:allow_nil])
         end
       end
 
@@ -50,6 +55,10 @@ module ComposableDecorator
         self.class.__associations
       end
 
+      private def __delegations
+        self.class.__delegations
+      end
+
       private def __decorator_methods(assoc)
         __association_class(assoc).__decorators.map(&:instance_methods).flatten
       end

data/lib/composable_decorator/active_record/dsl.rb

@@ -17,8 +17,10 @@ module ComposableDecorator
         define_singleton_method(:__decorators) { decorators + existing_decorators }
       end
 
-      def __initialize_decorators
+      def __initialize
         define_singleton_method(:__decorators) { [] }
+        define_singleton_method(:__associations) { [] }
+        define_singleton_method(:__delegations) { [] }
       end
 
       # # delegates all of the decorated methods for each has_one or belongs_to association.
@@ -46,16 +48,26 @@ module ComposableDecorator
         existing_associations = __associations
 
         __define_delegation(
-          associations: associations + existing_associations,
+          associations: associations,
           prefix: prefix,
           allow_nil: allow_nil,
           handle_nil_with: handle_nil_with)
+
+        define_singleton_method(:__associations) { associations + existing_associations }
       end
 
       def __define_delegation(associations: [], prefix: true, allow_nil: true, handle_nil_with: '')
-        define_singleton_method(:__associations) { associations }
-        define_method(:__prefix) { prefix }
-        define_method(:__allow_nil) { allow_nil }
+        existing_delegations = __delegations
+
+        define_singleton_method(:__delegations) {
+          [
+            {
+              associations: associations,
+              prefix: prefix,
+              allow_nil: allow_nil
+            }
+          ] + existing_delegations
+        }
       end
     end
   end

data/lib/composable_decorator/version.rb

@@ -1,3 +1,3 @@
 module ComposableDecorator
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composable_decorator
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam Steel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-24 00:00:00.000000000 Z
+date: 2016-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails