project 0.8.0 → 0.9.0

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.9.0

data/lib/project/errors.rb

@@ -10,9 +10,6 @@ module Project
   end
   
   class AbstractClassError < ProjectError; end
-  class MissingProjectKeyError < ProjectError; end
-  class MissingProjectError < ProjectError; end
-  class MissingWorkflowError < ProjectError; end
   class MissingTemplateVariable < ProjectError; end
   
 end

data/lib/project/loader.rb

@@ -1,5 +1,5 @@
-require 'fileutils'
 module Project
+  require 'fileutils'
   require 'yaml'
   
   class Loader

data/lib/project/runner.rb

@@ -16,19 +16,32 @@ module Project
     end
     
     def run!
-      $stdout.puts "* Opening project '#{self.key}' using workflow '#{self.project.workflow}'"
+      say "* Opening project '#{self.key}' using workflow '#{self.project.workflow}'"
+      seperator
       
-      self.workflow.each do |command|
+      self.workflow.each_with_index do |command, index|
         command = Template.new(command, self.project).parse
+        output  = %x[ #{command} ].chomp
         
-        %x[ #{command} ]
+        unless output.empty?
+          say output
+          seperator unless index == (self.workflow.size - 1)
+        end
       end
     end
     
     private
+    def say(*things)
+      $stdout.puts *things
+    end
+    
     def exit_with(message, code=1)
-      $stdout.puts message
+      say message
       Kernel.exit(code)
     end
+    
+    def seperator
+      say "", ("*" * 80), ""
+    end
   end
 end

data/project.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{project}
-  s.version = "0.8.0"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Nesbitt"]

data/readme.rdoc

@@ -9,7 +9,7 @@
 
 == Overview
 
-
+Project aims to make working with multiple projects as simple as possible. By registering projects with workflows you can quickly create a set of commands that will be run against each project.
 
 == Installation
 
@@ -17,11 +17,34 @@ The project is hosted on rubygems.org. Getting it is simple:
 
   gem install project
 
-# Install notes
+Once the gem is installed run:
+
+  project install
+
+Assuming you haven't already had the gem installed this will create a file at ~/.project. This is the main configuration file used to drive project.
 
 == Usage
 
+Project uses a YAML file for its configuration. Edit the file located in at ~/.project to you liking.
+
+=== Projects
+
+A project can be anything revolving around a particular context. A typical use would be opening your default environment surrounding a project. An example project configuration might look like this:
+
+  :name:
+    :path: /path/to/project
+    :workflow: default
+
+The only required key within a project is *workflow*. This is important as you need to tell project which workflow to apply against the project. Any other variables specified here will be passed through to a workflow (more on this below).
+
+==== Workflows
+
+A workflow is a set of command you want run against a particular project. An example workflow might look something like this:
+
+  :default:
+    - cd %path
 
+A workflow is just a YAML array of templated commands. Any variable used in a workflow will get looked up on the project that is running it. In the example above the %path variable has been replaced by the path variable specified within the project. Using this method you can quickly build up a set of common workflows to use against any project.
 
 == Bugs
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 8
+  - 9
   - 0
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Josh Nesbitt