vigetlabs-provisional 2.1.0 → 2.1.1

data/{README.rdoc → README.md}

@@ -1,22 +1,22 @@
-= Provisional
+# Provisional
 
-== Description
+## Description
 
 Provisional creates a new Rails project, using a standard Rails 2.3 application template, and checks it into a new SCM repository.
 
 In the future, Provisional may be expanded to create production and staging environments, set up continuous integration, and automate other tasks that are usually performed at the beginning of a project.
 
-== Requirements
+## Requirements
 
 Provisional requires Rails 2.3.0 or greater.
 
 Provisional is only tested on Mac OS X. It should also work on Linux. It is not tested or supported on Windows.
 
-== Installation
+## Installation
 
     sudo gem install provisional
 
-== Usage
+## Usage
 
     Options:
           --name, -n <s>:   Name of the project
@@ -29,26 +29,25 @@ Provisional is only tested on Mac OS X. It should also work on Linux. It is not
         --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):
+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, 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.)
+* `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.)
+* `unfuddle_svn`: creates a Subversion repository called `project_name` under an existing Unfuddle project using the specified credentials, and checks it out into the `project_name` directory.
 
 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
-* installs gems: mocha, factory_girl, shoulda
-* installs plugins: hoptoad_notifier, jrails, model_generator_with_factories, viget_deployment, vl_cruise_control
-* installs a .gitignore file to ignore logs, temp files, sqlite3 databases, rcov reports, and database.yml
+* installs gems: `mocha`, `factory_girl`, `shoulda`
+* installs plugins: `hoptoad_notifier`, `jrails`, `model_generator_with_factories`, `viget_deployment`, `vl_cruise_control`
+* installs a .gitignore file to ignore logs, temp files, sqlite3 databases, rcov reports, and `database.yml`
 * 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 an SCM repository and checks the application in (pushing to origin if GitHub is used)
+* copies `database.yml` to `database.yml-sample`
+* removes `public/index.html`, `test/fixtures`, prototype, and script.aculo.us
+* creates an SCM repository and checks the application in
 
 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:
 
@@ -57,15 +56,19 @@ All of these options can be specified either on the command line, or in a YAML f
 
 Options specified via the command line take precedence over options specified in a YAML file, if both are specified.
 
-== GitHub
+## 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 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
+## Unfuddle
+
+To use Unfuddle (for either Git or Subversion) 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.
+
+## TODO
 
-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.
+Beanstalk (http://beanstalkapp.com/) will be supported once their API (currently in private beta) is available to all users.
 
-== License
+## License
 
 Copyright (c) 2009 Mark Cornick of Viget Labs <mark@viget.com>
 

data/VERSION.yml

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

data/lib/provisional/scm/svn.rb

@@ -0,0 +1,49 @@
+require 'fileutils'
+require 'rails/version'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+module Provisional
+  module SCM
+    class Svn
+      def initialize(options)
+        @options = options
+      end
+
+      def rescuing_exceptions(&block)
+        begin
+          yield
+        rescue
+          raise RuntimeError, "Repository not created due to exception: #{$!}"
+        end
+      end
+
+      def init
+        raise NotImplementedError, "The SVN scm cannot currently be used directly"
+      end
+
+      def generate_rails
+        rescuing_exceptions do
+          system("svn co --username=#{@options['username']} --password=#{@options['password']} #{@options['url']} #{@options['name']}")
+          Dir.chdir @options['name']
+          %w(branches tags trunk).each {|d| Dir.mkdir(d)}
+          system("svn add branches tags trunk")
+          system("svn commit -m 'Structure by Provisional'")
+          Dir.chdir 'trunk'
+
+          generator_options = ['.', '-m', @options['template_path']]
+          Rails::Generator::Base.use_application_sources!
+          Rails::Generator::Scripts::Generate.new.run generator_options, :generator => 'app'
+        end
+      end
+
+      def checkin
+        # TODO: set svn:ignores
+        rescuing_exceptions do
+          system("svn add *")
+          system("svn commit -m 'Initial commit by Provisional'")
+        end
+      end
+    end
+  end
+end

data/lib/provisional/scm/unfuddle_svn.rb

@@ -0,0 +1,43 @@
+require 'provisional/scm/svn'
+require 'net/http'
+require 'builder'
+
+module Provisional
+  module SCM
+    class UnfuddleSvn < Provisional::SCM::Svn
+      def initialize(options)
+        %w(username password domain id).each do |opt|
+          raise ArgumentError, "#{opt} must be specified" unless options[opt]
+        end
+        super
+      end
+
+      def init
+        begin
+          xml = Builder::XmlMarkup.new
+          xml.repository do
+            xml.abbreviation @options['name']
+            xml.title @options['name']
+            xml.system 'svn'
+            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 not created on Unfuddle due to HTTP error: #{response.code}"
+          end
+
+          @options['url'] = "http://#{@options['domain']}.unfuddle.com/svn/#{@options['domain']}_#{@options['name']}/"
+        rescue
+          raise RuntimeError, "Repository not created on Unfuddle due to exception: #{$!}"
+        end
+      end
+    end
+  end
+end

data/test/unit/svn_test.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require File.dirname(__FILE__) + '/../../lib/provisional/scm/svn'
+
+class SvnTest < Test::Unit::TestCase
+
+  def setup
+    @scm = Provisional::SCM::Svn.new(
+    {
+      'name' => 'name',
+      'template_path' => 'template_path',
+      'url' => 'url',
+      'username' => 'username',
+      'password' => 'password'
+    }
+    )
+  end
+
+  def test_init
+    assert_raise NotImplementedError do
+      @scm.init
+    end
+  end
+
+  def test_generate_rails
+    @scm.expects(:system).with("svn co --username=username --password=password url name")
+    Dir.expects(:chdir).with('name')
+    %w(branches tags trunk).each {|d| Dir.expects(:mkdir).with(d)}
+    @scm.expects(:system).with("svn add branches tags trunk")
+    @scm.expects(:system).with("svn commit -m 'Structure by Provisional'")
+    Dir.expects(:chdir).with('trunk')
+    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_generate_rails_should_raise_RuntimeError_if_any_step_raises_any_exception
+    @scm.expects(:system).with("svn co --username=username --password=password url name")
+    Dir.expects(:chdir).with('name').raises(Errno::ENOENT)
+    assert_raise RuntimeError do
+      @scm.generate_rails
+    end
+  end
+
+  def test_checkin
+    @scm.expects(:system).with("svn add *")
+    @scm.expects(:system).with("svn commit -m 'Initial commit by Provisional'")
+    @scm.checkin
+  end
+
+  def test_checkin_should_raise_RuntimeError_if_any_step_raises_any_exception
+    @scm.expects(:system).with("svn add *").raises(RuntimeError)
+    assert_raise RuntimeError do
+      @scm.checkin
+    end
+  end
+end

data/test/unit/unfuddle_svn_test.rb

@@ -0,0 +1,55 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require File.dirname(__FILE__) + '/../../lib/provisional/scm/unfuddle_svn'
+
+class UnfuddleSvnTest < Test::Unit::TestCase
+  def setup
+    @scm = Provisional::SCM::UnfuddleSvn.new(
+    {
+      'name' => 'name',
+      'template_path' => 'template_path',
+      'domain' => 'domain',
+      'id' => 1,
+      'username' => 'username',
+      'password' => 'password'
+    }
+    )
+  end
+
+  def test_init
+    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.init
+  end
+
+  def test_init_should_raise_RuntimeError_if_unfuddle_api_call_fails
+    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.init
+    end
+  end
+  
+  def test_init_should_raise_RuntimeError_if_any_step_raises_any_exception
+    Net::HTTP.expects(:new).with("domain.unfuddle.com", 80).raises(Net::HTTPNotFound)
+  
+    assert_raise RuntimeError do
+      @scm.init
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: vigetlabs-provisional
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors: 
 - Mark Cornick
@@ -59,9 +59,9 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 files: 
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION.yml
 - bin/provisional
@@ -69,12 +69,16 @@ files:
 - lib/provisional/project.rb
 - lib/provisional/scm/git.rb
 - lib/provisional/scm/github.rb
+- lib/provisional/scm/svn.rb
 - lib/provisional/scm/unfuddle.rb
+- lib/provisional/scm/unfuddle_svn.rb
 - lib/provisional/templates/viget.rb
 - test/test_helper.rb
 - test/unit/git_test.rb
 - test/unit/github_test.rb
 - test/unit/project_test.rb
+- test/unit/svn_test.rb
+- test/unit/unfuddle_svn_test.rb
 - test/unit/unfuddle_test.rb
 has_rdoc: true
 homepage: http://github.com/vigetlabs/provisional
@@ -107,4 +111,6 @@ test_files:
 - test/unit/git_test.rb
 - test/unit/github_test.rb
 - test/unit/project_test.rb
+- test/unit/svn_test.rb
+- test/unit/unfuddle_svn_test.rb
 - test/unit/unfuddle_test.rb