lite-decorator 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d3c025083ce298a82c386461c7e2b8b48606916aa38e421391a014ef16ec3ba
-  data.tar.gz: a319dbe20b7b3cd9f3af475f96afa20cf33cb02323cfe47e26cd1c16d2bbb665
+  metadata.gz: b217a968ad5aa2bfc976383a9458990fbfad83387e0f533a4f34b7666ce895a7
+  data.tar.gz: 8071528b21c91446bdd136b49c9aca06cc93594af049ac7e5ece08a36dcd6990
 SHA512:
-  metadata.gz: c758c5b34a92815bab10680c367b77aae5086bff0e24ec771c47e2380e0db942021512f1f3adbd50693d07792cb9341df77d4c004f3c254eff36367b4e30b1ca
-  data.tar.gz: a88fb13faf0304434515cab3447434845008381bd1e64c8caa5fee3ec10c9b2fd1a1bb0513f21bc779e3bc819a08a79ce48dfc0ad6a9c46deae98afdc238c309
+  metadata.gz: a9e7f484acae99a89351772d7e5e8d820bb9ecdbee1b0811a0f76ff49f6dff9797d8706b936e0fb8607ab0c83735c81e93ab8f6bd5346f4c5ece47e14123df73
+  data.tar.gz: 9526e30deed656eb2deb927d78b6d5762cd00aa1ce308e6ea556d7e12ee64a1a33e609e9bd36980d0460ef887e87661d1352324cfa0a820d9b424e6ecd2618d8

data/.rubocop.yml

@@ -18,6 +18,8 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/**/*'
     - '*.gemspec'
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
 RSpec/ExampleLength:
   Enabled: false
 RSpec/MultipleExpectations:

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.1] - 2019-09-02
+### Added
+- Add rails generators
+
 ## [1.0.0] - 2019-09-01
 ### Added
 - Initial project version

data/Gemfile.lock

@@ -1,11 +1,24 @@
 PATH
   remote: .
   specs:
-    lite-decorator (1.0.0)
+    lite-decorator (1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionpack (6.0.0)
+      actionview (= 6.0.0)
+      activesupport (= 6.0.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.0)
+      activesupport (= 6.0.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
     activemodel (6.0.0)
       activesupport (= 6.0.0)
     activerecord (6.0.0)
@@ -18,20 +31,47 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.1, >= 2.1.8)
     ast (2.4.0)
+    builder (3.2.3)
     colorize (0.8.1)
     concurrent-ruby (1.1.5)
+    crass (1.0.4)
     database_cleaner (1.7.0)
     diff-lcs (1.3)
+    erubi (1.8.0)
     fasterer (0.6.0)
       colorize (~> 0.7)
       ruby_parser (>= 3.13.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
+    nokogiri (1.10.4)
+      mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.4.0)
       ast (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.2.0)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (6.0.0)
+      actionpack (= 6.0.0)
+      activesupport (= 6.0.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (12.3.3)
     rspec (3.8.0)
@@ -63,6 +103,7 @@ GEM
       sexp_processor (~> 4.9)
     sexp_processor (4.12.1)
     sqlite3 (1.4.1)
+    thor (0.20.3)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -77,6 +118,7 @@ DEPENDENCIES
   bundler
   database_cleaner
   fasterer
+  generator_spec
   lite-decorator!
   rake
   rspec

data/README.md

@@ -24,15 +24,25 @@ Or install it yourself as:
 
 ## Table of Contents
 
+* [Setup](#setup)
 * [Usage](#usage)
-* [Access](#access)
 
 ## Usage
 
-Using the decorator class is as simple as creating a class that inherits from the base file.
+`rails g lite:decorator:install` will generate the following file:
+`../app/decorators/application_decorator.rb`
 
 ```ruby
-class UserDecorator < Lite::Decorator::Base
+class ApplicationDecorator < Lite::Query::Base
+end
+```
+
+Use `rails g decorator NAME` will generate the following file: `../app/decorators/[name]_decorator.rb`
+
+You will then need to fill this class with the methods you want to decorate:
+
+```ruby
+class UserDecorator < ApplicationDecorator
 
   def full_name
     first_name + ' ' + last_name

data/lib/generators/lite/decorator/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Lite
+  module Decorator
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_application_query_file
+        copy_file('install.rb', 'app/decorators/application_decorator.rb')
+      end
+
+    end
+  end
+end

data/lib/generators/lite/decorator/templates/install.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationDecorator < Lite::Decorator::Base
+end

data/lib/generators/rails/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generate a decorator file
+
+Example:
+    rails generate decorator NAME
+
+    This will create:
+        - app/decorators/[name]_decorator.rb
+        - spec/decorators/[name]_decorator_spec.rb

data/lib/generators/rails/decorator_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Rails
+  class DecoratorGenerator < Rails::Generators::NamedBase
+
+    source_root File.expand_path('../templates', __FILE__)
+    check_class_collision suffix: 'Decorator'
+
+    def copy_files
+      path = File.join('app', 'decorators', class_path, "#{file_name}_decorator.rb")
+      empty_directory('app/decorators')
+      template('decorator.rb.tt', path)
+    end
+
+    def copy_specs
+      path = File.join('spec', 'decorators', class_path, "#{file_name}_decorator_spec.rb")
+      empty_directory('spec/decorators')
+      template('spec.rb.tt', path)
+    end
+
+    private
+
+    def file_name
+      @_file_name ||= remove_possible_suffix(super)
+    end
+
+    def remove_possible_suffix(name)
+      name.sub(/_?decorator$/i, '')
+    end
+
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %>Decorator < ApplicationDecorator
+end
+<% end -%>

data/lib/generators/rails/templates/spec.rb.tt

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

data/lib/lite/decorator/version.rb

@@ -3,7 +3,7 @@
 module Lite
   module Decorator
 
-    VERSION ||= '1.0.0'
+    VERSION ||= '1.0.1'
 
   end
 end

data/lib/lite/decorator.rb

@@ -3,3 +3,6 @@
 %w[version base].each do |name|
   require "lite/decorator/#{name}"
 end
+
+require 'generators/lite/decorator/install_generator'
+require 'generators/rails/decorator_generator'

data/lite-decorator.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'fasterer'
+  spec.add_development_dependency 'generator_spec'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite-decorator
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Juan Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-01 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +186,12 @@ files:
 - _config.yml
 - bin/console
 - bin/setup
+- lib/generators/lite/decorator/install_generator.rb
+- lib/generators/lite/decorator/templates/install.rb
+- lib/generators/rails/USAGE
+- lib/generators/rails/decorator_generator.rb
+- lib/generators/rails/templates/decorator.rb.tt
+- lib/generators/rails/templates/spec.rb.tt
 - lib/lite/decorator.rb
 - lib/lite/decorator/base.rb
 - lib/lite/decorator/version.rb