duties 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edbe40e92993677875bf20a969da0da52510e54a
+  data.tar.gz: 1285e2050b670d768cca9e561d2524117d92a3aa
+SHA512:
+  metadata.gz: c1cde1edaf89b8d427d6b59a23b59727efe16e79b9692d6a7919b3ead4244107bbaccbc466c29cc2b97aa0721d669e9d17347a869dffe0c999478347651d84e0
+  data.tar.gz: bf9e023647f0f35f8d2a0ea6cc618ef6f2f9f22abf3abc389cc87ebaa88fb32ffc3648e78308f0125cbe97e53fd6353d1c2678c5ce41e63e5841b5ad1ae1830f

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pat Allan & Inspire9
+
+MIT License
+
+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,52 @@
+# Duties
+
+A Rails engine that runs activities related to a duty in a specific order, via Sidekiq.
+
+Duties are composed of one or more activities. These activities have positions, and they can share positions, which allows for parallel processing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'duties', '0.0.1'
+```
+
+## Usage
+
+```ruby
+# config/initializers/duties.rb
+Duties.duty_namespace     = MyDuties
+Duties.activity_namespace = MyActivities
+
+# app/lib/my_duties/compile.rb
+class MyDuties::Compile < Duties::Duty
+  def enqueue_activities
+    enqueue_activity 'clean',     at: 1
+    enqueue_activity 'configure', at: 2
+    enqueue_activity 'make',      at: 3
+  end
+end
+
+# app/lib/my_activities/clean.rb
+class MyActivities::Clean < Duties::Activity
+  def clean
+    # can use data to access duty information provided when queued.
+  end
+end
+
+# Wherever you want to queue up the compile duty
+Duties::Duty.enqueue 'compile', 'foo' => 'bar'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/inspire9/duties/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
+
+## Credits
+
+Copyright (c) 2014, Duties is developed and maintained by Pat Allan and [Inspire9](http://inspire9.com), and is released under the open MIT Licence.

data/Rakefile

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

data/app/models/duties/activity_record.rb

@@ -0,0 +1,16 @@
+class Duties::ActivityRecord < ActiveRecord::Base
+  self.table_name = 'duties_activity_records'
+
+  belongs_to :duty_record, class_name: 'Duties::DutyRecord'
+
+  validates :name,        presence: true
+  validates :duty_record, presence: true
+  validates :position,    presence: true
+
+  scope :by_position, lambda { |position| where(position: position) }
+  scope :failures,    lambda { where status: 'failure' }
+
+  def success?
+    status == 'success'
+  end
+end

data/app/models/duties/duty_record.rb

@@ -0,0 +1,8 @@
+class Duties::DutyRecord < ActiveRecord::Base
+  self.table_name = 'duties_duty_records'
+
+  has_many :activity_records, class_name: 'Duties::ActivityRecord'
+  serialize :data, JSON
+
+  validates :name, presence: true
+end

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/db/migrate/1_create_duties_and_activities.rb

@@ -0,0 +1,23 @@
+class CreateDutiesAndActivities < ActiveRecord::Migration
+  def change
+    create_table :duties_duty_records do |t|
+      t.string  :name,    null: false
+      t.text    :data,    default: '{}'
+      t.timestamps
+    end
+
+    add_index :duties_duty_records, :created_at, order: {created_at: :desc}
+    add_index :duties_duty_records, :name
+
+    create_table :duties_activity_records do |t|
+      t.string  :name,           null: false
+      t.integer :duty_record_id, null: false
+      t.integer :position,       null: false
+      t.string  :status,         null: false, default: 'pending'
+      t.timestamps
+    end
+
+    add_index :duties_activity_records, :duty_record_id
+    add_index :duties_activity_records, :name
+  end
+end

data/duties.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'duties'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Pat Allan']
+  spec.email         = ['pat@freelancing-gods.com']
+  spec.summary       = %q{Run activities related to a duty in a specific order}
+  spec.description   = %q{A Rails engine that runs activities related to a duty in a specific order, via Sidekiq.}
+  spec.homepage      = 'https://github.com/inspire9/duties'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'json'
+  spec.add_runtime_dependency 'rails',   '~> 4.0'
+  spec.add_runtime_dependency 'sidekiq', '> 2.17.0'
+
+  spec.add_development_dependency 'combustion',  '0.5.1'
+  spec.add_development_dependency 'rspec-rails', '~> 3.0.2'
+  spec.add_development_dependency 'sqlite3',     '~> 1.3.8'
+end

data/lib/duties/activity.rb

@@ -0,0 +1,24 @@
+class Duties::Activity
+  def self.call(record)
+    activity = new(record)
+    begin
+      activity.call
+      record.update_attributes status: 'success'
+
+      Duties::Next.call record.duty_record, record.position
+    rescue => error
+      record.update_attributes status: 'failure'
+    end
+  end
+
+  def initialize(activity)
+    @activity = activity
+  end
+
+  private
+
+  attr_reader :activity
+
+  delegate :duty, to: :activity
+  delegate :data, to: :duty
+end

data/lib/duties/activity_job.rb

@@ -0,0 +1,19 @@
+class Duties::ActivityJob
+  include Sidekiq::Worker
+
+  sidekiq_options :retry => true
+
+  def perform(activity_id)
+    activity = Duties::ActivityRecord.find_by_id activity_id
+    return if activity.nil?
+    klass    = activity_class activity.name.classify
+
+    klass.call activity
+  end
+
+  private
+
+  def activity_class(name)
+    Duties.activity_namespace.const_get name
+  end
+end

data/lib/duties/duty.rb

@@ -0,0 +1,40 @@
+class Duties::Duty
+  def self.call(record)
+    new(record).call
+  end
+
+  def self.enqueue(name, data = {})
+    duty = Duties::DutyRecord.create! name: name, data: data
+
+    Duties::DutyJob.perform_async duty.id
+
+    duty.id
+  end
+
+  def initialize(record)
+    @record = record
+  end
+
+  def enqueue_activities
+    # Hook for subclasses to implement
+  end
+
+  def call
+    enqueue_activities
+    start_activities
+  end
+
+  private
+
+  attr_reader :record
+
+  def enqueue_activity(name, options)
+    record.activity_records.create! name: name, position: options[:at]
+  end
+
+  def start_activities
+    record.activity_records.by_position(1).each do |activity|
+      Duties::ActivityJob.perform_async activity.id
+    end
+  end
+end

data/lib/duties/duty_job.rb

@@ -0,0 +1,18 @@
+class Duties::DutyJob
+  include Sidekiq::Worker
+
+  sidekiq_options retry: true
+
+  def perform(duty_id)
+    duty  = Duties::DutyRecord.find duty_id
+    klass = duty_class duty.name.classify
+
+    klass.call duty
+  end
+
+  private
+
+  def duty_class(name)
+    Duties.duty_namespace.const_get name
+  end
+end

data/lib/duties/engine.rb

@@ -0,0 +1,3 @@
+class Duties::Engine < Rails::Engine
+  engine_name :duties
+end

data/lib/duties/next.rb

@@ -0,0 +1,37 @@
+class Duties::Next
+  def self.call(record, position)
+    new(record, position).call
+  end
+
+  def initialize(record, position)
+    @record, @position = record, position
+  end
+
+  def call
+    # We're done here. Stop.
+    return if any_failures?
+    return unless finished_current? && more_to_come?
+
+    activity_records.by_position(position + 1).each do |activity|
+      Duties::ActivityJob.perform_async activity.id
+    end
+  end
+
+  private
+
+  attr_reader :record, :position
+
+  delegate :activity_records, to: :record
+
+  def any_failures?
+    activity_records.by_position(position).failures.any?
+  end
+
+  def finished_current?
+    activity_records.by_position(position).all? &:success?
+  end
+
+  def more_to_come?
+    activity_records.by_position(position + 1).any?
+  end
+end

data/lib/duties.rb

@@ -0,0 +1,12 @@
+require 'sidekiq'
+
+module Duties
+  mattr_accessor :duty_namespace, :activity_namespace
+end
+
+require 'duties/activity'
+require 'duties/activity_job'
+require 'duties/duty'
+require 'duties/duty_job'
+require 'duties/engine'
+require 'duties/next'

data/spec/acceptance/running_duties_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module Running
+  module Duties
+    class ExampleOne < ::Duties::Duty
+      def enqueue_activities
+        enqueue_activity 'success_one', at: 1
+        enqueue_activity 'success_two', at: 2
+      end
+    end
+  end
+
+  module Activities
+    class SuccessOne < ::Duties::Activity
+      def call
+        #
+      end
+    end
+
+    class SuccessTwo < ::Duties::Activity
+      def call
+        #
+      end
+    end
+  end
+end
+
+describe 'Running duties' do
+  before :each do
+    Duties.duty_namespace     = Running::Duties
+    Duties.activity_namespace = Running::Activities
+  end
+
+  it 'processes each activity for the duty' do
+    id = Duties::Duty.enqueue 'example_one'
+
+    duty = Duties::DutyRecord.find(id)
+    expect(duty.activity_records.length).to eq(2)
+    expect(duty.activity_records.pluck(:status)).to eq(['success', 'success'])
+  end
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define do
+  #
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+
+Bundler.setup :default, :development
+
+require 'rails'
+require 'combustion'
+require 'duties'
+require 'sidekiq/testing'
+
+Combustion.initialize! :action_controller, :active_record
+
+require 'rspec/rails'
+
+Sidekiq::Testing.inline!
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: duties
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 2.17.0
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.8
+description: A Rails engine that runs activities related to a duty in a specific order,
+  via Sidekiq.
+email:
+- pat@freelancing-gods.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/models/duties/activity_record.rb
+- app/models/duties/duty_record.rb
+- config.ru
+- db/migrate/1_create_duties_and_activities.rb
+- duties.gemspec
+- lib/duties.rb
+- lib/duties/activity.rb
+- lib/duties/activity_job.rb
+- lib/duties/duty.rb
+- lib/duties/duty_job.rb
+- lib/duties/engine.rb
+- lib/duties/next.rb
+- spec/acceptance/running_duties_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+homepage: https://github.com/inspire9/duties
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Run activities related to a duty in a specific order
+test_files:
+- spec/acceptance/running_duties_spec.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/combustion_test.sqlite
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb