workflow-join 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09d63e2d8e1cc948a6cd156f826c75b8e3c0ac88
+  data.tar.gz: c6f9ef0cbfb2f147118ced9916ab77460f8bb127
+SHA512:
+  metadata.gz: 462f516b6ea0a7a980b11338668d358a46890ab157c08c1b1f7b46969a8c030ca6e94e7917ceb044ec4aa76b1b204363c8490a44fc5d73b72679e8d20228a901
+  data.tar.gz: 80b1130fd8a22d0a1baa6bb8a3574201d95bffd96b428596b7c226fb9ca65482d0a0a1c4f90330caeb7f859255be4dc67ef6fe962528ccb777891d394ddcf80e

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/.rubocop.yml

@@ -0,0 +1,60 @@
+inherit_from: .rubocop_todo.yml
+
+# Offense count: 6
+# Cop supports --auto-correct.
+# Configuration parameters: , SupportedStyles.
+# SupportedStyles: only_raise, only_fail, semantic
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 180
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 50
+
+Style/EmptyCaseCondition:
+  Exclude:
+    - 'lib/**/*'
+    - 'spec/**/*'
+
+Style/AsciiIdentifiers:
+  Exclude:
+    - 'lib/**/*'
+    - 'spec/**/*'
+
+Style/AsciiComments:
+  Exclude:
+    - 'lib/**/*'
+    - 'spec/**/*'
+
+Style/Documentation:
+  Exclude:
+    - 'lib/**/*'
+    - 'spec/**/*'
+
+Style/RaiseArgs:
+  Exclude:
+    - 'lib/**/*'
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'lib/**/*'
+    - 'spec/**/*'
+
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/**/*'
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,67 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-09-15 16:00:14 +0200 using RuboCop version 0.42.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AlignWith, SupportedStyles.
+# SupportedStyles: either, start_of_block, start_of_line
+Lint/BlockAlignment:
+  Exclude:
+    - 'lib/workflow/join.rb'
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 49
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 46
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: call, braces
+Style/LambdaCall:
+  Exclude:
+    - 'lib/workflow/join.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/workflow/join/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'spec/workflow/join_spec.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RescueModifier:
+  Exclude:
+    - 'lib/workflow/join.rb'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'bin/console'
+    - 'lib/workflow/join/version.rb'
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: snake_case, camelCase
+Style/VariableName:
+  Exclude:
+    - 'lib/workflow/join.rb'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.8
+  - 2.2.2
+  - 2.3.1
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Aleksei Matiushkin
+
+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,70 @@
+# Workflow::Join
+
+[![Build Status](https://travis-ci.org/am-kantox/workflow-join.svg?branch=master)](https://travis-ci.org/am-kantox/workflow-join)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'workflow-join'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workflow-join
+
+## Usage
+
+```ruby
+class Master
+  include Workflow
+
+  attr_accessor :slave
+
+  def initialize(*)
+    @slave = Slave.new
+  end
+
+  workflow do
+    state :meeting do
+      event :go, transitions_to: :after_meeting
+    end
+    state :after_meeting
+
+    # before entering :after_meeting state, wait for @slave to enter :resolved state
+    guard :@slave, inner: :after_meeting, outer: :resolved
+  end
+end
+
+class Slave
+  include Workflow
+
+  workflow do
+    state :unresolved do
+      event :resolve, transitions_to: :resolved
+    end
+    state :resolved
+  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/[USERNAME]/workflow-join. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,24 @@
+# encoding: UTF-8
+require 'rubygems'
+
+require 'bundler'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+desc 'Tests'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '-Ispec'
+  #  spec.rcov = true
+end
+
+task default: [:spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "workflow/join"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/workflow/join.rb

@@ -0,0 +1,94 @@
+require 'workflow'
+require 'workflow/join/version'
+
+Workflow::ClassMethods.prepend(Module.new do
+  def workflow(&specification)
+    # extend instances
+    prepend(Module.new do # this should be safe, since there could not be two subsequent workflow DSL
+      attr_reader :pending_transitions # FIXME PERSIST!!!
+      def guards!
+        λλs = spec.guards.map do |inner, outers|
+                outers.map do |getter, state|
+                  guard! inner, getter, state
+                end
+              end.flatten
+        λλs << spec.before_transition_proc if spec.before_transition_proc
+        spec.before_transition_proc = ->(from, to, name, *args) { λλs.each { |λ| λ.(from, to, name, *args) } }
+      end
+
+      def guard!(inner, getter, state)
+        slave = getter.call(self)
+        slave.instance_variable_set(:@☛, (slave.instance_variable_get(:@☛) || []) | [self])
+        slave_hook = "on_#{state}_entry".to_sym
+        slave.class.prepend(Module.new do
+          define_method slave_hook do |old_state, event, *args|
+            @☛.each do |master|
+              next unless master.pending_transitions.is_a?(Array)
+              master.pending_transitions.reject! do |transition|
+                begin
+                  master.send("#{transition}!".to_sym)
+                  true
+                rescue
+                  false # no transition no cry
+                end
+              end
+            end
+            super(old_state, event, *args) rescue nil # no super no cry
+          end
+        end)
+        lambda do |_, to, name, *|
+          if to.to_sym == inner && !slave.send("#{state}?".to_sym)
+            @pending_transitions ||= []
+            @pending_transitions |= [name]
+            halt("Waiting for guard workflow to enter “:#{state}” state")
+          end
+        end
+      end
+    end)
+
+    # extend singleton class to update guards in constructor
+    singleton_class.prepend(Module.new do
+      def new(*)
+        super.tap(&:guards!)
+      end
+    end)
+
+    super
+  end
+end)
+
+module Workflow
+  module Join
+    GUARD_PARAMS_ERROR = 'Either guard instance variable name or a code block is required'.freeze
+    GUARD_POINTCUT_ERROR = 'Both :inner and :outer states are required'.freeze
+    GUARD_IS_NOT_WORKFLOW = 'Guard given must be a workflow instance'.freeze
+
+    def guards
+      @guards ||= {}
+    end
+
+    def guard(getter = nil, inner: nil, outer: nil)
+      fail Workflow::WorkflowDefinitionError, GUARD_PARAMS_ERROR unless !getter.nil? ^ block_given?
+      fail Workflow::WorkflowDefinitionError, GUARD_POINTCUT_ERROR unless inner && outer
+
+      guard = if block_given?
+                Proc.new
+              else
+                g = getter.to_sym
+                lambda do |host|
+                  case
+                  when /\A@/ =~ g.to_s && host.instance_variable_defined?(g)
+                    host.instance_variable_get(g)
+                  when host.methods.include?(g) && host.method(g).arity.zero?
+                    host.send g
+                  end.tap do |guard_instance|
+                    fail Workflow::WorkflowDefinitionError, GUARD_IS_NOT_WORKFLOW unless guard_instance.is_a?(Workflow)
+                  end
+                end
+              end
+      (guards[inner.to_sym] ||= []) << [guard, outer.to_sym]
+    end
+  end
+end
+
+Workflow::Specification.prepend Workflow::Join

data/lib/workflow/join/version.rb

@@ -0,0 +1,5 @@
+module Workflow
+  module Join
+    VERSION = "0.1.1"
+  end
+end

data/workflow-join.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workflow/join/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'workflow-join'
+  spec.version       = Workflow::Join::VERSION
+  spec.authors       = ['Aleksei Matiushkin']
+  spec.email         = ['aleksei.matiushkin@kantox.com']
+
+  spec.summary       = 'Extension to workflow gem providing join functionality for workflows.'
+  spec.description   = 'Workflow extension that allows to fork workflows with other workflows and join them at specific states.'
+  spec.homepage      = 'https://github.com/am-kantox/workflow-join'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+
+  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_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'workflow', '~> 1.2'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: workflow-join
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Aleksei Matiushkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: workflow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Workflow extension that allows to fork workflows with other workflows
+  and join them at specific states.
+email:
+- aleksei.matiushkin@kantox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/workflow/join.rb
+- lib/workflow/join/version.rb
+- workflow-join.gemspec
+homepage: https://github.com/am-kantox/workflow-join
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Extension to workflow gem providing join functionality for workflows.
+test_files: []