vigetlabs-provisional 2.0.2

data/README.rdoc

@@ -0,0 +1,59 @@
+= Provisional
+
+== 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
+
+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
+
+    sudo gem install provisional
+
+== 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
+
+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)
+
+(Subversion and Viget-specific SCM's were removed in Provisional 2.0.0. They may return at a later date.)
+
+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
+* 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)
+
+== 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
+
+== License
+
+Copyright (c) 2009 Mark Cornick of Viget Labs <mark@viget.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/VERSION.yml

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

data/bin/provisional

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+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'
+end
+
+Provisional::Project.new(options)

data/lib/provisional.rb

@@ -0,0 +1,17 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'provisional/project'
+
+module Provisional
+  IGNORE_FILES = [
+    ['coverage'],
+    ['config/database.yml'],
+    ['db/*.sqlite3'],
+    ['log/*.log'],
+    ['tmp/restart.txt'],
+    ['tmp/cache/*'],
+    ['tmp/pids/*'],
+    ['tmp/sessions/*'],
+    ['tmp/sockets/*']
+  ]
+end

data/lib/provisional/project.rb

@@ -0,0 +1,51 @@
+require 'active_support'
+require 'uri'
+
+module Provisional
+  class Project
+    attr_reader :options
+    
+    def initialize(options)
+      @options = options
+
+      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"))
+        end
+        raise ArgumentError, "is not valid: #{@options[:template]}" unless File.exist?(@options[:template_path])
+      else
+        @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")
+
+      begin
+        require "provisional/scm/#{@options[:scm]}"
+      rescue MissingSourceFile
+        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 = scm_class.new(@options)
+      scm.init
+      scm.generate_rails
+      scm.checkin
+    end
+
+    def is_valid_url?(url)
+      begin
+        [URI::HTTP, URI::HTTPS].include?(URI.parse(url).class)
+      rescue URI::InvalidURIError
+        false
+      end
+    end
+
+  end
+end

data/lib/provisional/scm/git.rb

@@ -0,0 +1,44 @@
+require 'fileutils'
+require 'git'
+require 'rails/version'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+module Provisional
+  module SCM
+    class Git
+      def initialize(options)
+        @options = options
+      end
+
+      def gitignore
+        Provisional::IGNORE_FILES.join("\n")
+      end
+
+      def init
+        FileUtils.mkdir_p @options[:name]
+        Dir.chdir @options[:name]
+        @options[:path] = Dir.getwd
+        ::Git.init
+      end
+
+      def generate_rails
+        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
+
+      def checkin
+        repo = ::Git.open @options[:path]
+        Dir.chdir @options[:path]
+        File.open('.gitignore', 'w') do |f|
+          f.puts gitignore
+        end
+        repo.add '.'
+        repo.commit 'Initial commit by Provisional'
+        repo
+      end
+    end
+  end
+end

data/lib/provisional/scm/github.rb

@@ -0,0 +1,21 @@
+require 'provisional/scm/git'
+require 'net/http'
+
+module Provisional
+  module SCM
+    class Github < Provisional::SCM::Git
+      def checkin
+        repo = super
+        github_user = repo.config 'github.user'
+        github_token = repo.config 'github.token'
+        Net::HTTP.post_form URI.parse('http://github.com/api/v2/yaml/repos/create'), {
+          'login' => github_user,
+          'token' => github_token,
+          'name' => @options[:name]
+        }
+        repo.add_remote('origin', "git@github.com:#{github_user}/#{@options[:name]}.git")
+        repo.push
+      end
+    end
+  end
+end

data/lib/provisional/templates/viget.rb

@@ -0,0 +1,27 @@
+# rails new_app_name -m viget.rb
+
+# freeze rails
+rake 'rails:freeze:gems'
+
+# install gems
+gem 'mocha', :version => '>= 0.9.5'
+gem 'thoughtbot-factory_girl', :lib => 'factory_girl', :source => 'http://gems.github.com', :version => '>= 1.2.0'
+gem 'thoughtbot-shoulda', :lib => 'shoulda', :source => 'http://gems.github.com', :version => '>= 2.10.1'
+rake 'gems:install gems:unpack'
+
+# install plugins
+plugin 'hoptoad_notifier', :git => 'git://github.com/thoughtbot/hoptoad_notifier.git'
+plugin 'jrails', :git => 'git://github.com/aaronchi/jrails.git'
+plugin 'model_generator_with_factories', :git => 'git://github.com/vigetlabs/model_generator_with_factories.git'
+plugin 'viget_deployment', :git => 'git://github.com/vigetlabs/viget_deployment.git'
+plugin 'vl_cruise_control', :git => 'git://github.com/vigetlabs/vl_cruise_control.git'
+
+# generate viget_deployment stuff
+generate :viget_deployment
+
+# clean up
+run 'rm -rf public/index.html log/* test/fixtures config/database.yml'
+inside ('public/javascripts') do
+  run 'rm -f dragdrop.js controls.js effects.js prototype.js'
+end
+rake 'jrails:install:javascripts'

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require File.dirname(__FILE__) + '/../lib/provisional'

