active_operation 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: eead73f1ad502fdd329a6cd5ae6acc20306472df
-  data.tar.gz: c4adb13fbb34e04cf4895175babc9d458ff8c6bc
+SHA256:
+  metadata.gz: 0af2d62196c5a9ae917f9071afe1cc8b861929b75d9508f1f6193e8a87509f07
+  data.tar.gz: 15861fe07258fa8a11bacdc0d9c578da175070bba359122cf8446fce8958ea3e
 SHA512:
-  metadata.gz: 32c999e6bd87a939c985ea696250cf00de302fe0b7749edb07339381e1a543c4baaa54bc10b3101b0215f34f9955e9bf13d555ac581a693d276f029015ad0d82
-  data.tar.gz: ac35417f23a2a4321e11869b3c95f8a0120da18cf4b71cbae7ad22494d3eb04b8638f2d119cdaa960cb25c84de908bc63a9a3fb4b9eba736e0b385ecd8afb6fe
+  metadata.gz: a16400a73363829404d5767b189061319bb76a620af86b30af62ebf7537d90344ca7ab167cd27ad92fb1230c0779e1ab5c1ae0b32f90d4472647b490d21ecffa
+  data.tar.gz: 661062ef56212fc48c83cdd512728148c4b967bea8991f87ae60f845420eb5b851faa9b0c862a6b8a150a3af59c5cf26d2322eb729c9f077b6eedd8a2513b06f

data/.github/workflows/testing.yml

@@ -0,0 +1,26 @@
+name: Testing
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Ruby v${{ matrix.ruby_version}}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [2.6.9, 2.7.5, 3.0.3]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Konstantin Tennhard
+Copyright (c) 2016-2021 Konstantin Tennhard
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,17 +1,20 @@
 # ActiveOperation
