vigetlabs-provisional 2.0.3 → 2.1.0

data/README.rdoc

@@ -19,20 +19,26 @@ Provisional is only tested on Mac OS X. It should also work on Linux. It is not
 == Usage
 
     Options:
-                 --name, -n <s>:   Name of the project
-                  --scm, -s <s>:   SCM to use (default: git)
-                --rails, -r <s>:   Path to rails generator script (default: first occurrence of rails in $PATH)
-             --template, -t <s>:   Rails template to use (default: viget)
-                  --version, -v:   Print version and exit
-                     --help, -h:   Show this message
+          --name, -n <s>:   Name of the project
+           --scm, -s <s>:   SCM to use (default: git)
+      --template, -t <s>:   Rails template to use (default: viget)
+        --domain, -d <s>:   Domain (for some SCMs, see below)
+      --username, -u <s>:   Username (for some SCMs, see below)
+      --password, -p <s>:   Password (for some SCMs, see below)
+            --id, -i <s>:   Id (for some SCMs, see below)
+        --config, -c <s>:   Config file (optional)
+              --help, -h:   Show this message
 
 The SCM option can be one of the following ("project_name" refers to the value of the --name option):
 
-* git: creates a git repository in the project_name directory
-* github: creates a git repository in the project_name directory, creates project_name on GitHub using the specified credentials, and adds it as origin (see section below about required Git configuration)
+* git: creates a git repository in the project_name directory.
+* github: creates a git repository in the project_name directory, creates project_name on GitHub using the specified credentials, adds it as the "origin" remote, and pushes. (See section below about required configuration.)
+* unfuddle: creates a git repository in the project_name directory, creates a repository called project_name under an existing Unfuddle project using the specified credentials, and adds it as the "origin" remote. _You must push manually_ because Unfuddle typically has a lag of a few minutes between when a repository is created and when it can be accessed. (See section below about required configuration.)
 
 (Subversion and Viget-specific SCM's were removed in Provisional 2.0.0. They may return at a later date.)
 
+The domain, username, password, and id options are used by certain SCMs to provide information needed to use an API. The documentation on these SCMs (below) will indicate how they are to be used.
+
 The template option can be either a literal path to a template file, a URL for a template on a remote server, or the name of one of the templates found in lib/provisional/templates (without the .rb suffix.) The default viget template does the following:
 
 * freezes rails from currently installed gems
@@ -42,11 +48,22 @@ The template option can be either a literal path to a template file, a URL for a
 * generates Capistrano configuration with viget_deployment
 * copies database.yml to database.yml-sample
 * removes public/index.html, test/fixtures, prototype, and script.aculo.us
-* creates a SCM repository and checks the application in (pushing to origin if the github SCM is used)
+* creates an SCM repository and checks the application in (pushing to origin if GitHub is used)
+
+All of these options can be specified either on the command line, or in a YAML file indicated by the --config option. The YAML file should be in simple key: value format:
+
+    name: awesome_project
+    scm: git
+
+Options specified via the command line take precedence over options specified in a YAML file, if both are specified.
 
 == GitHub
 
-To use GitHub, you will need to place your GitHub username and token in your Git configuration as described here: http://github.com/guides/local-github-config
+To use GitHub, you will need to place your GitHub username and token in your Git configuration as described here: http://github.com/guides/local-github-config Since there is already this established convention for GitHub credentials, to prevent redundant configuration, Provisional does not use its own configuration options for GitHub access.
+
+== Unfuddle
+
+To use Unfuddle, you will need to specify the --domain, --id, --username and --password options. --domain is used to specify your unfuddle.com subdomain; --id is used to specify a project ID. Using a YAML file containing these options is recommended and should be helpful.
 
 == License
 

data/Rakefile

@@ -0,0 +1,87 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "provisional"
+    gem.summary = "Automation for new Rails Projects"
+    gem.email = "mark@viget.com"
+    gem.homepage = "http://github.com/vigetlabs/provisional"
+    gem.authors = ["Mark Cornick"]
+    gem.rubyforge_project = "viget"
+    gem.add_dependency 'trollop', '>= 1.10.2'
+    gem.add_dependency 'rails', '>= 2.3.0'
+    gem.add_dependency 'git', '>= 1.0.5'
+    gem.add_dependency 'builder', '>= 2.1.2'
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+    test.rcov_opts << '-x gems'
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "provisional #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem"]
+    
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/provisional/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 2
-:minor: 0
-:patch: 3
+:minor: 1
+:patch: 0

