easy_gen 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '039f3a56535913793c5650392d33a758ed535b5408d3378d0333931d8d4ad7c2'
-  data.tar.gz: 88b749acf53e01644f352b29c70f3313c46461d964121c2b4c61fa59deaf4de5
+  metadata.gz: afdc2c7d450b407a19e0b5a82f98940bd963e5c2834d60e21779dfd9d13d957b
+  data.tar.gz: 4fc94179b298f2d5fcf1d86616ff0a97f305f4a0f44251d7a5624087fa5e7969
 SHA512:
-  metadata.gz: 3e5bc98279170412cc346fb9c0e3cdd0b2b73bd53411bbb767ddc0bafcd613db800ad73735b0dc3ba4848f9601603f4ff04ecbecf1d98821a58d1290a99af3d3
-  data.tar.gz: 94ed33ad98ae628b1d7b8b471fe0ce75c9603f676861003f83722f8c2a6ba740ee300ba379b5513dedda24fe2a2dc608447d3e46c50dd7de50ad492fbf1b6637
+  metadata.gz: 30a98e94af6ca028739c7e19ae5eb9e2c830faf35ad2ba55627317cf7ea52dd4e4f7d772ded27626db44771e06c5dc55e9000e0d8a8d98a5e474418a9b6f1084
+  data.tar.gz: eb49eaf5177912c6f5820797523b437435c2c8cf9f36c2d1577199956da1b8e2bf95847f15bf76037d42e47c3d375f536c595b255ec13d3c4884b00b2d6875b1

data/README.md

@@ -22,7 +22,7 @@ In the usual way.
 
 ## Using generators
 
