easy_gen 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73f1ce33e410e6ad3997a84d409cbebf17f67a1b6d29c65aa98e2b7266f3aa67
-  data.tar.gz: 533bd5fca3036da27a8a2c02f64069a1afbe2ebdcc5bbfa255584cf58eccdb9e
+  metadata.gz: 78c3340c938e79d367a536ce3baa166f48f29ab4841248f684365326c984e38a
+  data.tar.gz: a7bb4d826a15b058dd4e1b3d4f4a4f0c1e266496e4176d12780ed05e48bb5f58
 SHA512:
-  metadata.gz: e9c780b6c6f9ffa8b58cf1a7caa1ee12c2d0877327ad85347981c320c836c70a9802b2626ea5ec332b2f9086eb67f50340d9a0f1aa0f5323b5e71f5fb1985240
-  data.tar.gz: 4fda618be443a171c34bd6209a5723ac074bc1d4b861c647de96345b83bf4742ff86aa88e2115152a236f78240dce557af23ed988cd827ed3554296678cb46b7
+  metadata.gz: 445c0290345dae4a65c8f8d13b1255cce639074d909da9b15bfdf23100e8785137caaadf4210f81e47d3b0e2933170ad5db219b4892dd20dae867399d16a3194
+  data.tar.gz: 231e436f75e3e287316991dc9095f644d37710f138251a091865e4d1edc5a56404b786463465252d31a77a9bcc63d62e0247434307b00f3f037e5c039e8fb5f8

data/README.md

@@ -2,7 +2,7 @@
 
 Save typing when generating service objects in a standard pattern.
 
-Add the following to your Gemfile:
+Add the following to the development group in your Gemfile:
 
 ```ruby
 gem "easy_gen"
@@ -18,18 +18,33 @@ In the usual way.
 
 ## Using generators
 
-All you need to do is to run:
+#Service Objects (See this link for example usage: https://www.honeybadger.io/blog/refactor-ruby-rails-service-object/):
 
 ```sh
-bundle exec rails g service ServiceClassName
+bundle exec rails g service serviceclassname
 ```
 
 The command above:
 
 - Creates '/app/services' directory if it doesnt exist.
-- Installs new application service class in '/app/services' with the name 'ApplicationService.rb' in file '/app/services/application_service.rb.'
+- 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' with the class name 'ServiceClassName' in the file /app/services/service_class_name.rb.  This will inherit from /app/services/application_services.rb.'
 - Creates '/test/services' directory if it doesnt exist.
-- Installs new test class in '/app/services' with the name 'ServiceClassNameTest' in the file '/test/services/service_class_name_test.rb'.
+- 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 ):
+
+```sh
+bundle exec rails g null modelname
+```
+
+The command above:
+
+- Creates '/app/domain' directory if it doesnt exist.
+- 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'.
+
 
 ** Nothing clever - just saves a bit of typing

data/lib/easy_gen/abstract_generator.rb

@@ -0,0 +1,41 @@
+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

data/lib/easy_gen/null/USAGE

@@ -0,0 +1,14 @@
+Description:
+  Lays out a new null value object under /app/domain, with a test file under /test/domain.
+  The null value class will inherit from /app/domain/application_null class which will be created.
+  if you use the generator to delete null classes, these will be removed together with directories once
+  the count of non abstract classes == 0.
+
+Example:
+    `rails generate null MyModel`
+
+    This will create:
+        app/domain/application_null.rb
+        app/domain/null_my_model.rb
+        test/domain/null_my_model_test.rb
+

data/lib/easy_gen/null/null_generator.rb

@@ -0,0 +1,51 @@
+require 'rails/generators'
+require 'fileutils'
+
+template_dir = File.expand_path('templates', __dir__)
+
+class NullGenerator < Rails::Generators::NamedBase
+  include AbstractGenerator
+  # bundle exec rails g null MyModel
+  # bundle exec rails d null MyModel
+
+  LOCATION = "domain"
+  TYPE = "null"
+
+  AR_DEFAULTS = {integer: 0,
+                 string: '"No Value"',
+                 text: '"No Value"',
+                 float: 0.0,
+                 decimal: 0.0,
+                 binary: false,
+                 boolean: false,
+                 date: 'Date.parse("1 Jan 1970")',
+                 datetime: 'Date.parse("1 Jan 1970")',
+                 timestamp: 'Date.parse("1 Jan 1970")',
+                 time:  'Time.parse("00:00:00")' }
+
+  source_root File.expand_path("templates", __dir__)
+
+  argument :model, type: :string, default: "ERROR",  banner: "model"
+
+  def main
+    copy_templates
+  end
+
+  private
+
+  def model_name
+    model == "ERROR" ? class_name : model
+  end
+
+  def clazz
+    Kernel.const_get(model_name)
+  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/null/templates/application_null.rb.tt

@@ -0,0 +1,35 @@
+class ApplicationNull
+
+  def id
+    raise "You are calling id on an object that doesn't exist."
+  end
+
+  def valid?
+    false
+  end
+
+  def present?
+    false
+  end
+
+  def blank?
+    true
+  end
+
+  def save
+    raise ActiveRecord::RecordInvalid
+  end
+
+  def save!
+    raise ActiveRecord::RecordInvalid
+  end
+
+  def update
+    raise ActiveRecord::RecordInvalid
+  end
+
+  def update!
+    raise ActiveRecord::RecordInvalid
+  end
+
+end

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

@@ -0,0 +1,10 @@
+class <%= class_name %>Null < ApplicationNull
+
+  # Generated fake attributes
+  <% clazz_columns.each do |column, ar_column|  %>
+  <%= "def #{column}" %>
+  <%= "  return #{default_value(ar_column.type)}" %>
+  <%= "end" %>
+  <% end %>
+
+end

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

@@ -0,0 +1,57 @@
+require "test_helper"
+
+class <%= class_name %>NullTest < ActiveSupport::TestCase
+  setup do
+    @null = <%= class_name %>Null.new
+  end
+
+  test 'id raises' do
+    assert_raises RuntimeError do
+      @null.id
+    end
+  end
+
+  test 'is invalid' do
+    refute @null.valid?
+  end
+
+  test 'is not present' do
+    refute @null.present?
+  end
+
+  test 'is blank' do
+    assert @null.blank?
+  end
+
+  test 'save raises' do
+    assert_raises ActiveRecord::RecordInvalid do
+      @null.save
+    end
+  end
+
+  test 'save! raises' do
+    assert_raises ActiveRecord::RecordInvalid do
+      @null.save!
+    end
+  end
+
+  test 'update raises' do
+    assert_raises ActiveRecord::RecordInvalid do
+      @null.update
+    end
+  end
+
+  test 'update! raises' do
+    assert_raises ActiveRecord::RecordInvalid do
+      @null.update!
+    end
+  end
+
+  # Generated fake attributes
+  <% clazz_columns.each do |column, ar_column|  %>
+  <%= "test '#{column} is #{default_value(ar_column.type)}' do" %>
+  <%= "  assert @null.#{column} == #{default_value(ar_column.type)}" %>
+  <%= "end" %>
+  <% end %>
+
+end

data/lib/easy_gen/railtie.rb

@@ -13,15 +13,12 @@ module EasyGen
         @@generator_files << Dir["#{dir}/*_generator.rb"]
       end
       @@generator_files.flatten!
-      puts "#{@@generator_files}"
 
     end
 
     generators do
       @@generator_files.each do | file |
-        puts "requiring #{file}"
         require file
-        puts "Done require"
       end
     end
   end

data/lib/easy_gen/service/service_generator.rb

@@ -2,37 +2,20 @@ require 'rails/generators'
 require 'fileutils'
 
 template_dir = File.expand_path('templates', __dir__)
-puts "Templates in: #{template_dir}"
 
 class ServiceGenerator < Rails::Generators::NamedBase
+  include AbstractGenerator
+
   # bundle exec rails g service MyService
-  # bundle exec rails generate service MyService
   # bundle exec rails d service MyService
-  # bundle exec rails delete service MyService
-  #
-
-  source_root File.expand_path("templates", __dir__)
 
-  def copy_templates
-    unless File.exist? "app/services/application_service.rb"
-      template "application_service.rb", "app/services/application_service.rb"
-    end
-    template "service.rb", "app/services/#{file_path}_service.rb"
-    template "service_test.rb", "test/services/#{file_path}_service_test.rb"
+  LOCATION = "services"
+  TYPE = "service"
 
-    if no_services?
-      teardown 'app'
-      teardown 'test'
-    end
-  end
-
-  private
+  source_root File.expand_path("templates", __dir__)
 
-  def no_services?
-    Dir["./app/services/*"].length == 1 && File.exist?("app/services/application_service.rb") && Dir["./test/services/*"].length == 0
+  def main
+    copy_templates
   end
 
-  def teardown(location)
-    FileUtils.rm_rf(Rails.root.join(location,'services'))
-  end
 end

data/lib/easy_gen/version.rb

@@ -1,3 +1,3 @@
 module EasyGen
-  VERSION = "1.0.1"
+  VERSION = "1.1.1"
 end

data/lib/easy_gen.rb

@@ -1,4 +1,5 @@
 require "easy_gen/version"
+require "easy_gen/abstract_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.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Simon Stearn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies: []
 description: A simple generator for /app/services classes and matching minitests
 email: simonstearn@gmail.com
@@ -19,6 +19,12 @@ files:
 - LICENSE.md
 - README.md
 - lib/easy_gen.rb
+- lib/easy_gen/abstract_generator.rb
+- lib/easy_gen/null/USAGE
+- lib/easy_gen/null/null_generator.rb
+- lib/easy_gen/null/templates/application_null.rb.tt
+- lib/easy_gen/null/templates/null.rb.tt
+- lib/easy_gen/null/templates/null_test.rb.tt
 - lib/easy_gen/railtie.rb
 - lib/easy_gen/service/USAGE
 - lib/easy_gen/service/service_generator.rb