sidestate 0.1.0

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Envato
+
+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.textile

@@ -0,0 +1,32 @@
+h1. SideState
+
+*SideState* is an extention for "AASM":http://github.com/rubyist/aasm, which stores the state in a separate object (and thus providing historical information on the state changes for a given record).
+
+h2. Installation
+
+<pre><code>gem install sidestate</code></pre>
+
+h2. Usage
+
+You'll want to set up AASM as normal, with states, events and transitions. To get SideState working nicely, you'll want to include the module of the same name into your model:
+
+<pre><code>class Article < ActiveRecord::Base
+  include AASM
+  include Sidestate
+  
+  # ...
+end</code></pre>
+
+Then, you'll want the model and migration generated for the companion state object:
+
+<pre><code>script/generate sidestate article</code></pre>
+
+You can add whatever you like to the new model (in this example, it would be called ArticleState), but make sure you don't delete the foreign key and name columns. It's also a good idea to add an index to the foreign key column (the generator isn't smart enough to do this yet).
+
+h2. Warning
+
+Very much a beta, and might change dramatically. Seems to work in basic situations, at least. Your mileage may vary.
+
+h2. Credits
+
+Copyright (c) 2010 "Envato":http://envato.com/. Initially developed by "Pat Allan":http://freelancing-gods.com. Released under an open licence.

data/generators/sidestate/sidestate_generator.rb

@@ -0,0 +1,49 @@
+require 'rails_generator/generators/components/model/model_generator'
+
+class SidestateGenerator < ModelGenerator
+  def manifest
+    record do |m|
+      m.class_collisions class_path, class_name
+      
+      m.directory File.join('app/models', class_path)  
+      m.template 'model:model.rb',
+        File.join('app/models', class_path, "#{file_name}.rb")
+      m.migration_template 'model:migration.rb', 'db/migrate',
+        :assigns => {
+          :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}",
+          :table_name     => file_path.gsub(/\//, '_').pluralize,
+          :attributes     => [
+            Rails::Generator::GeneratedAttribute.new(:name,       :string),
+            Rails::Generator::GeneratedAttribute.new(foreign_key, :integer)
+          ]
+        },
+        :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+    end
+  end
+  
+  protected
+  
+  def banner
+    "Usage: #{$0} #{spec.name} ModelName"
+  end
+  
+  def add_options!(opt)
+    # Do nothing - which removes the normal model generator options
+  end
+  
+  def class_name
+    super + "State"
+  end
+  
+  def file_name
+    super + "_state"
+  end
+  
+  def file_path
+    super + "_state"
+  end
+  
+  def foreign_key
+    file_name.gsub(/_state$/, '_id').to_sym
+  end
+end

data/lib/sidestate/hook.rb

@@ -0,0 +1,41 @@
+module Sidestate::Hook
+  def self.included(base)
+    base.instance_eval do
+      extend Sidestate::Hook::ClassMethods
+      has_many aasm_state_collection
+      
+      after_save :save_aasm_state_object
+      
+      define_method(aasm_state_object) do
+        aasm_state_collection.last
+      end      
+    end
+  end
+  
+  module ClassMethods
+    def aasm_state_collection
+      "#{name}State".pluralize.underscore.to_sym
+    end
+    
+    def aasm_state_object
+      "#{name}State".underscore.to_sym
+    end
+  end
+  
+  private
+  
+  def save_aasm_state_object
+    return unless send("#{aasm_column}_changed?")
+    
+    old_state, new_state = send("#{aasm_column}_change")
+    aasm_state_collection.create :name => new_state.to_s
+  end
+  
+  def aasm_state_collection
+    send(self.class.aasm_state_collection)
+  end
+  
+  def aasm_column
+    self.class.aasm_column
+  end
+end

data/lib/sidestate.rb

@@ -0,0 +1,8 @@
+module Sidestate
+  def self.included(base)
+    base.send :include, Sidestate::Hook
+  end
+end
+
+require 'aasm'
+require 'sidestate/hook'

data/spec/generators/sidestate/sidestate_generator_spec.rb

@@ -0,0 +1,42 @@
+require 'spec/spec_helper'
+
+describe SidestateGenerator do
+  before :each do
+    Rails::Generator::Scripts::Generate.new.run(
+      ['sidestate', 'item'],
+      :destination => 'tmp',
+      :quiet       => true
+    )
+  end
+  
+  after :each do
+    FileUtils.rm_r 'tmp/app'
+    FileUtils.rm_r 'tmp/db'
+  end
+  
+  it "should generate a migration for the given model's state class" do
+    Dir['tmp/db/migrate/*_create_item_states*'].should_not be_empty
+  end
+  
+  it "should generate the given model's state class" do
+    File.exist?('tmp/app/models/item_state.rb').should be_true
+  end
+  
+  describe 'migration' do
+    before :each do
+      @file = open(Dir['tmp/db/migrate/*_create_item_states*'].first).read
+    end
+    
+    it "should set the table name" do
+      @file.should match(/create_table :item_states/)
+    end
+    
+    it "should include the name" do
+      @file.should match(/t\.string :name/)
+    end
+    
+    it "should include the foreign key" do
+      @file.should match(/t\.integer :item_id/)
+    end
+  end
+end

data/spec/sidestate/hook_spec.rb

@@ -0,0 +1,39 @@
+require 'spec/spec_helper'
+
+describe Sidestate::Hook do
+  context '#article_state' do
+    it "should create a new state when a model object is created" do
+      article = Article.create
+      article.article_state.should_not be_nil
+    end
+    
+    it "should set the state accordingly" do
+      Article.create.article_state.name.should == 'draft'
+    end
+    
+    it "should track state changes" do
+      Timecop.travel 1.day.ago
+      article = Article.create
+      Timecop.return
+      
+      article.publish!
+      article.article_state.name.should == 'published'
+    end
+  end
+  
+  context '#article_states' do
+    it "should store all states for a given object" do
+      Timecop.travel 2.days.ago
+      article = Article.create
+      Timecop.return
+      Timecop.travel 1.day.ago
+      article.publish!
+      Timecop.return
+      article.flag!
+      
+      article.article_states.collect { |state|
+        state.name
+      }.should == ['draft', 'published', 'flagged']
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'fileutils'
+require 'active_record'
+
+require 'aasm'
+require 'sidestate'
+
+require 'spec'
+require 'spec/autorun'
+require 'timecop'
+
+Spec::Runner.configure do |config|
+  Dir['spec/support/*.rb'].sort.each do |file|
+    require file.gsub(/\.rb/, '')
+  end
+end

data/spec/support/database.rb

@@ -0,0 +1,7 @@
+FileUtils.rm_r    'tmp'
+FileUtils.mkdir_p 'tmp'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => 'tmp/development.sqlite3'
+)

