project 0.9.3 → 1.0.0

data/Rakefile

@@ -6,7 +6,7 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "project"
     gem.summary = "A streamlined approach to working with multiple projects and tasks."
-    gem.description = ""
+    gem.description = "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."
     gem.email = "josh@josh-nesbitt.net"
     gem.homepage = "http://github.com/joshnesbitt/project"
     gem.authors = ["Josh Nesbitt"]

data/VERSION

@@ -1 +1 @@
-0.9.3
+1.0.0

data/lib/project.rb

@@ -14,4 +14,5 @@ require 'project'
 require 'loader'
 require 'runner'
 
-Project::Loader.config_path(ENV["HOME"] + "/.project")
+PROJECT_CONFIG = File.join(ENV["HOME"], '.project')
+Project::Loader.config_path(PROJECT_CONFIG)

data/lib/project/core_ext.rb

@@ -1,5 +1,3 @@
-# Core extensions
-
 class OpenStruct
   
   def [](key)

data/lib/project/loader.rb

@@ -10,15 +10,25 @@ module Project
         path ? (@config_path = path) : @config_path
       end
     end
+    attr_reader :raw_config
+    
+    def initialize
+      @template_path = File.join(ROOT, 'templates', 'example.yml')
+    end
     
     def load!
       if File.exists?(self.class.config_path)
-        config = YAML.load_file(self.class.config_path)
-        Project.load_from_hash(config[:projects]) unless config[:projects].nil?
-        Workflow.load_from_hash(config[:workflows]) unless config[:workflows].nil?
+        @raw_config = YAML.load_file(self.class.config_path)
+        
+        Project.load_from_hash(@raw_config[:projects]) unless @raw_config[:projects].nil?
+        Workflow.load_from_hash(@raw_config[:workflows]) unless @raw_config[:workflows].nil?
       else
-        FileUtils.cp(ROOT + "/templates/example.yml", self.class.config_path, { :verbose => true })
-        $stdout.puts "* No YAML file found at #{self.class.config_path}. One has been created for you, please edit it to your liking and try again."
+        FileUtils.cp(@template_path, self.class.config_path)
+        
+        $stdout.puts "* No YAML configuration file found!",
+                     "+ #{self.class.config_path}",
+                     "* One has been created for you, please edit it to your liking and try again."
+        
         Kernel.exit(1)
       end
     end

data/lib/project/lookup.rb

@@ -23,6 +23,10 @@ module Project
         end
       end
       
+      def clear_all
+        @store = {}
+      end
+      
       protected
       def return_object(data)
         raise AbstractClassError, "this is an abstract class method and should not be called directly."

data/lib/project/runner.rb

@@ -1,7 +1,7 @@
 module Project
   class Runner
     attr_accessor :key, :project, :workflow
-
+    
     def initialize(key)
       exit_with "No project key given" if key.nil?
       self.key = key.chomp.to_sym
@@ -19,7 +19,7 @@ module Project
       say "* Opening project '#{self.key}' using workflow '#{self.project.workflow}'"
       
       self.workflow.each_with_index do |command, index|
-        command = Template.new(command, self.project).parse
+        command = Template.new(command, self.project).parse!
         output  = %x[ #{command} ].chomp
         
         unless output.empty?

data/lib/project/template.rb

@@ -1,22 +1,23 @@
 module Project
   class Template
     attr_accessor :subject, :replacements
-    REGEX = /%([a-z|A-Z]*)?/
-
+    REGEX = /%([a-z|A-Z|_]*)?/
+    
     def initialize(subject, replacements)
       self.subject      = subject
       self.replacements = replacements
     end
-
-    def parse
+    
+    def parse!
       matches = self.subject.scan(REGEX)
       matches.flatten!
-
+      
       matches.each do |match|
-        raise MissingTemplateVariable, "No variable named %#{match} was specified in the project #{self.key}" if replacements[match].nil?
-        self.subject.gsub!("%#{match}", replacements[match])
+        replacement = replacements[match.to_sym]
+        raise MissingTemplateVariable, "No variable named %#{match} was found on the specified project." if replacement.nil?
+        self.subject.gsub!("%#{match}", replacement)
       end
-
+      
       self.subject
     end
   end

data/lib/project/workflow.rb

@@ -1,7 +1,7 @@
 module Project
   class Workflow < Lookup
     class << self
-
+      
       protected
       def return_object(data)
         data

data/project.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{project}
-  s.version = "0.9.3"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Nesbitt"]
-  s.date = %q{2010-08-19}
-  s.description = %q{}
+  s.date = %q{2010-08-21}
+  s.description = %q{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.}
   s.email = %q{josh@josh-nesbitt.net}
   s.executables = ["project", "project"]
   s.extra_rdoc_files = [
@@ -32,8 +32,15 @@ Gem::Specification.new do |s|
      "lib/project/template.rb",
      "lib/project/workflow.rb",
      "project.gemspec",
-     "readme.rdoc",
+     "readme.textile",
+     "spec/fixtures/config.yml",
+     "spec/lib/core_ext_spec.rb",
+     "spec/lib/errors_spec.rb",
+     "spec/lib/loader_spec.rb",
      "spec/lib/lookup_spec.rb",
+     "spec/lib/project_spec.rb",
+     "spec/lib/template_spec.rb",
+     "spec/lib/workflow_spec.rb",
      "spec/spec_helper.rb",
      "spec/watch.rb",
      "templates/example.yml"
@@ -41,10 +48,16 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/joshnesbitt/project}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A streamlined approach to working with multiple projects and tasks.}
   s.test_files = [
-    "spec/lib/lookup_spec.rb",
+    "spec/lib/core_ext_spec.rb",
+     "spec/lib/errors_spec.rb",
+     "spec/lib/loader_spec.rb",
+     "spec/lib/lookup_spec.rb",
+     "spec/lib/project_spec.rb",
+     "spec/lib/template_spec.rb",
+     "spec/lib/workflow_spec.rb",
      "spec/spec_helper.rb",
      "spec/watch.rb"
   ]
