active_operation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38af3fab295c23cd57429dc1f481b5aee13a8bcc
+  data.tar.gz: c3c4bc019d611d19a35d15ab48e6e8268e168785
+SHA512:
+  metadata.gz: 923a98f234f74a0cd9b73a5d648b7aa062fa958043fbfd4c080841106fd9db258c96b4abc93b432f5471042226c56e086ab3a83e6dd1243ee0f9878b37ab1a70
+  data.tar.gz: 940a102d89f627796988ae5ea1e01ac4af5ee75fd73a764289f681c1f3f7655a56e81c41c064cbcf1af052ff391673ab011ebe360c4c0651126a91f489e981f1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_operation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# ActiveOperation
+
+`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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_operation', '~> 0.1.0'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install active_operation
+```
+
+## Usage
+
+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.
+All arguments are accessible through reader and writer methods.
+`ActiveOperation` uses `SmartProperties` to provide this feature.
+More information on the available configuration options can be found in the project [README](https://github.com/t6d/smart_properties).
+
+Every operation must implement the `#execute` method, which describes its core functionality.
+Additionally, operations support the following callbacks: `before`, `around`, `after`, `succeeded`, `halted`, `error`.
+The callback mechanism utilizes `ActiveSupport::Callbacks`.
+Thus, everything known from Rails is applicable for operation callbacks, too.
+
+```ruby
+# app/operations/user/signup.rb
+class User::Signup < ActiveOperation::Base
+  input :email, accepts: String, type: :keyword, required: true
+  input :password, accepts: String, type: :keyword, required: true
+
+  before do
+    user = User.find_by(email: email)
+    halt user unless user.nil?
+  end
+
+  def execute
+    User.create!(email: email, password: password)
+  end
+
+  succeeded do
+    Email::SendWelcomeMail.perform(output)
+  end
+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.
+
+Operations go through different states during their lifecycle.
+After executing an operation, the state can be used for branching purposes.
+In the example below, the operation's state is used to decide wether to redirect to the `user_path` or to re-render the `new` page.
+
+```ruby
+# app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  def create
+    signup = User::Signup.new(**signup_params)
+    @user = signup.call
+
+    if signup.succeeded?
+      redirect_to user_path(@user)
+    else
+      flash[:error] = "Could not create user"
+      render :new
+    end
+  end
+
+  private
+
+  def signup_params
+    params.permit(:email, :password)
+  end
+end
+```
+
+## 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.
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_operation.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_operation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_operation"
+  spec.version       = ActiveOperation::VERSION
+  spec.authors       = ["Konstantin Tennhard", "Sebastian Szturo"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_operation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/active_operation.rb

@@ -0,0 +1,11 @@
+require "active_support/callbacks"
+require "smart_properties"
+
+module ActiveOperation
+  class Error < RuntimeError; end
+  class AlreadyCompletedError < Error; end
+end
+
+require "active_operation/version"
+require "active_operation/input"
+require "active_operation/base"

data/lib/active_operation/base.rb

@@ -0,0 +1,155 @@
+class ActiveOperation::Base
+  include SmartProperties
+  include ActiveSupport::Callbacks
+
+  attr_accessor :output
+  attr_accessor :error
+
+  property :state, accepts: [:initialized, :halted, :succeeded, :failed], required: true, default: :initialized
+  protected :state=
+
+  define_callbacks :execute
+  define_callbacks :error, scope: [:name]
+  define_callbacks :succeeded, scope: [:name]
+  define_callbacks :halted, scope: [:name]
+
+  class << self
+    def call(*args)
+      new(*args).call
+    end
+
+    def inputs
+      []
+    end
+
+    protected
+
+    def input(name, type: :positional, **configuration)
+      property(name, type: type, **configuration)
+    end
+
+    def property(name, type: :keyword,  **configuration)
+      @inputs ||= []
+
+      if type == :positional
+        @inputs << ActiveOperation::Input.new(type: :positional, property: super(name, required: true, **configuration))
+      else
+        @inputs << ActiveOperation::Input.new(type: :keyword, property: super(name, **configuration))
+      end
+    end
+
+    def before(*args, &callback)
+      set_callback(:execute, :before, *args, &callback)
+    end
+
+    def around(*args, &callback)
+      set_callback(:execute, :around, *args, &callback)
+    end
+
+    def after(*args, &callback)
+      set_callback(:execute, :after, *args, &callback)
+    end
+
+    def error(*args, &callback)
+      set_callback(:error, :after, *args, &callback)
+    end
+
+    def succeeded(*args, &callback)
+      set_callback(:succeeded, :after, *args, &callback)
+    end
+
+    def halted(*args, &callback)
+      set_callback(:halted, :after, *args, &callback)
+    end
+
+    private
+
+    def method_added(method)
+      super
+      protected method if method == :execute
+    end
+
+    def inherited(subclass)
+      subclass.define_singleton_method(:inputs) do
+        superclass.inputs + Array(@inputs)
+      end
+    end
+  end
+
+  around do |operation, callback|
+    catch(:abort) do
+      callback.call
+    end
+  end
+
+  def initialize(*positional_arguments, **keyword_arguments)
+    expected_positional_arguments = self.class.inputs.select(&:positional?)
+
+    raise ArgumentError, "wrong number of arguments" if positional_arguments.length != expected_positional_arguments.length
+
+    super(
+      keyword_arguments.merge(
+        expected_positional_arguments.zip(positional_arguments).map { |input, value| [input.name, value] }.to_h
+      )
+    )
+  end
+
+  def call
+    run_callbacks :execute do
+      catch(:abort) do
+        next if completed?
+        @output = execute
+        self.state = :succeeded
+      end
+    end
+
+    run_callbacks :halted if halted?
+    run_callbacks :succeeded if succeeded?
+
+    self.output
+  rescue => error
+    self.state = :failed
+    self.error = error
+    run_callbacks :error
+    raise
+  end
+
+  def output
+    call unless self.completed?
+    @output
+  end
+
+  def halted?
+    state == :halted
+  end
+
+  def succeeded?
+    state == :succeeded
+  end
+
+  def completed?
+    halted? || succeeded?
+  end
+
+  protected
+
+  def execute
+    raise NotImplementedError
+  end
+
+  def halt(*args)
+    raise ActiveOperation::AlreadyCompletedError if completed?
+
+    self.state = :halted
+    @output = args.length > 1 ? args : args.first
+    throw :abort
+  end
+
+  def succeed(*args)
+    raise ActiveOperation::AlreadyCompletedError if completed?
+
+    self.state = :succeeded
+    @output = args.length > 1 ? args : args.first
+    throw :abort
+  end
+end

data/lib/active_operation/input.rb

@@ -0,0 +1,18 @@
+class ActiveOperation::Input
+  include SmartProperties
+
+  property :type, accepts: [:positional, :keyword], required: true
+  property :property, accepts: SmartProperties::Property, required: true
+
+  def positional?
+    type == :positional
+  end
+
+  def keyword?
+    type == :keyword
+  end
+
+  def name
+    property.name
+  end
+end

data/lib/active_operation/version.rb

@@ -0,0 +1,3 @@
+module ActiveOperation
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: active_operation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Konstantin Tennhard
+- Sebastian Szturo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: smart_properties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- konstantin@tennhard.net
+- sebastian.szturo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_operation.gemspec
+- bin/console
+- bin/setup
+- lib/active_operation.rb
+- lib/active_operation/base.rb
+- lib/active_operation/input.rb
+- lib/active_operation/version.rb
+homepage: https://gitub.com/t6d/active_operation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveOperation is a micro-framework for modelling business processes.
+test_files: []