data/bin/provisional

@@ -5,11 +5,14 @@ require 'provisional'
 require 'trollop'
 
 options = Trollop::options do
-  # version "1.2.4"
   opt :name, "Name of the project", :type => String
-  opt :scm, "SCM to use", :type => String, :default => 'git'
-  opt :rails, "Path to rails generator script", :type => String, :default => `which rails`.chomp
-  opt :template, "Rails template to use", :type => String, :default => 'viget'
+  opt :scm, "SCM to use", :type => String
+  opt :template, "Rails template to use", :type => String
+  opt :domain, "Domain (for some SCMs, see documentation)", :type => String
+  opt :username, "Username (for some SCMs, see documentation)", :type => String
+  opt :password, "Password (for some SCMs, see documentation)", :type => String
+  opt :id, "Id (for some SCMs, see documentation)", :type => String
+  opt :config, "Config file (optional)", :type => String
 end
 
 Provisional::Project.new(options)

data/lib/provisional/project.rb

@@ -1,38 +1,47 @@
 require 'active_support'
 require 'uri'
+require 'yaml'
 
 module Provisional
   class Project
     attr_reader :options
     
     def initialize(options)
-      @options = options
+      @options = HashWithIndifferentAccess.new
+      if options[:config]
+        begin
+          @options = @options.merge(YAML.load_file(options[:config]))
+        rescue
+          raise ArgumentError, "could not be loaded or parsed: #{options[:config]}"
+        end
+      end
+      @options = @options.merge(options.reject{|k,v| v.nil?})
 
-      unless is_valid_url?(@options[:template])
-        if File.exist?(File.expand_path(@options[:template]))
-          @options[:template_path] = File.expand_path(@options[:template])
+      @options[:scm] ||= 'git'
+      @options[:template] ||= 'viget'
+
+      unless is_valid_url?(@options['template'])
+        if File.exist?(File.expand_path(@options['template']))
+          @options['template_path'] = File.expand_path(@options['template'])
         else
-          @options[:template_path] = File.expand_path(File.join(File.dirname(__FILE__),'templates',"#{@options[:template]}.rb"))
+          @options['template_path'] = File.expand_path(File.join(File.dirname(__FILE__),'templates',"#{@options['template']}.rb"))
         end
-        raise ArgumentError, "is not valid: #{@options[:template]}" unless File.exist?(@options[:template_path])
+        raise ArgumentError, "is not valid: #{@options['template']}" unless File.exist?(@options['template_path'])
       else
-        @options[:template_path] = @options[:template]
+        @options['template_path'] = @options['template']
       end
 
-      raise ArgumentError, "must be specified" unless @options[:name]
-      raise ArgumentError, "already exists: #{@options[:name]}" if File.exist?(@options[:name])
-      raise ArgumentError, "already exists: #{@options[:name]}.repo" if @options[:scm] == 'svn' && File.exist?("#{@options[:name]}.repo")
+      raise ArgumentError, "name must be specified" unless @options['name']
+      raise ArgumentError, "already exists: #{@options['name']}" if File.exist?(@options['name'])
+      raise ArgumentError, "already exists: #{@options['name']}.repo" if @options['scm'] == 'svn' && File.exist?("#{@options['name']}.repo")
 
       begin
-        require "provisional/scm/#{@options[:scm]}"
+        require "provisional/scm/#{@options['scm']}"
       rescue MissingSourceFile
-        raise ArgumentError, "is not supported: #{@options[:scm]}"
+        raise ArgumentError, "is not supported: #{@options['scm']}"
       end
 
-      raise ArgumentError, "must be specified" if @options[:rails].to_s.empty?
-      raise ArgumentError, "is not valid: #{@options[:rails]}" unless File.exist?(@options[:rails]) && File.executable?(@options[:rails])
-
-      scm_class = "Provisional::SCM::#{@options[:scm].classify}".constantize
+      scm_class = "Provisional::SCM::#{@options['scm'].classify}".constantize
       scm = scm_class.new(@options)
       scm.init
       scm.generate_rails

