strategy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6959b8c7099aa8ddaf5c6a868e97ecdc3751c8c
+  data.tar.gz: f9999439f1e67db5a104b58f83feac6fe85db868
+SHA512:
+  metadata.gz: 384e90d59bef7a33eb45f678d46b509dae1f3902e1c8d1fc510f72f26164c62f3338817bfabd266a879e5c8e838305d93925b8e2fa04767acebc0f391551f9b0
+  data.tar.gz: 7b52e70710d073c8c07e609aa7f51a5ba89402e72ae1f68b6f042802960c51b1f7fcfebc4bf9836e8e23a9fbe71d07b2c02222e207ae6267e2e9308f72718e9b

data/lib/strategy.rb

@@ -0,0 +1,2 @@
+require 'strategy/step'
+require 'strategy/plan'

data/lib/strategy/plan.rb

@@ -0,0 +1,62 @@
+module Strategy
+  # Plan is a wrapper around a set of executable steps. It maintains a runbook
+  # of what to do and how to do it, and provides an easy way of displaying an
+  # execution plan or "strategy" before executing anything. A Plan object is the
+  # highest-level container around an execution strategy, and may contain as few
+  # or as many Step objects as required.
+  class Plan
+    attr_reader :name
+
+    # 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
+    #   describes what the plan will do.
+    #
+    def initialize name
+      @name = name
+      @steps = []
+    end
+
+    # Adds a step object to the execution plan. Each step carries its own set of
+    # actions, description, and so on.
+    #
+    # == Parameters:
+    # step::
+    #   A Strategy::Step object encapsulating some actions
+    #
+    def add step
+      if !step.kind_of? Step
+        raise TypeError, "Expected Strategy::Step but got #{step.class}"
+      end
+      @steps << step
+    end
+
+    # Iterate over all steps contained in the plan and execute them. This method
+    # will yield the step number and description if a block is given, which
+    # enables one to print out a step banner just before execution if desired.
+    def execute!
+      n = 0
+      @steps.each do |step|
+        n += 1
+        if block_given?
+          yield n, step.name
+        end
+        step.execute!
+      end
+    end
+
+    # Describe the plan itself and all steps involved. This method puts together
+    # a textual representation of the execution plan which can be displayed to a
+    # user before executing anything for confirmation.
+    def describe
+      description = [@name]
+      n = 0
+      @steps.each do |step|
+        description << "  #{n+=1}. #{step.name}"
+      end
+      description.join "\n"
+    end
+  end
+end

data/lib/strategy/step.rb

@@ -0,0 +1,33 @@
+module Strategy
+  # Step encapsulates a single step in a larger plan of execution. A step
+  # 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
+
+    # 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.
+    #
+    def initialize name
+      @name = name
+      @actions = []
+    end
+
+    # Adds a new action to the step. Actions are given as a code block, and
+    # will be executed in the order they are added (if the step is executed).
+    def action &block
+      @actions << block
+    end
+
+    # Execute all actions sequentially as they appear in the Step.
+    def execute!
+      @actions.each do |action|
+        action.call
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: strategy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Uber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create runnable, stepped plans to control execution
+email: ru@ryanuber.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/strategy/plan.rb
+- lib/strategy/step.rb
+- lib/strategy.rb
+homepage: https://github.com/ryanuber/strategy-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '1.8'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Create runnable, stepped execution plans
+test_files: []