light-service 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10ae707b6938f2898615668928728eb8e562fb9ed2f0ecf17e50deff76226a44
-  data.tar.gz: c870f719d663dd1aec96d895196f57b2caaae1cb9e61d073bd5fcef7ce33cff5
+  metadata.gz: f400829da41766f56e7f0cb9cfe95aa028ef8ab34bf0bc5794bfafcff3cdcfb1
+  data.tar.gz: 41dbd504ac39a0804eb445b4af086dbcf9986264077994277e17fde98b7bdc3d
 SHA512:
-  metadata.gz: 3062b1c4d10519f2f60c527ecedee3647d13c85419e5ad38db7ec7046b0cba68b122d044a1045724bc034c64d6e3b4afc3482cfa9bb8a87ee77ef5f847e0e728
-  data.tar.gz: c240aec3f4244f7ebb17f06c98e21c03495c1718d34dafcd862209fc95323bde27db6e9144e38ad285d0b83b2182713d5d1690dc43f28c95b591dd9d56aec7b7
+  metadata.gz: e9a1148b82b6e1a0813400b0d23b013ff6f06965f3204bb3fa95101adc8a749223dd334887f7543622b4a829fd17f190c21dd5f601df3aecde8d8451459a76af
+  data.tar.gz: f0aec690e94896dcc13d6caa774003e49ddfa6b74c5acf9272fb7b9d3710d28db4a29601e725e3729deba820013c62b740739d5c6052c4c5ae93fd885cec6fda

data/.travis.yml

@@ -20,7 +20,6 @@ script:
   - bundle exec rubocop
 
 gemfile:
-  - gemfiles/activesupport_3.gemfile
   - gemfiles/activesupport_4.gemfile
   - gemfiles/activesupport_5.gemfile
   - gemfiles/activesupport_6.gemfile

data/Appraisals

@@ -1,7 +1,3 @@
-appraise "activesupport-3" do
-  gem "activesupport", "~> 3.0"
-end
-
 appraise "activesupport-4" do
   gem "activesupport", "~> 4.0"
 end

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in light_service.gemspec
 gemspec
-
-gem 'appraisal', '~> 2.0'

data/README.md

