composable_decorator 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab7452f0819960368e842bb6ebcfeaa1419a058d
-  data.tar.gz: 7bca3b3cdb974c0f5498b82300bd5d519e2d661c
+  metadata.gz: d0fa65ef7eb8fc9f424b8995c47aaeec25cbff91
+  data.tar.gz: a7d9cd5bb1aec8857c5e93b69a990ad309e10a0a
 SHA512:
-  metadata.gz: 9e8a40c6d12b76bc7cd62de3618c9e3e4b9ab182b184688acb8e1eef32f45bb5ac55d52ea5e3dc83e164ee9f885b3ab53f142e55b08da303018dcd1fb92f4092
-  data.tar.gz: 1cb8a7c80b335881b971ca5c89e0cf5cdab3756daf25779ab37dc6488b700c7fb0c9e2127382b3dfae602e1432a492de9c7b7916b770659585adeb646d469714
+  metadata.gz: b521e76e756b291fa352c617c72ff51ac3073c8fad20ad9c88fe41137c9377bc793f132ab817ed57282b0d789c6fa87f20827885c4fc041ac7eec750ba1df9b3
+  data.tar.gz: 0d3bedc34f1419b4c338041ef7a962fea86a85c56ce63262224313d8ecb6aa32b9b665a108fa0b40be0c457915be7d98c3dafd86ec140e9a2f4e0602057aae2c

data/README.md

@@ -75,6 +75,24 @@ end
 @user.full_name
 @user.full_phone_number
 
+# decorators are inherited
+#
+#
+module HatDecorator
+  def hat_decorated_method
+    "hat decorator method"
+  end
+end
+
+class Hat < ActiveRecord::Base
+  decorate_with HatDecorator
+end
+
+class Stetson < Hat
+end
+
+Stetson.new.decorate.hat_decorator_method #=> "hat decorator method"
+
 # DELEGATIONS
 #
 # We can delegate the association's decorated methods to the model
@@ -83,7 +101,6 @@ class Address < ActiveRecord::Base
 end
 
 class User
-  decorate_with Name, PhoneNumber
   delegate_decorated_to :address
 end
 

data/composable_decorator.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["adamgsteel@gmail.com"]
 
   spec.summary       = %q{A simple, composable decorator pattern for Ruby.}
+  spec.description   = %q{Supports decorator composition and inheritance in ActiveRecord.}
   spec.homepage      = "https://www.github.com/adsteel/composable_decorator"
   spec.license       = "MIT"
 
@@ -26,7 +27,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rails", '~> 4.2'
+
   spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
 end

data/lib/composable_decorator/active_record/base.rb

@@ -0,0 +1,57 @@
+require_relative './dsl'
+
+module ComposableDecorator
+  module ActiveRecord
+    module Base
+      def self.included(mod)
+        mod.extend DSL
+
+        mod.__define_delegation
+      end
+
+      def decorate
+        __add_decorators
+        __decorate_associations
+        __delegate_decorated_association_methods
+
+        self
+      end
+
+      private def __add_decorators
+        __decorators.each do |decorator|
+          extend(decorator)
+        end
+      end
+
+      private def __decorate_associations
+        __associations.each do |assoc|
+          public_send(assoc).try(:decorate)
+        end
+      end
+
+      private def __delegate_decorated_association_methods
+        __associations.each do |assoc|
+          methods = __decorator_methods(assoc)
+
+          self.class.delegate(
+            *methods,
+            to: assoc,
+            prefix: __prefix,
+            allow_nil: __allow_nil)
+        end
+      end
+
+      private def __decorators
+        self.class.__decorators
+      end
+
+      private def __decorator_methods(assoc)
+        __association_class(assoc).__decorators.map(&:instance_methods).flatten
+      end
+
+      private def __association_class(assoc)
+        self.class.reflect_on_association(assoc).klass
+      end
+    end
+  end
+end

data/lib/composable_decorator/active_record/dsl.rb

@@ -0,0 +1,57 @@
+module ComposableDecorator
+  module ActiveRecord
+    module DSL
+      # # declares the order of decorators applied to an instance
+      # # that calls the #decorate method
+      #
+      # class AdminUser
+      #   decorate_with UserDecorator, AdminDecorator
+      #
+      # # The above code results in #decorate first decorating the instance
+      # # with the UserDecorator, then the AdminDecorator
+      #
+      # @Param +decorators+ is an <Array> of classes
+      def decorate_with(*decorators)
+        existing_decorators = defined?(__decorators) ? __decorators : []
+
+        define_singleton_method(:__decorators) { decorators + existing_decorators }
+      end
+
+      # # delegates all of the decorated methods for each has_one or belongs_to association.
+      #
+      # module PostDecorator
+      #   delegate_decorated_to :author
+      #
+      #   def full_name
+      #     "#{name} {created_at}"
+      #
+      # class Post
+      #   belongs_to :author
+      #   decorate_with PostDecorator
+      #
+      # # The above code allows you to call:
+      #
+      # post.decorate
+      # post.author_full_name
+      #
+      # # Like Rails's #delegate method, you can choose to allow_nil
+      # # or to prefix the delegated method. Both default to true.
+      #
+      # @Param +associations+ is an <Array> of symbols
+      def delegate_decorated_to(*associations, prefix: true, allow_nil: true, handle_nil_with: '')
+        __define_delegation(
+          associations: associations,
+          prefix: prefix,
+          allow_nil: allow_nil,
+          handle_nil_with: handle_nil_with)
+      end
+
+      def __define_delegation(associations: [], prefix: true, allow_nil: true, handle_nil_with: '')
+        define_method(:__associations) { associations }
+        define_method(:__prefix) { prefix }
+        define_method(:__allow_nil) { allow_nil }
+        define_method(:__handle_nil_with) { handle_nil_with }
+      end
+    end
+  end
+end

