distribot-planner 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: fab7851292ebeb2fc444596898b00dad7406d8f9
4
+ data.tar.gz: 176a615f90f2dc202cfdb6b8dd3508942998705f
5
+ SHA512:
6
+ metadata.gz: 520c59020b7a542103d03fa987e08f4d0a1452b65f33732c8b565e2a83ec8b39aa1d5a3c2788c8669fb36f8e36bb8782acd90bb2f1c3650dbd0ff1888d9de0c7
7
+ data.tar.gz: cdc75af97b29853e8409e4bc21b857fb86580e14895f21bcb96309b907e0eea3ec4d603c2f68fff9a57bcf0f74ec7f91ee9428af3839fbe5c7ac3e7c15abe422
data/.gitignore ADDED
@@ -0,0 +1,2 @@
1
+ coverage/
2
+ *.png
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format doc
2
+ --color
3
+ --tty
data/.travis.yml ADDED
@@ -0,0 +1,10 @@
1
+ ---
2
+
3
+ language: ruby
4
+ rvm: 2.0.0
5
+ before_install:
6
+ - gem install bundler --no-ri --no-rdoc
7
+ script: CODECLIMATE_REPO_TOKEN=x bundle && bundle exec rspec
8
+ addons:
9
+ code_climate:
10
+ repo_token: x
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+
2
+ source 'https://rubygems.org'
3
+ gem "facets", require: false
4
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,63 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ distribot-planner (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ activesupport (4.2.3)
10
+ i18n (~> 0.7)
11
+ json (~> 1.7, >= 1.7.7)
12
+ minitest (~> 5.1)
13
+ thread_safe (~> 0.3, >= 0.3.4)
14
+ tzinfo (~> 1.1)
15
+ byebug (5.0.0)
16
+ columnize (= 0.9.0)
17
+ columnize (0.9.0)
18
+ diff-lcs (1.2.5)
19
+ docile (1.1.5)
20
+ facets (3.0.0)
21
+ i18n (0.7.0)
22
+ json (1.8.3)
23
+ minitest (5.7.0)
24
+ rake (10.4.2)
25
+ rspec (3.3.0)
26
+ rspec-core (~> 3.3.0)
27
+ rspec-expectations (~> 3.3.0)
28
+ rspec-mocks (~> 3.3.0)
29
+ rspec-core (3.3.2)
30
+ rspec-support (~> 3.3.0)
31
+ rspec-expectations (3.3.1)
32
+ diff-lcs (>= 1.2.0, < 2.0)
33
+ rspec-support (~> 3.3.0)
34
+ rspec-mocks (3.3.2)
35
+ diff-lcs (>= 1.2.0, < 2.0)
36
+ rspec-support (~> 3.3.0)
37
+ rspec-support (3.3.0)
38
+ shoulda-matchers (2.8.0)
39
+ activesupport (>= 3.0.0)
40
+ simplecov (0.10.0)
41
+ docile (~> 1.1.0)
42
+ json (~> 1.8)
43
+ simplecov-html (~> 0.10.0)
44
+ simplecov-html (0.10.0)
45
+ thread_safe (0.3.5)
46
+ tzinfo (1.2.2)
47
+ thread_safe (~> 0.1)
48
+
49
+ PLATFORMS
50
+ ruby
51
+
52
+ DEPENDENCIES
53
+ bundler (~> 1.7)
54
+ byebug
55
+ distribot-planner!
56
+ facets
57
+ rake (~> 10.0)
58
+ rspec
59
+ shoulda-matchers
60
+ simplecov
61
+
62
+ BUNDLED WITH
63
+ 1.11.2
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright {yyyy} {name of copyright owner}
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,43 @@
1
+
2
+ # distribot-planner
3
+
4
+ A planning extension for Distribot handlers.
5
+
6
+ ## Installation
7
+
8
+ ### In your Gemfile
9
+
10
+ ```ruby
11
+ gem 'distribot-planner'
12
+ ```
13
+
14
+ ### Usage
15
+
16
+ ```ruby
17
+ require 'distribot-planner'
18
+
19
+ Distribot.plan :greeting do
20
+ task :get_name do
21
+ handler HandlerTo::GetName
22
+ end
23
+
24
+ group :decide_greeting_context, depends_on: :get_name do
25
+ handler HandlerTo::GetTimeOfDay
26
+ handler HandlerTo::GuessGender
27
+ handler HandlerTo::DetermineSocialStatus
28
+ end
29
+
30
+ task :assemble_greeting, depends_on: :decide_greeting_context do
31
+ handler HandlerTo::AssembleGreeting
32
+ end
33
+
34
+ task :wait_for_proper_timing, depends_on: :assemble_greeting do
35
+ handler HandlerTo::WaitForProperTiming
36
+ end
37
+
38
+ task :say_greeting, depends_on: :wait_for_proper_timing do
39
+ handler HandlerTo::SayGreeting
40
+ end
41
+ end
42
+
43
+ ```
data/Rakefile ADDED
@@ -0,0 +1,16 @@
1
+ include Rake::DSL
2
+
3
+ task :environment do
4
+ require 'bundler/setup'
5
+ lib = File.expand_path('../lib', __FILE__)
6
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
7
+ require 'distribot-plan'
8
+ end
9
+
10
+ desc 'enter a REPL console within this project environment'
11
+ task :console => :environment do
12
+ require 'irb'
13
+ require 'irb/completion'
14
+ ARGV.clear
15
+ IRB.start
16
+ end
@@ -0,0 +1,22 @@
1
+ Gem::Specification.new do |spec|
2
+ spec.name = 'distribot-planner'
3
+ spec.version = '0.1.0'
4
+ spec.authors = ['John Drago']
5
+ spec.email = 'jdrago.999@gmail.com'
6
+ spec.homepage = 'https://twitter.com/devstack'
7
+ spec.summary = 'A planning extension for Distribot handlers.'
8
+ spec.description = 'A planning extension for Distribot handlers.'
9
+ spec.required_rubygems_version = '>= 1.3.6'
10
+
11
+ spec.files = `git ls-files -z`.split("\x0")
12
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
13
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
14
+ spec.require_paths = ['lib']
15
+
16
+ spec.add_development_dependency 'bundler', '~> 1.7'
17
+ spec.add_development_dependency 'rake', '~> 10.0'
18
+ spec.add_development_dependency 'rspec'
19
+ spec.add_development_dependency 'shoulda-matchers'
20
+ spec.add_development_dependency 'byebug'
21
+ spec.add_development_dependency 'simplecov'
22
+ end
@@ -0,0 +1,48 @@
1
+
2
+ require 'ostruct'
3
+ module Distribot
4
+
5
+ class Plan
6
+ include TSort
7
+ attr_accessor :name, :tasks
8
+ def initialize(name)
9
+ @name = name
10
+ @tasks = [ ]
11
+ end
12
+
13
+ def group(name, options={}, &block)
14
+ task_group = TaskGroup.new(name, options[:depends_on])
15
+ task_group.instance_eval(&block)
16
+ self.tasks += task_group.tasks
17
+ end
18
+
19
+ def task(name, options={}, &block)
20
+ if tasks.select{ |task| task.name.to_s == name.to_s }.any?
21
+ raise TaskConfigError.new "The name '%s' is already taken"
22
+ end
23
+ task = Task.new(name, options[:depends_on])
24
+ task.instance_eval(&block)
25
+ tasks << task
26
+ end
27
+
28
+ def schedule
29
+ grouped = tsort_each_child.map{|parent, tasks| tasks}
30
+ grouped.map{ |g| g.map(&:handler_data) }
31
+ end
32
+
33
+ def self.all
34
+ @@plans ||= [ ]
35
+ @@plans
36
+ end
37
+
38
+ def self.reset!
39
+ @@plans = [ ]
40
+ end
41
+
42
+ private
43
+
44
+ def tsort_each_child(&block)
45
+ tasks.group_by(&:depends_on).each(&block)
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,24 @@
1
+
2
+ module Distribot
3
+ class Task < Struct.new(:name, :depends_on, :handler_data)
4
+ def handler(handler)
5
+ case handler.class.to_s
6
+ when 'String', 'Class'
7
+ self.handler_data = {
8
+ name: handler
9
+ }
10
+ when 'Hash'
11
+ handler[:version] ||= nil
12
+ unless handler.keys.sort == [:name, :version]
13
+ raise TaskConfigError.new 'task handler must contain :name and :version'
14
+ end
15
+ self.handler_data = {
16
+ name: handler[:name],
17
+ version: handler[:version]
18
+ }.reject{ |k,v| v.nil? }
19
+ else
20
+ raise TaskConfigError.new 'task handler must be a String or Hash, not a %s' % handler.class.to_s
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,14 @@
1
+
2
+ module Distribot
3
+ class TaskGroup < Struct.new(:name, :depends_on)
4
+ attr_accessor :tasks
5
+
6
+ def handler(handler_data)
7
+ @tasks ||= [ ]
8
+ task_name = '%s.%s' % [ self.name, name ]
9
+ task = Task.new(task_name, self.depends_on)
10
+ task.handler(handler_data)
11
+ @tasks << task
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,18 @@
1
+
2
+ require 'facets/module/cattr'
3
+ require 'tsort'
4
+ require 'distribot/plan'
5
+ require 'distribot/task'
6
+ require 'distribot/task_group'
7
+
8
+ module Distribot
9
+ class TaskConfigError < StandardError; end
10
+
11
+ def self.plan(name, &block)
12
+ plan = Plan.new(name)
13
+ plan.instance_eval(&block)
14
+ Plan.all << plan
15
+ plan
16
+ end
17
+
18
+ end
@@ -0,0 +1,29 @@
1
+ require 'spec_helper'
2
+
3
+ describe Distribot do
4
+ it 'is a module' do
5
+ expect(Distribot).to be_a Module
6
+ end
7
+ it 'exposes Distribot.plan as a static method on the Distribot module' do
8
+ expect(Distribot).to respond_to :plan
9
+ end
10
+ describe '#plan' do
11
+ before do
12
+ @plan_name = SecureRandom.hex(6)
13
+ expect(Distribot::Plan).to receive(:new).with(@plan_name) do |&block|
14
+ plan = double('plan')
15
+ expect(plan).to receive(:instance_eval)
16
+ expect(Distribot::Plan).to receive(:all) do
17
+ fake_all = double('all')
18
+ expect(fake_all).to receive(:<<).with(plan)
19
+ fake_all
20
+ end
21
+ plan
22
+ end
23
+ end
24
+ it 'creates a new plan and adds it to the collection of plans' do
25
+ # Enough hype:
26
+ Distribot.plan(@plan_name) do; end
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,121 @@
1
+ require 'spec_helper'
2
+
3
+ describe Distribot::Plan do
4
+ it 'is a class' do
5
+ expect(Distribot::Plan).to be_a Class
6
+ end
7
+
8
+ describe 'attributes' do
9
+ let(:subject){ described_class.new(:foo) }
10
+ it { should respond_to :name }
11
+ it { should respond_to :tasks }
12
+ it 'tasks should be an array' do
13
+ expect(described_class.new(:foo).tasks).to be_an Array
14
+ end
15
+ end
16
+
17
+ describe '.all' do
18
+ before do
19
+ Distribot.plan :foo do; end
20
+ end
21
+ it 'returns the collection of Plans' do
22
+ expect(described_class.all.map(&:name)).to include :foo
23
+ end
24
+ end
25
+
26
+ describe '.reset!' do
27
+ before do
28
+ Distribot.plan :foo do; end
29
+ end
30
+ it 'clears any Plans from the collection' do
31
+ described_class.reset!
32
+ expect(described_class.all).to be_empty
33
+ end
34
+ end
35
+
36
+ describe '#group(name, options={}, &block)' do
37
+ before do
38
+ @expected_tasks = ['foo', 'bar']
39
+ expect(Distribot::TaskGroup).to receive(:new) do
40
+ group = double('group')
41
+ expect(group).to receive(:instance_eval)
42
+ expect(group).to receive(:tasks){ @expected_tasks }
43
+ group
44
+ end
45
+
46
+ @plan = described_class.new(:foo)
47
+ @tasks = @plan.group(:foo) do; end
48
+ end
49
+ it 'creates a new TaskGroup and reaps the tasks from it' do
50
+ expect(@tasks).to eq @expected_tasks
51
+ end
52
+ end
53
+
54
+ describe '#task(name, options={}, &block)' do
55
+ before do
56
+ @plan = described_class.new(:foo)
57
+ end
58
+ context 'when the task name' do
59
+ context 'is not already used' do
60
+ before do
61
+ @name = SecureRandom.hex(6)
62
+ @plan.task(@name) do
63
+ handler 'Foo'
64
+ end
65
+ end
66
+ it 'adds the task to the collection of tasks' do
67
+ expect(@plan.tasks.map(&:name)).to include @name
68
+ end
69
+ end
70
+ context 'is already in use' do
71
+ before do
72
+ @name = SecureRandom.hex(6)
73
+ @plan.task(@name) do
74
+ handler 'Foo'
75
+ end
76
+ end
77
+ it 'raises an exception' do
78
+ expect {
79
+ @plan.task(@name) do
80
+ handler 'Bar'
81
+ end
82
+ }.to raise_error Distribot::TaskConfigError
83
+ end
84
+ end
85
+ end
86
+ end
87
+
88
+ describe '#schedule' do
89
+ before do
90
+ Distribot.plan :foo do
91
+ task :step1 do
92
+ handler 'Step1Handler'
93
+ end
94
+ group :step2, depends_on: :step1 do
95
+ handler 'Foo'
96
+ handler 'Bar'
97
+ handler 'Baz'
98
+ end
99
+ task :step3_a, depends_on: :step2 do
100
+ handler 'Bux'
101
+ end
102
+ task :step3_b, depends_on: :step2 do
103
+ handler 'Qux'
104
+ end
105
+ task :step4, depends_on: :step3_b do
106
+ handler 'Flux'
107
+ end
108
+ end
109
+ @expected_schedule = [
110
+ [{name: 'Step1Handler'}],
111
+ [{name: 'Foo'},{name: 'Bar'},{name: 'Baz'}],
112
+ [{name: 'Bux'},{name: 'Qux'}],
113
+ [{name: 'Flux'}]
114
+ ]
115
+ end
116
+ it 'returns a schedule data structure based on the described Plans' do
117
+ expect(Distribot::Plan.all.last.schedule).to eq @expected_schedule
118
+ end
119
+ end
120
+
121
+ end
@@ -0,0 +1,25 @@
1
+ require 'spec_helper'
2
+
3
+ describe Distribot::TaskGroup do
4
+ it 'is a class' do
5
+ expect(Distribot::TaskGroup).to be_a Class
6
+ end
7
+
8
+ describe 'attributes' do
9
+ it { should respond_to :name }
10
+ it { should respond_to :depends_on }
11
+ it { should respond_to :tasks }
12
+ end
13
+
14
+ describe '#handler(handler_data)' do
15
+ before do
16
+ @task_group = described_class.new(:foo)
17
+ @task_group.handler(name: 'FooBar', version: '0.1.1')
18
+ end
19
+ it 'should add a properly-configured Distribot::Task to #tasks' do
20
+ expect(@task_group.tasks.count).to eq 1
21
+ task = @task_group.tasks.last
22
+ expect(task.handler_data).to eq(name: 'FooBar', version: '0.1.1')
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,67 @@
1
+ require 'spec_helper'
2
+
3
+ describe Distribot::Task do
4
+ it 'is a class' do
5
+ expect(described_class).to be_a Class
6
+ end
7
+
8
+ describe 'attributes' do
9
+ it { should respond_to :name }
10
+ it { should respond_to :depends_on }
11
+ it { should respond_to :handler_data }
12
+ end
13
+
14
+ describe '#handler(handler)' do
15
+ before do
16
+ @task = described_class.new(:foo)
17
+ end
18
+ context 'when given a' do
19
+ context 'String' do
20
+ before do
21
+ @task.handler('Foo')
22
+ end
23
+ it 'uses a nil version' do
24
+ expect(@task.handler_data[:version]).to be_nil
25
+ end
26
+ end
27
+ context 'Hash' do
28
+ context 'which is valid' do
29
+ before do
30
+ @valid = {
31
+ name: 'Foo',
32
+ version: '0.1.0'
33
+ }
34
+ end
35
+ context 'and includes version' do
36
+ before do
37
+ @task.handler(@valid)
38
+ end
39
+ it 'uses the provided version' do
40
+ expect(@task.handler_data[:version]).to eq @valid[:version]
41
+ end
42
+ end
43
+ context 'and does not include version' do
44
+ before do
45
+ @task.handler(@valid.delete_if{|x,y| x == :version})
46
+ end
47
+ it 'uses a nil version' do
48
+ expect(@task.handler_data[:version]).to be_nil
49
+ end
50
+ end
51
+ end
52
+ context 'which is invalid because' do
53
+ context 'it is a hash with invalid keys' do
54
+ it 'raises an exception' do
55
+ expect{@task.handler(invalid: Hash)}.to raise_error Distribot::TaskConfigError
56
+ end
57
+ end
58
+ context 'is is an unrecognized type' do
59
+ it 'raises an exception' do
60
+ expect{@task.handler(12345)}.to raise_error Distribot::TaskConfigError
61
+ end
62
+ end
63
+ end
64
+ end
65
+ end
66
+ end
67
+ end
@@ -0,0 +1,62 @@
1
+ # Did we get executed via 'rake'?
2
+ is_rake_exec = $0 =~ /\/rake/
3
+
4
+ unless is_rake_exec
5
+ ENV['RACK_ENV'] = 'test'
6
+ require 'simplecov'
7
+ SimpleCov.start do
8
+ add_filter '.vendor/'
9
+ add_filter 'spec/'
10
+ end
11
+ SimpleCov.minimum_coverage 52
12
+ end
13
+
14
+ require 'rspec'
15
+ require 'bundler'
16
+ require 'shoulda-matchers'
17
+ require 'byebug'
18
+
19
+ lib = File.expand_path('../../lib', __FILE__)
20
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
21
+
22
+ require 'distribot-planner'
23
+
24
+ Bundler.load
25
+
26
+ def configure_rspec
27
+
28
+ RSpec.configure do |config|
29
+
30
+ config.expect_with :rspec do |expectations|
31
+ expectations.include_chain_clauses_in_custom_matcher_descriptions = true
32
+ # Allow foo.should syntax:
33
+ expectations.syntax = [:should, :expect]
34
+ end
35
+
36
+ config.mock_with :rspec do |mocks|
37
+ mocks.syntax = [:should, :expect]
38
+ mocks.verify_partial_doubles = true
39
+ end
40
+
41
+ config.run_all_when_everything_filtered = true
42
+
43
+ config.warnings = true
44
+
45
+ if config.files_to_run.one?
46
+ config.default_formatter = 'doc'
47
+ end
48
+
49
+ config.before(:each) do
50
+ Distribot::Plan.reset!
51
+ end
52
+
53
+ config.order = :random
54
+
55
+ Kernel.srand config.seed
56
+ end
57
+ end
58
+
59
+
60
+ unless is_rake_exec
61
+ configure_rspec()
62
+ end
metadata ADDED
@@ -0,0 +1,149 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: distribot-planner
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - John Drago
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2016-03-17 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.7'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.7'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
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
+ - !ruby/object:Gem::Dependency
56
+ name: shoulda-matchers
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: byebug
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: simplecov
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ description: A planning extension for Distribot handlers.
98
+ email: jdrago.999@gmail.com
99
+ executables: []
100
+ extensions: []
101
+ extra_rdoc_files: []
102
+ files:
103
+ - ".gitignore"
104
+ - ".rspec"
105
+ - ".travis.yml"
106
+ - Gemfile
107
+ - Gemfile.lock
108
+ - LICENSE
109
+ - README.md
110
+ - Rakefile
111
+ - distribot-planner.gemspec
112
+ - lib/distribot-planner.rb
113
+ - lib/distribot/plan.rb
114
+ - lib/distribot/task.rb
115
+ - lib/distribot/task_group.rb
116
+ - spec/distribot-plan/module_spec.rb
117
+ - spec/distribot-plan/plan_spec.rb
118
+ - spec/distribot-plan/task_group_spec.rb
119
+ - spec/distribot-plan/task_spec.rb
120
+ - spec/spec_helper.rb
121
+ homepage: https://twitter.com/devstack
122
+ licenses: []
123
+ metadata: {}
124
+ post_install_message:
125
+ rdoc_options: []
126
+ require_paths:
127
+ - lib
128
+ required_ruby_version: !ruby/object:Gem::Requirement
129
+ requirements:
130
+ - - ">="
131
+ - !ruby/object:Gem::Version
132
+ version: '0'
133
+ required_rubygems_version: !ruby/object:Gem::Requirement
134
+ requirements:
135
+ - - ">="
136
+ - !ruby/object:Gem::Version
137
+ version: 1.3.6
138
+ requirements: []
139
+ rubyforge_project:
140
+ rubygems_version: 2.2.2
141
+ signing_key:
142
+ specification_version: 4
143
+ summary: A planning extension for Distribot handlers.
144
+ test_files:
145
+ - spec/distribot-plan/module_spec.rb
146
+ - spec/distribot-plan/plan_spec.rb
147
+ - spec/distribot-plan/task_group_spec.rb
148
+ - spec/distribot-plan/task_spec.rb
149
+ - spec/spec_helper.rb