-### Service Object Classes
+### Service Classes
 (See this link for example usage: https://www.honeybadger.io/blog/refactor-ruby-rails-service-object/):
 
 ```sh
@@ -49,6 +49,23 @@ bundle exec rails g service serviceclassname --module cool
 - 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'.
 
+### Validator Classes
+(See this link for example usage: https://womanonrails.com/custom-rails-validators ):
+
+```sh
+bundle exec rails g validator target
+```
+
+The command above:
+
+- Creates '/app/validators' directory if it doesnt exist.
+- Installs new application validator class in '/app/validator' with the name 'ApplicationValidator' in file '/app/services/application_validator.rb.' which inherits from ActiveModel::EachValidator.
+- Installs new validator class in '/app/validators' with the class name 'TargetValidator' in the file /app/validators/target_validator.rb.  This will inherit from /app/services/application_validator.rb.'
+- Creates '/test/validators' directory if it doesnt exist.
+- Installs new test class in '/test/validators' with the name 'TargetValidatorTest' in the file '/test/validators/target_validator_test.rb'.
+
+Yeah I know there are other types of validators - pull requests gratefully received.  I have only ever used EachValidators, and them many times..
+
 ### Null Object Classes
 (See this link for typical usage: https://medium.com/@kelseydh/using-the-null-object-pattern-with-ruby-on-rails-b645ebf79785 ):
 

data/lib/easy_gen/decorator/decorator_generator.rb

@@ -18,21 +18,8 @@ class DecoratorGenerator < Rails::Generators::NamedBase
   class_option :module, type: :string
 
   def main
-    raise "No such model - please check naming" unless model_exists?
+    raise "No such model - #{model_name} - in #{model_path} (#{Dir.pwd})- 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/easy_gen_generator.rb

@@ -49,16 +49,19 @@ module EasyGenGenerator
     @generator_type ||= self.class::TYPE
   end
 
+  def abstract_base_class_count
+    Object.const_defined?("#{self.class}::BASE_CLASSES") ? self.class::BASE_CLASSES : 1
+  end
   def no_files?
-    only_one_file? && file_is_abstract_class? && no_tests?
+    count_of_files_indicates_empty? && files_are_abstract_class? && no_tests?
   end
 
-  def only_one_file?
-    Dir["./app/#{base_location}/**/*"].reject { | path | File.directory?(path) }.length == 1
+  def count_of_files_indicates_empty?
+    Dir["./app/#{base_location}/**/*"].reject { | path | File.directory?(path) }.length == abstract_base_class_count
   end
 
-  def file_is_abstract_class?
-    File.exist?("app/#{base_location}/application_#{generator_type}.rb")
+  def files_are_abstract_class?
+     Dir["app/#{base_location}/application_*.rb"].length == abstract_base_class_count
   end
 
   def no_tests?
@@ -77,13 +80,40 @@ module EasyGenGenerator
     Dir["./app/#{location}/**/*"].reject { | path | File.directory?(path) }.length == 0
   end
 
+  def gem_testing?
+    Rails.root.blank?
+  end
+
+  def application_root_path
+    gem_testing? ? Pathname.new("./") : Rails.root
+  end
+
   def teardown(places)
-    print "Removing directories: "
+    return if (places.blank? || location.blank?)
     places.each do | place |
-      print place + '/' + location + " "
-      FileUtils.rm_rf(Rails.root.join(place,"#{location}"))
+      FileUtils.rm_rf(application_root_path.join(place,"#{location}"))
+    end
+  end
+
+  def model_exists?
+    @files ||= Dir[model_path + '*.rb']
+    @models ||= @files.map{ |m| File.basename(m, '.rb').camelize }
+
+    @models.include? model_name.camelize
+  end
+
+  def model_path
+    Pathname(application_root_path.to_s + '/app/models/')
+  end
+
+  def model_name
+    model == "ERROR" ? class_name : model
+  end
+
+  def eg_debug(message)
+    File.open("/Users/simon/Documents/Personal/Code/easy_gen/tmp/log.txt", "a") do |f|
+      f.write message + "\n"
     end
-    puts "- done"
   end
 
 end

data/lib/easy_gen/null/null_generator.rb

@@ -1,3 +1,4 @@
+require 'rails/all'
 require 'rails/generators'
 require 'fileutils'
 
@@ -35,26 +36,18 @@ class NullGenerator < Rails::Generators::NamedBase
 
   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
+  def clazz_columns
+    clazz.columns_hash.reject { | key, value | key == "id" }
   end
 
   def clazz
-    Kernel.const_get(model_name)
+    eg_debug "**** Model: #{model_name} - #{model_name.class} - #{model_name.method(:constantize).source_location} ****"
+
+    model_name.constantize
   end
 
   def default_value(ar_type)
     return AR_DEFAULTS[ar_type.to_sym]
   end
-
-  def clazz_columns
-    clazz.columns_hash.reject { | key, value | key == "id" }
-  end
 end

data/lib/easy_gen/strategy/strategy_generator.rb

@@ -11,6 +11,7 @@ class StrategyGenerator < Rails::Generators::NamedBase
 
   LOCATION = "strategies"
   TYPE = "strategy"
+  BASE_CLASSES = 2
 
   source_root File.expand_path("templates", __dir__)
   argument :strategies, type: :array, default: [], banner: "strategy strategy.."

data/lib/easy_gen/validator/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/validator/templates/application_validator.rb.tt

@@ -0,0 +1,3 @@
+class ApplicationValidator < ActiveModel::EachValidator
+
+end

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

@@ -0,0 +1,11 @@
+class <%= class_name %>Validator < ApplicationValidator
+
+  def validate_each(record, attribute, value)
+    return false if value.blank?
+    return true
+  end
+
+
+  private
+
+end

data/lib/easy_gen/validator/templates/validator_test.rb.tt

@@ -0,0 +1,23 @@
+require "test_helper"
+
+
+class <%= class_name %>Validatable
+  include ActiveModel::Validations
+  attr_accessor  :<%= class_name.downcase %>
+
+  validates :<%= class_name.downcase %>, <%= class_name.downcase %>: true
+
+end
+
+
+class <%= class_name %>ValidatorTest < ActiveSupport::TestCase
+  setup do
+    @testable = <%= class_name %>Validatable.new
+  end
+
+  test 'Confirms there is a value' do
+    @testable.<%= class_name.downcase %> = 1
+    assert @testable.valid?
+  end
+
+end

data/lib/easy_gen/validator/validator_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'fileutils'
+
+template_dir = File.expand_path('templates', __dir__)
+
+class ValidatorGenerator < Rails::Generators::NamedBase
+  include EasyGenGenerator
+
+  # bundle exec rails g service MyService
+  # bundle exec rails d service MyService
+
+  LOCATION = "validators"
+  TYPE = "validator"
+
+  source_root File.expand_path("templates", __dir__)
+
+  def main
+    copy_templates
+  end
+
+  private
+
+end

data/lib/easy_gen/version.rb

@@ -1,3 +1,3 @@
 module EasyGen
-  VERSION = "1.4.0"
+  VERSION = "1.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_gen
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Simon Stearn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-03-25 00:00:00.000000000 Z
 dependencies: []
 description: A simple generator for some standard design pattern classes and matching
   minitests.
@@ -45,6 +45,11 @@ files:
 - lib/easy_gen/strategy/templates/context_test.rb.tt
 - lib/easy_gen/strategy/templates/strategy.rb.tt
 - lib/easy_gen/strategy/templates/strategy_test.rb.tt
+- lib/easy_gen/validator/USAGE
+- lib/easy_gen/validator/templates/application_validator.rb.tt
+- lib/easy_gen/validator/templates/validator.rb.tt
+- lib/easy_gen/validator/templates/validator_test.rb.tt
+- lib/easy_gen/validator/validator_generator.rb
 - lib/easy_gen/version.rb
 homepage: https://rubygems.org/gems/easy_gen
 licenses: