easy_gen 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2d07dc8b6f85a2b78e8c91b2d89fa4cd6fcf832e3d138dc8ca3e5c9de18b832
-  data.tar.gz: 8c316ff1f599fbaa893e2360c25aab5cd1ef5266cf5668bfcf07075781a5f13e
+  metadata.gz: 95fcbb1b48e4b5858a5854dadc9fe36ba71f9f3398ca4af37d1c2ca3034ca59d
+  data.tar.gz: 99967e9153f72da95d478f89588c9a146632fd4620774bad171839dd327e3062
 SHA512:
-  metadata.gz: 49e6f40b59eb2def1cf616009b88926383b53a213f60e17636559e0ca055ef23d7d2d234ce4832c815be0feb02e5cdaf69560d43b2d6c8e096a98e16e297dcfc
-  data.tar.gz: 1b489b8a5d176975a4dfc2ae3737ab82e58a57eb49061f25bdfdd525927618240b3849cba596658bf658e0c74dbbaa9440fd3b858a6796c2ab05fee5ac861428
+  metadata.gz: 9b22fa93da43aa81936bd2d697b2019b951ef391d2baad23ba9c3144d893459af4fbb2f0cd24f770f2b3a63753428aa41d7f4c6bdaeb44f6ca31a92cd27667ac
+  data.tar.gz: 1a9b12cd25981af1c3db68fef2f6e0fb1ef7179bc6b33cefe02e3cfbba7128f19b7bc75a5cb7667694c2c07dce0a00ac4aad4843d8785b0f95f579d727325351

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,7 +18,7 @@ In the usual way.
 
 ## Using generators
 
-All you need to do is to run:
+#Service Objects:
 
 ```sh
 bundle exec rails g service ServiceClassName
@@ -27,9 +27,24 @@ 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 'NullModelname' in the file /app/domain/null_modelname.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 'ServiceClassNameTest' in the file '/test/domain/null_modelname_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

@@ -0,0 +1,25 @@
+require 'pathname'
+
+module EasyGen
+  class EasyGenRailtie < Rails::Railtie
+
+    initializer "easy_gen_railtie.configure_generators" do
+
+      generator_dirs = Pathname(File.dirname(__dir__) + '/easy_gen/').children.select(&:directory?)
+
+
+      @@generator_files = []
+      generator_dirs.each do | dir |
+        @@generator_files << Dir["#{dir}/*_generator.rb"]
+      end
+      @@generator_files.flatten!
+
+    end
+
+    generators do
+      @@generator_files.each do | file |
+        require file
+      end
+    end
+  end
+end

data/lib/easy_gen/service/USAGE

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

data/lib/easy_gen/service/service_generator.rb

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

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

@@ -0,0 +1,3 @@
+class ApplicationService
+
+end

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

@@ -0,0 +1,9 @@
+class <%= class_name %>Service < ApplicationService
+
+  def initialize
+  end
+
+  def call
+  end
+
+end

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

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class <%= class_name %>ServiceTest < ActiveSupport::TestCase
+  setup do
+  end
+
+end

data/lib/easy_gen/version.rb

@@ -0,0 +1,3 @@
+module EasyGen
+  VERSION = "1.1.0"
+end

data/lib/easy_gen.rb

@@ -0,0 +1,6 @@
+require "easy_gen/version"
+require "easy_gen/abstract_generator"
+require 'easy_gen/railtie'
+
+module EasyGen
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_gen
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 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
@@ -18,6 +18,20 @@ extra_rdoc_files: []
 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
+- lib/easy_gen/service/templates/application_service.rb.tt
+- lib/easy_gen/service/templates/service.rb.tt
+- lib/easy_gen/service/templates/service_test.rb.tt
+- lib/easy_gen/version.rb
 homepage: https://rubygems.org/gems/easy_gen
 licenses:
 - MIT