data/test/unit/git_test.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require File.dirname(__FILE__) + '/../../lib/provisional/scm/git'
+
+class GitTest < Test::Unit::TestCase
+
+  def setup
+    @scm = Provisional::SCM::Git.new(
+    {
+      :name => 'name',
+      :template_path => 'template_path',
+      :rails => 'rails'
+    }
+    )
+  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')
+    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)
+    @scm.checkin
+  end
+end

data/test/unit/github_test.rb

@@ -0,0 +1,52 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require File.dirname(__FILE__) + '/../../lib/provisional/scm/github'
+
+class GithubTest < Test::Unit::TestCase
+  def setup
+    @scm = Provisional::SCM::Github.new(
+    {
+      :name => 'name',
+      :template_path => 'template_path',
+      :rails => 'rails'
+    }
+    )
+  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(:config).with('github.user').returns('user')
+    repo_stub.expects(:config).with('github.token').returns('token')
+    repo_stub.expects(:add_remote)
+    repo_stub.expects(:push)
+
+    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)
+
+    @scm.checkin
+  end
+end

data/test/unit/project_test.rb

@@ -0,0 +1,130 @@
+require File.dirname(__FILE__) + '/../test_helper'
+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
+    git_stub = stub()
+    git_stub.expects(:init).returns('true')
+    git_stub.expects(:generate_rails).returns('true')
+    git_stub.expects(:checkin).returns('true')
+    Provisional::SCM::Git.expects(:new).returns(git_stub)
+  end
+
+  def new_project(opts = {})
+    opts = {:name => 'name', :template => 'viget', :rails => RAILS, :scm => 'git'}.merge(opts)
+    Provisional::Project.new(opts)
+  end
+
+  def test_new_project_should_call_init_generate_rails_and_checkin
+    stub_git
+    new_project
+  end
+
+  def test_should_be_able_to_use_a_literal_template_path
+    stub_git
+    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
+
+  def test_should_find_the_template_path_based_on_the_template_option
+    stub_git
+    assert_equal DEFAULT_TEMPLATE_PATH, new_project.options[:template_path]
+  end
+
+  def test_should_raise_argumenterror_if_invalid_template_url_is_specified
+    bogus_url = 'bagel://pants/wizard'
+    URI.expects(:parse).with(bogus_url).raises(URI::InvalidURIError)
+    assert_raise ArgumentError do
+      project = new_project(:template => bogus_url)
+    end
+  end
+
+  def test_should_raise_argumenterror_if_name_is_not_specified
+    assert_raise ArgumentError do
+      new_project(:name => nil)
+    end
+  end
+
+  def test_should_raise_argumenterror_if_name_already_exists
+    File.expects(:exist?).with('name').returns(true)
+    File.expects(:exist?).with(File.expand_path('viget')).returns(false)
+    File.expects(:exist?).with(DEFAULT_TEMPLATE_PATH).returns(true)
+    assert_raise ArgumentError do
+      new_project
+    end
+  end
+
+  def test_should_raise_argumenterror_if_namedotrepo_already_exists_and_scm_is_svn
+    File.expects(:exist?).with('name').returns(false)
+    File.expects(:exist?).with('name.repo').returns(true)
+    File.expects(:exist?).with(DEFAULT_TEMPLATE_PATH).returns(true)
+    File.expects(:exist?).with(File.expand_path('viget')).returns(false)
+    assert_raise ArgumentError do
+      new_project(:scm => 'svn')
+    end
+  end
+
+  def test_should_raise_argumenterror_if_unsupported_scm_is_specified
+    assert_raise ArgumentError do
+      new_project(:scm => 'bogus')
+    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')
+    end
+  end
+
+  def test_should_not_raise_argumenterror_if_a_valid_http_template_url_is_specified
+    stub_git
+    assert_nothing_raised do
+      new_project(:template => 'http://example.com/')
+    end
+  end
+
+  def test_should_not_raise_argumenterror_if_a_valid_https_template_url_is_specified
+    stub_git
+    assert_nothing_raised do
+      new_project(:template => 'https://example.com/')
+    end
+  end
+
+  def test_should_raise_argumenterror_if_a_valid_other_template_url_is_specified
+    assert_raise ArgumentError do
+      new_project(:template => 'ftp://example.com/')
+    end
+  end
+
+  def test_should_raise_argumenterror_if_an_invalid_url_is_specified
+    assert_raise ArgumentError do
+      new_project(:template => 'bogus://awesome.pants/')
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: vigetlabs-provisional
+version: !ruby/object:Gem::Version 
+  version: 2.0.2
+platform: ruby
+authors: 
+- Mark Cornick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-21 00:00:00 -07:00
+default_executable: provisional
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.10.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: git
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.5
+    version: 
+description: 
+email: mark@viget.com
+executables: 
+- provisional
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- VERSION.yml
+- bin/provisional
+- lib/provisional
+- lib/provisional/project.rb
+- lib/provisional/scm
+- lib/provisional/scm/git.rb
+- lib/provisional/scm/github.rb
+- lib/provisional/templates
+- 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
+has_rdoc: true
+homepage: http://github.com/vigetlabs/provisional
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: viget
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Automation for new Rails Projects
+test_files: []
+