Add support for gem consumer custom templates

.rubocop.yml

@@ -29,10 +29,10 @@ Lint:
 
 Metrics/BlockLength:
   Exclude:
-    - '**/*.gemspec'
-    - '**/*.rake'
-    - 'Rakefile'
-    - 'spec/**/*.rb'
+    - "**/*.gemspec"
+    - "**/*.rake"
+    - "Rakefile"
+    - "spec/**/*.rb"
 
 RSpec:
   Language:
@@ -48,4 +48,8 @@ RSpec/NestedGroups:
 
 Style/BlockDelimiters:
   Exclude:
-    - 'spec/**/*'
+    - "spec/**/*"
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - lib/generators/onesie/templates/template.rb

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Added `.DS_Store` to `.gitignore`
 - Added support for Rails > 5
+- Added support for custom templates
 
 ### Changed
 - Switch `colorize` gem for `rainbow`

doc/how_to_guides/usage.md

@@ -16,10 +16,12 @@ be achieved with either the Rails generator or the Rake task
 #### API
 ```
 Usage:
-  rails generate onesie:task NAME PRIORITY [options]
+  rails generate onesie:task NAME [options]
 
 Options:
   [--skip-namespace], [--no-skip-namespace]  # Skip namespace (affects only isolated applications)
+  [--priority] # Specify a priority that the onesie should run as
+  [--template] # Specify a custom template for generating the onesie
 
 Runtime options:
   -f, [--force]                    # Overwrite files that already exist
@@ -31,22 +33,25 @@ Runtime options:
 
 #### Examples
 ```bash
-bundle exec rails generate onesie:task MyTask      # creates a normal priority task
-bundle exec rails generate onesie:task MyTask high # creates a high priority task
+bundle exec rails generate onesie:task MyTask                                           # creates a normal priority task
+bundle exec rails generate onesie:task MyTask --priority high                           # creates a high priority task
+bundle exec rails generate onesie:task MyTask --template SampleTemplate                 # creates a onesie using a custom template called SampleTemplate
+bundle exec rails generate onesie:task MyTask --priority high --template SampleTemplate # creates a onesie specifying both priority and the custom template
 ```
 
 ### Rake
 
 #### API
 ```bash
-rake onesie:new[name,priority]         # Generates a new Onesie Task
+rake onesie:new[name,priority,template]         # Generates a new Onesie Task
 ```
 
 #### Examples
 
 ```bash
 bundle exec rake onesie:new['MyTask']        # creates a normal priority task
 bundle exec rake onesie:new['MyTask','high'] # creates a high priority task
