workflow_sequel_adapter 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+before_script:
+  - sudo apt-get install -qq graphviz

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jack Chu
+
+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,50 @@
+# workflow_sequel_adapter
+
+This gem is a persistence adapter for the [Workflow](http://github.com/geekq/workflow) gem. All you do is include this adapter, and `Workflow` will use the `workflow_column` to retrieve and persist the workflow state.
+
+Workflow is a state machine gem you can include to add state machine functionality to your classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'workflow_sequel_adapter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install workflow_sequel_adapter
+
+## Usage
+
+```ruby
+class User < Sequel::Model
+  include Workflow
+  # include the adapter after including Workflow
+  include WorkflowSequelAdapter
+
+  # uses 'state' as the workflow_column instead of 'workflow_state'
+  workflow_column :state
+
+  workflow do
+    state :active do
+      event :deactivate, transition_to: :inactive
+    end
+
+    state :inactive do
+      event :activate, transition_to: :active
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+task :default => :test
+
+desc "Run tests"
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << 'lib' << 'test'
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = true
+  end
+end

data/lib/workflow_sequel_adapter.rb

@@ -0,0 +1,24 @@
+require "workflow_sequel_adapter/version"
+
+module WorkflowSequelAdapter
+  def before_validation
+    write_initial_state
+    super
+  end
+
+  def load_workflow_state
+    send self.class.workflow_column
+  end
+
+  def persist_workflow_state(new_value)
+    send "#{self.class.workflow_column}=", new_value
+    save_changes
+  end
+
+  private
+  def write_initial_state
+    if load_workflow_state.nil? || load_workflow_state == ''
+      send("#{self.class.workflow_column}=", current_state.to_s)
+    end
+  end
+end

data/lib/workflow_sequel_adapter/version.rb

@@ -0,0 +1,3 @@
+module WorkflowSequelAdapter
+  VERSION = "0.0.1"
+end

data/test/test_helper.rb

@@ -0,0 +1,40 @@
+require 'sequel'
+require 'workflow'
+require 'workflow_sequel_adapter'
+require 'minitest/autorun'
+
+DB = Sequel.sqlite
+
+Sequel::Model.raise_on_save_failure = false
+
+DB.instance_eval do
+  create_table :users do
+    primary_key :id
+    String :email
+    String :password
+    String :state
+  end
+end
+
+class User < Sequel::Model
+  include Workflow
+  include WorkflowSequelAdapter
+
+  workflow_column :state
+
+  workflow do
+    state :active do
+      event :deactivate, transition_to: :inactive
+    end
+
+    state :inactive do
+      event :activate, transition_to: :active
+    end
+  end
+end
+
+class MiniTest::Spec
+  before do
+    Sequel::Model.db.from(:users).truncate
+  end
+end

data/test/workflow_sequel_adapter_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+describe WorkflowSequelAdapter do
+  describe User do
+    before do
+      @user = User.create(email: 'user@example.com', password: 'password')
+    end
+
+    it 'starts in active state' do
+      @user.state.must_equal 'active'
+    end
+
+    describe 'in the inactive state' do
+      it 'transitions to the inactive state via the deactivate event' do
+        @user.can_deactivate?.must_equal true
+        @user.deactivate!
+        @user.state.must_equal 'inactive'
+      end
+
+      it 'cannot be activated if already active' do
+        @user.can_activate?.must_equal false
+      end
+    end
+
+    describe 'in the inactive state' do
+      before do
+        @user.deactivate!
+      end
+
+      it 'transitions to the active state via the activate event' do
+        @user.can_activate?.must_equal true
+        @user.activate!
+        @user.state.must_equal 'active'
+      end
+
+      it 'cannot be deactivated if already inactive' do
+        @user.can_deactivate?.must_equal false
+      end
+    end
+  end
+end

data/workflow_sequel_adapter.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'workflow_sequel_adapter/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "workflow_sequel_adapter"
+  gem.version       = WorkflowSequelAdapter::VERSION
+  gem.authors       = ["Jack Chu"]
+  gem.email         = ["kamuigt@gmail.com"]
+  gem.description   = %q{workflow_sequel_adapter is a persistence adapter for the Workflow gem. All you do is include this adapter, and `Workflow` will use the `workflow_column` to retrieve and persist the workflow state.}
+  gem.summary       = %q{workflow_sequel_adapter is a persistence adapter for the Workflow gem.}
+  gem.homepage      = "http://github.com/kamui/workflow_sequel_adapter"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "workflow"
+  gem.add_dependency "sequel"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: workflow_sequel_adapter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jack Chu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: workflow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: workflow_sequel_adapter is a persistence adapter for the Workflow gem.
+  All you do is include this adapter, and `Workflow` will use the `workflow_column`
+  to retrieve and persist the workflow state.
+email:
+- kamuigt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/workflow_sequel_adapter.rb
+- lib/workflow_sequel_adapter/version.rb
+- test/test_helper.rb
+- test/workflow_sequel_adapter_test.rb
+- workflow_sequel_adapter.gemspec
+homepage: http://github.com/kamui/workflow_sequel_adapter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 221529894828090429
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 221529894828090429
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: workflow_sequel_adapter is a persistence adapter for the Workflow gem.
+test_files:
+- test/test_helper.rb
+- test/workflow_sequel_adapter_test.rb