data/lib/provisional/scm/git.rb

@@ -25,17 +25,17 @@ module Provisional
 
       def init
         rescuing_exceptions do
-          FileUtils.mkdir_p @options[:name]
-          Dir.chdir @options[:name]
-          @options[:path] = Dir.getwd
+          FileUtils.mkdir_p @options['name']
+          Dir.chdir @options['name']
+          @options['path'] = Dir.getwd
           ::Git.init
         end
       end
 
       def generate_rails
         rescuing_exceptions do
-          generator_options = ['.', '-m', @options[:template_path]]
-          Dir.chdir @options[:path]
+          generator_options = ['.', '-m', @options['template_path']]
+          Dir.chdir @options['path']
           Rails::Generator::Base.use_application_sources!
           Rails::Generator::Scripts::Generate.new.run generator_options, :generator => 'app'
         end
@@ -43,8 +43,8 @@ module Provisional
 
       def checkin
         rescuing_exceptions do
-          repo = ::Git.open @options[:path]
-          Dir.chdir @options[:path]
+          repo = ::Git.open @options['path']
+          Dir.chdir @options['path']
           File.open('.gitignore', 'w') do |f|
             f.puts gitignore
           end

data/lib/provisional/scm/github.rb

@@ -12,9 +12,9 @@ module Provisional
           Net::HTTP.post_form URI.parse('https://github.com/api/v2/yaml/repos/create'), {
             'login' => github_user,
             'token' => github_token,
-            'name' => @options[:name]
+            'name' => @options['name']
           }
-          repo.add_remote('origin', "git@github.com:#{github_user}/#{@options[:name]}.git")
+          repo.add_remote('origin', "git@github.com:#{github_user}/#{@options['name']}.git")
           repo.push
         rescue
           raise RuntimeError, "Repository created locally, but not pushed to GitHub due to exception: #{$!}"

data/lib/provisional/scm/unfuddle.rb

@@ -0,0 +1,45 @@
+require 'provisional/scm/git'
+require 'net/http'
+require 'builder'
+
+module Provisional
+  module SCM
+    class Unfuddle < Provisional::SCM::Git
+      def initialize(options)
+        %w(username password domain id).each do |opt|
+          raise ArgumentError, "#{opt} must be specified" unless options[opt]
+        end
+        super
+      end
+
+      def checkin
+        begin
+          repo = super
+
+          xml = Builder::XmlMarkup.new
+          xml.repository do
+            xml.abbreviation @options['name']
+            xml.title @options['name']
+            xml.system 'git'
+            xml.projects do
+              xml.project(:id => @options['id'])
+            end
+          end
+
+          http = Net::HTTP.new("#{@options['domain']}.unfuddle.com", 80)
+          request = Net::HTTP::Post.new('/api/v1/repositories.xml', 'Content-Type' => 'application/xml')
+          request.basic_auth(@options['username'], @options['password'])
+          request.body = xml.target!
+          response, data = http.request(request)
+          unless response.code == "201"
+            raise RuntimeError, "Repository created locally, but not created on Unfuddle due to HTTP error: #{response.code}"
+          end
+
+          repo.add_remote('origin', "git@#{@options['domain']}.unfuddle.com:#{@options['domain']}/#{@options['name']}.git")
+        rescue
+          raise RuntimeError, "Repository created locally, but not pushed to Unfuddle due to exception: #{$!}"
+        end
+      end
+    end
+  end
+end

data/test/unit/git_test.rb

@@ -6,9 +6,8 @@ class GitTest < Test::Unit::TestCase
   def setup
     @scm = Provisional::SCM::Git.new(
     {
-      :name => 'name',
-      :template_path => 'template_path',
-      :rails => 'rails'
+      'name' => 'name',
+      'template_path' => 'template_path'
     }
     )
   end

data/test/unit/github_test.rb

@@ -5,9 +5,8 @@ class GithubTest < Test::Unit::TestCase
   def setup
     @scm = Provisional::SCM::Github.new(
     {
-      :name => 'name',
-      :template_path => 'template_path',
-      :rails => 'rails'
+      'name' => 'name',
+      'template_path' => 'template_path'
     }
     )
   end

