Increase Speed & Documentation & Comments

Author: akodkod

README.md

@@ -4,29 +4,87 @@
 [![Code Climate](https://codeclimate.com/github/light-ruby/light-decorator/badges/gpa.svg)](https://codeclimate.com/github/light-ruby/light-decorator)
 [![Test Coverage](https://codeclimate.com/github/light-ruby/light-decorator/badges/coverage.svg)](https://codeclimate.com/github/light-ruby/light-decorator/coverage)
 
+Easiest and fast way to decorate Ruby on Rails models.
+
+Decorator pattern - What is it?
+- [Wikipedia](https://en.wikipedia.org/wiki/Decorator_pattern)
+- [Thoughtbot](https://robots.thoughtbot.com/evaluating-alternative-decorator-implementations-in)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'light-decorator'
+gem 'light-decorator', '~> 0.5.0'
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+Create the `ApplicationDecorator`
 
-Or install it yourself as:
+```ruby
+# app/decorators/application_decorator.rb
+class ApplicationDecorator < Light::Decorator::Decorate
+end
+```
 
-    $ gem install light-decorator
+Create decorator for your model. For example we will use the `User` model.
 
-## Usage
+```ruby
+# app/decorators/user_decorator.rb
+class UserDecorator < Application
+  def full_name
+    "#{object.first_name} #{object.last_name}"
+  end
+end
+```
+
+Decorate your model in controller or anywhere.
 
-TODO: Write usage instructions here
+```ruby
+# Single record
+User.find(params[:id]).decorate
+User.find_and_decorate(params[:id])
+User.decorate.find(params[:id])
+
+# Collection
+User.all.decorate
+User.decorate
+User.limit(10).decorate
+User.decorate.limit(10)
+
+# Options
+User.find_and_decorate(params[:id], with: AnotherUserDecorator)
+
+# Associations will be decorated automatically
+user = User.find_and_decorate(params[:id])
+user.decorated? # true
+user.comments.decorated? # true
+user.comments.first.decorated? # true
+```
+
+Example of Decorator
+```ruby
+class UserDecorator < ApplicationDecorator
+  def full_name
+    "#{object.first_name} #{object.last_name}"
+    # or
+    "#{o.first_name} #{o.last_name}"
+  end
+  
+  def full_name_link
+    helpers.link_to full_name, user_path(object)
+    # or
+    h.link_to full_name, user_path(object)
+  end
+end
+```
 
-## Development
+## Next steps
 
-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.
+- [ ] Create rake task `light-decorator:install`
+- [ ] Create generators
+- [ ] Create configuration file
 
 ## Contributing
 

gemfiles/rails_4_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    light-decorator (0.1.0)
+    light-decorator (0.5.0)
       rails (>= 4.0.0)
       request_store (>= 1.0.0)
 

gemfiles/rails_4_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    light-decorator (0.1.0)
+    light-decorator (0.5.0)
       rails (>= 4.0.0)
       request_store (>= 1.0.0)
 

gemfiles/rails_4_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    light-decorator (0.1.0)
+    light-decorator (0.5.0)
       rails (>= 4.0.0)
       request_store (>= 1.0.0)
 

gemfiles/rails_5_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    light-decorator (0.1.0)
+    light-decorator (0.5.0)
       rails (>= 4.0.0)
       request_store (>= 1.0.0)
 

lib/light/decorator.rb

@@ -1,6 +1,6 @@
+require 'rails'
+require 'active_record'
 require 'request_store'
-require 'rails/railtie'
-require 'active_support/concern'
 
 require 'light/decorator/version'
 require 'light/decorator/exceptions'
@@ -13,6 +13,8 @@
 
 module Light
   module Decorator
-    NOT_DELEGATABLE_METHODS = Kernel.methods + [:decorated?, :==, :===, :eql?, :equal?]
+    NOT_DELEGATABLE_METHODS = (
+      Kernel.methods + ActiveRecord::Base.methods + [:decorated?, :==, :===, :eql?, :equal?]
+    ).freeze
   end
 end

lib/light/decorator/concerns/associations/collection_proxy.rb

@@ -5,6 +5,10 @@ module Associations
         module CollectionProxy
           extend ActiveSupport::Concern
 
+          # Decorate ActiveRecord::Model associations
+          #
+          # @param [Hash] options (optional)
+          # @return [ActiveRecord::Associations::CollectionProxy]
           def decorate(options = {})
             @decorated = true
 
@@ -14,6 +18,9 @@ def decorate(options = {})
             self
           end
 
+          # Check current association is decorated or not
+          #
+          # @return [Bool]
           def decorated?
             !@decorated.nil?
           end

lib/light/decorator/concerns/base.rb

@@ -4,6 +4,10 @@ module Concerns
       module Base
         extend ActiveSupport::Concern
 
+        # Decorate ActiveRecord::Model
+        #
+        # @param [Hash] options (optional)
+        # @return [Object] decorator or self
         def decorate(options = {})
           return self if decorated?
 
@@ -14,6 +18,9 @@ def decorate(options = {})
           self
         end
 
+        # Check current ActiveRecord::Model is decorated or not
+        #
+        # @return [Bool]
         def decorated?
           false
         end
@@ -39,10 +46,19 @@ def decorator_class(options)
         end
 
         module ClassMethods
+          # Decorate all scope for ActiveRecord::Model
+          #
+          # @param [Hash] options (optional)
+          # @return [ActiveRecord::Relation]
           def decorate(options = {})
             all.decorate(options)
           end
 
+          # Find ActiveRecord::Model and decorate it
+          #
+          # @param [Integer] id
+          # @param [Hash] options (optional)
+          # @return [ActiveRecord::Model]
           def find_and_decorate(id, options = {})
             find(id).decorate(options)
           end

lib/light/decorator/concerns/relation.rb

@@ -4,6 +4,10 @@ module Concerns
       module Relation
         extend ActiveSupport::Concern
 
+        # Decorate ActiveRecord::Relation
+        #
+        # @param [Hash] options
+        # @return [ActiveRecord::Relation] decorated collection
         def decorate(options = {})
           @decorated = true
 
@@ -12,6 +16,9 @@ def decorate(options = {})
           self
         end
 
+        # Check current ActiveRecord::Relation is decorated or not
+        #
+        # @return [Bool]
         def decorated?
           !@decorated.nil?
         end

lib/light/decorator/decorate.rb

@@ -1,8 +1,6 @@
 module Light
   module Decorator
     class Decorate
-      extend Forwardable
-
       # @return original object
       attr_reader :object
 
@@ -20,22 +18,21 @@ def initialize(object, options = {})
         decorate_associations
       end
 
-      class << self
-        alias decorate new
-      end
-
+      # Check current ActiveRecord::Model is decorated or not
+      #
+      # @return [Bool]
       def decorated?
         true
       end
 
+      # Current view scope
+      #
+      # @return [ActionView::Base]
       def helpers
         return @helpers if defined?(@helpers)
         @helpers = Light::Decorator::ViewContext.current
       end
 
-      alias o object
-      alias h helpers
-
       def ==(other)
         super || object == other
       end
@@ -44,22 +41,25 @@ def eql?(other)
         super || object.eql?(other)
       end
 
+      class << self
+        alias decorate new
+      end
+
+      alias o object
+      alias h helpers
+
       private
 
       def delegate_methods
-        methods = object.methods - Light::Decorator::NOT_DELEGATABLE_METHODS
-        self.class.def_delegators :@object, *methods
+        # It's more faster than using Forwardable
+        (object.public_methods - Light::Decorator::NOT_DELEGATABLE_METHODS).each do |method|
+          define_singleton_method method do |*args, &block|
+            object.__send__(method, *args, &block)
+          end
+        end
       end
 
       def decorate_associations
-        # TODO: Remove it before production
-        # meta = class << self; self; end
-        # object._reflections.keys.each do |reflection_name|
-        #   meta.send(:define_method, "#{reflection_name}_a") do
-        #     [4,3,2,1]
-        #   end
-        # end
-
         object.class.reflect_on_all_associations.map(&:name).each do |reflection_name|
           define_singleton_method reflection_name do
             object.public_send(reflection_name).decorate(@options.reverse_merge(soft: true))