easy_gen 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c73b60e1c24075a1662af912505f2da6d3c4c716b5573e5c2186ff0684d4d0c0
-  data.tar.gz: 0eb19ee899681fc035827e937926ec526a87e79dc93d03b39b3e9af339065c68
+  metadata.gz: 84e5d8b3dd221105fc7faee88424a7449da87521eaf72b53a5c9a92a7aad079d
+  data.tar.gz: efeae962cbe6e7f33c1a6778c3b525154e3a5c59622ba024432b107ec5ca3a24
 SHA512:
-  metadata.gz: 4e1f84b24cd3c5591b0dfe4e3c3a73e3e43012a3d904577c68258e261783aa100fce4262a8312d7aedb25325816b5f129c193ae64e905941aaef3221660dded9
-  data.tar.gz: 05d0904c0759b3a0d23a0bf66c54d361c3c0371a59629225a217bdf4ab9dee3a7074d6ea3833249457dc3033d4af15826cbe7b7372d0abbf34e7d3de291b7d48
+  metadata.gz: 5c0d9d64439a1ec66a43760ca9810de56247ae7d9800cd32a2fe9d7fac8f0e186e3c8f538b55f40d49c125ddf9b988e5f3f90693532b21d23439578d870ebe02
+  data.tar.gz: 18995f5c9dfde49f9d252ecf83d5f40559f22200f7d0b570ab9f9576e9b92d9e6bce7513399c113e41e58690f51a7dd45b2603302b0299dfb5e0cb6a88a20067

data/README.md

@@ -1,6 +1,10 @@
-# easy_gen : Simple generator to add service class and minitest to rails projects
+![gem version badge](https://badge.fury.io/rb/easy_gen.svg)
 
-Save typing when generating service objects in a standard pattern.
+# easy_gen : Simple generator to add various classes with barebones minitest to rails projects
+
+Save typing when generating certain classes in somewhat standard patterns.
+
+## Installation
 
 Add the following to the development group in your Gemfile:
 
@@ -18,7 +22,8 @@ In the usual way.
 
 ## Using generators
 
-#Service Objects (See this link for example usage: https://www.honeybadger.io/blog/refactor-ruby-rails-service-object/):
+### Service Object Classes
+(See this link for example usage: https://www.honeybadger.io/blog/refactor-ruby-rails-service-object/):
 
 ```sh
 bundle exec rails g service serviceclassname
@@ -32,7 +37,20 @@ The command above:
 - Creates '/test/services' directory if it doesnt exist.
 - Installs new test class in '/test/services' with the name 'ServiceClassNameTest' in the file '/test/services/service_class_name_test.rb'.
 
-#Null Objects (See this link for typical usage https://medium.com/@kelseydh/using-the-null-object-pattern-with-ruby-on-rails-b645ebf79785 ):
+optionally run with the module option to embed within a module namespace.  For example:
+
+```sh
+bundle exec rails g service serviceclassname --module cool
+```
+
+- Creates '/app/services/cool' directory if it doesnt exist.
+- Installs new application service class in '/app/services' with the name 'ApplicationService' in file '/app/services/application_service.rb.'
+- Installs new service class in '/app/services/cool' with the class name 'Cool::ServiceClassName' in the file /app/services/cool/service_class_name.rb.  This will inherit from /app/services/application_services.rb.'
+- Creates '/test/services/cool' directory if it doesnt exist.
+- Installs new test class in '/test/services/cool' with the name 'ServiceClassNameTest' in the file '/test/services/cool/service_class_name_test.rb'.
+
+### Null Object Classes
+(See this link for typical usage: https://medium.com/@kelseydh/using-the-null-object-pattern-with-ruby-on-rails-b645ebf79785 ):
 
 ```sh
 bundle exec rails g null modelname
@@ -44,7 +62,27 @@ The command above:
 - Installs new application domain class in '/app/domain' with the name 'ApplicationNull' in file '/app/domain/application_null.rb.'
 - Installs new domain class in '/app/domain' with the class name 'ModelnameNull' in the file /app/domain/modelname_null.rb.  This will inherit from /app/domain/application_null.rb.'
 - Creates '/test/domain' directory if it doesnt exist.
-- Installs new test class in '/test/domain' with the name 'ModelnameNullTest' in the file '/test/domain/modelname_null_test.rb'.
+- Installs new test class in '/test/domain' with the name 'ModelnameNullTest' in the file '/test/domain/modelname_null_test.rb'. Tests include 'stubbing' of all model 'columns' based on data type, with assertions (coverage baby).
+
+Module option is also supported.
+
+### Decorator Classes
+(See this link for typical usage: https://www.thegreatcodeadventure.com/rails-refactoring-part-iii-the-decorator-pattern/)
+
+```sh
+bundle exec rails g decorator modelname
+```
+
+The command above:
+
+- Creates '/app/decorators' directory if it doesnt exist.
+- Installs new application decorator class in '/app/decorators' with the name 'ApplicationDecorator' in file '/app/decorators/application_decorator.rb.'.  This inherits from Rubys SimpleDelegator class.
+- Installs new decorators class in '/app/decorators' with the class name 'ModelnameDecorator' in the file /app/decorators/modelname_decorator.rb.  This will inherit from /app/decorators/application_decorator.rb.'
+- Creates '/test/decorators' directory if it doesnt exist.
+- Installs new test class in '/test/decorators' with the name 'ModelnameDecoratorTest' in the file '/test/decorators/modelname_decorator_test.rb'.
+
 
+Module option is also supported.
 
+## Summary
 ** Nothing clever - just saves a bit of typing

data/lib/easy_gen/abstract_generator.rb

@@ -4,8 +4,8 @@ require 'fileutils'
 module AbstractGenerator
 
   def copy_templates
-    unless File.exist? "app/#{location}/application_#{generator_type}.rb"
-      template "application_#{generator_type}.rb", "app/#{location}/application_#{generator_type}.rb"
+    unless File.exist? "app/#{base_location}/application_#{generator_type}.rb"
+      template "application_#{generator_type}.rb", "app/#{base_location}/application_#{generator_type}.rb"
     end
     template "#{generator_type}.rb", "app/#{location}/#{file_path}_#{generator_type}.rb"
     template "#{generator_type}_test.rb", "test/#{location}/#{file_path}_#{generator_type}_test.rb"
@@ -13,26 +13,74 @@ module AbstractGenerator
     if no_files?
       teardown ['app', 'test']
     end
+
+    if no_files_for_module?
+      teardown ['app', 'test']
+    end
   end
 
   private
 
+  def module?
+    options[:module].present?
+  end
+
+  def module_name
+    @module_name ||= module? ? options[:module] : ""
+  end
+
+  def module_prefix
+    @module_prefix ||= module? ? "#{module_name.camelize}::" : ""
+  end
+
+  def module_dir
+    @module_dir ||= module? ? "/#{module_name.downcase}" : ""
+  end
+
+  def base_location
+    @base_location ||= self.class::LOCATION
+  end
+
   def location
-    self.class::LOCATION
+    @location ||= base_location + module_dir
   end
 
   def generator_type
-    self.class::TYPE
+    @generator_type ||= self.class::TYPE
   end
 
   def no_files?
-    Dir["./app/#{location}/*"].length == 1 && File.exist?("app/#{location}/application_#{generator_type}.rb") && Dir["./test/#{location}/*"].length == 0
+    only_one_file? && file_is_abstract_class? && no_tests?
+  end
+
+  def only_one_file?
+    Dir["./app/#{base_location}/**/*"].reject { | path | File.directory?(path) }.length == 1
+  end
+
+  def file_is_abstract_class?
+    File.exist?("app/#{base_location}/application_#{generator_type}.rb")
+  end
+
+  def no_tests?
+    Dir["./test/#{base_location}/**/*"].reject { | path | File.directory?(path) }.length == 0
+  end
+
+  def no_files_for_module?
+    no_app_files_for_module? && no_test_files_for_module?
+  end
+
+  def no_test_files_for_module?
+    Dir["./test/#{location}/**/*"].reject { | path | File.directory?(path) }.length == 0
+  end
+
+  def no_app_files_for_module?
+    Dir["./app/#{location}/**/*"].reject { | path | File.directory?(path) }.length == 0
   end
 
   def teardown(places)
-    print "Removing:"
+    print "Removing directories: "
     places.each do | place |
-      print place + " "
+      print place + '/' + location + " "
       FileUtils.rm_rf(Rails.root.join(place,"#{location}"))
     end
     puts "- done"

data/lib/easy_gen/decorator/USAGE

@@ -0,0 +1,14 @@
+Description:
+  Lays out a new service object under /app/decorators, with a test file under /test/decorators.
+  The service class will inherit from /app/decorators/application_decorator class which will be created.
+  if you use the generator to delete decorator classes, these will be removed together with directories once
+  the count of non abstract classes == 0.
+
+Example:
+    `rails generate decorator Mydecorator`
+
+    This will create:
+        app/decorators/application_decorator.rb
+        app/decorators/my_decorator.rb
+        test/decorators/my_decorator_test.rb
+

data/lib/easy_gen/decorator/decorator_generator.rb

@@ -0,0 +1,38 @@
+require 'rails/generators'
+require 'fileutils'
+
+template_dir = File.expand_path('templates', __dir__)
+
+class DecoratorGenerator < Rails::Generators::NamedBase
+  include AbstractGenerator
+
+  # bundle exec rails g service MyService
+  # bundle exec rails d service MyService
+
+  LOCATION = "decorators"
+  TYPE = "decorator"
+
+  source_root File.expand_path("templates", __dir__)
+
+  argument :model, type: :string, default: "ERROR",  banner: "model"
+  class_option :module, type: :string
+
+  def main
+    raise "No such model - please check naming" unless model_exists?
+    copy_templates
+  end
+
+  private
+
+  def model_exists?
+    files = Dir[Rails.root + 'app/models/*.rb']
+    models = files.map{ |m| File.basename(m, '.rb').camelize }
+
+    models.include? model_name.camelize
+  end
+
+  def model_name
+    model == "ERROR" ? class_name : model
+  end
+
+end

data/lib/easy_gen/decorator/templates/application_decorator.rb.tt

@@ -0,0 +1,3 @@
+class ApplicationDecorator < SimpleDelegator
+
+end

data/lib/easy_gen/decorator/templates/decorator.rb.tt

@@ -0,0 +1,6 @@
+class <%= module_prefix %><%= class_name %>Decorator < ApplicationDecorator
+
+  # Expects to be created from <%= class_name %> like this:
+  # <%= module_prefix %><%= class_name %>Decorator.new(@my_<%= class_name.downcase %>)
+
+end

data/lib/easy_gen/decorator/templates/decorator_test.rb.tt

@@ -0,0 +1,8 @@
+require "test_helper"
+
+class <%= class_name %>DecoratorTest < ActiveSupport::TestCase
+  setup do
+    @decorator = <%= module_prefix %><%= class_name %>Decorator.new(<%= class_name%>.first)
+  end
+
+end

data/lib/easy_gen/null/null_generator.rb

@@ -26,6 +26,7 @@ class NullGenerator < Rails::Generators::NamedBase
   source_root File.expand_path("templates", __dir__)
 
   argument :model, type: :string, default: "ERROR",  banner: "model"
+  class_option :module, type: :string
 
   def main
     raise "No such model - please check naming" unless model_exists?

data/lib/easy_gen/null/templates/null.rb.tt

@@ -1,4 +1,4 @@
-class <%= class_name %>Null < ApplicationNull
+class <%= module_prefix %><%= class_name %>Null < ApplicationNull
 
   # Generated fake attributes
   <% clazz_columns.each do |column, ar_column|  %>

data/lib/easy_gen/null/templates/null_test.rb.tt

@@ -1,8 +1,8 @@
 require "test_helper"
 
-class <%= class_name %>NullTest < ActiveSupport::TestCase
+class <%= module_prefix %><%= class_name %>NullTest < ActiveSupport::TestCase
   setup do
-    @null = <%= class_name %>Null.new
+    @null = <%= module_prefix %><%= class_name %>Null.new
   end
 
   test 'id raises' do

data/lib/easy_gen/service/service_generator.rb

@@ -14,6 +14,8 @@ class ServiceGenerator < Rails::Generators::NamedBase
 
   source_root File.expand_path("templates", __dir__)
 
+  class_option :module, type: :string
+
   def main
     copy_templates
   end

data/lib/easy_gen/service/templates/service.rb.tt

@@ -1,4 +1,4 @@
-class <%= class_name %>Service < ApplicationService
+class <%= module_prefix %><%= class_name %>Service < ApplicationService
 
   def initialize
   end

data/lib/easy_gen/version.rb

@@ -1,3 +1,3 @@
 module EasyGen
-  VERSION = "1.1.2"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_gen
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Simon Stearn
@@ -20,6 +20,11 @@ files:
 - README.md
 - lib/easy_gen.rb
 - lib/easy_gen/abstract_generator.rb
+- lib/easy_gen/decorator/USAGE
+- lib/easy_gen/decorator/decorator_generator.rb
+- lib/easy_gen/decorator/templates/application_decorator.rb.tt
+- lib/easy_gen/decorator/templates/decorator.rb.tt
+- lib/easy_gen/decorator/templates/decorator_test.rb.tt
 - lib/easy_gen/null/USAGE
 - lib/easy_gen/null/null_generator.rb
 - lib/easy_gen/null/templates/application_null.rb.tt