data/test/unit/project_test.rb

@@ -3,7 +3,6 @@ require File.dirname(__FILE__) + '/../../lib/provisional/scm/git'
 
 class ProjectTest < Test::Unit::TestCase
 
-  RAILS = `which rails`.chomp
   DEFAULT_TEMPLATE_PATH = File.expand_path(File.join(File.dirname(__FILE__), '../../lib/provisional/templates/viget.rb'))
 
   def stub_git
@@ -15,10 +14,25 @@ class ProjectTest < Test::Unit::TestCase
   end
 
   def new_project(opts = {})
-    opts = {:name => 'name', :template => 'viget', :rails => RAILS, :scm => 'git'}.merge(opts)
+    opts = {:name => 'name', :template => 'viget', :scm => 'git'}.merge(opts)
     Provisional::Project.new(opts)
   end
 
+  def test_should_be_able_to_use_a_config_file
+    options = {'name' => 'albert', 'template' => 'viget', 'scm' => 'git'}
+    YAML.expects(:load_file).with('config.yml').returns(options)
+    stub_git
+    project = Provisional::Project.new(:config => 'config.yml')
+    assert_equal 'albert', project.options[:name]
+  end
+
+  def test_should_bail_on_config_file_errors
+    YAML.expects(:load_file).with('config.yml').raises(Errno::ENOENT)
+    assert_raise ArgumentError do
+      Provisional::Project.new(:config => 'config.yml')
+    end
+  end
+
   def test_new_project_should_call_init_generate_rails_and_checkin
     stub_git
     new_project
@@ -29,7 +43,6 @@ class ProjectTest < Test::Unit::TestCase
     path_to_my_template = File.expand_path('my_template.rb')
     File.expects(:exist?).with(path_to_my_template).times(2).returns(true)
     File.expects(:exist?).with('name').returns(false)
-    File.expects(:exist?).with(RAILS).returns(true)
     project = new_project(:template => 'my_template.rb')
     assert_equal path_to_my_template, project.options[:template_path]
   end
@@ -78,24 +91,6 @@ class ProjectTest < Test::Unit::TestCase
     end
   end
 
-  def test_should_raise_argumenterror_if_no_scm_is_specified
-    assert_raise ArgumentError do
-      new_project(:scm => nil)
-    end
-  end
-
-  def test_should_raise_argumenterror_if_no_rails_is_specified
-    assert_raise ArgumentError do
-      new_project(:rails => nil)
-    end
-  end
-
-  def test_should_raise_argumenterror_if_invalid_rails_is_specified
-    assert_raise ArgumentError do
-      new_project(:rails => 'bogus')
-    end
-  end
-
   def test_should_raise_argumenterror_if_invalid_template_is_specified
     assert_raise ArgumentError do
       new_project(:template => 'bogus')

data/test/unit/unfuddle_test.rb