@@ -2,11 +2,12 @@
 
 [![Gem Version](https://img.shields.io/gem/v/light-service.svg)](https://rubygems.org/gems/light-service)
 [![Build Status](https://secure.travis-ci.org/adomokos/light-service.svg)](http://travis-ci.org/adomokos/light-service)
+[![codecov](https://codecov.io/gh/adomokos/light-service/branch/master/graph/badge.svg)](https://codecov.io/gh/adomokos/light-service)
 [![Code Climate](https://codeclimate.com/github/adomokos/light-service.svg)](https://codeclimate.com/github/adomokos/light-service)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
 [![Download Count](https://ruby-gem-downloads-badge.herokuapp.com/light-service?type=total)](https://rubygems.org/gems/light-service)
 
-<br><br>
+<br>
 
 ![Orchestrators-Deprecated](resources/orchestrators_deprecated.svg)
 <br>Version 0.9.0 deprecates Orchestrators and moves all their functionalities into Organizers. Please check out [this PR](https://github.com/adomokos/light-service/pull/132) to see the changes.
@@ -15,6 +16,11 @@
 
 ## Table of Content
 * [Why LightService?](#why-lightservice)
+* [Getting Started](#getting-started)
+    * [Requirements](#requirements)
+    * [Installation](#installation)
+    * [Your first action](#your-first-action)
+    * [Your first organizer](#your-first-organizer)
 * [Stopping the Series of Actions](#stopping-the-series-of-actions)
     * [Failing the Context](#failing-the-context)
     * [Skipping the Rest of the Actions](#skipping-the-rest-of-the-actions)
@@ -27,7 +33,7 @@
 * [Localizing Messages](#localizing-messages)
 * [Orchestrator Logic in Organizers](#orchestrator-logic-in-organizers)
 * [ContextFactory for Faster Action Testing](#contextfactory-for-faster-action-testing)
-
+* [Rails support](#rails-support)
 
 ## Why LightService?
 
@@ -175,7 +181,143 @@ end
 I gave a [talk at RailsConf 2013](http://www.adomokos.com/2013/06/simple-and-elegant-rails-code-with.html) on
 simple and elegant Rails code where I told the story of how LightService was extracted from the projects I had worked on.
 
+## Getting started
+
+### Requirements
+
+This gem requires ruby 2.x. Use of [generators](#rails-support) requires Rails 5+ (tested on Rails 5.x & 6.x only. Will probably work on
+Rails versions as old as 3.2)
+
+### Installation
+
+In your Gemfile:
+
+```ruby
+gem 'light-service'
+```
+
+And then
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install light-service
+```
+
+### Your first action
+
+LightService's building blocks are actions that are normally composed within an organizer, but can be run independently.
+Let's make a simple greeter action. Each action can take an optional list of expected inputs and promised outputs. If
+these are specified and missing at action start and stop respectively, an exception will be thrown.
+
+```ruby
+class GreetsPerson
+  extend ::LightService::Action
+
+  expects :name
+  promises :greeting
+
+  executed do |context|
+    context.greeting = "Hey there, #{name}. You enjoying LightService so far?"
+  end
+end
+```
 
+When an action is run, you have access to its returned context, and the status of the action. You can invoke an
+action by calling `.execute` on its class with `key: value` arguments, and inspect its status and context like so:
+
+```ruby
+outcome = GreetsPerson.execute(name: "Han")
+
+if outcome.success?
+  puts outcome.greeting # which was a promised context value
+elsif outcome.failure?
+  puts "Rats... I can't say hello to you"
+end
+```
+
+You will notice that actions are set up to promote simplicity, i.e. they either succeed or fail, and they have
+very clear inputs and outputs. Ideally, they should do [exactly one thing](https://en.wikipedia.org/wiki/Single-responsibility_principle). This makes them as easy to test as unit tests.
+
+### Your first organizer
+
+LightService provides a facility to compose actions using organizers. This is great when you have a business process
+to execute that has multiple steps. By composing actions that do exactly one thing, you can sequence simple
+actions together to perform complex multi-step business processes in a clear manner that is very easy
+to reason about.
+
+There are advanced ways to sequence actions that can be found later in the README, but we'll keep this simple for now.
+First, let's add a second action that we can sequence to run after the `GreetsPerson` action from above:
+
+```ruby
+class RandomlyAwardsPrize
+  extend ::LightService::Action
+
+  expects :name, :greeting
+  promises :did_i_win
+
+  executed do |context|
+    prize_num  = "#{context.name}__#{context.greeting}".length
+    prizes     = ["jelly beans", "ice cream", "pie"]
+    did_i_win  = rand((1..prize_num)) % 7 == 0
+    did_i_lose = rand((1..prize_num)) % 13 == 0
+
+    if did_i_lose
+      # When failing, send a message as an argument, readable from the return context
+      context.fail!("you are exceptionally unlucky")
+    else
+      # You can specify 'optional' context items by treating context like a hash.
+      # Useful for when you may or may not be returning extra data. Ideally, selecting
+      # a prize should be a separate action that is only run if you win.
+      context[:prize]   = "lifetime supply of #{prizes.sample}" if did_i_win
+      context.did_i_win = did_i_win
+    end
+  end
+end
+```
+
+And here's the organizer that ties the two together. You implement a `call` class method that takes some arguments and
+from there sends them to `with` in `key: value` format which forms the initial state of the context. From there, chain
+`reduce` to `with` and send it a list of action class names in sequence. The organizer will call each action, one
+after the other, and build up the context as it goes along.
+
+```ruby
+class WelcomeAPotentiallyLuckyPerson
+  extend LightService::Organizer
+
+  def self.call(name)
+    with(:name => name).reduce(GreetsPerson, RandomlyAwardsPrize)
+  end
+end
+```
+
+When an organizer is run, you have access to the context as it passed through all actions, and the overall status
+of the organized execution. You can invoke an organizer by calling `.call` on the class with the expected arguments,
+and inspect its status and context just like you would an action:
+
+```ruby
+outcome = WelcomeAPotentiallyLuckyPerson.call("Han")
+
+if outcome.success?
+  puts outcome.greeting # which was a promised context value
+
+  if outcome.did_i_win
+    puts "And you've won a prize! Lucky you. Please see the front desk for your #{outcome.prize}."
+  end
+else # outcome.failure? is true, and we can pull the failure message out of the context for feedback to the user.
+  puts "Rats... I can't say hello to you, because #{outcome.message}."
+end
+```
+
+Because organizers generally run through complex business logic, and every action has the potential to cause a failure,
+testing an organizer is functionally equivalent to an integration test.
+
+For further examples, please visit the project's [Wiki](https://github.com/adomokos/light-service/wiki) and review
+the ["Why LightService" section](#why-lightservice) above.
 
 ## Stopping the Series of Actions
 When nothing unexpected happens during the organizer's call, the returned `context` will be successful. Here is how you can check for this:
@@ -857,28 +999,52 @@ This context then can be passed to the action under test, freeing you up from th
 
 In case your organizer has more logic in its `call` method, you could create your own test organizer in your specs like you can see it in this [acceptance test](spec/acceptance/testing/context_factory_spec.rb#L4-L11). This is reusable in all your action tests.
 
-## Requirements
+## Rails support
+
+LightService includes Rails generators for creating both Organizers and Actions along with corresponding tests. Currently only RSpec is
+supported ([PR's for supporting MiniTest are welcome](https://github.com/adomokos/light-service/pulls))
 
-This gem requires ruby 2.x
+Note: Generators are namespaced to `light_service` not `light-service` due to Rake name constraints.
 
-## Installation
-Add this line to your application's Gemfile:
+### Organizer generation
 
-    gem 'light-service'
+```shell
+rails generate light_service:organizer My::SuperFancy::Organizer
+# -- or
+rails generate light_service:organizer my/super_fancy/organizer
+```
 
-And then execute:
+Options for this generator are:
 
-    $ bundle
+* `--dir=<SOME_DIR>`. `<SOME_DIR>` defaults to `organizers`. Will write organizers to `/app/organizers`, and specs to `/spec/organizers`
+* `--no-tests`. Default is `--tests`. Will generate a test file matching the namespace you've supplied.
 
-Or install it yourself as:
+### Action generation
+
+```shell
+rails generate light_service:action My::SuperFancy::Action
+# -- or
+rails generate light_service:action my/super_fancy/action
+```
+
+Options for this generator are:
 
-    $ gem install light-service
+* `--dir=<SOME_DIR>`. `<SOME_DIR>` defaults to `actions`. Will write actions to `/app/actions`, and specs to `/spec/actions`
+* `--no-tests`. Defaults is `--tests`. Will generate a test file matching the namespace you've supplied.
+* `--no-roll-back`. Default is `--roll-back`. Will generate a `rolled_back` block for you to implement with [roll back functionality](#action-rollback).
+
+### Advanced action generation
+
+You are able to optionally specify `expects` and/or `promises` keys during generation
+
+```shell
+rails generate light_service:action CrankWidget expects:one_fish,two_fish promises:red_fish,blue_fish
+```
 
-## Usage
-Based on the refactoring example above, just create an organizer object that calls the
-actions in order and write code for the actions. That's it.
+When specifying `expects`, convenience variables will be initialized in the `executed` block so that you don't have to call
+them through the context. A stub context will be created in the test file using these keys too.
 
-For further examples, please visit the project's [Wiki](https://github.com/adomokos/light-service/wiki).
+When specifying `promises`, specs will be created testing for their existence after executing the action.
 
 ## Contributing
 1. Fork it

data/RELEASES.md

@@ -1,5 +1,11 @@
 A brief list of new features and changes introduced with the specified version.
 
+### 0.15.0
+* [Add Rails Generators](https://github.com/adomokos/light-service/pull/194) - LightService actions and organizers can be generated with generators
+* [Add CodeCov](https://github.com/adomokos/light-service/pull/195) - Upload code coverage report to codecov.io
+* [Remove ActiveSupport 3 checks](https://github.com/adomokos/light-service/pull/197) - They are unsupported, no need to tests them any more.
+
+
 ### 0.14.0
 * [Add 'organized_by' to context](https://github.com/adomokos/light-service/pull/192) - Context now have an #organized_by attribute
 

data/gemfiles/activesupport_4.gemfile

@@ -3,6 +3,5 @@
 source "https://rubygems.org"
 
 gem "activesupport", "~> 4.0"
-gem "appraisal", "~> 2.0"
 
 gemspec :path => "../"

data/gemfiles/activesupport_5.gemfile

@@ -3,6 +3,5 @@
 source "https://rubygems.org"
 
 gem "activesupport", "~> 5.0"
-gem "appraisal", "~> 2.0"
 
 gemspec :path => "../"

data/gemfiles/activesupport_6.gemfile

@@ -3,6 +3,5 @@
 source "https://rubygems.org"
 
 gem "activesupport", "~> 6.0"
-gem "appraisal", "~> 2.0"
 
 gemspec :path => "../"

data/lib/generators/light_service/action_generator.rb

@@ -0,0 +1,90 @@
+require_relative './generator_utils'
+
+module LightService
+  module Generators
+    class ActionGenerator < Rails::Generators::Base
+      include GeneratorUtils
+
+      argument :name, :type => :string
+      argument :keys,
+               :type => :hash,
+               :default => { "expects" => '', "promises" => '' },
+               :banner => "expects:one,thing promises:something,else"
+
+      class_option :dir,
+                   :type => :string,
+                   :default => "actions",
+                   :desc => "Path to write actions to"
+
+      class_option :tests,
+                   :type => :boolean,
+                   :default => true,
+                   :desc => "Generate tests (currently only RSpec supported)"
+
+      class_option :roll_back,
+                   :type => :boolean,
+                   :default => true,
+                   :desc => "Add a roll back block"
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc <<~DESCRIPTION
+        Description:
+          Will create the boilerplate for an action. Pass it an action name, e.g.
+            foo_bar, or FooBar   - will create FooBar in app/actions/foo_bar.rb
+            foo/bar, or Foo::Bar - will create Foo::Bar in app/actions/foo/bar.rb
+
+        Expects & Promises:
+          Specify a list of expected context keys by passing expects and a comma separated
+          list of keys. Adds keys to the `expects` list, creates convenience variables in
+          the action, and generates a stub context in generated specs.
+
+            expects:foo,bar,baz
+
+          Specify promised context keys in the same manner as 'expects' above. This adds
+          keys to the `promises` list, and creates stub expectations in generated specs.
+
+            promises:quux,quark
+
+        Options:
+          Skip rspec test creation with --no-tests
+          Skip ActionRollback creation with --no-roll-back
+          Write actions to a specified dir with --dir="services". Default is "actions" in app/actions
+
+        Full Example:
+          rails g light_service:action My::Awesome::Action expects:foo,bar promises:baz,qux
+      DESCRIPTION
+
+      # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      def create_action
+        gen_vals = create_required_gen_vals_from(name)
+
+        @module_path     = gen_vals[:module_path]
+        @class_name      = gen_vals[:class_name]
+        @full_class_name = gen_vals[:full_class_name]
+        @expects         = keys["expects"].to_s.downcase.split(',')
+        @promises        = keys["promises"].to_s.downcase.split(',')
+
+        file_name = gen_vals[:file_name]
+        file_path = gen_vals[:file_path]
+
+        root_dir    = options.dir.downcase
+        action_dir  = File.join('app', root_dir, *file_path)
+        action_file = "#{action_dir}/#{file_name}"
+
+        make_nested_dir(action_dir)
+        template("action_template.erb", action_file)
+
+        return unless must_gen_tests?
+
+        spec_dir       = File.join('spec', root_dir, *file_path)
+        spec_file_name = gen_vals[:spec_file_name]
+        spec_file      = "#{spec_dir}/#{spec_file_name}"
+
+        make_nested_dir(spec_dir)
+        template("action_spec_template.erb", spec_file)
+      end
+      # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
+    end
+  end
+end

data/lib/generators/light_service/generator_utils.rb

@@ -0,0 +1,45 @@
+module LightService
+  module Generators
+    module GeneratorUtils
+      def make_nested_dir(dir)
+        FileUtils.mkdir_p(dir)
+      end
+
+      def supported_test_frameworks
+        %i[rspec]
+      end
+
+      def test_framework_supported?
+        supported_test_frameworks.include? test_framework
+      end
+
+      # Don't know a better way to get to this value, unfortunately.
+      def test_framework
+        # Rails.application.config.generators.options[:rails][:test_framework]
+        # When/if Minitest is supported, this will need to be updated to detect
+        # the selected test framework, and switch templates accordingly
+        :rspec
+      end
+
+      def must_gen_tests?
+        options.tests? && test_framework_supported?
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def create_required_gen_vals_from(name)
+        path_parts = name.underscore.split('/')
+
+        {
+          :path_parts => path_parts,
+          :file_path => path_parts.reverse.drop(1).reverse,
+          :module_path => path_parts.reverse.drop(1).reverse.join('/').classify,
+          :class_name => path_parts.last.classify,
+          :file_name => "#{path_parts.last}.rb",
+          :spec_file_name => "#{path_parts.last}_spec.rb",
+          :full_class_name => name.classify
+        }
+      end
+      # rubocop:enable Metrics/AbcSize
+    end
+  end
+end

data/lib/generators/light_service/organizer_generator.rb

@@ -0,0 +1,66 @@
+require_relative './generator_utils'
+
+module LightService
+  module Generators
+    class OrganizerGenerator < Rails::Generators::Base
+      include GeneratorUtils
+
+      argument :name, :type => :string
+
+      class_option :dir,
+                   :type => :string,
+                   :default => "organizers",
+                   :desc => "Path to write organizers to"
+
+      class_option :tests,
+                   :type => :boolean,
+                   :default => true,
+                   :desc => "Generate tests (currently only RSpec supported)"
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc <<~DESCRIPTION
+        Description:
+          Will create the boilerplate for an organizer. Pass it an organizer name, e.g.
+            thing_maker, or ThingMaker   - will create ThingMaker in app/organizers/thing_maker.rb
+            thing/maker, or Thing::Maker - will create Thing::Maker in app/organizers/thing/maker.rb
+
+        Options:
+          Skip rspec test creation with --no-tests
+          Write organizers to a specified dir with --dir="workflows". Default is "organizers" in app/organizers
+
+        Full Example:
+          rails g light_service:organizer My::Awesome::Organizer
+      DESCRIPTION
+
+      # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+      def create_organizer
+        gen_vals = create_required_gen_vals_from(name)
+
+        @module_path     = gen_vals[:module_path]
+        @class_name      = gen_vals[:class_name]
+        @full_class_name = gen_vals[:full_class_name]
+
+        file_name = gen_vals[:file_name]
+        file_path = gen_vals[:file_path]
+
+        root_dir       = options.dir.downcase
+        organizer_dir  = File.join('app', root_dir, *file_path)
+        organizer_file = "#{organizer_dir}/#{file_name}"
+
+        make_nested_dir(organizer_dir)
+        template("organizer_template.erb", organizer_file)
+
+        return unless must_gen_tests?
+
+        spec_dir       = File.join('spec', root_dir, *file_path)
+        spec_file_name = gen_vals[:spec_file_name]
+        spec_file      = "#{spec_dir}/#{spec_file_name}"
+
+        make_nested_dir(spec_dir)
+        template("organizer_spec_template.erb", spec_file)
+      end
+      # rubocop:enable Metrics/MethodLength,Metrics/AbcSize
+    end
+  end
+end

data/lib/generators/light_service/templates/action_spec_template.erb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe <%= @full_class_name %>, type: :action do
+  subject { described_class.execute(ctx) }
+
+  let(:ctx) do
+    {
+    <%- if @expects.any? -%>
+    <%- @expects.each do |key| -%>
+      <%= key %>: nil,
+    <%- end -%>
+    <%- end -%>
+    }
+  end
+
+  context "when executed" do
+    xit "is expected to be successful" do
+      expect(subject).to be_a_success
+    end
+    <%- if @promises.any? -%>
+    <%- @promises.each do |key| -%>
+
+    xit "is expected to promise '<%= key %>'" do
+      expect(subject.<%= key %>).to eq Some<%= key.classify %>Class
+    end
+    <%- end -%>
+    <%- end -%>
+  end
+end

data/lib/generators/light_service/templates/action_template.erb

@@ -0,0 +1,30 @@
+<%- indent = !@module_path.empty? ? '  ' : '' -%>
+# frozen_string_literal: true
+
+<%= "module #{@module_path}\n" unless @module_path.empty? -%>
+<%= "#{indent}class #{@class_name}" %>
+  <%= indent %>extend ::LightService::Action
+
+  <%- if @expects.any? -%>
+  <%= indent %>expects  <%= @expects.map { |k| ":#{k}" }.join(', ') %>
+  <%- end -%>
+  <%- if @promises.any? -%>
+  <%= indent %>promises <%= @promises.map { |k| ":#{k}" }.join(', ') %>
+  <%- end -%>
+  <%- if (@expects + @promises).any? -%>
+
+  <%- end -%>
+  <%= indent %>executed do |ctx|
+    <%- if @expects.any? -%>
+    <%- @expects.each do |key| -%>
+    <%= indent %><%= key %> = ctx.<%= key %>
+    <%- end -%>
+    <%- end -%>
+  <%= indent %>end
+  <%- if options.roll_back -%>
+
+  <%= indent %>rolled_back do |ctx|
+  <%= indent %>end
+  <%- end -%>
+<%= indent %>end
+<%= 'end' unless @module_path.empty? -%>

data/lib/generators/light_service/templates/organizer_spec_template.erb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe <%= @full_class_name %>, type: :organizer do
+  subject { described_class.call(ctx) }
+
+  let(:ctx) do
+    {
+      #foo: 'something foo',
+      #bar: { baz: qux },
+    }
+  end
+
+  context "when called" do
+    xit "is expected to be successful" do
+      expect(subject).to be_a_success
+    end
+  end
+end

data/lib/generators/light_service/templates/organizer_template.erb

@@ -0,0 +1,22 @@
+<%- indent = !@module_path.empty? ? '  ' : '' -%>
+# frozen_string_literal: true
+
+<%= "module #{@module_path}\n" unless @module_path.empty? -%>
+<%= "#{indent}class #{@class_name}" %>
+  <%= indent %>extend ::LightService::Organizer
+
+  <%= indent %>def self.call(params)
+  <%= indent %>  with(
+  <%= indent %>    #foo: params[:foo],
+  <%= indent %>    #bar: params[:bar]
+  <%= indent %>  ).reduce(actions)
+  <%= indent %>end
+
+  <%= indent %>def self.actions
+  <%= indent %>  [
+  <%= indent %>    #<%= "#{@module_path}::" if @module_path.present? %>OneAction,
+  <%= indent %>    #<%= "#{@module_path}::" if @module_path.present? %>TwoAction,
+  <%= indent %>  ]
+  <%= indent %>end
+<%= indent %>end
+<%= 'end' unless @module_path.empty? -%>

data/lib/light-service/version.rb

@@ -1,3 +1,3 @@
 module LightService
-  VERSION = "0.14.0".freeze
+  VERSION = "0.15.0".freeze
 end

data/light-service.gemspec

@@ -18,8 +18,12 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency("activesupport", ">= 3.0.0")
 
+  gem.add_development_dependency("generator_spec", "~> 0.9.4")
+  gem.add_development_dependency("test-unit", "~> 3.0") # Needed for generator specs.
+  gem.add_development_dependency("appraisal", "~> 2.3")
   gem.add_development_dependency("rspec", "~> 3.0")
   gem.add_development_dependency("simplecov", "~> 0.17")
+  gem.add_development_dependency("codecov", "~> 0.1")
   gem.add_development_dependency("rubocop", "~> 0.68.0")
   gem.add_development_dependency("rubocop-performance", "~> 1.2.0")
   gem.add_development_dependency("pry", "~> 0.12.2")

data/spec/lib/generators/action_generator_advanced_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+require_relative '../../../lib/generators/light_service/action_generator.rb'
+require_relative './full_generator_test_blobs'
+
+describe LightService::Generators::ActionGenerator, :type => :generator do
+  destination File.expand_path('tmp', __dir__)
+
+  context "when generating an advanced action" do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    after(:all) do
+      FileUtils.rm_rf destination_root
+    end
+
+    arguments %w[
+      my/fancy/action
+      expects:foo,bar
+      promises:baz,qux
+      --no-roll-back
+      --dir=services
+    ]
+
+    specify do
+      expect(destination_root).to(have_structure do
+        directory "app/services/my/fancy" do
+          file "action.rb" do
+            contains FullGeneratorTestBlobs.advanced_action_blob
+          end
+        end
+
+        directory "spec/services/my/fancy" do
+          file "action_spec.rb" do
+            contains FullGeneratorTestBlobs.advanced_action_spec_blob
+          end
+        end
+      end)
+    end
+  end
+end

data/spec/lib/generators/action_generator_simple_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+require_relative '../../../lib/generators/light_service/action_generator.rb'
+require_relative './full_generator_test_blobs'
+
+describe LightService::Generators::ActionGenerator, :type => :generator do
+  destination File.expand_path('tmp', __dir__)
+
+  context "when generating a simple action" do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    after(:all) do
+      FileUtils.rm_rf destination_root
+    end
+
+    arguments %w[my_action]
+
+    specify do
+      expect(destination_root).to(have_structure do
+        directory "app/actions" do
+          file "my_action.rb" do
+            contains FullGeneratorTestBlobs.simple_action_blob
+          end
+        end
+
+        directory "spec/actions" do
+          file "my_action_spec.rb" do
+            contains FullGeneratorTestBlobs.simple_action_spec_blob
+          end
+        end
+      end)
+    end
+  end
+end

data/spec/lib/generators/full_generator_test_blobs.rb

@@ -0,0 +1,193 @@
+# rubocop:disable Metrics/ClassLength, Metrics/MethodLength
+class FullGeneratorTestBlobs
+  def self.simple_action_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      class MyAction
+        extend ::LightService::Action
+
+        executed do |ctx|
+        end
+
+        rolled_back do |ctx|
+        end
+      end
+    BLOB
+  end
+
+  def self.simple_action_spec_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      require 'rails_helper'
+
+      RSpec.describe MyAction, type: :action do
+        subject { described_class.execute(ctx) }
+
+        let(:ctx) do
+          {
+          }
+        end
+
+        context "when executed" do
+          xit "is expected to be successful" do
+            expect(subject).to be_a_success
+          end
+        end
+      end
+    BLOB
+  end
+
+  # There's some weird whitespace issue which prevents
+  # using HEREDOCS :(
+  def self.advanced_action_blob
+    "# frozen_string_literal: true\n" \
+      "\n" \
+      "module My::Fancy\n" \
+      "  class Action\n" \
+      "    extend ::LightService::Action\n" \
+      "\n" \
+      "    expects  :foo, :bar\n" \
+      "    promises :baz, :qux\n" \
+      "\n" \
+      "    executed do |ctx|\n" \
+      "      foo = ctx.foo\n" \
+      "      bar = ctx.bar\n" \
+      "    end\n" \
+      "  end\n" \
+      "end"
+  end
+
+  def self.advanced_action_spec_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      require 'rails_helper'
+
+      RSpec.describe My::Fancy::Action, type: :action do
+        subject { described_class.execute(ctx) }
+
+        let(:ctx) do
+          {
+            foo: nil,
+            bar: nil,
+          }
+        end
+
+        context "when executed" do
+          xit "is expected to be successful" do
+            expect(subject).to be_a_success
+          end
+
+          xit "is expected to promise 'baz'" do
+            expect(subject.baz).to eq SomeBazClass
+          end
+
+          xit "is expected to promise 'qux'" do
+            expect(subject.qux).to eq SomeQuxClass
+          end
+        end
+      end
+    BLOB
+  end
+
+  def self.simple_organizer_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      class MyOrganizer
+        extend ::LightService::Organizer
+
+        def self.call(params)
+          with(
+            #foo: params[:foo],
+            #bar: params[:bar]
+          ).reduce(actions)
+        end
+
+        def self.actions
+          [
+            #OneAction,
+            #TwoAction,
+          ]
+        end
+      end
+    BLOB
+  end
+
+  def self.simple_organizer_spec_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      require 'rails_helper'
+
+      RSpec.describe MyOrganizer, type: :organizer do
+        subject { described_class.call(ctx) }
+
+        let(:ctx) do
+          {
+            #foo: 'something foo',
+            #bar: { baz: qux },
+          }
+        end
+
+        context "when called" do
+          xit "is expected to be successful" do
+            expect(subject).to be_a_success
+          end
+        end
+      end
+    BLOB
+  end
+
+  def self.advanced_organizer_blob
+    "# frozen_string_literal: true\n" \
+      "\n" \
+      "module My::Fancy\n" \
+      "  class Organizer\n" \
+      "    extend ::LightService::Organizer\n" \
+      "\n" \
+      "    def self.call(params)\n" \
+      "      with(\n" \
+      "        #foo: params[:foo],\n" \
+      "        #bar: params[:bar]\n" \
+      "      ).reduce(actions)\n" \
+      "    end\n" \
+      "\n" \
+      "    def self.actions\n" \
+      "      [\n" \
+      "        #My::Fancy::OneAction,\n" \
+      "        #My::Fancy::TwoAction,\n" \
+      "      ]\n" \
+      "    end\n" \
+      "  end\n" \
+      "end"
+  end
+
+  def self.advanced_organizer_spec_blob
+    <<~BLOB
+      # frozen_string_literal: true
+
+      require 'rails_helper'
+
+      RSpec.describe My::Fancy::Organizer, type: :organizer do
+        subject { described_class.call(ctx) }
+
+        let(:ctx) do
+          {
+            #foo: 'something foo',
+            #bar: { baz: qux },
+          }
+        end
+
+        context "when called" do
+          xit "is expected to be successful" do
+            expect(subject).to be_a_success
+          end
+        end
+      end
+    BLOB
+  end
+end
+# rubocop:enable Metrics/ClassLength, Metrics/MethodLength

data/spec/lib/generators/organizer_generator_advanced_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+require_relative '../../../lib/generators/light_service/organizer_generator.rb'
+require_relative './full_generator_test_blobs'
+
+describe LightService::Generators::OrganizerGenerator, :type => :generator do
+  destination File.expand_path('tmp', __dir__)
+
+  context "when generating an advanced organizer" do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    after(:all) do
+      FileUtils.rm_rf destination_root
+    end
+
+    arguments %w[my/fancy/organizer --dir=processes]
+
+    specify do
+      expect(destination_root).to(have_structure do
+        directory "app/processes/my/fancy" do
+          file "organizer.rb" do
+            contains FullGeneratorTestBlobs.advanced_organizer_blob
+          end
+        end
+
+        directory "spec/processes/my/fancy" do
+          file "organizer_spec.rb" do
+            contains FullGeneratorTestBlobs.advanced_organizer_spec_blob
+          end
+        end
+      end)
+    end
+  end
+end

data/spec/lib/generators/organizer_generator_simple_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+require_relative '../../../lib/generators/light_service/organizer_generator.rb'
+require_relative './full_generator_test_blobs'
+
+describe LightService::Generators::OrganizerGenerator, :type => :generator do
+  destination File.expand_path('tmp', __dir__)
+
+  context "when generating a simple organizer" do
+    before(:all) do
+      prepare_destination
+      run_generator
+    end
+
+    after(:all) do
+      FileUtils.rm_rf destination_root
+    end
+
+    arguments %w[my_organizer]
+
+    specify do
+      expect(destination_root).to(have_structure do
+        directory "app/organizers" do
+          file "my_organizer.rb" do
+            contains FullGeneratorTestBlobs.simple_organizer_blob
+          end
+        end
+
+        directory "spec/organizers" do
+          file "my_organizer_spec.rb" do
+            contains FullGeneratorTestBlobs.simple_organizer_spec_blob
+          end
+        end
+      end)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,8 +8,10 @@ if ENV['RUN_COVERAGE_REPORT']
     add_filter 'vendor/'
     add_filter %r{^/spec/}
   end
-
   SimpleCov.minimum_coverage_by_file 90
+
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
 end
 
 require 'light-service'
@@ -19,5 +21,7 @@ require 'pry'
 require 'support'
 require 'test_doubles'
 require 'stringio'
+require 'fileutils'
+require 'generator_spec'
 
 I18n.enforce_available_locales = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Attila Domokos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -112,10 +168,16 @@ files:
 - README.md
 - RELEASES.md
 - Rakefile
-- gemfiles/activesupport_3.gemfile
 - gemfiles/activesupport_4.gemfile
 - gemfiles/activesupport_5.gemfile
 - gemfiles/activesupport_6.gemfile
+- lib/generators/light_service/action_generator.rb
+- lib/generators/light_service/generator_utils.rb
+- lib/generators/light_service/organizer_generator.rb
+- lib/generators/light_service/templates/action_spec_template.erb
+- lib/generators/light_service/templates/action_template.erb
+- lib/generators/light_service/templates/organizer_spec_template.erb
+- lib/generators/light_service/templates/organizer_template.erb
 - lib/light-service.rb
 - lib/light-service/action.rb
 - lib/light-service/configuration.rb
@@ -179,6 +241,11 @@ files:
 - spec/action_spec.rb
 - spec/context/inspect_spec.rb
 - spec/context_spec.rb
+- spec/lib/generators/action_generator_advanced_spec.rb
+- spec/lib/generators/action_generator_simple_spec.rb
+- spec/lib/generators/full_generator_test_blobs.rb
+- spec/lib/generators/organizer_generator_advanced_spec.rb
+- spec/lib/generators/organizer_generator_simple_spec.rb
 - spec/localization_adapter_spec.rb
 - spec/organizer/with_reducer_spec.rb
 - spec/organizer_key_aliases_spec.rb
@@ -258,6 +325,11 @@ test_files:
 - spec/action_spec.rb
 - spec/context/inspect_spec.rb
 - spec/context_spec.rb
+- spec/lib/generators/action_generator_advanced_spec.rb
+- spec/lib/generators/action_generator_simple_spec.rb
+- spec/lib/generators/full_generator_test_blobs.rb
+- spec/lib/generators/organizer_generator_advanced_spec.rb
+- spec/lib/generators/organizer_generator_simple_spec.rb
 - spec/localization_adapter_spec.rb
 - spec/organizer/with_reducer_spec.rb
 - spec/organizer_key_aliases_spec.rb

data/gemfiles/activesupport_3.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "activesupport", "~> 3.0"
-gem "appraisal", "~> 2.0"
-
-gemspec :path => "../"