light-decorator 0.5.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78faf0429db08cdbb372146394c776d42228e916
-  data.tar.gz: bb207231bd193d44de3f2bd97cbaf0d836653b97
+  metadata.gz: 247bcaa3a6bb0fe2bbe4f112e0422dcd5f294a21
+  data.tar.gz: d501bf7b57e024db89623b2eb7ec7ecb52bc3e73
 SHA512:
-  metadata.gz: 6fec0dc9c556822ae7b628bf1f52a1209eb4843a4f753ee2a0df51e0398e783e19f434039b0dc7cfb118b283ccbd9534bbeacc2382cb82afb5e3e6848ef68e32
-  data.tar.gz: 23b3b5ebc2c79756f9b2f0b48720a04119a92631e6e363c88fbd48c470ce83d4cb2ef241875c802c1fd843f4cabc63e81f3175c469c521a42b7ad4886c0888d1
+  metadata.gz: bbf95ea9db48bfc27651e8753ad2c0390ae2755cc6136ac27a04fd0d2156f7e54e4f1315c66e75aa9a3b002f20baf7d18c7322143f718f1c78d4352b3e451cb3
+  data.tar.gz: f2468f0a450f5b6be3f0eeeec071a5c642e491903beeeea03f8eb6b7d0c805aa477b7ee8de28a8131c08d653586991611bbec590a7b52c87b60890d2c78a50dc

data/.rubocop.yml

@@ -1,6 +1,11 @@
 AllCops:
   TargetRubyVersion: 2.0
   DisabledByDefault: true
+  Exclude:
+    - 'lib/generators/rails/decorator/templates/decorator.rb'
+    - 'lib/generators/rspec/decorator/templates/decorator_spec.rb'
+    - 'lib/generators/test_unit/decorator/templates/decorator_test.rb'
+    - 'lib/generators/light/decorator/install/templates/application_decorator.rb'
 
 #################### Lint ################################
 

data/README.md

@@ -1,12 +1,12 @@
-# Light::Decorator
+# Light Decorator
 
 [![Build Status](https://travis-ci.org/light-ruby/light-decorator.svg?branch=master)](https://travis-ci.org/light-ruby/light-decorator)
 [![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.
+Easiest and fast way to decorate Ruby on Rails models. Compatible with Rails 5.0 and 4.2, 4.1, 4.0.
 
-Decorator pattern - What is it?
+Decorator Pattern – What is it? Check it here:
 - [Wikipedia](https://en.wikipedia.org/wiki/Decorator_pattern)
 - [Thoughtbot](https://robots.thoughtbot.com/evaluating-alternative-decorator-implementations-in)
 
@@ -15,20 +15,19 @@ Decorator pattern - What is it?
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'light-decorator', '~> 0.5.3'
+gem 'light-decorator', '~> 1.0.0'
 ```
 
-## Usage
-
-Create the `ApplicationDecorator`
+Create base class `ApplicationDecorator` in folder `app/decorators/application_decorator.rb`
 
-```ruby
-# app/decorators/application_decorator.rb
-class ApplicationDecorator < Light::Decorator::Decorate
-end
+```
+rails g light:decorator:install
 ```
 
+## Usage
+
 Create decorator for your model. For example we will use the `User` model.
+We can manually create file:
 
 ```ruby
 # app/decorators/user_decorator.rb
@@ -39,6 +38,12 @@ class UserDecorator < Application
 end
 ```
 
+Or we can just use command to create this file:
+
+```
+rails g decorator User
+```
+
 Decorate your model in controller or anywhere.
 
 ```ruby
@@ -75,15 +80,15 @@ class UserDecorator < ApplicationDecorator
   def full_name_link
     helpers.link_to full_name, user_path(object)
     # or
-    h.link_to full_name, user_path(object)
+    h.link_to full_name, user_path(o)
   end
 end
 ```
 
 ## Next steps
 
-- [ ] Create rake task `light-decorator:install`
-- [ ] Create generators
+- [x] Create installation generator
+- [x] Create decorator generator
 - [ ] Create configuration file
 
 ## Contributing

data/gemfiles/rails_4_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    light-decorator (0.5.3)
+    light-decorator (1.0.0)
       rails (>= 4.0.0)
       request_store (>= 1.0.0)
 
@@ -59,6 +59,9 @@ GEM
     factory_girl (4.7.0)
       activesupport (>= 3.0.0)
     ffaker (2.2.0)
+    generator_spec (0.9.3)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
     i18n (0.7.0)
     json (1.8.3)
     mail (2.6.4)
@@ -134,6 +137,7 @@ DEPENDENCIES
   combustion (~> 0.5.4)
   factory_girl (~> 4.0)
   ffaker (~> 2.2.0)
+  generator_spec (~> 0.9.3)
   light-decorator!
   rails (= 4.0.13)
   rake (~> 10.0)

data/gemfiles/rails_4_1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    light-decorator (0.5.3)
+    light-decorator (1.0.0)
       rails (>= 4.0.0)
       request_store (>= 1.0.0)
 
@@ -61,6 +61,9 @@ GEM
     factory_girl (4.7.0)
       activesupport (>= 3.0.0)
     ffaker (2.2.0)
+    generator_spec (0.9.3)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
     i18n (0.7.0)
     json (1.8.3)
     mail (2.6.4)
@@ -138,6 +141,7 @@ DEPENDENCIES
   combustion (~> 0.5.4)
   factory_girl (~> 4.0)
   ffaker (~> 2.2.0)
+  generator_spec (~> 0.9.3)
   light-decorator!
   rails (= 4.1.15)
   rake (~> 10.0)

data/gemfiles/rails_4_2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    light-decorator (0.5.3)
+    light-decorator (1.0.0)
       rails (>= 4.0.0)
       request_store (>= 1.0.0)
 
@@ -70,6 +70,9 @@ GEM
     factory_girl (4.7.0)
       activesupport (>= 3.0.0)
     ffaker (2.2.0)
+    generator_spec (0.9.3)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
     globalid (0.3.6)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
@@ -160,6 +163,7 @@ DEPENDENCIES
   combustion (~> 0.5.4)
   factory_girl (~> 4.0)
   ffaker (~> 2.2.0)
+  generator_spec (~> 0.9.3)
   light-decorator!
   rails (= 4.2.6)
   rake (~> 10.0)

data/gemfiles/rails_5_0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    light-decorator (0.5.3)
+    light-decorator (1.0.0)
       rails (>= 4.0.0)
       request_store (>= 1.0.0)
 
@@ -72,6 +72,9 @@ GEM
     factory_girl (4.7.0)
       activesupport (>= 3.0.0)
     ffaker (2.2.0)
+    generator_spec (0.9.3)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
     globalid (0.3.6)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
@@ -170,6 +173,7 @@ DEPENDENCIES
   combustion (~> 0.5.4)
   factory_girl (~> 4.0)
   ffaker (~> 2.2.0)
+  generator_spec (~> 0.9.3)
   light-decorator!
   rails (= 5.0.0.rc1)
   rake (~> 10.0)

data/lib/generators/light/decorator/install/install_generator.rb

@@ -0,0 +1,13 @@
+module Light
+  module Decorator
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        source_root File.expand_path('../templates', __FILE__)
+
+        def create_application_decorator
+          template 'application_decorator.rb', File.join('app/decorators', 'application_decorator.rb')
+        end
+      end
+    end
+  end
+end

data/lib/generators/light/decorator/install/templates/application_decorator.rb

@@ -0,0 +1,2 @@
+class ApplicationDecorator < Light::Decorator::Base
+end

data/lib/generators/rails/decorator/decorator_generator.rb

@@ -0,0 +1,14 @@
+module Rails
+  module Generators
+    class DecoratorGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      check_class_collision suffix: 'Decorator'
+
+      def create_decorator
+        template 'decorator.rb', File.join('app/decorators', class_path, "#{file_name}_decorator.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/rails/decorator/templates/decorator.rb

@@ -0,0 +1,10 @@
+class <%= class_name %>Decorator < ApplicationDecorator
+  # Use `object` or `o` to access object
+  # Use `helper` or `h` to access helpers
+  #
+  # Example:
+  #
+  # def created_at
+  #   h.content_tag :span, o.created_at.to_s(:long)
+  # end
+end

data/lib/generators/rails/hooks.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/rails/model/model_generator'
+require 'rails/generators/rails/resource/resource_generator'
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+
+module Rails
+  module Generators
+    class ModelGenerator
+      hook_for :decorator, default: true
+    end
+
+    class ResourceGenerator
+      hook_for :decorator, default: true
+    end
+
+    class ScaffoldControllerGenerator
+      hook_for :decorator, default: true
+    end
+  end
+end

data/lib/generators/rspec/decorator/decorator_generator.rb

@@ -0,0 +1,11 @@
+module RSpec
+  module Generators
+    class DecoratorGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_decorator_spec
+        template 'decorator_spec.rb', File.join('spec/decorators', class_path, "#{file_name}_decorator_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/decorator/templates/decorator_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe <%= class_name %>Decorator do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/test_unit/decorator/decorator_generator.rb

@@ -0,0 +1,11 @@
+module TestUnit
+  module Generators
+    class DecoratorGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_decorator_test
+        template 'decorator_test.rb', File.join('test/decorators', class_path, "#{file_name}_decorator_test.rb")
+      end
+    end
+  end
+end

data/lib/generators/test_unit/decorator/templates/decorator_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+class <%= class_name %>DecoratorTest < ActiveSupport::TestCase
+  def test_decorate
+  end
+end

data/lib/light/decorator/decorate.rb

@@ -1,6 +1,6 @@
 module Light
   module Decorator
-    class Decorate
+    class Base
       # @return original object
       attr_reader :object
 

data/lib/light/decorator/railtie.rb

@@ -2,7 +2,6 @@ module Light
   module Decorator
     class Railtie < Rails::Railtie
       config.after_initialize do |app|
-        # Eager loading of Decorators classes
         app.config.paths.add 'app/decorators', eager_load: true
       end
 
@@ -23,6 +22,13 @@ module Light
           end
         end
       end
+
+      generators do |app|
+        Rails::Generators.configure! app.config.generators
+        Rails::Generators.hidden_namespaces.uniq!
+
+        require 'generators/rails/hooks'
+      end
     end
   end
 end

data/lib/light/decorator/version.rb

@@ -1,5 +1,5 @@
 module Light
   module Decorator
-    VERSION = '0.5.3'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/light-decorator.gemspec

@@ -35,5 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'capybara', '~> 2.7.0'
   spec.add_development_dependency 'factory_girl', '~> 4.0'
   spec.add_development_dependency 'ffaker', '~> 2.2.0'
+  spec.add_development_dependency 'generator_spec', '~> 0.9.3'
   spec.add_development_dependency 'codeclimate-test-reporter'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light-decorator
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Emelianenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -178,6 +178,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +235,15 @@ files:
 - gemfiles/rails_4_2.gemfile.lock
 - gemfiles/rails_5_0.gemfile
 - gemfiles/rails_5_0.gemfile.lock
+- lib/generators/light/decorator/install/install_generator.rb
+- lib/generators/light/decorator/install/templates/application_decorator.rb
+- lib/generators/rails/decorator/decorator_generator.rb
+- lib/generators/rails/decorator/templates/decorator.rb
+- lib/generators/rails/hooks.rb
+- lib/generators/rspec/decorator/decorator_generator.rb
+- lib/generators/rspec/decorator/templates/decorator_spec.rb
+- lib/generators/test_unit/decorator/decorator_generator.rb
+- lib/generators/test_unit/decorator/templates/decorator_test.rb
 - lib/light/decorator.rb
 - lib/light/decorator/concerns/associations/collection_proxy.rb
 - lib/light/decorator/concerns/base.rb