easy_gen 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78c3340c938e79d367a536ce3baa166f48f29ab4841248f684365326c984e38a
-  data.tar.gz: a7bb4d826a15b058dd4e1b3d4f4a4f0c1e266496e4176d12780ed05e48bb5f58
+  metadata.gz: da5081ab9fcb9c258551212d713efb95c53fb2a4d2ca36d9c3dbcce0877e8795
+  data.tar.gz: 9acc796a3b32b21a01221ba75946f07b2dcf8b700fb7477bba151eec55a49f25
 SHA512:
-  metadata.gz: 445c0290345dae4a65c8f8d13b1255cce639074d909da9b15bfdf23100e8785137caaadf4210f81e47d3b0e2933170ad5db219b4892dd20dae867399d16a3194
-  data.tar.gz: 231e436f75e3e287316991dc9095f644d37710f138251a091865e4d1edc5a56404b786463465252d31a77a9bcc63d62e0247434307b00f3f037e5c039e8fb5f8
+  metadata.gz: 4960a5de4a1f2cc4e907f10f8521555d0d16c22c92ca69676b7becef5ac9e54bb7145c5e74d1fb1e9af2fc193e36d10cb9f35f484729fbb52e2e99a6c75400bd
+  data.tar.gz: a934ff6004b73cede4d86cfa5f8fcbfd9e4e02f127f4fcdf64e0f19e5b862315a45b8aaa9d2832c99a1e8052362bb64fe65eaa154a4439165f7afbcbdec3c0a0

data/README.md

@@ -18,7 +18,7 @@ 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 +32,7 @@ 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 ):
+#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
@@ -46,5 +46,20 @@ The command above:
 - 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'.
 
+#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'.
+
+
 
 ** Nothing clever - just saves a bit of typing

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,37 @@
+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"
+
+  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 <%= class_name %>Decorator < ApplicationDecorator
+
+  # Expects to be created from <%= class_name %> like this:
+  # <%= 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 = <%= class_name %>Decorator.new(<%= class_name%>.first)
+  end
+
+end

data/lib/easy_gen/null/null_generator.rb

@@ -28,11 +28,19 @@ class NullGenerator < Rails::Generators::NamedBase
   argument :model, type: :string, default: "ERROR",  banner: "model"
 
   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

data/lib/easy_gen/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_gen
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.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