rorsvnprep 0.1.1 → 0.1.2

data/bin/rorsvnprep

@@ -1,80 +1,4 @@
 #!/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 you have given it the full subversion repository
-# URI, complete with any applicable path details for within the repository. The
-# script also will just break if you don't give it any subversion details, so
-# don't use the script unless you have something to give it. Also, the 
-# --password switch is broken, so don't use it. And finally, remember this is
-# still a very 'beta' quality product so don't depend on it for anythign really
-# important.
-#
-# == 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
-# * 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.
 require 'optparse'
 require 'rorsvnprep'
 
@@ -143,59 +67,4 @@ logfile = File::new( "rorsvnprep.log", "a" ) if arguments[:log]
 # Create an instance of our prep class with all our options
 rsp = RailsSVNPrep.new( project, svnuri, password, logfile, verbose )
 
-# TODO: Switch over to following code and remove everything beyond it
-#
-#rsp.run
-
-# Create a project
-rsp.create_project
-
-# OLD: Create our new project
-#puts "Creating Rails project: #{project}" if arguments[:verbose]
-#
-#if arguments[:verbose]
-#  system "rails #{project}"
-#else  
-#  system "rails #{project} >> /dev/null"
-#end
-#
-#Dir::chdir project
-
-  # Trim out all the stuff we don't want in the initial subversion import and
-  # move some other stuff around.
-  puts "Triming initial project..." if arguments[:verbose]
-  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"
-
-  # Perform our initial subversion import
-  puts "Importing project to subvserion..." if arguments[:verbose]
-  system "svn import #{svnuri} -m \"Initial import\" > /dev/null"
-  Dir::chdir ".."
-  system "rm -rf #{project} > /dev/null"
-
-  # Perform a subversion checkout of our project
-  puts "Checking out project from subversion..." if arguments[:verbose]
-  system "svn co #{svnuri} #{project} > /dev/null"
-  Dir::chdir project
-
-  # Setup svn:ignore properties
-  puts "Configuring svn:ignore properties..." if arguments[:verbose]
-  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"
-
-  # Committing updates
-  puts "Committing updates..." if arguments[:verbose]
-  system "svn commit -m \"Updated svn:ignore properties\" > /dev/null"
-
-  # Return to where we started
-  Dir::chdir ".."
-  puts "Done with project: #{project}"
+rsp.run

data/lib/rorsvnprep.rb

@@ -1,14 +1,68 @@
-# This file contains the main class definition for the Ruby on Rails Subversion
-# Prep Tool.
+# = Ruby on Rails Subversion Prep Tool
 #
-# Author:: James W. Thompson, II
-# Copyright:: Copyright (c) 2007, James W. Thompson, II
+# This file contains the main class that powers the Ruby on Rails Subversion
+# Prep Tool's script found in bin/rorsvnprep.
+#
+# 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>rorsvnprep</b> <em>example --svn=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.
+#
+# == 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>
+#
+# == 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.
+
 
 # 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
-  @@version = [ 0, 1, 1 ]
+  @@version = [ 0, 1, 2 ]
   
   @project = nil
   @svn = nil
@@ -27,6 +81,8 @@ class RailsSVNPrep
     @verbose = verbose
   end
 
+  # A simple method that calls all the other individual methods as necessary to
+  # create the rails project, prep it and produce a good working copy.
   def run
     puts "Rails SVN Prep: Starting." if @verbose
     @logfile.puts "Rails SVN Prep: Starting." if @logfile
@@ -59,7 +115,7 @@ class RailsSVNPrep
     #  raise StandardError
     #end
     
-    if system "rails #{@project} >> /dev/null"
+    if system "rails #{@project} > /dev/null"
       puts "Rails Project Folder Successfully Created."  if @verbose
       @logfile.puts "Rails Project Folder Successfully Created."  if @logfile
       Dir::chdir @project
@@ -70,22 +126,73 @@ class RailsSVNPrep
     end
   end
 
+  # This method prunes the initial project structure by renaming 
+  # config/database.yml, getting rid of the default README and README_FOR_APP
+  # files and clearing our the log/ and tmp/ folders.
   def trim_project
+    puts "Triming initial project." if @verbose
+    @logfile.puts "Triming initial project." if @logfile
+    
+    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"
   end
   
+  # This method produces .cvsignore files for those times when you don't want an
+  # initial subversion import done.
+  #
+  # TODO: Actually implement this.
   def generate_cvsignore
   end
   
+  # This method performs the initial subversion import and then deletes the 
+  # project folder in preparation for the initial checkout.
   def subversion_import
+    puts "Importing project to subvserion." if @verbose
+    @logfile.puts "Importing project to subvserion." if @logfile
+
+    system "svn import #{@svn} -m \"Initial import\" > /dev/null"
+    Dir::chdir ".."
+    system "rm -rf #{@project} > /dev/null"
   end
   
+  # This method produces the initial working copy via a subversion checkout.
   def subversion_checkout
+    puts "Checking out project from subversion." if @verbose
+    @logfile.puts "Checking out project from subversion." if @logfile
+
+    system "svn co #{@svn} #{@project} > /dev/null"
+    Dir::chdir @project
   end
   
+  # This method sets the svn:ignore property across a number of folders to make
+  # sure files that don't belong in version control don't end up in it.
   def subversion_propset
+    puts "Configuring svn:ignore properties." if @verbose
+    @logfile.puts "Configuring svn:ignore properties." if @logfile
+
+    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"
   end
   
+  # This method finishes up by committing to subversion if needed and 
+  # performing other house-keeping measures.
   def finalize
+    if @svn
+      puts "Committing updates." if @verbose
+      @logfile.puts "Committing updates." if @logfile
+    
+      system "svn commit -m \"Updated svn:ignore properties\" > /dev/null"
+      Dir::chdir ".."
+    end
   end
 
   # A convenience method to return our version number

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: rorsvnprep
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-02-20 00:00:00 -05:00
+  version: 0.1.2
+date: 2007-02-22 00:00:00 -05:00
 summary: Provides additional automation to make managing Rails project with subversion easier.
 require_paths: 
 - lib