rockflow 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b682fb3b2338fa9ebb7b1846778b86e9736ef499
+  data.tar.gz: 9a80879bc9d000c23fd1a2822128b8565dce1b68
+SHA512:
+  metadata.gz: 1fdf33c5dd77e323941b3b9182b4aad95f409af4cded49750de5432d5f53ac68fdfa9700b5bed97dd0dc6495509dc11f03a53b0c14e27c6fdcc8d11664201147
+  data.tar.gz: 09d19df5250fcc4f809d118cbdc6e19c514ec9761e66bb595c6efc1006fa71e8ceef3618304c5fda1d9eb0e92c0d90a61ff1f64d453d77c0cbef111dbbf3469c

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,101 @@
+# Rockflow
+
+What is rockflow? Well with rockflow you are able to define workflows (yes even parallel workflows) by writing simple small steps and aggregating them in your flow (the bigger picture... you know)
+
+Let's start the tour!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rockflow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rockflow
+
+## Usage
+
+To write your own flow you need two ingredients: the **flow** and your **steps** lets start by looking at the flow.
+
+##### Flow
+```ruby
+# app/workflows/awesome_flow.rb
+class AwesomeFlow < Rockflow::Flow
+    def setup
+        rock RockStep1
+        rock RockStep2
+        rock RockStep3, after: [RockStep1, RockStep2]
+    end
+end
+```
+Easy right? Notice that **RockStep1** and **RockStep2** will be executed parallel (so beware of thread safety and stuff). **RockStep3** will only execute if **RockStep1** and **RockStep2** are finished.
+Here is a picture.
+
+## [![](http://i.imgur.com/7BrU2kT.png)](https://qurasoft.de)
+##### Steps
+Look at my steps ... my steps are amazing...
+```ruby
+# app/steps/rock_step1.rb
+class RockStep1 < Rockflow::Step
+    def it_up
+        puts "Iam RockStep1 and i am adding something to the payload"
+        add_payload :a, 2
+    end
+end
+```
+```ruby
+# app/steps/rock_step2.rb
+class RockStep2 < Rockflow::Step
+    def it_up
+        puts "Iam RockStep2 and i am adding something to the payload"
+        add_payload :b, 2
+    end
+end
+```
+
+```ruby
+# app/steps/rock_step3.rb
+class RockStep3 < Rockflow::Step
+     def it_up
+        puts "Iam RockStep3 and i am aggregating something from the payload"
+        result = payload[:a] + payload[:b] + payload[:c]
+        puts "Result: #{result}"
+    end
+end
+```
+So now i have defined my steps and my flow but how can i execute it? Well simple just use it like this:
+
+```ruby
+flow = AwesomeFlow.new
+flow.concert! # execute all steps
+```
+
+#### Summary
+Define your flow by inheriting from **RockFlow::Flow**. Inside your defined flow override the setup method and use the **rock** keyword defined by your step class. Available options for the rock method are at the moment:
+- **after** which takes a StepClass or an array of step classes.
+
+After that start writing your steps by inheriting from **RockFlow::Step** and overriding the **it_up** method. Inside of your inherited class you can use following methods.
+
+- add_payload key, value - This method adds data that can be used across your steps inside of your flow
+- payload - This method gives you the chance to access your whole payload from your flow.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rockflow/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rockflow"
+
+# 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/rockflow/flow.rb

@@ -0,0 +1,42 @@
+module Rockflow
+  class Flow
+
+    attr_accessor :steps, :payload
+
+    def initialize(payload = {})
+      @steps = []
+      @payload = payload
+      setup
+    end
+
+    def setup
+    end
+
+    def rock(klazz, opts = {})
+      @steps << klazz.new(self, opts)
+    end
+
+    def concert!
+      while !steps_finished?
+        ::Parallel.each(next_free_steps, in_threads: 4) do |step|
+          step.it_up
+          step.finish!
+        end
+      end
+    end
+
+    def next_free_steps
+      @steps.select do |step|
+        step.after_dependencies_finished? && !step.finished?
+      end
+    end
+
+    def steps_finished?
+      @steps.inject(true) do |result, elem|
+        result = result && elem.finished?
+        result
+      end
+    end
+
+  end
+end

data/lib/rockflow/step.rb

@@ -0,0 +1,48 @@
+module Rockflow
+  class Step
+    attr_accessor :flow, :status
+
+    def initialize(flow, opts = {})
+      @flow = flow
+      @after_dependencies = []
+      @status = :not_started
+      add_after_dependencies(opts[:after])
+    end
+
+    def it_up
+    end
+
+    def payload
+      @flow.payload
+    end
+
+    def finish!
+      @status = :finished
+    end
+
+    def finished?
+      @status == :finished
+    end
+
+    def add_payload(key, value)
+      @flow.payload[key] = value
+    end
+
+    def add_after_dependencies(deps = [])
+      [deps].flatten.each do |dep|
+        @after_dependencies << dep
+      end
+    end
+
+    def after_dependencies_finished?
+      @after_dependencies.inject(true) do |result, elem|
+        dependent_steps_running = !(@flow.steps.select do |step|
+          step.class == elem && !step.finished?
+        end.any?)
+        result = result && dependent_steps_running
+        result
+      end
+    end
+
+  end
+end

data/lib/rockflow/version.rb

@@ -0,0 +1,3 @@
+module Rockflow
+  VERSION = "1.0.0"
+end

data/lib/rockflow.rb

@@ -0,0 +1,6 @@
+require 'rockflow/version'
+require 'rockflow/flow'
+require 'rockflow/step'
+require 'parallel'
+module Rockflow
+end

data/rockflow.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rockflow/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "rockflow"
+  spec.version = Rockflow::VERSION
+  spec.authors = ["Erwin Schens"]
+  spec.email = ["erwinschens@uni-koblenz.de"]
+
+  spec.summary = %q{Create workflows the easy way}
+  spec.description = %q{Rockflow allows you to define easy workflows that rock.}
+  spec.homepage = "http://qurasoft.de"
+  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_dependency 'parallel', '~> 1.6.1', '>= 1.6.1'
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rockflow
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Erwin Schens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Rockflow allows you to define easy workflows that rock.
+email:
+- erwinschens@uni-koblenz.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rockflow.rb
+- lib/rockflow/flow.rb
+- lib/rockflow/step.rb
+- lib/rockflow/version.rb
+- rockflow.gemspec
+homepage: http://qurasoft.de
+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.6
+signing_key: 
+specification_version: 4
+summary: Create workflows the easy way
+test_files: []