light-service 0.11.0 → 0.16.0

data/RELEASES.md

@@ -1,5 +1,26 @@
 A brief list of new features and changes introduced with the specified version.
 
+### 0.16.0
+* [Drop Ruby 2.4 support](https://github.com/adomokos/light-service/pull/207)
+* [Fix callback current action](https://github.com/adomokos/light-service/pull/209)
+* [Add Context accessors](https://github.com/adomokos/light-service/pull/211)
+* [Switched to GH Actions from Travis CI](https://github.com/adomokos/light-service/pull/212)
+
+### 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
+
+### 0.13.0
+* [Add 'add_to_context' and 'add_aliases'](https://github.com/adomokos/light-service/pull/172) - Updating Ruby compatibility, minor fixes
+
+### 0.12.0
+* [Per organizer logger](https://github.com/adomokos/light-service/pull/162)
+* [Fix 'fail_and_return!' not accepting 'error_code' option](https://github.com/adomokos/light-service/pull/168)
+
 ### 0.11.0
 * [Switch to 'each_with_object' in WithReducer](https://github.com/adomokos/light-service/pull/149).
 

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_3.gemfile → activesupport_6.gemfile}

@@ -2,7 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "~> 3.0"
-gem "appraisal", "~> 2.0"
+gem "activesupport", "~> 6.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.rb

@@ -1,4 +1,5 @@
 require 'logger'
+require 'active_support/core_ext/string'
 
 require 'light-service/version'
 

data/lib/light-service/action.rb

@@ -44,6 +44,9 @@ module LightService
             catch(:jump_when_failed) do
               call_before_action(action_context)
               yield(action_context)
+
+              # Reset the stored action in case it was changed downstream
+              action_context.current_action = self
               call_after_action(action_context)
             end
           end

data/lib/light-service/context.rb

@@ -8,7 +8,7 @@ module LightService
 
   # rubocop:disable ClassLength
   class Context < Hash
-    attr_accessor :message, :error_code, :current_action
+    attr_accessor :message, :error_code, :current_action, :organized_by
 
     def initialize(context = {},
                    outcome = Outcomes::SUCCESS,
@@ -18,6 +18,7 @@ module LightService
       @message = message
       @error_code = error_code
       @skip_remaining = false
+
       context.to_hash.each { |k, v| self[k] = v }
     end
 
@@ -88,7 +89,7 @@ module LightService
 
     def fail_and_return!(*args)
       fail!(*args)
-      throw(:jump_when_failed, *args)
+      throw(:jump_when_failed)
     end
 
     def fail_with_rollback!(message = nil, error_code = nil)
@@ -114,9 +115,11 @@ module LightService
     end
 
     def define_accessor_methods_for_keys(keys)
-      return if keys.nil?
-      keys.each do |key|
+      return if keys.blank?
+
+      Array(keys).each do |key|
         next if respond_to?(key.to_sym)
+
         define_singleton_method(key.to_s) { fetch(key) }
         define_singleton_method("#{key}=") { |value| self[key] = value }
       end
@@ -161,6 +164,7 @@ module LightService
 
     def check_nil(value)
       return 'nil' unless value
+
       "'#{value}'"
     end
   end

data/lib/light-service/context/key_verifier.rb

@@ -111,7 +111,24 @@ module LightService
       end
 
       def reserved_keys
-        %i[message error_code current_action].freeze
+        %i[message error_code current_action organized_by].freeze
+      end
+    end
+
+    class ReservedKeysViaOrganizerVerifier < ReservedKeysVerifier
+      def initialize(context_data)
+        @context = LightService::Context.make(context_data)
+      end
+
+      def violated_keys
+        context.keys.map(&:to_sym) & reserved_keys
+      end
+
+      def error_message
+        <<~ERR
+          reserved keys cannot be added to the context
+          reserved key: [#{format_keys(violated_keys)}]
+        ERR
       end
     end
   end