action-plan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa0d0f2855aba5c8ff65e52284a7cfc6545dbae2
+  data.tar.gz: c2c638d88dec6b7410f891631946acdf8630e9a9
+SHA512:
+  metadata.gz: 2e27e4fe2fa1bbdef3ab99475d37123709d3755b499ff2ed725007596fff6e242909fe58b0895efc4e9603c09bd568bbd53144d6412c107d2129966ab45547a0
+  data.tar.gz: 3a3111387638adb9365893a184695eb300e5cab80787a3fa479a6ee6c3b3bc6bf0fd4542b479a524e5e25ff06a359c3e7da1b28257494cbbe8afe6eb6e191ad6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--format html
+--out tmp/rspec_results.html

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in action-plan.gemspec
+gemspec
+
+# fixes https://github.com/guard/guard/issues/833
+gem 'rb-inotify', github: 'e2/rb-inotify', branch: 'misc_bugfixes'

data/Guardfile

@@ -0,0 +1,19 @@
+directories %w(lib spec config)
+
+guard_rspec_options = {
+  cmd: "bin/rspec",
+  title: "Action::State",
+  failed_mode: :focus,
+  all_after_pass: true
+}
+
+guard :rspec, guard_rspec_options do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Artem Baguinski
+
+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,41 @@
+# Action::Plan
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/action/plan`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action-plan'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install action-plan
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/action-plan.
+
+
+## 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/action-plan.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action/plan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action-plan"
+  spec.version       = Action::Plan::VERSION
+  spec.authors       = ["Artem Baguinski"]
+  spec.email         = ["abaguinski@depraktijkindex.nl"]
+
+  spec.summary       = %q{Plan and eventually execute actions}
+  spec.homepage      = "https://github.com/artm/action-plan"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+
+  spec.add_dependency "activesupport", "> 4.0"
+  spec.add_dependency "wisper", "~> 2.0.0.rc1"
+end

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler", "bundler")

data/bin/coderay

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("coderay", "coderay")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "action/plan"
+
+# 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/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/launchy

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'launchy' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("launchy", "launchy")

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/listen

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'listen' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("listen", "listen")

data/bin/pry

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("pry", "pry")

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/bin/thor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'thor' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("thor", "thor")

data/config/Guardfile

@@ -0,0 +1,19 @@
+directories %w(lib spec config)
+
+guard_rspec_options = {
+  cmd: "bin/rspec",
+  title: "Action::State",
+  failed_mode: :focus,
+  all_after_pass: true
+}
+
+guard :rspec, guard_rspec_options do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/lib/action/base.rb

@@ -0,0 +1,50 @@
+require "wisper"
+require "active_support/configurable"
+
+module Action
+  class Base
+    include ActiveSupport::Configurable
+    include Wisper::Publisher
+
+    def configure
+      yield config if block_given?
+      self
+    end
+
+    # default implementation
+    # plan arg is a planning DSL
+    def plan plan
+      plan.myself if respond_to?(:run)
+    end
+
+    # plan arg is an Action::Plan instance
+    def expand_into plan:
+      plan PlanningDSL.new(plan: plan, action: self)
+    end
+
+    class PlanningDSL
+      def initialize plan:, action:
+        @plan = plan
+        @action = action
+      end
+
+      def myself
+        @plan.schedule_action(@action.class, @action.config)
+      end
+
+      def action action_class, &block
+        @plan.plan_action(action_class, &block)
+      end
+    end
+
+    protected
+
+    def todo= total
+    end
+
+    def done= count
+    end
+  end
+
+  class Error < RuntimeError ; end
+end

data/lib/action/plan.rb

@@ -0,0 +1,101 @@
+require "json"
+require "wisper"
+require "action/plan/version"
+require "action/state"
+
+module Action
+  class Plan
+    include Wisper::Publisher
+
+    def initialize
+      @schedule = []
+      yield DSL.new(self) if block_given?
+    end
+
+    def run &block
+      raise NotRunnable, "#{status} plan can't be run" unless runnable?
+      schedule.each do |state|
+        next if state.status == :done
+        action = state.create_action
+        state.on(:status_changed) do |state, new_status, old_status|
+          broadcast :plan_state_changed, self, state, new_status, old_status
+        end
+        action.on(:progress) do |done, total|
+          broadcast :action_progress, self, action, done, total
+        end
+        run_action action, state, &block
+        break unless state.status == :done
+      end
+    end
+
+    def action_states
+      schedule.dup
+    end
+
+    def status
+      Action::State.sequence_status(schedule.map(&:status))
+    end
+
+    RunnableStatuses = [:planned, :failed, :empty]
+    def runnable?
+      RunnableStatuses.include?(status)
+    end
+
+    def to_json *options
+      {
+        JSON.create_id => self.class.name,
+        schedule: schedule
+      }.to_json(*options)
+    end
+
+    def self.json_create hash_plan
+      schedule = hash_plan["schedule"].map{|h| Action::State.new(h)}
+      Action::Plan.new.tap{ |plan|
+        plan.instance_variable_set(:@schedule, schedule)
+      }
+    end
+
+    def == other
+      self.class == other.class && schedule == other.action_states
+    end
+
+    class DSL
+      def initialize plan
+        @plan = plan
+      end
+
+      def action *args, &block
+        @plan.plan_action *args, &block
+        self
+      end
+    end
+
+    class Error < RuntimeError ; end
+    class NotRunnable < Error ; end
+
+    # let action plan itself
+    def plan_action action_class, &block
+      action_class.new.configure(&block).expand_into(plan: self)
+    end
+
+    # schedule action execution at the current point in the plan
+    def schedule_action action_class, config
+      new_state = Action::State.new(action_class: action_class, config: config)
+      schedule << new_state
+      new_state.status = :planned
+    end
+
+    private
+
+    attr_reader :schedule
+
+    def run_action action, state
+      state.status = :running
+      action.run
+      state.status = :done
+    rescue Exception => e
+      state.status = :failed
+      broadcast :action_failure, self, action, e
+    end
+  end
+end

data/lib/action/plan/version.rb

@@ -0,0 +1,5 @@
+module Action
+  class Plan
+    VERSION = "0.1.0"
+  end
+end

data/lib/action/state.rb

@@ -0,0 +1,50 @@
+require "wisper"
+require "active_support/ordered_hash"
+require "active_support/core_ext/hash"
+require "active_support/core_ext/string/inflections"
+
+module Action
+  class State
+    include Wisper::Publisher
+    attr_accessor :status
+
+    def initialize options = {}
+      options = options.symbolize_keys
+      @action_class = options[:action_class]
+      @action_class = @action_class.constantize if String === @action_class
+      @config = options.fetch(:config, ActiveSupport::OrderedHash.new)
+      @status = options.fetch(:status, :initial).to_sym
+    end
+
+    def create_action
+      @action_class.new.configure do |config|
+        config.replace(@config)
+        config.freeze
+      end
+    end
+
+    def to_json *options
+      to_h.to_json(*options)
+    end
+
+    def to_h
+      {
+        action_class: @action_class.name,
+        config: @config,
+        status: @status,
+      }
+    end
+
+    def == other
+      self.class == other.class && self.to_h == other.to_h
+    end
+
+    def status= new_status
+      old_status = @status
+      @status = new_status
+      broadcast :status_changed, self, new_status, old_status
+      @status
+    end
+  end
+end
+require "action/state/class_methods"

data/lib/action/state/class_methods.rb

@@ -0,0 +1,36 @@
+module Action
+  class State
+    module ClassMethods
+      def sequence_status sequence
+        chunks = sequence.chunk{|status|status}
+        statuses = chunks.map(&:first)
+        chunks = chunks.map(&:last)
+        current = nil
+        case chunks.count
+        when 0
+          return :empty
+        when 1
+          status = statuses.first
+          return status if [:done, :planned].include?(status)
+          current = 0
+        when 2
+          current = if statuses.first == :done
+                      1
+                    elsif statuses.last == :planned
+                      0
+                    end
+        when 3
+          current = 1 if statuses.first == :done && statuses.last == :planned
+        end
+        if current
+          status = statuses[current]
+          if [:failed, :running].include?(status) && chunks[current].length == 1
+            return status
+          end
+        end
+        :invalid
+      end
+    end
+    extend ClassMethods
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: action-plan
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artem Baguinski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !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: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.rc1
+description: 
+email:
+- abaguinski@depraktijkindex.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action-plan.gemspec
+- bin/_guard-core
+- bin/bundler
+- bin/coderay
+- bin/console
+- bin/guard
+- bin/htmldiff
+- bin/launchy
+- bin/ldiff
+- bin/listen
+- bin/pry
+- bin/rake
+- bin/rspec
+- bin/setup
+- bin/thor
+- config/Guardfile
+- lib/action/base.rb
+- lib/action/plan.rb
+- lib/action/plan/version.rb
+- lib/action/state.rb
+- lib/action/state/class_methods.rb
+homepage: https://github.com/artm/action-plan
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Plan and eventually execute actions
+test_files: []