sidestate 0.2.0 → 0.2.1

data/LICENCE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Envato
+Copyright (c) 2010 Envato & Pat Allan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -6,6 +6,8 @@ h2. Installation
 
 <pre><code>gem install sidestate</code></pre>
 
+Don't forget to add it to your environment.rb or Gemfile.
+
 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:
@@ -23,10 +25,16 @@ Then, you'll want the model and migration generated for the companion state obje
 
 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).
 
+*Important Note*: Sidestate adds a has_many association from the main class to the state class, and a belongs_to one in the other direction. You don't need to (and shouldn't) add these yourself.
+
+*Another Important Note*: You will still need the state column (default is aasm_state) in your main class - this makes querying on the current state of objects much easier, and SideState expects it as well.
+
+And that's pretty much it - whenever the state changes on your main class, a new state object will be saved to the database as well. Just keep using AASM as you normally do.
+
 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.
+Copyright (c) 2010 "Envato":http://envato.com/. Initially developed by "Pat Allan":http://freelancing-gods.com. Released under an MIT licence.

data/lib/sidestate/hook.rb

@@ -44,7 +44,7 @@ module Sidestate::Hook
     return unless send("#{aasm_column}_changed?")
     
     old_state, new_state = send("#{aasm_column}_change")
-    aasm_state_collection.create :name => new_state.to_s
+    aasm_state_collection.create :name => new_state.to_s, self.class.name.underscore.to_sym => self
   end
   
   def aasm_state_collection

metadata

@@ -1,12 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sidestate
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Pat Allan
@@ -19,58 +14,44 @@ default_executable:
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aasm
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 1
-        - 5
         version: 2.1.5
-  type: :runtime
-  version_requirements: *id001
+    version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 9
         version: 1.2.9
-  type: :development
-  version_requirements: *id002
+    version: 
 - !ruby/object:Gem::Dependency 
   name: yard
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
-  type: :development
-  version_requirements: *id003
+    version: 
 - !ruby/object:Gem::Dependency 
   name: timecop
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 3
-        - 4
         version: 0.3.4
-  type: :development
-  version_requirements: *id004
+    version: 
 description: Track state history using AASM
 email: pat@freelancing-gods.com
 executables: []
@@ -98,20 +79,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
+  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
+  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: AASM Extention for storing state in a separate model