abid 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea0a29c738c86aebaf241507a7b0acab89dc3cf7
+  data.tar.gz: c708d6813dae9bd21cd8e1c2d4396d3a055dc50f
+SHA512:
+  metadata.gz: 845024d893bf17650b189eabb90280840827f3e03910fb61e76c35e0446bceb9755ce8d79c46397aa0245ac26c54ecbc6c78bc98172594a2304bf850e35ff25d
+  data.tar.gz: 3e18c50195b334d8bebb1137ff45417198ae57466a3ef50aad14d630c23467bb423572047e9f1647f16ae3a14e9245fae9764479b4cb6bdf5c43002c2178485d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.0
+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 abid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Hikaru Ojima
+
+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,89 @@
+# Abid
+
+Abid is a simple Workflow Engine based on Rake.
+
+## Installation
+
+1. Install abid gem.
+
+    Add this line to your application's Gemfile:
+
+    ```ruby
+    gem 'abid'
+    ```
+
+    And then execute:
+
+        $ bundle
+
+    Or install it yourself as:
+
+        $ gem install abid
+
+    After installed execute:
+
+2. Setup a database.
+
+        $ bundle exec abid db:migrate
+
+## Usage
+
+Abid is an extention of rake, so you can use any rake syntax.
+
+First, you must write a “Abidfile” file which contains the tasks:
+
+```ruby
+require 'open-uri'
+
+task default: 'count'
+
+play :fetch_source do
+  param :date, type: :date
+
+  def run
+    mkdir 'out'
+    open('http://example.com') do |f|
+      File.write("out/#{date.strftime('%Y-%m-%d')}/example.com", f.read)
+    end
+  end
+end
+
+play :count do
+  param :date, type: :date
+
+  def setup
+    needs 'fetch_source', date: date
+  end
+
+  def run
+    puts File.read("out/#{date.strftime('%Y-%m-%d')}/example.com").lines.length
+  end
+end
+```
+
+Then you can invoke the task:
+
+```
+$ bundle exec abid count date=2016-01-01
+```
+
+This Abidfile has two tasks: `fetch_source` and `count`. They can be treated as a normal rake task, but they have some additional features:
+
+* A play can take parameters. They are declared with `param` keyword, and passed via environment variables.
+* All play results are saved to the external database. If a play is invoked twice with same parameters, it will be ignored.
+* Depending tasks can be declared in `setup` method. If a depending task is a play task, parameters can be passed.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/ojima-h/abid. 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,32 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+
+namespace :db do
+  desc 'Run migrations'
+  task :migrate, [:version] do |_t, args|
+    require 'sqlite3'
+    require 'sequel'
+
+    database_url = 'sqlite://' + File.expand_path('../tmp/abid.db', __FILE__)
+    migrations_path = File.expand_path('../migrations', __FILE__)
+
+    require 'sequel'
+    Sequel.extension :migration
+    db = Sequel.connect(database_url)
+    if args[:version]
+      puts "Migrating to version #{args[:version]}"
+      Sequel::Migrator.run(db, migrations_path, target: args[:version].to_i)
+    else
+      puts 'Migrating to latest'
+      Sequel::Migrator.run(db, migrations_path)
+    end
+  end
+end

data/abid.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'abid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "abid"
+  spec.version       = Abid::VERSION
+  spec.authors       = ["Hikaru Ojima"]
+  spec.email         = ["amijo4rihaku@gmail.com"]
+
+  spec.summary       = "Abid is a simple Workflow Engine based on Rake."
+  spec.description   = "Abid is a simple Workflow Engine based on Rake."
+  spec.homepage      = "https://github.com/ojima-h/abid"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|sample)/}) }
+  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 "minitest"
+
+  spec.add_dependency "rake", "~> 10.0"
+  spec.add_dependency "concurrent-ruby-ext"
+  spec.add_dependency "inifile"
+  spec.add_dependency "sequel"
+  spec.add_dependency "sqlite3"
+  spec.add_dependency "rbtree"
+end

data/bin/console

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

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'abid'
+
+Abid::Application.new.run

data/lib/Abidfile.rb

@@ -0,0 +1,80 @@
+namespace :state do
+  task default: :list
+
+  desc 'Show play histories'
+  play :list do
+    set :volatile, true
+
+    param :started_after, type: :time, default: nil
+    param :started_before, type: :time, default: nil
+
+    def run
+      states = Abid::State.list(
+        started_after: started_after,
+        started_before: started_before
+      )
+
+      table = states.map do |state|
+        params = state[:params].map do |k, v|
+          v.to_s =~ /\s/ ? "#{k}='#{v}'" : "#{k}=#{v}"
+        end.join(' ')
+        [
+          state[:id].to_s,
+          state[:state].to_s,
+          state[:name],
+          params,
+          state[:start_time].to_s,
+          state[:end_time].to_s
+        ]
+      end
+
+      header = %w(id state name params start_time end_time)
+
+      tab_width = header.each_with_index.map do |c, i|
+        [c.length, table.map { |row| row[i].length }.max || 0].max
+      end
+
+      header.each_with_index do |c, i|
+        print c.ljust(tab_width[i] + 2)
+      end
+      puts
+
+      header.each_with_index do |_, i|
+        print '-' * (tab_width[i] + 2)
+      end
+      puts
+
+      table.map do |row|
+        row.each_with_index do |v, i|
+          print v.ljust(tab_width[i] + 2)
+        end
+        puts
+      end
+    end
+  end
+end
+
+namespace :db do
+  desc 'Delete play history'
+  task :revoke, [:task] do |_t, args|
+    task = Rake.application[args[:task]]
+    state = Abid::State.find(task)
+    state.revoke
+  end
+
+  desc 'Run migrations'
+  task :migrate, [:version] do |_t, args|
+    migrations_path = File.expand_path('../../migrations', __FILE__)
+
+    require 'sequel'
+    Sequel.extension :migration
+    db = Rake.application.database
+    if args[:version]
+      puts "Migrating to version #{args[:version]}"
+      Sequel::Migrator.run(db, migrations_path, target: args[:version].to_i)
+    else
+      puts 'Migrating to latest'
+      Sequel::Migrator.run(db, migrations_path)
+    end
+  end
+end

