rails-decorators 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2b058e294fde7539190070d9b3136d605cae188
+  data.tar.gz: 68cb945a3eaf62cb046404b26fa55d500e5fcdbc
+SHA512:
+  metadata.gz: cce41bd1af784df612dfb8c1f45236b4331e29d67b5cf4c012126f925c842674de2cb797e52282185037e5ab06785ece88c8e957cfc6ce12b5aaa7155121b0d6
+  data.tar.gz: 5604cad44131f137b6baa2c96964237da3be1d310089a292bd962268100728ca46d282d4ea101cf6917eed78e2adcf8b54d646d0c7da017cfef702d6e572f6f4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Ben Crouse
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+# Rails::Decorators
+Using [Rails engines](http://guides.rubyonrails.org/engines.html) extensively, we needed a way to customize behavior for implementations of the platform. Rails provides a great mechanism for views and assets, but doesn't offer any functionality to handle controller/model/lib overriding/customizing. The suggested mechanism in the documentation is `class_eval` or ActiveSupport::Concern. Our preferred method for this is module prepending, which is cleaner than `class_eval` in that it avoids alias method chaining and becomes part of the ancestor chain.
+
+We also want junior developers to be able to jump in and be productive ASAP - not necessarily requiring they learn the techniques of `class_eval` to fix a bug or get a simple task done. Yes, we educate and promote this as the developer grows, but we want the barriers to contribution as low as possible.
+
+We like the [`ActiveSupport::Concern`](http://api.rubyonrails.org/classes/ActiveSupport/Concern.html) API, so this library mimics the API of `ActiveSupport::Concern` and layers on top some niceties for the specific task of customizing a Rails engine. Also, we don't like having to store decorated behavior in a separate directory (like https://github.com/parndt/decorators). Storing decorations in the same place as new classes makes it much easier to see the overall picture of how the engine has been customized/extended in one shot.
+
+## Usage
+Say we have a class in an engine like so:
+```ruby
+# in ecommerce/app/models/ecommerce/product.rb
+module Ecommerce
+  class Product < ApplicationRecord
+    def price
+      skus.first.price
+    end
+  end
+end
+```
+
+`Rails::Decorators` allows customizing this class like so:
+```ruby
+# in Rails.root/app/models/ecommerce/product.decorator
+module Ecommerce
+  decorate Product do
+    decorated do
+      # Class methods may be called here.
+      attr_writer :on_sale
+    end
+
+    class_methods do
+      # Methods defined here extend/decorate static methods on the
+      # decorated class.
+      def sorts
+        super + ['discount_rate']
+      end
+    end
+
+    # Methods defined here extend/decorate instance methods on the
+    # decorated class.
+    def price
+      result = super
+      result *= discount_rate if on_sale?
+      result
+    end
+  end
+end
+```
+
+`Rails::Decorators` achieves this in a manner similar to `ActiveSupport::Concern` - it dynamically creates a module out of the block passed, and then prepends that into the original class. The above is equivalent to (note that this would need to be required using `require_dependency` as well):
+```ruby
+# in Rails.root/app/models/ecommerce/product_decorator.rb
+module Ecommerce
+  class Product
+    module Decorator
+      module ClassMethods
+        # Methods defined here extend/decorate static methods on the
+        # decorated class.
+        def sorts
+          super + ['discount_rate']
+        end
+      end
+
+      # Methods defined here extend/decorate instance methods on the
+      # decorated class.
+      def price
+        result = super
+        result *= discount_rate if on_sale?
+        result
+      end
+    end
+  end
+
+  Product.send(:prepend, Product::Decorator)
+  Product.singleton_class.send(:prepend, Product::Decorator::ClassMethods)
+  Product.class_eval do
+    # Class methods may be called here.
+    attr_writer :on_sale
+  end
+end
+```
+
+You can also decorate more than one class at a time:
+```ruby
+# in Rails.root/app/models/ecommerce/navigable.decorator
+module Ecommerce
+  decorate Product, Category, Page do
+    def generate_slug
+      # my custom logic here
+    end
+  end
+end
+```
+
+Other engines may want to namespace their customizations so as not to collide with further customizations:
+```ruby
+# in ecommerce_blog/app/models/ecommerce/product.decorator
+module Ecommerce
+  decorate Product, with: 'blog' do
+    def blog_entries
+      BlogEntry.for_product(id)
+    end
+  end
+end
+```
+
+It is strongly suggested you update your editor of choice to use Ruby syntax highlighting on \*.decorator files.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-decorators'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install rails-decorators
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails::Decorators'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/rails/decorators.rb

@@ -0,0 +1,14 @@
+module Rails
+  module Decorators
+    mattr_accessor :extension
+    self.extension = :decorator
+  end
+end
+
+require 'rails/decorators/engine'
+require 'rails/decorators/version'
+require 'rails/decorators/application'
+require 'rails/decorators/active_support'
+require 'rails/decorators/decorator'
+require 'rails/decorators/invalid_decorator'
+require 'rails/decorators/object'

data/lib/rails/decorators/active_support.rb

@@ -0,0 +1,52 @@
+module ActiveSupport
+  module Dependencies
+    module Loadable
+      private
+
+      # Monkey patched because Ruby's `require` doesn't load files that don't
+      # end in `.rb`, so we have to use `load` for decorators.
+      #
+      # The difference in semantics between `require` and `load` won't really
+      # matter since Rails handles this in development and code doesn't get
+      # reloaded in other environments.
+      #
+      # This module is mixed in to Object.
+      #
+      def require(file)
+        file_string = file.to_s
+
+        if file_string.end_with?(".#{Rails::Decorators.extension}")
+          load(file_string)
+        else
+          super
+        end
+      end
+    end
+
+    # Monkey patched because Rails appends a `.rb` to all files it tries to
+    # load with `require_dependency`. It does this for a good reason: both the
+    # oob `require` and oob `load` provided by Ruby will accept a path ending
+    # with `.rb`. But in our case, we want to ensure that decorators are loaded
+    # with `load` since `require` doesn't accept files that don't end with
+    # `.rb`.
+    #
+    def self.load_file(path, const_paths = loadable_constants_for_path(path))
+      path = path.gsub(/\.rb\z/, '') if path.end_with?(".#{Rails::Decorators.extension}.rb")
+
+      #
+      # Below this copy/pasted from Rails :(
+      #
+      const_paths = [const_paths].compact unless const_paths.is_a? Array
+      parent_paths = const_paths.collect { |const_path| const_path[/.*(?=::)/] || ::Object }
+
+      result = nil
+      newly_defined_paths = new_constants_in(*parent_paths) do
+        result = Kernel.load path
+      end
+
+      autoloaded_constants.concat newly_defined_paths unless load_once_path?(path)
+      autoloaded_constants.uniq!
+      result
+    end
+  end
+end

data/lib/rails/decorators/application.rb

@@ -0,0 +1,17 @@
+module Rails
+  class Application < Engine
+    module Decorators
+      def watchable_args
+        result = super
+
+        result.last.keys.each do |path|
+          result.last[path] << Rails::Decorators.extension
+        end
+
+        result
+      end
+    end
+
+    prepend Decorators
+  end
+end

data/lib/rails/decorators/decorator.rb

@@ -0,0 +1,116 @@
+module Rails
+  module Decorators
+    module Decorator
+      def self.loader(roots)
+        Proc.new do
+          roots.each do |root|
+            decorators = Dir.glob("#{root}/app/**/*.#{Rails::Decorators.extension}")
+            decorators.sort!
+            decorators.each { |d| require_dependency(d) }
+          end
+        end
+      end
+
+      def self.decorate(*targets, &module_definition)
+        options = targets.extract_options!
+
+        targets.each do |target|
+          unless target.is_a?(Class)
+            raise(
+              InvalidDecorator,
+              <<-eos.strip_heredoc
+
+                Problem:
+                  You cannot decorate a Module
+                Summary:
+                  Decoration only works with classes. Decorating modules requires
+                  managing load order, a problem that is very complicated and
+                  beyond the scope of this system.
+                Resolution:
+                  Decorate multiple classes that include the module like so:
+                  `decorate Catalog::Product, Content::Page do`
+              eos
+            )
+          end
+
+          if target.name.to_s.end_with?('Helper')
+            raise(
+              InvalidDecorator,
+              <<-eos.strip_heredoc
+
+                Problem:
+                  Rails::Decorators doesn't work with helpers.
+                Summary:
+                  Rails does some magic with helpers which in certain cases
+                  causes decoration to not work.
+                Resolution:
+                  Create a new helper and in a `to_prepare` block, use
+                  ActionPack's `helper` method to include the helper, e.g.
+                  `MyEngine::ApplicationController.helper(MyEngine::BlogsHelper)`
+              eos
+            )
+          end
+
+          decorator_name = "#{options[:with].to_s.camelize}#{target.to_s.demodulize}Decorator"
+
+          if target.const_defined?(decorator_name)
+            # We are probably reloading in Rails development env if this happens
+            next if !Rails.application.config.cache_classes
+
+            raise(
+              InvalidDecorator,
+              <<-eos.strip_heredoc
+
+                Problem:
+                  #{decorator_name} is already defined in #{target.name}.
+                Summary:
+                  When decorating a class, Rails::Decorators dynamically defines
+                  a module for prepending the decorations passed in the block. In
+                  this case, the name for the decoration module is already defined
+                  in the namespace, so decorating would redefine the constant.
+                Resolution:
+                  Please specify a unique `with` option when decorating #{target.name}.
+              eos
+            )
+          end
+
+          mod = Module.new do
+            extend Rails::Decorators::Decorator
+            module_eval(&module_definition)
+          end
+
+          target.const_set(decorator_name, mod)
+          mod.decorates(target)
+        end
+      end
+
+      def prepend_features(base)
+        super
+
+        if const_defined?(:ClassMethodsDecorator)
+          base
+            .singleton_class
+            .send(:prepend, const_get(:ClassMethodsDecorator))
+        end
+
+        if instance_variable_defined?(:@_decorated_block)
+          base.class_eval(&@_decorated_block)
+        end
+      end
+
+      def decorated(&block)
+        instance_variable_set(:@_decorated_block, block)
+      end
+
+      def class_methods(&class_methods_module_definition)
+        mod = const_set(:ClassMethodsDecorator, Module.new)
+        mod.module_eval(&class_methods_module_definition)
+      end
+      alias_method :module_methods, :class_methods
+
+      def decorates(klass)
+        klass.send(:prepend, self)
+      end
+    end
+  end
+end

data/lib/rails/decorators/engine.rb

@@ -0,0 +1,18 @@
+module Rails
+  module Decorators
+    class Engine < ::Rails::Engine
+      isolate_namespace Rails::Decorators
+
+      config.before_initialize do |app|
+        engines = ObjectSpace
+                    .each_object(Class)
+                    .select { |klass| klass < ::Rails::Engine }
+                    .select { |klass| klass.name.present? }
+                    .select { |klass| klass != ::Rails::Application }
+
+        loader = Decorator.loader(engines.map(&:root) + [Rails.root])
+        app.config.to_prepare(&loader)
+      end
+    end
+  end
+end

data/lib/rails/decorators/invalid_decorator.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Decorators
+    class InvalidDecorator < RuntimeError; end
+  end
+end

data/lib/rails/decorators/object.rb

@@ -0,0 +1,3 @@
+class Object
+  delegate :decorate, to: Rails::Decorators::Decorator
+end

data/lib/rails/decorators/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Decorators
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rails-decorators
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Crouse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- bencrouse@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rails/decorators.rb
+- lib/rails/decorators/active_support.rb
+- lib/rails/decorators/application.rb
+- lib/rails/decorators/decorator.rb
+- lib/rails/decorators/engine.rb
+- lib/rails/decorators/invalid_decorator.rb
+- lib/rails/decorators/object.rb
+- lib/rails/decorators/version.rb
+homepage: https://github.com/weblinc/rails-decorators
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Rails::Decorators provides a clean, familiar API for decorating the behavior
+  of a Rails engine.
+test_files: []