@@ -53,7 +66,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])

data/readme.textile

@@ -0,0 +1,114 @@
+h1. Project
+
+* Overview
+* Installation
+* Usage
+* Bugs
+* Note on Patches/Pull Requests
+
+
+
+h2. 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.
+
+
+
+h2. Installation
+
+The project is hosted on "rubygems.org":http://rubygems.org. Getting it is simple:
+
+pre. gem install project
+
+Once the gem is installed run:
+
+pre. 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.
+
+
+
+h2. Usage
+
+Project uses a YAML file for its configuration. Edit the file located in at @~/.project@ to you liking.
+
+
+
+h3. Projects
+
+A project can be anything revolving around a particular context. A typical use case would be opening your default environment for a project. An example project configuration might look like this:
+
+pre. :name:
+  :path: /path/to/project
+  :workflow: default
+
+The only required key within a project is *workflow*. This is important as you need to tell the @project@ binary which workflow to apply against the project. Any other variables specified here will be passed through to a workflow (more on this below).
+
+
+
+h3. Workflows
+
+A workflow is a set of commands you want run against a particular project. An example workflow might look something like this:
+
+pre. :default:
+  - mate %path
+  - cd %path && gitx
+
+Which translates to:
+
+* @mate /path/to/project@
+* @cd /path/to/project && gitx@
+
+A workflow is just a YAML array of templated commands. Any variable used in a workflow will get looked up on the project that's running it. In the example above the @%path@ variable is replaced by the path specified within the project. Using this method you can quickly build up a set of common workflows to use against many projects.
+
+At the moment each command within a workflow is run inside it's own sub shell. This means that *every command is isolated from other commands within the same workflow*, so instead of doing two commands as @cd /some/path@ and @rake@ you would do @cd /some/path && rake@.
+
+My default workflow looks something like this:
+
+pre. :default:
+  - mate %path
+  - cd %path && gitx
+  - open 'http://%basecamp_url'
+  - open 'http://%app'
+  - cd %path && rails server
+
+Which:
+
+* opens a project in Textmate
+* opens it's Git history
+* opens the Basecamp project for the app
+* starts the Rails server (and opens it up in the default browser)
+
+*Note:* at the moment commands do not support being daemonised, hence why the call to @rails server@ is the last command executed.
+
+
+
+h3. Running a project
+
+Running a project is simple, just specify the name of the project you want to load and the workflow will run for it:
+
+pre. project name
+
+
+
+h2. Bugs
+
+If you have any problems with Project, please file an "issue":http://github.com/joshnesbitt/project/issues.
+
+
+
+h2. Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+
+h2. Author
+
+Josh Nesbitt / "josh@josh-nesbitt.net":mailto:josh@josh-nesbitt.net / "josh-nesbitt.net":http://josh-nesbitt.net

data/spec/fixtures/config.yml

@@ -0,0 +1,7 @@
+:workflows:
+  :default:
+    - mate %path
+:projects:
+  :example:
+    :path: /a/path
+    :workflow: default

data/spec/lib/core_ext_spec.rb

