coral_plan 0.1.1 → 0.1.2

data/Gemfile

@@ -4,7 +4,8 @@ gem "coral_core", "~> 0.1"
 
 group :development do
   gem "bundler", "~> 1.2"
-  gem "rspec", "~> 2.10"
-  gem "rdoc", "~> 3.12"  
   gem "jeweler", "~> 1.8"
+  gem "rspec", "~> 2.10"
+  gem "rdoc", "~> 3.12"
+  gem "yard", "~> 0.8"
 end

data/Gemfile.lock

@@ -1,9 +1,9 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    coral_core (0.1.1)
+    coral_core (0.1.4)
       git (= 1.2.5)
-      json (~> 1.7)
+      json (>= 1.4)
       log4r (~> 1.1)
     diff-lcs (1.1.3)
     git (1.2.5)
@@ -15,7 +15,7 @@ GEM
     json (1.7.6)
     log4r (1.1.10)
     rake (10.0.3)
-    rdoc (3.12)
+    rdoc (3.12.1)
       json (~> 1.4)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
@@ -25,6 +25,7 @@ GEM
     rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.2)
+    yard (0.8.4.1)
 
 PLATFORMS
   ruby
@@ -35,3 +36,4 @@ DEPENDENCIES
   jeweler (~> 1.8)
   rdoc (~> 3.12)
   rspec (~> 2.10)
+  yard (~> 0.8)

data/Rakefile

@@ -1,11 +1,12 @@
 # encoding: utf-8
 
 require 'rubygems'
-require 'bundler'
 require 'rake'
-require 'rake/testtask'
-require 'rdoc/task'
+require 'bundler'
 require 'jeweler'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+require 'yard'
 
 require './lib/coral_plan.rb'
 
@@ -47,22 +48,30 @@ Jeweler::RubygemsDotOrgTasks.new
 #-------------------------------------------------------------------------------
 # Testing
 
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+RSpec::Core::RakeTask.new(:spec, :tag) do |spec, task_args|
+  options = []
+  options << "--tag #{task_args[:tag]}" if task_args.is_a?(Array) && ! task_args[:tag].to_s.empty?  
+  spec.rspec_opts = options.join(' ')
 end
 
-task :default => :test
+task :default => :spec
 
 #-------------------------------------------------------------------------------
 # Documentation
 
-Rake::RDocTask.new do |rdoc|
-  version = Coral::Plan::VERSION
+version   = Coral::Plan::VERSION
+doc_title = "coral_plan #{version}"
 
+Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = "coral_plan #{version}"
+  rdoc.title    = doc_title
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+#---
+
+YARD::Rake::YardocTask.new do |ydoc|
+  ydoc.files   = [ 'README*', 'lib/**/*.rb' ]
+  ydoc.options = [ "--output-dir yardoc", "--title '#{doc_title}'" ]
+end

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/coral_plan.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "coral_plan"
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adrian Webb"]
+  s.date = "2013-02-08"
+  s.description = "= coral_plan\n\nThis library provides the ability to create, load, execute, and save \nexecution plans.\n\nThe Coral Plan library contains a system that defines execution plans of \nCLI commands.  The goal is to make it easy to create, edit, load, execute,\nand save these plans in a machine readable format (ie; JSON).  The system \nis composed of Events, Commands, Actions, and of course Plans. There are a\nfew simple rules:\n    \n1. All plans begin with a Command but may have more Commands defined\n   that act in sequence unless there are errors with previous commands.\n    \n2. Commands can trigger Events of various types, where Events are reading\n   and checking (ie; Regular expressions) Command output line by line.\n       \n3. Events have different criteria for measuring success and will have \n   different fields.  For example, a Regexp event contains a 'pattern'\n   field.\n       \n4. Actions listen for Events and run Commands, with the ability to override\n   default Command parameters.  Actions may also generate Events on either\n   successful execution or failure which can trigger other Actions.\n       \nNote:  This library is still very early in development!\n\n== Contributing to coral_plan\n \n* Check out the latest master to make sure the feature hasn't been implemented \n  or the bug hasn't been fixed yet.\n* Check out the issue tracker to make sure someone already hasn't requested \n  it and/or contributed it.\n* Fork the project.\n* Start a feature/bugfix branch.\n* Commit and push until you are happy with your contribution.\n* Make sure to add tests for it. This is important so I don't break it in a \n  future version unintentionally.\n* Please try not to mess with the Rakefile, version, or history. If you want \n  to have your own version, or is otherwise necessary, that is fine, but \n  please isolate to its own commit so I can cherry-pick around it.\n\n== Copyright\n\nLicensed under GPLv3.  See LICENSE.txt for further details.\n\nCopyright (c) 2013  Adrian Webb <adrian.webb@coraltech.net>\nCoral Technology Group LLC"
+  s.email = "adrian.webb@coraltech.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "coral_plan.gemspec",
+    "lib/coral_plan.rb",
+    "lib/coral_plan/action.rb",
+    "lib/coral_plan/base.rb",
+    "lib/coral_plan/command.rb",
+    "lib/coral_plan/event.rb",
+    "spec/coral_test_kernel.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/coraltech/ruby-coral_plan"
+  s.licenses = ["GPLv3"]
+  s.rdoc_options = ["--title", "Coral Execution Plan library", "--main", "README.rdoc", "--line-numbers"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.8.1")
+  s.rubyforge_project = "coral_plan"
+  s.rubygems_version = "1.8.15"
+  s.summary = "Provides the ability to create, load, execute, and save execution plans"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<coral_core>, ["~> 0.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.10"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8"])
+    else
+      s.add_dependency(%q<coral_core>, ["~> 0.1"])
+      s.add_dependency(%q<bundler>, ["~> 1.2"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8"])
+      s.add_dependency(%q<rspec>, ["~> 2.10"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<yard>, ["~> 0.8"])
+    end
+  else
+    s.add_dependency(%q<coral_core>, ["~> 0.1"])
+    s.add_dependency(%q<bundler>, ["~> 1.2"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8"])
+    s.add_dependency(%q<rspec>, ["~> 2.10"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<yard>, ["~> 0.8"])
+  end
+end
+

data/spec/coral_test_kernel.rb

@@ -0,0 +1,22 @@
+
+module Kernel
+
+  #-----------------------------------------------------------------------------
+  # Utilities
+
+  def capture
+    out     = StringIO.new
+    $stdout = out
+    
+    error   = StringIO.new
+    $stderr = error
+    
+    # Go do stuff!
+    yield    
+    return out, error
+    
+  ensure
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+
+require 'rspec'
+require 'stringio'
+require 'coral_plan'
+
+require 'coral_test_kernel'
+
+#-------------------------------------------------------------------------------
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+  config.color_enabled  = true
+  config.formatter      = 'documentation'
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: coral_plan
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Adrian Webb
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-07 00:00:00 Z
+date: 2013-02-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: coral_core
@@ -48,9 +48,24 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: jeweler
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 8
+        version: "1.8"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -61,11 +76,11 @@ dependencies:
         - 10
         version: "2.10"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: rdoc
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -76,22 +91,22 @@ dependencies:
         - 12
         version: "3.12"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: yard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 31
+        hash: 27
         segments: 
-        - 1
+        - 0
         - 8
-        version: "1.8"
+        version: "0.8"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 description: |-
   = coral_plan
   
@@ -157,11 +172,14 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- coral_plan.gemspec
 - lib/coral_plan.rb
 - lib/coral_plan/action.rb
 - lib/coral_plan/base.rb
 - lib/coral_plan/command.rb
 - lib/coral_plan/event.rb
+- spec/coral_test_kernel.rb
+- spec/spec_helper.rb
 homepage: http://github.com/coraltech/ruby-coral_plan
 licenses: 
 - GPLv3