data/lib/composable_decorator/version.rb

@@ -1,3 +1,3 @@
 module ComposableDecorator
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/composable_decorator.rb

@@ -1,14 +1,5 @@
-require_relative "./composable_decorator/version"
-require_relative './composable_decorator/dsl'
-require_relative './composable_decorator/models'
-
-module ComposableDecorator
-end
-
-module ActiveRecord
-  class Base
-    extend ComposableDecorator::DSL
-    include ComposableDecorator::Models
-  end
-end
+require 'composable_decorator/version'
+require 'composable_decorator/active_record/base'
+require 'active_record'
 
+ActiveRecord::Base.include ComposableDecorator::ActiveRecord::Base

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: composable_decorator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Adam Steel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2015-12-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,17 +70,31 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '1.3'
+description: Supports decorator composition and inheritance in ActiveRecord.
 email:
 - adamgsteel@gmail.com
 executables: []
@@ -71,8 +113,8 @@ files:
 - bin/setup
 - composable_decorator.gemspec
 - lib/composable_decorator.rb
-- lib/composable_decorator/dsl.rb
-- lib/composable_decorator/models.rb
+- lib/composable_decorator/active_record/base.rb
+- lib/composable_decorator/active_record/dsl.rb
 - lib/composable_decorator/version.rb
 homepage: https://www.github.com/adsteel/composable_decorator
 licenses:

data/lib/composable_decorator/dsl.rb

@@ -1,54 +0,0 @@
-module ComposableDecorator
-  module DSL
-    # # declares the order of decorators applied to an instance
-    # # that calls the #decorate method
-    #
-    # class AdminUser
-    #   decorate_with UserDecorator, AdminDecorator
-    #
-    # # The above code results in #decorate first decorating the instance
-    # # with the UserDecorator, then the AdminDecorator
-    #
-    # @Param +decorators+ is an <Array> of classes
-    def decorate_with(*decorators)
-      define_method(:decorators) { decorators }
-    end
-
-    # # delegates all of the decorated methods for each association.
-    #
-    # module PostDecorator
-    #   def full_name
-    #     "#{name} {created_at}"
-    #
-    # class Post
-    #   decorate_with PostDecorator
-    #
-    # class Author
-    #   has_many :posts
-    #   delegate_decorated_to :posts
-    #
-    # # The above code allows you to call:
-    #
-    # author.decorate
-    # author.post_full_name
-    #
-    # # Like Rails's #delegate method, you can choose to allow_nil
-    # # or to prefix the delegated method. Both default to true.
-    #
-    # @Param +associations+ is an <Array> of symbols
-    def delegate_decorated_to(*associations, prefix: true, allow_nil: true, handle_nil_with: '')
-      define_delegate_decorated_methods(
-        associations: associations,
-        prefix: prefix,
-        allow_nil: allow_nil,
-        handle_nil_with: handle_nil_with)
-    end
-
-    def define_delegate_decorated_methods(associations: [], prefix: true, allow_nil: true, handle_nil_with: '')
-      define_method(:delegate_decorated_associations) { associations }
-      define_method(:delegate_decorated_prefix) { prefix }
-      define_method(:delegate_decorated_allow_nil) { allow_nil }
-      define_method(:delegate_decorated_handle_nil_with) { handle_nil_with }
-    end
-  end
-end

data/lib/composable_decorator/models.rb

@@ -1,53 +0,0 @@
-module ComposableDecorator
-  module Models
-    def self.included(base)
-      base.extend DSL
-
-      base.define_delegate_decorated_methods
-    end
-
-    def decorate
-      add_decorators
-      decorate_associations
-      delegate_decorated_association_methods
-
-      self
-    end
-
-    private def add_decorators
-      decorators.each do |decorator|
-        extend(decorator)
-      end
-    end
-
-    private def decorate_associations
-      method_delegate_decorated_associations.each do |assoc|
-        public_send(assoc).try(:decorate)
-      end
-    end
-
-    private def delegate_decorated_association_methods
-      class_delegate_decorated_associations.each do |klass|
-        methods = class_decorated_methods(klass)
-
-        self.class.delegate(
-          *methods,
-          to: klass.to_s.underscore,
-          prefix: delegate_decorated_prefix,
-          allow_nil: delegate_decorated_allow_nil)
-      end
-    end
-
-    private def class_decorated_methods(klass)
-      klass.new.decorators.map(&:instance_methods).flatten
-    end
-
-    private def class_delegate_decorated_associations
-      delegate_decorated_associations.map { |a| a.to_s.camelize.constantize }
-    end
-
-    private def method_delegate_decorated_associations
-      delegate_decorated_associations
-    end
-  end
-end