ohm-stateful-model 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f33f2372f11e87969180a69dc7d0062416c91488
4
+ data.tar.gz: 8cb7b1c7a9b650958671396f2b8903d9e18d80cb
5
+ SHA512:
6
+ metadata.gz: 7764875bcfd4a08b628f2f3e1300c1a6bcecbf522a7086e5586da1e489f4f31d7e670f58cb81ee60ec1f8667e04e540677810bb350e8965f8d27bc0f7fc4ac2a
7
+ data.tar.gz: 9bc6d3fc698e78ee09a8601eeebc4cf099046d9a28bc251c02b7463684ed0e670e9192084d3aa5135428c13560f1f6776ae2196e76284f69fe3fce73c4e10383
data/Gemfile ADDED
@@ -0,0 +1,13 @@
1
+ source "http://rubygems.org"
2
+
3
+ gemspec
4
+
5
+ group :development do
6
+ gem "pry-nav"
7
+ end
8
+
9
+ group :test do
10
+ gem "mock_redis", "~> 0.8.1"
11
+ gem "rspec", "2.14.1"
12
+ gem "rr", "~> 1.1.2"
13
+ end
@@ -0,0 +1,3 @@
1
+ == 1.0.0
2
+
3
+ * Birthday!
data/LICENSE ADDED
@@ -0,0 +1,177 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
@@ -0,0 +1,10 @@
1
+ # encoding: UTF-8
2
+
3
+ require 'rubygems' unless ENV['NO_RUBYGEMS']
4
+
5
+ require 'bundler'
6
+ require 'digest'
7
+
8
+ require 'rubygems/package_task'
9
+
10
+ Bundler::GemHelper.install_tasks
@@ -0,0 +1,5 @@
1
+ # encoding: UTF-8
2
+
3
+ module OhmStatefulModel
4
+ VERSION = "1.0.0"
5
+ end
@@ -0,0 +1,118 @@
1
+ # encoding: UTF-8
2
+
3
+ require 'ohm'
4
+ require 'state_machine'
5
+
6
+ module Ohm
7
+ class StatefulModel < Ohm::Model
8
+
9
+ class << self
10
+
11
+ attr_reader :state_machine_class, :state_machine_name
12
+
13
+ def use_state_machine(state_machine_class, options = {})
14
+ if @state_machine_class
15
+ raise "A state machine is already in use for this model"
16
+ else
17
+ if state_machine_class.ancestors.include?(Ohm::State)
18
+ @state_machine_class = state_machine_class
19
+ @state_machine_name = options[:attribute_name]
20
+ else
21
+ raise "#{state_machine_class} must inherit from Ohm::State"
22
+ end
23
+ end
24
+ end
25
+
26
+ end
27
+
28
+ attr_reader :state_machine
29
+
30
+ def initialize(*args)
31
+ if self.class.state_machine_class
32
+ @state_machine = self.class.state_machine_class.new
33
+
34
+ # define Ohm::Model attribute
35
+ self.class.attribute(state_machine_name)
36
+
37
+ # override state setting method so it updates both the attributes hash
38
+ # and the state machine's state
39
+ define_singleton_method(:"#{state_machine_name}=") do |new_state|
40
+ @attributes[state_machine_name] = new_state
41
+ @state_machine.state = new_state
42
+ end
43
+
44
+ # hook every transition so we can update the attributes hash
45
+ @state_machine.after_transition_proc = lambda do |obj, transition|
46
+ update_attributes(state_machine_name => obj.state)
47
+ end
48
+
49
+ super
50
+ initialize_value
51
+ else
52
+ super
53
+ end
54
+ end
55
+
56
+ def respond_to_missing?(method)
57
+ @state_machine.respond_to?(method)
58
+ end
59
+
60
+ def method_missing(method, *args, &block)
61
+ if @state_machine.respond_to?(method)
62
+ @state_machine.send(method, *args, &block)
63
+ else
64
+ raise NoMethodError.new("undefined method `#{method}' for #{self.class.name}")
65
+ end
66
+ end
67
+
68
+ private
69
+
70
+ def initialize_value
71
+ get(state_machine_name) unless new?
72
+ val = @attributes[state_machine_name]
73
+
74
+ if @state_machine.class.state_machine.states.keys.include?(val)
75
+ @state_machine.state = val
76
+ else
77
+ @attributes[state_machine_name] = @state_machine.state
78
+ end
79
+ end
80
+
81
+ def state_machine_name
82
+ self.class.state_machine_name || @state_machine.class.state_machine.name
83
+ end
84
+
85
+ end
86
+
87
+ class State
88
+
89
+ attr_accessor :after_transition_proc
90
+
91
+ class << self
92
+
93
+ alias_method :state_machine_without_additions, :state_machine
94
+
95
+ def state_machine(*args, &block)
96
+ if block
97
+ state_machine_without_additions(*args, &block).tap do |machine|
98
+ add_callbacks_to(machine)
99
+ end
100
+ else
101
+ state_machine_without_additions(*args)
102
+ end
103
+ end
104
+
105
+ def add_callbacks_to(obj)
106
+ obj.instance_eval do
107
+ after_transition do |obj, transition|
108
+ if obj.after_transition_proc
109
+ obj.after_transition_proc.call(obj, transition)
110
+ end
111
+ end
112
+ end
113
+ end
114
+
115
+ end
116
+
117
+ end
118
+ end
@@ -0,0 +1,25 @@
1
+ # encoding: UTF-8
2
+
3
+ $:.unshift File.join(File.dirname(__FILE__), 'lib')
4
+ require 'ohm/stateful-model/version'
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = "ohm-stateful-model"
8
+ s.version = ::OhmStatefulModel::VERSION
9
+ s.authors = ["Cameron Dutro"]
10
+ s.email = ["camertron@gmail.com"]
11
+ s.homepage = "http://github.com/camertron"
12
+
13
+ s.description = s.summary = "Integrate state machines (from the state_machine gem) into your Ohm models."
14
+
15
+ s.platform = Gem::Platform::RUBY
16
+ s.has_rdoc = true
17
+
18
+ s.add_dependency "ohm", "~> 1.3.2"
19
+ s.add_dependency "state_machine", "~> 1.2.0"
20
+
21
+ s.add_development_dependency 'rake'
22
+
23
+ s.require_path = 'lib'
24
+ s.files = Dir["{lib,spec}/**/**", "Gemfile", "History.txt", "Rakefile", "LICENSE", "ohm-stateful-model.gemspec"]
25
+ end
@@ -0,0 +1,35 @@
1
+ # encoding: UTF-8
2
+
3
+ require 'rspec'
4
+ require 'ohm/stateful_model'
5
+ require 'mock_redis'
6
+
7
+ module Ohm
8
+ class Connection
9
+
10
+ def redis
11
+ threaded[context] ||= ::MockRedis.new
12
+ end
13
+
14
+ end
15
+ end
16
+
17
+ class VehicleState < Ohm::State
18
+
19
+ state_machine :state, :initial => :parked do
20
+ event :park do
21
+ transition :idling => :parked
22
+ end
23
+
24
+ event :start_car do
25
+ transition :parked => :idling
26
+ end
27
+ end
28
+
29
+ end
30
+
31
+ class Vehicle < Ohm::StatefulModel
32
+
33
+ use_state_machine VehicleState
34
+
35
+ end
@@ -0,0 +1,83 @@
1
+ # encoding: UTF-8
2
+
3
+ require 'spec_helper'
4
+
5
+ describe Ohm::StatefulModel do
6
+ it "does not allow more than one state machine to be used" do
7
+ lambda do
8
+ Vehicle.class_eval do
9
+ use_state_machine VehicleState
10
+ end
11
+ end.should raise_error("A state machine is already in use for this model")
12
+ end
13
+
14
+ it "requires state machines to inherit from Ohm::State" do
15
+ lambda do
16
+ model = Class.new(Ohm::StatefulModel) do
17
+ FakeStateMachine = Class.new
18
+ use_state_machine FakeStateMachine
19
+ end
20
+ end.should raise_error("FakeStateMachine must inherit from Ohm::State")
21
+ end
22
+
23
+ it "should allow assigning state on create" do
24
+ vehicle = Vehicle.create(:state => "idling")
25
+ vehicle.state.should == "idling"
26
+ vehicle.state_machine.state.should == "idling"
27
+ vehicle.can_park?.should be_true
28
+ end
29
+
30
+ context "with a model" do
31
+ before(:each) do
32
+ @vehicle = Vehicle.new
33
+ end
34
+
35
+ it "should have successfully defined the state on the model" do
36
+ @vehicle.state.should == "parked"
37
+ @vehicle.state_machine.state.should == "parked"
38
+ end
39
+
40
+ it "allows state assignment" do
41
+ @vehicle.state = "idling"
42
+ @vehicle.state.should == "idling"
43
+ @vehicle.state_machine.state.should == "idling"
44
+ end
45
+
46
+ it "proxies state machine query methods" do
47
+ @vehicle.can_start_car?.should be_true
48
+ @vehicle.parked?.should be_true
49
+ end
50
+
51
+ it "allows changing state" do
52
+ @vehicle.start_car
53
+ @vehicle.state.should == "idling"
54
+ @vehicle.idling?.should be_true
55
+ @vehicle.park
56
+ @vehicle.state.should == "parked"
57
+ @vehicle.parked?.should be_true
58
+ end
59
+
60
+ context "and a persisted record" do
61
+ before(:each) do
62
+ @vehicle.save
63
+ end
64
+
65
+ it "persists the state along with the record" do
66
+ vehicle = Vehicle[@vehicle.id]
67
+ vehicle.state.should == "parked"
68
+ vehicle.parked?.should be_true
69
+ end
70
+
71
+ it "persists changed state" do
72
+ @vehicle.start_car
73
+ @vehicle.state.should == "idling"
74
+ @vehicle.idling?.should be_true
75
+ @vehicle.save
76
+
77
+ vehicle = Vehicle[@vehicle.id]
78
+ vehicle.state.should == "idling"
79
+ vehicle.idling?.should be_true
80
+ end
81
+ end
82
+ end
83
+ end
metadata ADDED
@@ -0,0 +1,95 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ohm-stateful-model
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Cameron Dutro
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-09-25 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: ohm
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: 1.3.2
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: 1.3.2
27
+ - !ruby/object:Gem::Dependency
28
+ name: state_machine
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ~>
32
+ - !ruby/object:Gem::Version
33
+ version: 1.2.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ~>
39
+ - !ruby/object:Gem::Version
40
+ version: 1.2.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: Integrate state machines (from the state_machine gem) into your Ohm models.
56
+ email:
57
+ - camertron@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - lib/ohm/stateful-model/version.rb
63
+ - lib/ohm/stateful_model.rb
64
+ - spec/spec_helper.rb
65
+ - spec/stateful_model_spec.rb
66
+ - Gemfile
67
+ - History.txt
68
+ - Rakefile
69
+ - LICENSE
70
+ - ohm-stateful-model.gemspec
71
+ homepage: http://github.com/camertron
72
+ licenses: []
73
+ metadata: {}
74
+ post_install_message:
75
+ rdoc_options: []
76
+ require_paths:
77
+ - lib
78
+ required_ruby_version: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - '>='
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ required_rubygems_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - '>='
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ requirements: []
89
+ rubyforge_project:
90
+ rubygems_version: 2.0.3
91
+ signing_key:
92
+ specification_version: 4
93
+ summary: Integrate state machines (from the state_machine gem) into your Ohm models.
94
+ test_files: []
95
+ has_rdoc: true