@@ -0,0 +1,106 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require File.dirname(__FILE__) + '/../../lib/provisional/scm/unfuddle'
+
+class UnfuddleTest < Test::Unit::TestCase
+  def setup
+    @scm = Provisional::SCM::Unfuddle.new(
+    {
+      'name' => 'name',
+      'template_path' => 'template_path',
+      'domain' => 'domain',
+      'id' => 1,
+      'username' => 'username',
+      'password' => 'password'
+    }
+    )
+  end
+
+  def test_gitignore
+    assert_equal Provisional::IGNORE_FILES.join("\n"), @scm.gitignore
+  end
+
+  def test_init
+    FileUtils.expects(:mkdir_p).with('name')
+    Dir.expects(:chdir).with('name')
+    Git.expects(:init)
+    @scm.init
+  end
+
+  def test_generate_rails
+    Dir.expects(:chdir)
+    Rails::Generator::Base.expects(:use_application_sources!)
+    generator_stub = stub()
+    generator_stub.expects(:run).with(%w(. -m template_path), :generator => 'app')
+    Rails::Generator::Scripts::Generate.expects(:new).returns(generator_stub)
+    @scm.generate_rails
+  end
+
+  def test_checkin
+    repo_stub = stub()
+    repo_stub.expects(:add).with('.')
+    repo_stub.expects(:commit).with('Initial commit by Provisional')
+    repo_stub.expects(:add_remote)
+
+    Git.expects(:open).returns(repo_stub)
+    Dir.expects(:chdir)
+    gitignore_file = stub()
+    gitignore_file.expects(:puts).with(@scm.gitignore)
+    File.expects(:open).with('.gitignore', 'w').yields(gitignore_file)
+
+    request_stub = stub()
+    request_stub.expects(:basic_auth).with('username', 'password')
+    request_stub.expects(:body=)
+    response_stub = stub(:code => '201')
+    http_stub = stub()
+    http_stub.expects(:request).with(request_stub).returns(response_stub, nil)
+    
+    Net::HTTP::Post.expects(:new).with('/api/v1/repositories.xml', 'Content-Type' => 'application/xml').returns(request_stub)
+    Net::HTTP.expects(:new).with("domain.unfuddle.com", 80).returns(http_stub)
+
+    @scm.checkin
+  end
+
+  def test_checkin_should_raise_RuntimeError_if_unfuddle_api_call_fails
+    repo_stub = stub()
+    repo_stub.expects(:add).with('.')
+    repo_stub.expects(:commit).with('Initial commit by Provisional')
+
+    Git.expects(:open).returns(repo_stub)
+    Dir.expects(:chdir)
+    gitignore_file = stub()
+    gitignore_file.expects(:puts).with(@scm.gitignore)
+    File.expects(:open).with('.gitignore', 'w').yields(gitignore_file)
+
+    request_stub = stub()
+    request_stub.expects(:basic_auth).with('username', 'password')
+    request_stub.expects(:body=)
+    response_stub = stub(:code => '500')
+    http_stub = stub()
+    http_stub.expects(:request).with(request_stub).returns(response_stub, nil)
+    
+    Net::HTTP::Post.expects(:new).with('/api/v1/repositories.xml', 'Content-Type' => 'application/xml').returns(request_stub)
+    Net::HTTP.expects(:new).with("domain.unfuddle.com", 80).returns(http_stub)
+
+    assert_raise RuntimeError do
+      @scm.checkin
+    end
+  end
+  
+  def test_checkin_should_raise_RuntimeError_if_any_step_raises_any_exception
+    repo_stub = stub()
+    repo_stub.expects(:add).with('.')
+    repo_stub.expects(:commit).with('Initial commit by Provisional')
+  
+    Git.expects(:open).returns(repo_stub)
+    Dir.expects(:chdir)
+    gitignore_file = stub()
+    gitignore_file.expects(:puts).with(@scm.gitignore)
+    File.expects(:open).with('.gitignore', 'w').yields(gitignore_file)
+  
+    Net::HTTP.expects(:new).with("domain.unfuddle.com", 80).raises(Net::HTTPNotFound)
+  
+    assert_raise RuntimeError do
+      @scm.checkin
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vigetlabs-provisional
 version: !ruby/object:Gem::Version 
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors: 
 - Mark Cornick
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-24 00:00:00 -07:00
+date: 2009-05-04 00:00:00 -07:00
 default_executable: provisional
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,6 +42,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.5
     version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
 description: 
 email: mark@viget.com
 executables: 
@@ -52,26 +62,24 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - README.rdoc
+- Rakefile
 - VERSION.yml
 - bin/provisional
-- lib/provisional
+- lib/provisional.rb
 - lib/provisional/project.rb
-- lib/provisional/scm
 - lib/provisional/scm/git.rb
 - lib/provisional/scm/github.rb
-- lib/provisional/templates
+- lib/provisional/scm/unfuddle.rb
 - lib/provisional/templates/viget.rb
-- lib/provisional.rb
 - test/test_helper.rb
-- test/unit
 - test/unit/git_test.rb
 - test/unit/github_test.rb
 - test/unit/project_test.rb
+- test/unit/unfuddle_test.rb
 has_rdoc: true
 homepage: http://github.com/vigetlabs/provisional
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -94,5 +102,9 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
 summary: Automation for new Rails Projects
-test_files: []
-
+test_files: 
+- test/test_helper.rb
+- test/unit/git_test.rb
+- test/unit/github_test.rb
+- test/unit/project_test.rb
+- test/unit/unfuddle_test.rb