easy_gen 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49aba729d4c64cdd2a07c27e9fa4119bfefbf02b30cc44e58407a9deaa050b2e
-  data.tar.gz: f6a74fba29331225739f45d117e3385a455966072b9aa02222fdd27b9f46bd8a
+  metadata.gz: '039f3a56535913793c5650392d33a758ed535b5408d3378d0333931d8d4ad7c2'
+  data.tar.gz: 88b749acf53e01644f352b29c70f3313c46461d964121c2b4c61fa59deaf4de5
 SHA512:
-  metadata.gz: 6666acd9b19b906459ca3e8a865f017fb93599f7c22294aff9218e533ddee212e7aea7762632840109eb7d0eca6e25a2152353e309b434005294945afae1eab7
-  data.tar.gz: 238b7af7e54c068b9c643c4ea3f515326ff1ce32765a7f744b6219ebefce2b661ebcb3a3a9039086c8f22f94e3bcc44decd8cea89d3103acfb5066e7d9906b68
+  metadata.gz: 3e5bc98279170412cc346fb9c0e3cdd0b2b73bd53411bbb767ddc0bafcd613db800ad73735b0dc3ba4848f9601603f4ff04ecbecf1d98821a58d1290a99af3d3
+  data.tar.gz: 94ed33ad98ae628b1d7b8b471fe0ce75c9603f676861003f83722f8c2a6ba740ee300ba379b5513dedda24fe2a2dc608447d3e46c50dd7de50ad492fbf1b6637

data/README.md

@@ -84,5 +84,39 @@ The command above:
 
 Module option is also supported.
 
