strategy 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 313846f0c19dea154b8ba65298ce28eb79043bc5
-  data.tar.gz: ff25f117d25be39dc138c54f230f7512d3b7a48e
+  metadata.gz: b90a3cd26bb65310c0188bc84c4c32cf01c6eaa8
+  data.tar.gz: ffe523137e89a5d3514d6eddda99f67f8169af36
 SHA512:
-  metadata.gz: eea489e5ae66e91a7d8dc14aa11a3c5ca0166ce485a006fd70c1a3678d5e1e84a7420db23c37e84952fc5399fa2999353c40f87f91b34d3bca619a9ef4727779
-  data.tar.gz: ef5e7e701e18ba6749bb5829c1bd90624584419066f9b61076db8fc7418f1ae98799f144d1f3293a49b0dcdf34ff1f4b74b801f14bcd1ecc161c67a3be272e8f
+  metadata.gz: 46c3eb57bd9e9cd9e19b2c52682d7b92a645db9d996d97b095cf4ede803fd3b157b162198e76f5bdc2d85f9d372c5ac99b7a8c36d4d44b03e89916205b4c7eaf
+  data.tar.gz: 7fd270a4ba0a6ec123948af44beba92c82d91a41ae122cd68e6ef1f1d50e7a719a523560dfe87986c8bc481d6855dd25c238dbe6ef7f2a8d4a161e3e59cfe782

data/lib/strategy.rb

@@ -1,2 +1,30 @@
 require 'strategy/step'
 require 'strategy/plan'
+
+module Strategy
+  # Convenience function to get a new Step quickly
+  #
+  # == Parameters:
+  # desc::
+  #   The description of the new step
+  #
+  # == Returns:
+  # A Strategy::Step with the specified description
+  #
+  def self.step desc
+    Strategy::Step.new desc
+  end
+
+  # Convenience function to get a new Plan quickly
+  #
+  # == Parameters:
+  # desc::
+  #   The description of the new plan
+  #
+  # == Returns:
+  # A Strategy::Plan with the specified description
+  #
+  def self.plan desc
+    Strategy::Plan.new desc
+  end
+end

data/lib/strategy/plan.rb

@@ -5,17 +5,17 @@ module Strategy
   # highest-level container around an execution strategy, and may contain as few
   # or as many Step objects as required.
   class Plan
-    attr_reader :name, :steps
+    attr_reader :description, :steps
 
     # Create a new plan, to which individual execution steps will be added.
     #
     # == Parameters:
-    # name::
-    #   The name of the execution plan. This is a short sentence which
+    # description::
+    #   The description of the execution plan. This is a short sentence which
     #   describes what the plan will do.
     #
-    def initialize name
-      @name = name
+    def initialize description
+      @description = description
       @steps = []
     end
 
@@ -41,7 +41,7 @@ module Strategy
       @steps.each do |step|
         n += 1
         if block_given?
-          yield n, step.name
+          yield n, step.description
         end
         step.execute!
       end
@@ -51,10 +51,10 @@ module Strategy
     # a textual representation of the execution plan which can be displayed to a
     # user before executing anything for confirmation.
     def describe
-      description = [@name]
+      description = [@description]
       n = 0
       @steps.each do |step|
-        description << "  #{n+=1}. #{step.name}"
+        description << "  #{n+=1}. #{step.description}"
       end
       description.join "\n"
     end

data/lib/strategy/step.rb

@@ -3,17 +3,17 @@ module Strategy
   # contains a set of actions, which are the actual pieces of executable
   # code, as well as a high-level description of what the step accomplishes.
   class Step
-    attr_reader :name, :actions
+    attr_reader :description, :actions
 
     # Creates a new Step, which can later be added to a Plan.
     #
     # == Parameters:
-    # name::
-    #   The name of the step. This is a high-level description of what the
-    #   step is supposed to accomplish.
+    # description::
+    #   The description of the step. This is a high-level description of what
+    #   the step is supposed to accomplish.
     #
-    def initialize name
-      @name = name
+    def initialize description
+      @description = description
       @actions = []
     end
 

data/spec/strategy/plan_spec.rb

@@ -2,29 +2,29 @@ require 'spec_helper'
 
 describe 'Plan' do
   before :all do
-    @plan = Strategy::Plan.new 'Test Plan'
+    @plan = Strategy.plan 'Test Plan'
 
-    step = Strategy::Step.new 'Step 1'
+    step = Strategy.step 'Step 1'
     step.action { puts 1 }
     @plan.add step
 
-    step = Strategy::Step.new 'Step 2'
+    step = Strategy.step 'Step 2'
     step.action { puts 2 }
     @plan.add step
   end
 
   it 'should add a description to the plan' do
-    expect(@plan.name).to eq('Test Plan')
+    expect(@plan.description).to eq('Test Plan')
   end
 
   it 'should accept new steps' do
-    step = Strategy::Step.new 'Step 3'
+    step = Strategy.step 'Step 3'
     step.action { puts 3 }
     @plan.add step
     expect(@plan.steps.length).to eq(3)
   end
 
-  it 'should reflect the proper plan name' do
+  it 'should reflect the proper plan description' do
     expect(@plan.describe).to include('Test Plan')
   end
 

data/spec/strategy/step_spec.rb

@@ -2,11 +2,11 @@ require 'spec_helper'
 
 describe 'Step' do
   before :all do
-    @step = Strategy::Step.new 'Test Step'
+    @step = Strategy.step 'Test Step'
   end
 
-  it 'should create a new step with proper name' do
-    expect(@step.name).to eq('Test Step')
+  it 'should create a new step with proper description' do
+    expect(@step.description).to eq('Test Step')
   end
 
   it 'should add an action properly' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strategy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ryan Uber