solidstate 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2440bdd08c03d227ce1343783e7fc863d197db67
-  data.tar.gz: 56ea18976e16dce884b21b2b1bc0a94a7be1b564
+  metadata.gz: 737e65abda45b1dc1b7ac8620811693c22832554
+  data.tar.gz: 93039656e96b052c7f92c6ac1c2c8c729cba01aa
 SHA512:
-  metadata.gz: 6d59cea2fb06b79b7f660cd4dcd8fff0927e843760434f3eba84edafcf87e7671a3577b06632b3eba225520eae0e0104fbb2445db1f5fd6addf493dcf42c4286
-  data.tar.gz: a1f6bb99d36c2ef57ea9914477d6863ed811895cfc817df780bfac72bde5cb082c10b53e1bf19f468af9e01e1900010118ddff87d7ebed846a24dc386ea58f95
+  metadata.gz: bd76cc42646c4370f3f0d931a16cc112a7a9dd9116b57be6bddce77f9eb7c7465c3a1aaccbcab1ac4a4ea7ac975938216231cdcd0b7a9954259aed5fe6ea7e1b
+  data.tar.gz: aa6734b9c93068df1c9f3d766743aed49a4f11255ac036d67cecaf9af0a5c9e24e3da4ffa985830c746fbb651c07987a8e6c2b9e453fc4e6ea0caed3da8761d7

data/README.md

@@ -3,6 +3,14 @@ SolidState
 
 Minuscule but solid state machine for Ruby classes. The only dependency is that your model responds to a getter and setter for `state`.
 
+## Installation
+
+In your Gemfile:
+
+    gem 'solidstate'
+
+## Usage
+
 ``` ruby
 
   # simplest example, using just an accessor
@@ -18,7 +26,7 @@ Minuscule but solid state machine for Ruby classes. The only dependency is that
   # whether the current status is X or Y.
 
   p = Post.new
-  p.state      # => 'draft'
+  p.state      # => 'draft' (default value set in database)
   p.draft?     # true
   p.published? # => false
   p.state = 'published'
@@ -42,6 +50,11 @@ Minuscule but solid state machine for Ruby classes. The only dependency is that
   p.state = 'deleted'
   p.valid?  # => false
 
+  # you also get scopes for free if the class responds_to the `scope` method
+  
+  Post.published.first # => #<Post ...>
+  Post.draft.count # => 1
+
   # ok, now let's gets get fancier. we're going to declare transitions
   # which will govern the possible directions in which an object's state
   # can move to.
@@ -64,10 +77,11 @@ Minuscule but solid state machine for Ruby classes. The only dependency is that
   # if so, sets the new state and optionally saves the record.
 
   s.active! # => true
-
+  s.state   # => 'active'
   s.inactive! # => raises InvalidTransitionError
 
   # this also works outside transition methods, of course.
+
   s.reload  # => true
   s.active? # => true
 

data/examples/active_record.rb

@@ -0,0 +1,26 @@
+require 'bundler/setup'
+require 'active_record'
+require_relative '../lib/solidstate'
+
+ActiveRecord::Base.establish_connection(
+  "adapter"  => "sqlite3",
+  "database" => ':memory:'
+)
+
+# ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+
+ActiveRecord::Schema.define :version => 0 do
+  create_table "subscribers", :force => true do |t|
+    t.string   "state", default: "inactive"
+  end
+end
+
+class Subscriber < ActiveRecord::Base
+  include SolidState
+
+  states :inactive, :active, :unsubscribed, :disabled do
+    transitions :from => :inactive, :to => :active
+    transitions :from => :active, :to => [:unsubscribed, :disabled]
+    transitions :from => :unsubscribed, :to => :active
+  end
+end

data/examples/mongo_mapper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'mongo_mapper'
+require_relative '../lib/solidstate'
+
+class Person
+  include MongoMapper::Document
+  include SolidState
+
+  STATES = %w(awake sleeping)
+
+  key :state, String, :default => STATES.first
+  # ensure_index :state
+
+  states *STATES
+end

data/lib/solidstate.rb

@@ -72,12 +72,6 @@ module SolidState
     end
   end
 
-  def once_not_subscribed
-
-  end
-
-  def after
-
   def set_state(new_state)
     return false unless can_transition_to?(new_state)
     self.state = new_state

data/solidstate.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "solidstate"
-  s.version     = '0.2.0'
+  s.version     = '0.3.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Tomás Pollak']
   s.email       = ['tomas@forkhq.com']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidstate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Tomás Pollak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-11 00:00:00.000000000 Z
+date: 2017-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,8 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- examples/active_record.rb
+- examples/mongo_mapper.rb
 - lib/solidstate.rb
 - solidstate.gemspec
 homepage: https://github.com/tomas/solidstate