rorsvnprep 0.0.1

data/README

@@ -0,0 +1,50 @@
+                     Ruby on Rails Subversion Prep Tool
+===============================================================================
+ README                                                             rorsvnprep
+
+This gem provides some aids for starting new Rails projects that will be 
+managed with the subversion SCM system. The command line utility provides will
+create a new project, perform initial modifications and even the initial 
+subversion specific actions to get your project under subversion management
+quickly and with a minimum of fuss.
+
+This gem provides a simple command-line tool that handles everything:
+
+  rorsvnprep
+  
+It is recommended that you create an alias for this command to save you on 
+typing. On most systems you can alias rorsvnprep to rsp without interfering 
+with anything else, but double-check on your own system before deciding on an
+alias.
+
+================
+Using rorsvnprep
+================
+
+The rorsvnprep command can accept a number of command-line parameters that 
+determine its behavior. At the very minimum you need to supply it with a 
+project name, just like you would the rails command. Under the hood rorsvnprep
+actually calls the rails command and then performs some basic preparations.
+
+If all you provide is the project name then rorsvnprep simply generates 
+.cvsignore files for your project as described later and trims a few extraneous
+directories and files. If, however, you also provide a repository URI via the
+'--svn [repos]' switch; then rorsvnprep will actually perform an initial import
+of your project and perform svn propset calls in place of using .cvsignore 
+files. You may supply a password to rorsvnprep to further automate things, if
+you haven't setup shared-key authentication, via the '--password [pass]' 
+switch.
+
+Assuming you supply nothing else, rorsvnprep will attempt to import your 
+project to '/<projectname>/trunk' within the supplied svn repository. However,
+you can change this behavior by supplying an alternate location via the 
+'--rpath [path]' switch. When finished importing and setting up your project
+rorsvnprep will leave you with a good working copy to begin development with.
+
+  -------------------
+  Command-Line Syntax
+  -------------------
+  
+  rorsvnprep projectname [--svn svn://example.org/path/to/repos]
+                         [--password pass]
+                         [--rpath /custom/trunk]

data/bin/rorsvnprep

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+#
+# = Ruby on Rails Subversion Prep Tool
+#
+# This script creates a new Rails application and prepares it for import into
+# subversion. It takes a number of command line arguments that specify things
+# like application name, repository location and other details to make the 
+# whole process as streamlined as possible. The more you give the script the 
+# more it will handle for you automatically.
+#
+# Author::      James W. Thompson, II
+# Copyright::   Copyright (c) 2007. James W. Thompson, II
+# License::     Licensed under an MIT style license
+#
+# == Command-Line Syntax
+#
+# <tt><b>ruby rorsvnprep.rb</b> <em>example svn://server/path/to/repos</em></tt>
+#
+# The command creates a new rails project called <em>example</em>, performs a
+# variety of actions in preparation for an initial subversion import and then
+# imports the project to the repository provided. The script then checks out 
+# the project and updates various svn:ignore properties before recommitting the
+# project and exiting.
+#
+# The script assumes you want your project stored in <em>projectname</em>/trunk
+# within the repository you provide, eventually this will become adjustable via
+# the command-line.
+#
+# == Effects
+#
+# * Renames <em>config/database.yml</em> to <em>config/database.yml.sample</em>
+# * Deletes extraneous files and directories
+#   * <tt><em>doc/README_FOR_APP</em></tt>
+#   * <tt><em>README</em></tt>
+#   * <tt><em>log/*</em></tt>
+#   * <tt><em>tmp/*</em></tt>
+# * Performs an initial import
+# * Performs an initial checkout
+# * Updates svn:ignore properties for project and recommits project
+#   * <tt><em>log/*.log</em></tt>
+#   * <tt><em>log/*.pid</em></tt>
+#   * <tt><em>tmp/*</em></tt>
+#   * <tt><em>db/*.db</em></tt>
+#   * <tt><em>db/*.sqlite</em></tt>
+#   * <tt><em>db/*.sqlite3</em></tt>
+#   * <tt><em>db/schema.rb</em></tt>
+#   * <tt><em>db/schema.sql</em></tt>
+#
+# == TODO
+#
+# * Rewrite to work with Ruby's subversion bindings if available
+# * Make explicitly object oriented
+# * Flesh out command-line options a bit and make them smarter
+# * Package as a Gem so it can be easily installed
+# * Add some helpful Subversion rake tasks
+#
+# == License
+# 
+# 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.
+
+if require('svn/core') && require('svn/client')
+  svnbind = true
+end
+
+# Initialize our parameters from the command line and raise errors when needed
+print "Initializing..."
+ARGV[0] ? appname = ARGV[0] : raise
+ARGV[1] ? svnrepo = ARGV[1] : raise
+print "Done.\n"
+
+print "\n"
+
+# Start by creating our actual project directory and then change into the new
+# directory
+print "Creating project..."
+system "rails #{appname} > /dev/null"
+Dir::chdir appname
+print "Done.\n"
+
+# Trim out all the stuff we don't want in the initial subversion import and
+# move some other stuff around.
+print "Triming initial project..."
+File::rename "config/database.yml", "config/database.yml.sample"
+File::delete "doc/README_FOR_APP"
+File::delete "README"
+system "rm -rf log/* > /dev/null"
+system "rm -rf tmp/* > /dev/null"
+print "Done.\n"
+
+# Perform our initial subversion import
+print "Importing project to subvserion..."
+system "svn import #{svnrepo}/#{appname}/trunk -m \"Initial import\" > /dev/null"
+Dir::chdir ".."
+system "rm -rf #{appname} > /dev/null"
+print "Done.\n"
+
+# Perform a subversion checkout of our project
+print "Checking out project from subversion..."
+system "svn co #{svnrepo}/#{appname}/trunk #{appname} > /dev/null"
+Dir::chdir appname
+print "Done.\n"
+
+# Setup svn:ignore properties
+print "Congiguring svn:ignore properties..."
+system "svn propset svn:ignore \"*.log\n*.pid\" log/ > /dev/null"
+system "svn update log/ > /dev/null"
+system "svn propset svn:ignore \"*\" tmp/ > /dev/null"
+system "svn update tmp/ > /dev/null"
+system "svn propset svn:ignore \"*.db\n*.sqlite\n*.sqlite3\nschema.rb\nschema.sql\" db/ > /dev/null"
+system "svn update db/ > /dev/null"
+system "svn propset svn:ignore \"database.yml\" config/ > /dev/null"
+system "svn update config/ > /dev/null"
+print "Done.\n"
+
+# Creating a svn_add_new rake task
+#print "Create a svn_add_new rake task..."
+#
+#print "Done.\n"
+
+# Committing updates
+print "Committing updates..."
+system "svn commit -m \"Updated svn:ignore properties\" > /dev/null"
+print "Done.\n"
+
+# Return to where we started
+Dir::chdir ".."

data/lib/rorsvnprep.rb

@@ -0,0 +1,101 @@
+# This file contains the main class definition for the Ruby on Rails Subversion
+# Prep Tool.
+#
+# Author:: James W. Thompson, II
+# Copyright:: Copyright (c) 2007, James W. Thompson, II
+
+# This class provides all the heavy lifting methods used by the command-line
+# utility. This class could also be implemented as part of another package to
+# provide further automated utilities.
+class RailsSVNPrep
+  @project = nil
+  @svn = nil
+  @password = nil
+  @log = false
+
+  # The new method expects up to four arguments. Only if the projname argument
+  # is missing will the method raise an error for anything other than failed
+  # validation.
+  def initialize(projname = nil, svnuri = nil, svnpass = nil, svnpath = nil, log = false)
+    if projname
+      if RailsSVNPrep::validate_name(projname)
+        @project = proj_name
+      else
+        raise ArgumentError,  "Invalid Project Name Supplied", caller
+      end
+    else
+      raise ArgumentError, "No Project Name Supplied", caller
+    end
+    
+    if svnuri
+      if RailsSVNPrep::validate_uri(svnuri)
+        @svn = svnuri
+      else
+        raise ArgumentError, "Invalid Subversion URI Supplied", caller
+      end
+    end
+    
+    if svnpath
+      if RailsSVNPrep::validate_path(svnpath)
+        @svn += svnpath
+      else  
+        raise ArgumentError, "Invalid Subversion Path Supplied", caller
+      end
+    elsif @svn
+      @svn += "/#{@project}/trunk"
+    end
+    
+    if svnpass
+      if RailsSVNPrep::validate_password(svnpass)
+        @password = svnpass
+      else
+        raise ArgumentError, "Invalid Password Supplied", caller
+      end
+    end
+    
+    @log = log
+    
+    @svn = RailsSVNPrep::normalize_svn(@svn)
+  end
+  
+  # This method creates a new project and moves us into the new directory. The
+  # method makes direct call to the rails command and dumps the output to 
+  # /dev/null.
+  def create_project
+    if Dir::glob(@project)
+      raise StandardError, "Directory #{@project} already exists", caller
+    end
+    
+    if system "rails #{@project} > /dev/null"
+      Dir::chdir @project
+    else
+      raise StandardError, "Unable to successfully run Rails", caller
+    end
+  end
+
+  #
+  # Below are a series of utility methods for validation and other internal
+  # processing requirements.
+  #
+  protected
+  
+    # A method to validate project names
+    def self.validate_name(projname)
+    
+    end
+  
+    # A method to validate subversion URIs
+    def self.validate_uri(svnuri)
+    
+    end
+  
+    # A method to validate a subversion repository path
+    def self.validate_path(svnpath)
+    
+    end
+  
+    # A method to normalize the combined subversion URI and repository path
+    def self.normalize_svn(svn)
+    
+    end
+end

data/test/rorsvnprep_test.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class RorsvnprepTest < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: rorsvnprep
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-02-15 00:00:00 -05:00
+summary: Provides additional automation to make managing Rails project with subversion easier.
+require_paths: 
+- lib
+email: jwthompson2@gmail.com
+homepage: http://rorsvnprep.rubyforge.org/
+rubyforge_project: rorsvnprep
+description: 
+autorequire: rorsvnprep
+default_executable: rorsvnprep
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- James W. Thompson, II
+files: 
+- lib/rorsvnprep.rb
+- README
+test_files: 
+- test/rorsvnprep_test.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: 
+- rorsvnprep
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cmdparse
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: