easy_gen 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da5081ab9fcb9c258551212d713efb95c53fb2a4d2ca36d9c3dbcce0877e8795
-  data.tar.gz: 9acc796a3b32b21a01221ba75946f07b2dcf8b700fb7477bba151eec55a49f25
+  metadata.gz: bf7fdedf390132cd01a86266cf8754bf95eec1dd241e10d4340ffb359c25a1c6
+  data.tar.gz: 2ee0232d6cee49802f26a05959c2cef19b9f5f398fed2c171ba4219bfef3d5eb
 SHA512:
-  metadata.gz: 4960a5de4a1f2cc4e907f10f8521555d0d16c22c92ca69676b7becef5ac9e54bb7145c5e74d1fb1e9af2fc193e36d10cb9f35f484729fbb52e2e99a6c75400bd
-  data.tar.gz: a934ff6004b73cede4d86cfa5f8fcbfd9e4e02f127f4fcdf64e0f19e5b862315a45b8aaa9d2832c99a1e8052362bb64fe65eaa154a4439165f7afbcbdec3c0a0
+  metadata.gz: 10fe25a13542af70057797ef83e98f1535a926d2f88c5552c9d6c33e1a35b6b9c6a6ce359006799816aa8a3aa884bf7e2cbec1f2f88455fe5c98192435c7f7cf
+  data.tar.gz: 517e0f682f27cb98a763a0389a942bd393af72acbb52ec264f26079f1ba9d34825dfb3deb68776c584002c122a019285dc932f0da26c488a63e3879caed9fba8

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 Object Classes (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 Object Classes (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,9 +62,12 @@ 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/)
+### 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
@@ -61,5 +82,7 @@ The command above:
 - 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/decorator/decorator_generator.rb

@@ -4,7 +4,7 @@ require 'fileutils'
 template_dir = File.expand_path('templates', __dir__)
 
 class DecoratorGenerator < Rails::Generators::NamedBase
-  include AbstractGenerator
+  include EasyGenGenerator
 
   # bundle exec rails g service MyService
   # bundle exec rails d service MyService
@@ -15,6 +15,7 @@ class DecoratorGenerator < 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/decorator/templates/decorator.rb.tt

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

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

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

data/lib/easy_gen/easy_gen_generator.rb

@@ -0,0 +1,89 @@
+require 'rails/generators'
+require 'fileutils'
+
+module EasyGenGenerator
+
+  def copy_templates
+    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"
+
+    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
+    @location ||= base_location + module_dir
+  end
+
+  def generator_type
+    @generator_type ||= self.class::TYPE
+  end
+
+  def no_files?
+    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 directories: "
+    places.each do | place |
+      print place + '/' + location + " "
+      FileUtils.rm_rf(Rails.root.join(place,"#{location}"))
+    end
+    puts "- done"
+  end
+
+end

data/lib/easy_gen/null/null_generator.rb

@@ -4,7 +4,7 @@ require 'fileutils'
 template_dir = File.expand_path('templates', __dir__)
 
 class NullGenerator < Rails::Generators::NamedBase
-  include AbstractGenerator
+  include EasyGenGenerator
   # bundle exec rails g null MyModel
   # bundle exec rails d null MyModel
 
@@ -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

@@ -4,7 +4,7 @@ require 'fileutils'
 template_dir = File.expand_path('templates', __dir__)
 
 class ServiceGenerator < Rails::Generators::NamedBase
-  include AbstractGenerator
+  include EasyGenGenerator
 
   # bundle exec rails g service MyService
   # bundle exec rails d service MyService
@@ -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.2.0"
+  VERSION = "1.3.1"
 end

data/lib/easy_gen.rb

@@ -1,5 +1,5 @@
 require "easy_gen/version"
-require "easy_gen/abstract_generator"
+require "easy_gen/easy_gen_generator"
 require 'easy_gen/railtie'
 
 module EasyGen

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_gen
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Simon Stearn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies: []
 description: A simple generator for /app/services classes and matching minitests
 email: simonstearn@gmail.com
@@ -19,12 +19,12 @@ files:
 - LICENSE.md
 - 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/easy_gen_generator.rb
 - lib/easy_gen/null/USAGE
 - lib/easy_gen/null/null_generator.rb
 - lib/easy_gen/null/templates/application_null.rb.tt

data/lib/easy_gen/abstract_generator.rb

@@ -1,41 +0,0 @@
-require 'rails/generators'
-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"
-    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"
-
-    if no_files?
-      teardown ['app', 'test']
-    end
-  end
-
-  private
-
-  def location
-    self.class::LOCATION
-  end
-
-  def 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
-  end
-
-  def teardown(places)
-    print "Removing:"
-    places.each do | place |
-      print place + " "
-      FileUtils.rm_rf(Rails.root.join(place,"#{location}"))
-    end
-    puts "- done"
-  end
-
-end