composable_decorator 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 764dabb6bfd382545b5d3e915b60165cd8758651
-  data.tar.gz: 167d13bf333c06229e3d285b5ea46543ab481210
+  metadata.gz: bd64fc6e7e0eb6eb8ade1ec99a2bad446c873674
+  data.tar.gz: b6def650c067d09960452e9c85d03bf2776905c9
 SHA512:
-  metadata.gz: a276bf7621da3b5130ea8f0a6e202b830d8e4bc8a2f5325da8d730643b879eecf4a9caf61969d7222e8568477352eb8e9c6688c04aba87c783250e064f592443
-  data.tar.gz: 938d036503e53fc96fcf1c1a7b47d39f7838b9a4571bf5cfb1ce6a08b19f6101934d7341de877a675c31ec5ca04cf40154652da85a2ca07c5e578c2329a7edf3
+  metadata.gz: 6fef48689f211503b63b9ae06d81d18ee2a42068c3f850f00033792a5bb98c4fc5da3b586a0b633f68e35552a5173000eb720339d9d65c9a4de54985d4dc7fa5
+  data.tar.gz: ca5b1ddd0df506f203068d2b221a9cfad409153c19e021bae32f962b9960d5dd484b4af7fb212753c6a82a78e10c110c699efa9c8514d479e9bc924446d5e776

data/README.md

@@ -1,9 +1,14 @@
 # ComposableDecorator
 
--- work in progress. I would not rely on this gem yet. --
-
 A simple, composable decorator for Rails models.
 
+## Example
+```ruby
+class User < ActiveRecord::Base
+  decorate_with NameDecorator, PhoneNumberDecorator
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,13 +27,72 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+# Decorators are declared in the /decorators folder
+#
+# app/decorators/name.rb
+module Name
+  def full_name
+    "#{first_Name} #{last_name}"
+  end
+end
+
+module PhoneNumber
+  def full_phone_number
+    "(#{area_code}) #{phone_number}"
+  end
+end
+
+# 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
+#
+# /app/models/user.rb
+class User < ActiveRecord::Base
+  decorate_with Name, PhoneNumber
+end
+
+# this is roughly the equivalent of wrapping the instance in first the Name decorator,
+# then the PhoneNumber decorator, i.e.
+class User < ActiveRecord::Base
+  extend Name
+  extend PhoneNumber
+  # more functionality runs here to work with AR relationships
+end
+
+# we can then decorate the model in the controller
+#
+# /app/controllers/users_controller.rb
+class UsersController
+  def show
+    ...
+    @user.decorate
+  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
+
+# DELEGATIONS
+#
+# We can delegate the association's decorated methods to the model
+class Address < ActiveRecord::Base
+  decorate_with AddressDecorator
+end
+
+class User
+  decorate_with Name, PhoneNumber
+  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
+```
 
 ## Contributing
 

data/lib/composable_decorator/version.rb

@@ -1,3 +1,3 @@
 module ComposableDecorator
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/lib/composable_decorator.rb

@@ -1,106 +1,17 @@
 require_relative "./composable_decorator/version"
+require_relative './composable_decorator/class_methods'
+require_relative './composable_decorator/instance_methods'
 
 module ComposableDecorator
-  module ClassMethods
-    # # 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
-
-  def self.included(base)
-    base.extend ClassMethods
-
-    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 }
+  def self.included(mod)
+    mod.extend ClassMethods
+    mod.include InstanceMethods
   end
+end
 
-  private def method_delegate_decorated_associations
-    delegate_decorated_associations
+module ActiveRecord
+  class Base
+    include ComposableDecorator
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composable_decorator
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam Steel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-26 00:00:00.000000000 Z
+date: 2015-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: A simple, composable decorator pattern for Ruby.