data/lib/abid.rb

@@ -0,0 +1,28 @@
+require 'rake'
+require 'date'
+require 'digest/md5'
+require 'english'
+require 'forwardable'
+require 'time'
+require 'yaml'
+require 'concurrent'
+require 'inifile'
+require 'rbtree'
+require 'sqlite3'
+require 'sequel'
+
+require 'abid/rake_extensions'
+require 'abid/version'
+require 'abid/waiter'
+require 'abid/worker'
+require 'abid/params_parser'
+require 'abid/play'
+require 'abid/state'
+require 'abid/task'
+require 'abid/task_manager'
+require 'abid/dsl_definition'
+require 'abid/application'
+
+module Abid
+  FIXNUM_MAX = (2**(0.size * 8 - 2) - 1) # :nodoc:
+end

data/lib/abid/application.rb

@@ -0,0 +1,141 @@
+module Abid
+  class Application < Rake::Application
+    include Abid::TaskManager
+
+    attr_reader :worker
+    attr_reader :config
+    attr_reader :futures
+
+    def initialize
+      super
+      @rakefiles = %w(abidfile Abidfile abidfile.rb Abidfile.rb) << abidfile
+      @futures = {}
+      @worker = Worker.new(self)
+    end
+
+    def run
+      Rake.application = self
+      super
+    end
+
+    def init(app_name = 'abid')
+      standard_exception_handling do
+        @config = IniFile.new(content: default_config)
+        @config.merge!(IniFile.load('config/abid.cfg'))
+      end
+
+      super(app_name)
+    end
+
+    # allows the `abid db:migrate` task to load without a abidfile
+    def abidfile
+      File.expand_path(File.join(File.dirname(__FILE__), '..', 'Abidfile.rb'))
+    end
+
+    def run_with_threads
+      yield
+    ensure
+      worker.shutdown
+    end
+
+    def invoke_task(task_string) # :nodoc:
+      name, args = parse_task_string(task_string)
+      self[name].async_invoke(*args).value!
+    end
+
+    def default_config
+      {}
+    end
+
+    def default_database_config
+      {
+        adapter: 'sqlite',
+        database: File.join(Dir.pwd, 'abid.db'),
+        max_connections: 1
+      }
+    end
+
+    def standard_rake_options
+      super.each do |opt|
+        case opt.first
+        when '--execute-print'
+          # disable short option
+          opt.delete_at(1)
+        when '--dry-run'
+          h = opt.last
+          opt[-1] = lambda do |value|
+            h.call(value)
+            options.disable_state = true
+          end
+        when '--version'
+          opt[-1] = lambda do |_value|
+            puts "Abid Version: #{Abid::VERSION} (Rake Version: #{RAKEVERSION})"
+            exit
+          end
+        end
+      end
+    end
+
+    def abid_options # :nodoc:
+      sort_options(
+        [
+          ['--check-parents', '-c',
+           'Run the task if the parents was updated.',
+           proc { options.check_prerequisites = true }
+          ],
+          ['--preview', '-p',
+           'Run tasks in preview mode.',
+           proc do
+             options.disable_state = true
+             options.preview = true
+           end
+          ],
+          ['--wait-external-task',
+           'Wait a task finished if it is running in externl process',
+           proc do
+             options.wait_external_task_interval = true
+           end
+          ]
+        ]
+      )
+    end
+
+    def handle_options
+      options.rakelib = ['rakelib']
+      options.trace_output = $stderr
+
+      OptionParser.new do |opts|
+        opts.banner = 'See full documentation at https://github.com/ojima-h/abid.'
+        opts.separator ''
+        opts.separator 'Show available tasks:'
+        opts.separator '    bundle exec abid -T'
+        opts.separator ''
+        opts.separator 'Invoke (or simulate invoking) a task:'
+        opts.separator '    bundle exec abid [--dry-run | --preview] TASK'
+        opts.separator ''
+        opts.separator 'Abid options:'
+        abid_options.each { |args| opts.on(*args) }
+        opts.separator ''
+        opts.separator 'Advanced options:'
+        standard_rake_options.each { |args| opts.on(*args) }
+
+        opts.on_tail('-h', '--help', '-H', 'Display this help message.') do
+          puts opts
+          exit
+        end
+
+        opts.environment('RAKEOPT')
+      end.parse!
+    end
+
+    def database
+      return @database if @database
+      if config.sections.include?('abid database')
+        cfg = config['abid database'].map { |k, v| [k.to_sym, v] }.to_h
+      else
+        cfg = default_database_config
+      end
+      @database = Sequel.connect(**cfg)
+    end
+  end
+end