+
 [![Gem Version](https://badge.fury.io/rb/active_operation.svg)](https://rubygems.org/gems/active_operation)
 [![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/active_operation?type=total)](https://rubygems.org/gems/active_operation)
 
 `ActiveOperation` is a micro-framework for modelling business processes.
 It is the perfect companion for any Rails application.
-The core idea behind an operation is to move code that usually would either live in a controller or a model into a dedicated object.
+The main idea behind an operation is to move code that traditionally either lives in a controller or a model into a dedicated object.
+Multiple operations can be combined into a pipeline.
+This helps with structuring large business processes and aids reusability.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'active_operation', '~> 0.1.0'
+gem 'active_operation'
 ```
 
 And then execute:
@@ -20,7 +23,7 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
+Or install it manually as:
 
 ```
 $ gem install active_operation
@@ -28,20 +31,24 @@ $ gem install active_operation
 
 ### Rails
 
-We recommend running the install generator to initialize a base operation:
+Run the the install generator to initialize a base operation:
 
 ```
 rails g active_operation:install
 ```
 
-You can also generate new operations using:
+Then generate the desired operation:
 
 ```
-rails g active_operation:operation Signup
+rails g active_operation:operation signup/create_user
 ```
 
 ## Usage
 
+We will first look at defining and using a single operation and then explore how to combine multiple operations into a pipeline.
+
+### Defining and using a single operation
+
 To define an operation, create a new class and inherit from `ActiveOperation::Base`.
 The input arguments of an operation are defined using the `input` statement.
 These statements describe the arguments the initializer takes.
@@ -76,8 +83,8 @@ end
 ```
 
 To execute an operation, instantiate it and invoke the `#call` method.
-As a result, this method will return the operation's output, which is also available through the `#output` method.
-For convenience, operations also expose a `.call` class method, which instantiates the operation, runs it and returns the its output.
+This method will return the operation's output, which is also available through the `#output` method.
+For convenience, operations also expose a `.call` class method, which instantiates the operation, runs it and returns its output.
 
 Operations go through different states during their lifecycle.
 After executing an operation, the state can be used for branching purposes.
@@ -106,17 +113,43 @@ class UsersController < ApplicationController
 end
 ```
 
+### Defining and using pipelines
+
+Continuing with the example above, given the two operations, `User::Signup` and `Email::SendWelcomeEmail`, a pipeline can be defined as follows:
+
+```ruby
+class OnboardUser < ActiveSupport::Pipeline
+  use User::Signup
+  use Email::SendWelcomeEmail
+end
+```
+
+The pipeline derives its inputs from the first operation – in this case `User::Signup`.
+Similarly, the pipeline's output is simply the output of the last operation.
+All operations beyond the first operation are expected to take its predecessors output as input.
+In the example above, `User::Signup` produces a `User` record that `Email::SendWelcomeEmail` takes as input.
+
+Pipeline themselves are operations and can therefore be invoked like any other operations.
+
+```ruby
+OnboardUser.call(email: "john@doe.com", password: "123456")
+```
+
+Furthermore, since pipelines are operations themselves, they can also be used within other pipelines.
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/t6d/active_operation.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/active_operation.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["konstantin@tennhard.net", "sebastian.szturo@gmail.com"]
 
   spec.summary       = %q{ActiveOperation is a micro-framework for modelling business processes.}
-  spec.homepage      = "https://gitub.com/t6d/active_operation"
+  spec.homepage      = "https://github.com/t6d/active_operation"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activesupport", "> 4.0"
-  spec.add_runtime_dependency "smart_properties", "~> 1.0"
+  spec.add_runtime_dependency "activesupport", "> 5.0"
+  spec.add_runtime_dependency "smart_properties", "~> 1.17"
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
 end

data/dev.yml

@@ -0,0 +1,7 @@
+---
+name: active-operation
+up:
+- ruby: 3.0.3
+- bundler
+commands:
+  test: bundle exec rake

data/lib/active_operation/base.rb

@@ -20,6 +20,37 @@ class ActiveOperation::Base
       new(*args).call
     end
 
+    def from_proc(execute)
+      Class.new(self) do
+        positional_arguments = []
+        keyword_arguments = []
+
+        execute.parameters.each do |type, name|
+          case type
+          when :req
+            input name, type: :positional, required: true
+            positional_arguments << name
+          when :keyreq
+            input name, type: :keyword, required: true
+            keyword_arguments << name
+          else
+            raise ArgumentError, "Argument type not supported: #{type}"
+          end
+        end
+
+        define_method(:execute) do
+          args = positional_arguments.map { |name| self[name] }
+          opts = keyword_arguments.map { |name| [name, self[name]] }.to_h
+
+          if opts.empty?
+            execute.call(*args)
+          else
+            execute.call(*args, **opts)
+          end
+        end
+      end
+    end
+
     def call(*args)
       perform(*args)
     end

data/lib/active_operation/matcher/execution.rb

@@ -161,6 +161,8 @@ module ActiveOperation
   end
 end
 
+require 'rspec/core' unless defined? RSpec.configure
+
 RSpec.configure do |config|
   config.include ActiveOperation::Matcher::Execution
 end

data/lib/active_operation/pipeline.rb

@@ -27,6 +27,8 @@ module ActiveOperation
       end
 
       def use(operation, options = {})
+        operation = ActiveOperation::Base.from_proc(operation) if operation.kind_of?(Proc)
+
         if operations.empty?
           inputs = operation.inputs
 

data/lib/active_operation/version.rb

@@ -1,3 +1,3 @@
 module ActiveOperation
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/active_operation.rb

@@ -1,3 +1,4 @@
+require "active_support/dependencies/autoload"
 require "active_support/callbacks"
 require "delegate"
 require "smart_properties"

data/lib/generators/active_operation/install/install_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 require 'rails/generators/active_record'
 
@@ -7,7 +8,7 @@ module ActiveOperation
       source_root File.expand_path('../../../../../support/templates', __FILE__)
 
       def create_application_operation
-        template 'application_operation.rb', 'app/operations/application_operation.rb'
+        template 'application_operation.rb.erb', 'app/operations/application_operation.rb'
       end
     end
   end

data/lib/generators/active_operation/operation/operation_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators/base'
 require 'rails/generators/active_record'
 
@@ -6,8 +7,10 @@ module ActiveOperation
     class OperationGenerator < Rails::Generators::NamedBase
       source_root File.expand_path('../../../../../support/templates', __FILE__)
 
+      hook_for :test_framework
+
       def create_operation
-        template 'operation.rb', File.join('app/operations', class_path, "#{file_name}.rb")
+        template 'operation.rb.erb', File.join('app/operations', class_path, "#{file_name}.rb")
       end
     end
   end

data/lib/generators/rspec/operation/operation_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Rspec
+  module Generators
+    class OperationGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../../../../../support/templates', __FILE__)
+
+      def copy_files
+        template 'operation_spec.rb.erb', File.join('spec/operations', class_path, "#{file_name}_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/test_unit/operation/operation_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module TestUnit
+  module Generators
+    class OperationGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../../../../../support/templates', __FILE__)
+
+      def copy_files
+        template 'operation_test.rb.erb', File.join('test/operations', class_path, "#{file_name}_test.rb")
+      end
+    end
+  end
+end

data/support/templates/{application_operation.rb → application_operation.rb.erb}

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 class ApplicationOperation < ActiveOperation::Base
 end

data/support/templates/{operation.rb → operation.rb.erb}

@@ -1,4 +1,5 @@
-class <%= name %> < ApplicationOperation
+# frozen_string_literal: true
+class <%= class_name %> < ApplicationOperation
   # input :email, accepts: String, type: :keyword, required: true
   # input :password, accepts: String, type: :keyword, required: true
   #

data/support/templates/operation_spec.rb.erb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'rails_helper'
+
+RSpec.describe <%= class_name %>, type: :operation do
+  describe "#execute" do
+    it "should be tested"
+  end
+end

data/support/templates/operation_test.rb.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>Test < ActiveSupport::TestCase
+  # test "#execute" do
+  #   # TODO
+  # end
+end
+<% end -%>

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: active_operation
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Konstantin Tennhard
 - Sebastian Szturo
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,56 +17,56 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: smart_properties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - konstantin@tennhard.net
 - sebastian.szturo@gmail.com
@@ -103,8 +103,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/testing.yml"
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -113,6 +115,7 @@ files:
 - active_operation.gemspec
 - bin/console
 - bin/setup
+- dev.yml
 - lib/active_operation.rb
 - lib/active_operation/base.rb
 - lib/active_operation/input.rb
@@ -125,13 +128,17 @@ files:
 - lib/generators/active_operation/install/install_generator.rb
 - lib/generators/active_operation/operation/USAGE
 - lib/generators/active_operation/operation/operation_generator.rb
-- support/templates/application_operation.rb
-- support/templates/operation.rb
-homepage: https://gitub.com/t6d/active_operation
+- lib/generators/rspec/operation/operation_generator.rb
+- lib/generators/test_unit/operation/operation_generator.rb
+- support/templates/application_operation.rb.erb
+- support/templates/operation.rb.erb
+- support/templates/operation_spec.rb.erb
+- support/templates/operation_test.rb.erb
+homepage: https://github.com/t6d/active_operation
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,9 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: ActiveOperation is a micro-framework for modelling business processes.
 test_files: []