data/spec/support/generators.rb

@@ -0,0 +1,7 @@
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+Rails::Generator::Base.append_sources(
+  Rails::Generator::PathSource.new(:local,
+    "#{File.dirname(__FILE__)}/../../generators")
+)

data/spec/support/migrations.rb

@@ -0,0 +1,12 @@
+ActiveRecord::Base.connection.create_table :articles, :force => true do |t|
+  t.string :subject
+  t.text   :content
+  t.string :aasm_state
+  t.timestamps
+end
+
+ActiveRecord::Base.connection.create_table :article_states, :force => true do |t|
+  t.integer :article_id
+  t.string  :name
+  t.timestamps
+end

data/spec/support/models.rb

@@ -0,0 +1,31 @@
+class Article < ActiveRecord::Base
+  include AASM
+  include Sidestate
+  
+  aasm_state :draft
+  aasm_state :published
+  aasm_state :flagged
+  aasm_state :deleted
+  
+  aasm_initial_state :draft
+  
+  aasm_event :publish do
+    transitions :from => :draft, :to => :published
+  end
+  
+  aasm_event :flag do
+    transitions :from => :published, :to => :flagged
+  end
+  
+  aasm_event :unflag do
+    transitions :from => :flagged, :to => :published
+  end
+  
+  aasm_event :delete do
+    transitions :from => [:draft, :published, :flagged], :to => :deleted
+  end
+end
+
+class ArticleState < ActiveRecord::Base
+  #
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: sidestate
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pat Allan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-11 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: aasm
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 5
+        version: 2.1.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 4
+        version: 0.3.4
+  type: :development
+  version_requirements: *id004
+description: Track state history using AASM
+email: pat@freelancing-gods.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- LICENCE
+- README.textile
+- generators/sidestate/sidestate_generator.rb
+- lib/sidestate.rb
+- lib/sidestate/hook.rb
+has_rdoc: true
+homepage: http://github.com/envato/sidestate
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: AASM Extention for storing state in a separate model
+test_files: 
+- spec/generators/sidestate/sidestate_generator_spec.rb
+- spec/sidestate/hook_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb
+- spec/support/generators.rb
+- spec/support/migrations.rb
+- spec/support/models.rb