+### Strategy Classes
+(See this link for typical usage: https://refactoring.guru/design-patterns/strategy/ruby/example)
+
+```sh
+bundle exec rails g strategy context strategy1 strategy2 ...
+```
+
+
+Example:
+
+```sh
+bundle exec rails g strategy fishing hook line net
+```
+
+The command above:
+
+- Creates '/app/strategies' directory if it doesnt exist.
+- Creates '/app/strategies/fishing' directory if it doesnt exist.
+- Installs new application context class in '/app/strategies' with the name 'ApplicationContext' in file '/app/strategies/application_context.rb.'.
+- Installs new application strategy class in '/app/strategies' with the name 'ApplicationStrategy' in file '/app/strategies/application_strategy.rb.'.
+- Installs new context module and class in '/app/strategies' with the class name 'Fishing::Context' in the file /app/strategies/fishing_context.rb.  This will inherit from /app/strategies/application_context.rb.'
+- Installs new strategy class in '/app/strategies/fishing' with the class name 'Fishing::FishingStrategy' in the file /app/strategies/fishing/fishing_strategy.rb.  This will inherit from /app/strategies/application_strategy.rb.'
+- Installs new strategy class in '/app/strategies/fishing' with the class name 'Fishing::HookStrategy' in the file /app/strategies/fishing/hook_strategy.rb.  This will inherit from /app/strategies/fishing/fishing_strategy.rb.'
+- Installs new strategy class in '/app/strategies/fishing' with the class name 'Fishing::LineStrategy' in the file /app/strategies/fishing/line_strategy.rb.  This will inherit from /app/strategies/fishing/fishing_strategy.rb.'
+- Installs new strategy class in '/app/strategies/fishing' with the class name 'Fishing::NetStrategy' in the file /app/strategies/fishing/net_strategy.rb.  This will inherit from /app/strategies/fishing/fishing_strategy.rb.'
+- Creates '/test/strategies' directory if it doesnt exist.
+- Creates '/test/strategies/fishing' directory if it doesnt exist.
+- Installs new test class in '/test/strategies' with the name 'FishingContext' in the file '/test/strategies/fishing_context_test.rb'.
+- Installs new test class in '/test/strategies/fishing' with the name 'FishingStrategy' in the file '/test/strategies/fishing_strategy_test.rb'.
+- Installs new test class in '/test/strategies/fishing' with the name 'HookStrategy' in the file '/test/strategies/hook_strategy_test.rb'.
+- Installs new test class in '/test/strategies/fishing' with the name 'LineStrategy' in the file '/test/strategies/line_strategy_test.rb'.
+- Installs new test class in '/test/strategies/fishing' with the name 'NetStrategy' in the file '/test/strategies/net_strategy_test.rb'.
+
+
 ## Summary
-** Nothing clever - just saves a bit of typing
+** Saves a bit of typing

data/lib/easy_gen/strategy/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/strategy/strategy_generator.rb

@@ -0,0 +1,52 @@
+require 'rails/generators'
+require 'fileutils'
+
+template_dir = File.expand_path('templates', __dir__)
+
+class StrategyGenerator < Rails::Generators::NamedBase
+  include EasyGenGenerator
+
+  # bundle exec rails g service MyService
+  # bundle exec rails d service MyService
+
+  LOCATION = "strategies"
+  TYPE = "strategy"
+
+  source_root File.expand_path("templates", __dir__)
+  argument :strategies, type: :array, default: [], banner: "strategy strategy.."
+
+
+  def main
+    copy_templates
+  end
+
+  private
+
+  def copy_templates
+    unless File.exist? "app/#{base_location}/application_#{generator_type}.rb"
+      template "application_context.rb", "app/#{base_location}/application_context.rb"
+      template "application_#{generator_type}.rb", "app/#{base_location}/application_#{generator_type}.rb"
+    end
+    template "context.rb", "app/#{location}/#{file_path}_context.rb"
+    template "context_test.rb", "test/#{location}/#{file_path}_context_test.rb"
+
+    @parent_strategy = ""
+    @strategy = class_name.camelize
+    template "#{generator_type}.rb", "app/#{location}/#{class_name.downcase}/#{class_name.downcase}_#{generator_type}.rb"
+
+    @parent_strategy = @strategy
+    strategies.each do | strategy |
+      @strategy = strategy.camelize
+      template "#{generator_type}.rb", "app/#{location}/#{class_name.downcase}/#{strategy.downcase}_#{generator_type}.rb"
+      template "#{generator_type}_test.rb", "test/#{location}/#{class_name.downcase}/#{strategy.downcase}_#{generator_type}_test.rb"
+    end
+
+    if no_files?
+      teardown ['app', 'test']
+    end
+
+    if no_files_for_module?
+      teardown ['app', 'test']
+    end
+  end
+end

data/lib/easy_gen/strategy/templates/application_context.rb.tt

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

data/lib/easy_gen/strategy/templates/application_strategy.rb.tt

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

data/lib/easy_gen/strategy/templates/context.rb.tt

@@ -0,0 +1,26 @@
+module <%= class_name %>
+  class Context < ApplicationContext
+    # The Context maintains a reference to one of the Strategy objects. The
+    # Context does not know the concrete class of a strategy. It should work with
+    # all strategies via the Strategy interface.
+    attr_writer :strategy
+
+    # Usually, the Context accepts a strategy through the constructor, but also
+    # provides a setter to change it at runtime.
+    def initialize(strategy)
+      @strategy = strategy
+    end
+
+    # Usually, the Context allows replacing a Strategy object at runtime.
+    def strategy=(strategy)
+      @strategy = strategy
+    end
+
+    # The Context delegates some work to the Strategy object instead of
+    # implementing multiple versions of the algorithm on its own.
+    def do_some_business_logic
+      # ...
+    end
+
+  end
+end

data/lib/easy_gen/strategy/templates/context_test.rb.tt

@@ -0,0 +1,11 @@
+require "test_helper"
+
+class <%= class_name %>ContextTest < ActiveSupport::TestCase
+  setup do
+    @context = <%= class_name %>::Context.new()
+  <% strategies.each do | strategy | %>
+    @<%= strategy %>_strategy = <%= class_name.camelize %>::<%= strategy.camelize %>Strategy.new()
+  <% end %>
+  end
+
+end

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

@@ -0,0 +1,5 @@
+class <%= class_name %>::<%= @strategy %>Strategy < <%= @parent_strategy.blank? ? "Application" : "#{@parent_strategy}::#{@parent_strategy}" %>Strategy
+  def call(data)
+    raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+  end
+end

data/lib/easy_gen/strategy/templates/strategy_test.rb.tt

@@ -0,0 +1,14 @@
+require "test_helper"
+
+class <%= class_name.camelize %><%= @strategy %>StrategyTest < ActiveSupport::TestCase
+  setup do
+    @strategy = <%= class_name %>::<%= @strategy.camelize %>Strategy.new()
+  end
+
+  test 'Raises <%= class_name.camelize %><%= @strategy %> not implemented' do
+    assert_raises NotImplementedError do
+      @strategy.call(0)
+    end
+  end
+
+end

data/lib/easy_gen/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_gen
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Simon Stearn
@@ -37,6 +37,14 @@ files:
 - 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/strategy/USAGE
+- lib/easy_gen/strategy/strategy_generator.rb
+- lib/easy_gen/strategy/templates/application_context.rb.tt
+- lib/easy_gen/strategy/templates/application_strategy.rb.tt
+- lib/easy_gen/strategy/templates/context.rb.tt
+- 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/version.rb
 homepage: https://rubygems.org/gems/easy_gen
 licenses: