state_machine_setters 1.0.0

data/.gitignore

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

data/.rspec

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create default@state_machine_setters

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Adam Hunter
+
+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,47 @@
+# StateMachineSetters
+
+Adds setters for state machine events to trigger state transitions by setting attributes.
+
+## Usage
+
+    class ExampleModel < ActiveRecord::Base
+      state_machine :state do
+        event :pay do
+          transition :unpaid => :paid
+        end
+      end
+
+      state_machine_setter :state
+    end
+
+    @example = ExampleModel.new
+    @example.pay = true # triggers @example.pay
+
+    # params[:example] == {:pay => {:purchased_by_id => 10, :purchase_amount => 50}}
+    @example.update_attributes(params[:example]) # will set the attributes with the hash then call `pay`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'state_machine_setters'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install state_machine_setters
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/state_machine_setters.rb

@@ -0,0 +1,33 @@
+require "state_machine"
+require "state_machine_setters/version"
+
+module StateMachineSetters
+
+  def state_machine_setter(state_machine_name)
+    ensure_state_machine!(state_machine_name)
+    add_state_machine_setters(state_machine_name)
+  end
+
+  private
+
+  def ensure_state_machine!(name)
+    return if respond_to?(:state_machines) && state_machines[name]
+    raise MissingStateMachineError.new("#{name} has not been defined.")
+  end
+
+  def add_state_machine_setters(name)
+    state_machines[name].events.map(&:name).each do |event|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def #{event}=(value)
+          self.attributes = value if value.is_a?(Hash)
+          #{event}
+        end
+      RUBY
+    end
+  end
+
+  class MissingStateMachineError < StandardError ; end
+
+end
+
+Object.extend StateMachineSetters

data/lib/state_machine_setters/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+$:.unshift('../lib')
+require 'state_machine_setters'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+class StateMachineExample
+  attr_accessor :state
+  state_machine :state do
+    event :run do
+      transition :still => :moving
+    end
+  end
+  state_machine_setter :state
+end

data/spec/state_machine_setters_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe StateMachineSetters do
+  it "is a module" do
+    StateMachineSetters.should be_a(Module)
+  end
+
+  it "loads state machine" do
+    Class.should respond_to(:state_machine)
+  end
+
+  it "adds `state_machine_setter` to class" do
+    Class.should respond_to(:state_machine_setter)
+  end
+
+  it "will raise a missing state_machine error when calling state_machine_setter without defining any state_machine first" do
+    expect { Class.state_machine_setter :some_machine }.to raise_error(StateMachineSetters::MissingStateMachineError)
+  end
+
+  it "will raise a missing state_machine error when calling state_machine_setter without defining the state_machine first" do
+    expect { StateMachineExample.state_machine_setter :some_machine }.to raise_error(StateMachineSetters::MissingStateMachineError)
+  end
+
+  describe "instances" do
+    before :each do
+      @example = StateMachineExample.new
+    end
+
+    it "adds a setter for each defined state transition in a class" do
+      @example.should respond_to(:run=)
+    end
+
+    it "will pass given attributes to an attributes= method when called" do
+      @example.should_receive(:attributes=).with(:awesome => 'yes')
+      @example.run = {:awesome => 'yes'}
+    end
+
+    it "will not pass attributes to attributes= if no hash is provided" do
+      @example.should_not_receive(:attributes=)
+      @example.run = true
+    end
+
+    it "will call the respective state transition when calling the setter" do
+      @example.should_receive(:run)
+      @example.run = true
+    end
+  end
+end

data/state_machine_setters.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/state_machine_setters/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Adam Hunter", "Chris Peters"]
+  gem.email         = ["adamhunter@me.com", "chrispeters.psu@gmail.com"]
+  gem.description   = %q{Adds setter methods based off of state machine transitions to allow triggering state changes from form attributes.}
+  gem.summary       = %q{Trigger state machine transitions from setters.}
+
+  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.name          = "state_machine_setters"
+  gem.require_paths = ["lib"]
+  gem.version       = StateMachineSetters::VERSION
+
+  gem.add_dependency "state_machine", ">= 1.1.2"
+  gem.add_development_dependency "rspec", "~> 2.10.0"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: state_machine_setters
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Hunter
+- Chris Peters
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: state_machine
+  requirement: &70347273677700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70347273677700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70347273676580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70347273676580
+description: Adds setter methods based off of state machine transitions to allow triggering
+  state changes from form attributes.
+email:
+- adamhunter@me.com
+- chrispeters.psu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/state_machine_setters.rb
+- lib/state_machine_setters/version.rb
+- spec/spec_helper.rb
+- spec/state_machine_setters_spec.rb
+- state_machine_setters.gemspec
+homepage: 
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Trigger state machine transitions from setters.
+test_files:
+- spec/spec_helper.rb
+- spec/state_machine_setters_spec.rb