+bundle exec rake onesie:new['MyTask','high','SampleTemplate'] # creates a high priority task using 'SampleTemplate'
 ```
 
 ## Write your Onesie Task

lib/generators/onesie/task_generator.rb

@@ -9,7 +9,14 @@ class TaskGenerator < Rails::Generators::NamedBase
       desc 'Generate a new Onesie Task'
       source_root File.expand_path('./templates', __dir__)
 
+      class_option :priority, type: :string, default: nil
+      PRIORITY_ARG = 0
+
+      class_option :template, type: :string, default: nil
+      TEMPLATE_ARG = 1
+
       TEMPLATE_FILENAME = 'task.rb'
+      DEFAULT_TEMPLATE = '# Write your Onesie Task here'
 
       def create_task
         template(TEMPLATE_FILENAME, filename, class_name: class_name)
@@ -21,10 +28,28 @@ def filename
         "#{Onesie::Manager.tasks_path}/#{task_version}_#{file_name}#{task_priority}.rb"
       end
 
+      def run_contents
+        read_template || DEFAULT_TEMPLATE
+      end
+
+      def read_template
+        return unless custom_template
+
+        Onesie::TemplateReader.read_template(custom_template_path)
+      end
+
+      def custom_template_path
+        Rails.root.join('onesie', 'templates', "#{custom_template.underscore}.rb")
+      end
+
       def task_priority
-        return unless args[0]
+        return unless (priority = options.priority || args[PRIORITY_ARG])
+
+        ".#{priority}"
+      end
 
-        ".#{args[0]}"
+      def custom_template
+        options.template || args[TEMPLATE_ARG]
       end
 
       def task_version

lib/generators/onesie/template_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module Onesie
+  module Generators
+    # Generates a new Onesie template
+    class TemplateGenerator < Rails::Generators::NamedBase
+      desc 'Generate a new Onesie template'
+      source_root File.expand_path('./templates', __dir__)
+
+      TEMPLATE_FILENAME = 'template.rb'
+
+      def create_template
+        template(TEMPLATE_FILENAME, filename)
+      end
+
+      private
+
+      def filename
+        "onesie/templates/#{file_name}.rb"
+      end
+    end
+  end
+end

lib/generators/onesie/templates/task.rb

@@ -7,7 +7,7 @@ class <%= class_name %> < Onesie::Task
       manual_task enabled: false
 
       def run
-        # Write your Onesie Task here
+<%= run_contents.chomp.indent(8) %>
       end
     end
   end

lib/generators/onesie/templates/template.rb

@@ -0,0 +1 @@
+# Write the contents of Onesie::Tasks#run here!

lib/onesie.rb

@@ -11,6 +11,7 @@
 require_relative 'onesie/task_proxy'
 require_relative 'onesie/task_record'
 require_relative 'onesie/task_wrapper'
+require_relative 'onesie/template_reader'
 require_relative 'onesie/version'
 
 module Onesie

lib/onesie/tasks/onesie.rake

@@ -8,12 +8,23 @@ namespace :onesie do
 
   # bundle exec rake onesie:new['MyTask']
   # bundle exec rake onesie:new['MyTask','high']
+  # bundle exec rake onesie:new['MyTask','high','ExampleTemplateName']
+  # bundle exec rake onesie:new['MyTask',,'ExampleTemplateName']
   desc 'Generates a new Onesie Task'
-  task :new, [:name, :priority] do |_t, args|
+  task :new, [:name, :priority, :template] do |_t, args|
     name = args.fetch(:name)
     priority = args.fetch(:priority, nil)
+    task_template = args.fetch(:template, nil)
 
-    Rails::Generators.invoke('onesie:task', [name, priority])
+    Rails::Generators.invoke('onesie:task', [name, priority, task_template])
+  end
+
+  # bundle exec rake onesie:new_template['ExampleTemplateName']
+  desc 'Generates a new Onesie Template'
+  task :new_template, [:filename] do |_t, args|
+    filename = args.fetch(:filename)
+
+    Rails::Generators.invoke('onesie:template', [filename])
   end
 
   # bundle exec rake onesie:rerun

lib/onesie/template_reader.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+using Rainbow
+
+module Onesie
+  # Responsible for loading custom template files
+  class TemplateReader
+    def self.read_template(path)
+      unless File.exist?(path)
+        puts "Custom Template could not be found at #{path}".red
+        return
+      end
+
+      File.read(path)
+    end
+  end
+end

spec/onesie/generators/task_generator_spec.rb

@@ -5,14 +5,45 @@
 
 RSpec.describe Onesie::Generators::TaskGenerator, type: :generator do
   destination File.expand_path('../../../tmp', __dir__)
-  arguments %w[TestTask]
 
   before do
-    prepare_destination
-    run_generator
+    allow(Rails).to receive(:root).and_return(Pathname.new('.'))
   end
 
-  it 'creates a new task file' do
-    assert_migration 'onesie/tasks/test_task.rb', /class TestTask < Onesie::Task/
+  context 'when only task name is specified' do
+    arguments %w[TestTask]
+
+    it 'creates a new task file with default template' do
+      allow(Onesie::TemplateReader).to receive(:read_template).and_return(nil)
+
+      prepare_destination
+      run_generator
+
+      assert_migration 'onesie/tasks/test_task.rb', /class TestTask < Onesie::Task/
+      assert_migration 'onesie/tasks/test_task.rb', /# Write your Onesie Task here/
+    end
+  end
+
+  context 'when template file is specified' do
+    arguments ['TestTask', nil, 'example_task']
+
+    it 'creates a new task file with the template file inside #run' do
+      allow(Onesie::TemplateReader).to receive(:read_template).and_return('# sample custom content')
+
+      prepare_destination
+      run_generator
+
+      assert_migration 'onesie/tasks/test_task.rb', /class TestTask < Onesie::Task/
+      assert_migration 'onesie/tasks/test_task.rb', /# sample custom content/
+    end
+  end
+
+  context 'when template file does not exist' do
+    it 'gracefully reverts to default template' do
+      prepare_destination
+      run_generator
+
+      assert_migration 'onesie/tasks/test_task.rb', /# Write your Onesie Task here/
+    end
   end
 end

spec/onesie/generators/template_generator_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'generator_spec'
+require 'generators/onesie/template_generator'
+
+RSpec.describe Onesie::Generators::TemplateGenerator, type: :generator do
+  destination File.expand_path('../../../tmp', __dir__)
+  arguments %w[ExampleTemplate]
+
+  before do
+    prepare_destination
+    run_generator
+  end
+
+  it 'creates a new template file' do
+    path = 'tmp/onesie/templates/example_template.rb'
+    expect(File.exist?(path)).to be(true)
+
+    contents = File.read(path)
+
+    expect(contents).to eq("# Write the contents of Onesie::Tasks#run here!\n")
+  end
+end