@@ -0,0 +1,13 @@
+module Project
+  describe OpenStruct do
+    
+    before do
+      @struct = OpenStruct.new(:one => "one", :two => "two", :three => "three")
+    end
+    
+    it "should provide [] as an interface to the OpenStructs' attributes" do
+      @struct[:one].should  == @struct.one # one
+      @struct[:four].should == @struct.four # nil
+    end
+  end
+end

data/spec/lib/errors_spec.rb

@@ -0,0 +1,21 @@
+module Project
+  describe ProjectError do
+    
+    it "should have a base error class" do
+      error = ProjectError.new("Error data")
+      error.data.should == "Error data"
+      
+      ProjectError.ancestors.should include(StandardError)
+    end
+    
+    it "should have the correct error classes available" do
+      data = "Error Data"
+      
+      [ProjectError, AbstractClassError, MissingTemplateVariable].each do |klass|
+        error = klass.new(data)
+        error.data.should == data
+        klass.ancestors.should include(StandardError)
+      end
+    end
+  end
+end

data/spec/lib/loader_spec.rb

@@ -0,0 +1,37 @@
+module Project
+  describe Loader do
+    
+    before do
+      @config_path = File.join(ROOT, 'spec', 'fixtures', 'config.yml')
+      Loader.config_path(@config_path)
+    end
+    
+    it "should allow a config path to be set" do
+      path = "/my/path/.project"
+      Loader.config_path(path)
+      Loader.config_path.should == path
+    end
+    
+    it "should create a configuration file on #load! if one does not exist" do
+      FileUtils.rm(@config_path) if File.exists?(@config_path)
+      File.exists?(@config_path).should == false
+      
+      loader = Loader.new
+      lambda { loader.load! }.should raise_error(SystemExit)
+      
+      File.exists?(@config_path).should == true
+    end
+    
+    it "should load Project and Workflow configurations if a configuration exists" do
+      loader = Loader.new
+      
+      unless File.exists?(@config_path)
+        lambda { loader.load! }.should raise_error(SystemExit)
+        File.exists?(@config_path).should == true
+      end
+      
+      loader.load!
+      loader.raw_config.should_not be_nil
+    end
+  end
+end

data/spec/lib/lookup_spec.rb

@@ -2,7 +2,18 @@ module Project
   describe Lookup do
     
     before do
-      @data = { :age => 20 }
+      Lookup.clear_all
+      
+      @data = {
+        :one => {
+          :workflow => :default,
+          :path => "/one/two/three"
+        },
+        :two => {
+          :workflow => :other,
+          :path => "/one/two/three/four"
+        }
+      }
     end
     
     it "should use a hash as a lookup object" do
@@ -10,14 +21,30 @@ module Project
     end
     
     it "should set a lookup key correctly" do
+      Lookup.set(:one, @data[:one])
+      Lookup.store[:one].should == @data[:one]
+    end
+    
+    it "raise an abstract class error on trying to get a key directly from the Lookup class" do
+      Lookup.set(:one, @data[:one])
+      lambda { Lookup.get(:one) }.should raise_error(AbstractClassError)
+    end
+    
+    it "should load a configuration from a hash" do
+      Lookup.load_from_hash(@data)
+      Lookup.store[:one].should == @data[:one]
       
-      Lookup.set(:bob, @data)
-      Lookup.store[:bob].should == @data
+      @data[:one].each_pair do |k, v|
+        Lookup.store[:one][k].should == v
+      end
     end
     
-    it "raise an abstract class error on trying to get a key" do
-      Lookup.set(:bob, @data)
-      lambda { Lookup.get(:bob) }.should raise_error(AbstractClassError)
+    it "should support wiping the entire lookups' content" do
+      Lookup.store.should == {}
+      Lookup.load_from_hash(@data)
+      Lookup.store.should_not be_empty
+      Lookup.clear_all
+      Lookup.store.should be_empty
     end
   end
 end

data/spec/lib/project_spec.rb

@@ -0,0 +1,41 @@
+module Project
+  describe Project do
+    
+    before do
+      Project.clear_all
+      
+      @data = {
+        :one => {
+          :workflow => :default,
+          :path => "/one/two/three"
+        },
+        :two => {
+          :workflow => :other,
+          :path => "/one/two/three/four"
+        }
+      }
+    end
+    
+    it "should set a project" do
+      Project.set(:one, @data[:one])
+      Project.store[:one].should == @data[:one]
+    end
+    
+    it "should get a projects data" do
+      Project.set(:one, @data[:one])
+      Project.get(:one).should == OpenStruct.new(@data[:one])
+    end
+    
+    it "should load a configuration from a hash" do
+      Project.load_from_hash(@data)
+      Project.get(:one).should == OpenStruct.new(@data[:one])
+    end
+    
+    it "should return an OpenStruct object as a keys data" do
+      Project.set(:one, @data[:one])
+      
+      Project.get(:one).class.should == OpenStruct
+      Project.get(:one).should == OpenStruct.new(@data[:one])
+    end
+  end
+end

data/spec/lib/template_spec.rb

@@ -0,0 +1,25 @@
+module Project
+  describe Template do
+    
+    it "should successfully replace a strings variables with the replacements given" do
+      subject = "cd %path && echo '%text' && echo '%other_var'"
+      replacements = {
+        :path => "/some/path",
+        :text => "hello there",
+        :other_var => "something"
+      }
+      
+      template = Template.new(subject, replacements)
+      result = template.parse!
+      result.should == "cd /some/path && echo 'hello there' && echo 'something'"
+    end
+    
+    it "should raise an error on replacing a value that doesnt exist" do
+      subject = "cd %path"
+      replacements = {}
+      
+      template = Template.new(subject, replacements)
+      lambda { template.parse! }.should raise_error(MissingTemplateVariable, "No variable named %path was found on the specified project.")
+    end
+  end
+end

data/spec/lib/workflow_spec.rb

@@ -0,0 +1,35 @@
+module Project
+  describe Workflow do
+    
+    before do
+      Workflow.clear_all
+      
+      @data = {
+        :one => ['one', 'two', 'three'],
+        :two => ['one', 'two', 'three', 'four']
+      }
+    end
+    
+    it "should set a workflow" do
+      Workflow.set(:one, @data[:one])
+      Workflow.store[:one].should == @data[:one]
+    end
+    
+    it "should get a workflows data" do
+      Workflow.set(:one, @data[:one])
+      Workflow.get(:one).should == @data[:one]
+    end
+    
+    it "should load a configuration from a hash" do
+      Workflow.load_from_hash(@data)
+      Workflow.get(:one).should == @data[:one]
+    end
+    
+    it "should return an Array object as a keys data" do
+      Workflow.set(:one, @data[:one])
+      
+      Workflow.get(:one).class.should == Array
+      Workflow.get(:one).should == @data[:one]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,3 +2,6 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'project'
 require 'spec'
+
+# Silence output
+$stdout = StringIO.new

metadata

@@ -3,10 +3,10 @@ name: project
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 9
-  - 3
-  version: 0.9.3
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Josh Nesbitt
@@ -14,13 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-19 00:00:00 +01:00
+date: 2010-08-21 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -31,7 +32,7 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
-description: ""
+description: 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.
 email: josh@josh-nesbitt.net
 executables: 
 - project
@@ -56,8 +57,15 @@ files:
 - lib/project/template.rb
 - lib/project/workflow.rb
 - project.gemspec
-- readme.rdoc
+- readme.textile
+- spec/fixtures/config.yml
+- spec/lib/core_ext_spec.rb
+- spec/lib/errors_spec.rb
+- spec/lib/loader_spec.rb
 - spec/lib/lookup_spec.rb
+- spec/lib/project_spec.rb
+- spec/lib/template_spec.rb
+- spec/lib/workflow_spec.rb
 - spec/spec_helper.rb
 - spec/watch.rb
 - templates/example.yml
@@ -71,6 +79,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -78,6 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -87,11 +97,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A streamlined approach to working with multiple projects and tasks.
 test_files: 
+- spec/lib/core_ext_spec.rb
+- spec/lib/errors_spec.rb
+- spec/lib/loader_spec.rb
 - spec/lib/lookup_spec.rb
+- spec/lib/project_spec.rb
+- spec/lib/template_spec.rb
+- spec/lib/workflow_spec.rb
 - spec/spec_helper.rb
 - spec/watch.rb

data/readme.rdoc

@@ -1,87 +0,0 @@
-= Project
-
-* Overview
-* Installation
-* Usage
-* Bugs
-* Note on Patches/Pull Requests
-
-
-
-== 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
-
-The project is hosted on rubygems.org. Getting it is simple:
-
-  gem install project
-
-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 case would be opening your default environment surrounding a particular 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 commands 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 specified within the project. Using this method you can quickly build up a set of common workflows to use against any project.
-
-
-=== Running a project
-
-Running a project is simple, just specify the name of the project you want to load and the workflow will run for it:
-
-  project name
-
-
-
-== Bugs
-
-If you have any problems with Project, please file an issue at http://github.com/joshnesbitt/project/issues.
-
-
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-
-
-== Copyright
-
-Copyright (c) 2010 Josh Nesbitt <josh@josh-nesbitt.net>. See LICENSE for details.