pol-svn_ignore_rails 1.0.2

data/.document

@@ -0,0 +1,4 @@
+History.rdoc
+License.txt
+README.rdoc
+Upgrade.rdoc

data/History.rdoc

@@ -0,0 +1,6 @@
+=== Version 1.0.2 ===
+* fixed a typo in the deploy.rb removal commit message
+* added an automatic svn commit message for the database.yml removal
+
+=== Version 1.0 ===
+* initial release

data/License.txt

@@ -0,0 +1,24 @@
+(The MIT License)
+
+====================================================================
+==== Svn_Ignore_Rails
+Copyright (c) 2009 Pol Llovet, Montana State University
+====================================================================
+
+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/Manifest.txt

@@ -0,0 +1,13 @@
+.document
+generators/svn_ignore
+generators/svn_ignore/CHANGES
+generators/svn_ignore/svn_ignore_generator.rb
+generators/svn_ignore/templates/svn_ignore.rake
+History.rdoc
+init.rb
+License.txt
+Manifest.txt
+Rakefile
+README.rdoc
+TODO.txt
+Upgrade.rdoc

data/README.rdoc

@@ -0,0 +1,42 @@
+= SVN_Ignore_Rails Rake Task
+
+== DESCRIPTION:
+
+Sensible SVN file removal/ignore from a Rails app
+
+svn_ignore_rails is a simple rails generator that puts a rake task in your app
+that allows you to remove and ignore files from your rails app that shouldn't
+be in your repository.
+
+== FEATURES:
+
+* Doesn't delete any files, just removes them from the repository (uses the --keep-local option)
+* Doesn't delete any directories, but recurses into them, ignoring files if appropriate
+* Commits along the way so you can revert back to a particular step if necessary
+* Has command-line options for verbose and simulation
+* Do a 'rake -T svn' to see what all it does
+
+== INSTALL:
+
+* Run (sudo if necessary): gem install git://github.com/pol-svn_ignore_rails.git
+* Run (in your rails app): script/generate svn_ignore_rails
+
+== USAGE:
+
+All operations should be performed within the the root of the rails app.
+It is expected that the app is entirely checked into SVN, at the very least, the
+repository is set.  Running 'svn update' from the root of the app should work.
+
+Run a simulation:
+$ rake svn:setup OPTIONS='simulation'
+
+Run a verbose simulation:
+$ rake svn:setup OPTIONS='simulation,verbose'
+
+Run just the config/ removals
+$ rake svn:remove_config
+
+Run the whole set of tasks
+$ rake svn:setup
+
+See the rake file for more information.

data/TODO.txt

@@ -0,0 +1,3 @@
+* Make the default behavior sensible when the app has not yet been committed to svn
+* Tests
+* Ask for svn repo credentials initially so the tasks don't spam for them

data/Upgrade.rdoc

@@ -0,0 +1 @@
+= This is Version 1.0

data/generators/svn_ignore/svn_ignore_rails_generator.rb

@@ -0,0 +1,28 @@
+require 'rbconfig'
+
+# This generator adds a rake task to a Rails project for svn file ignores
+class SvnIgnoreRailsGenerator < Rails::Generator::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  def initialize(runtime_args, runtime_options = {})
+    Dir.mkdir('lib/tasks') unless File.directory?('lib/tasks')
+    super
+  end
+  
+  def manifest
+    record do |m|
+      script_options     = { :chmod => 0755, :shebang => options[:shebang] == DEFAULT_SHEBANG ? nil : options[:shebang] }
+
+      m.directory 'lib/tasks'
+      m.template  'svn_ignore.rake', 'lib/tasks/svn_ignore.rake'
+    end
+  end
+  
+protected
+  
+  def banner
+    "Usage: #{$0} svn_ignore_rails"
+  end
+  
+end

data/generators/svn_ignore/templates/svn_ignore.rake

@@ -0,0 +1,196 @@
+# This file is copied to ~/lib/tasks when you run 'ruby script/generate svn_ignore_rails'
+# from the project root directory.
+options = {}
+ENV['OPTIONS'].split(',').each { |opt| options[opt.downcase.to_sym] = true } if ENV['OPTIONS']
+
+namespace :svn do
+  puts "Options: " + options.keys.join(',') unless options.empty?
+  abort(help_text) if options[:help]
+
+  desc "Remove and ignore config/initializers/site_keys.rb"
+  task :remove_site_keys_rb do
+    tasks = TaskQueue.new
+    tasks.concat remove_file_with_example(File.join('config','initializers'),'site_keys.rb')
+    tasks.add_msg "Committing..."
+    tasks.add_cmd "svn commit #{RAILS_ROOT} -m 'Remove and ignore config/initializers/site_keys.rb'"
+    tasks.run(options)
+  end
+  
+  desc "Remove and ignore config/database.yml"
+  task :remove_database_yml do
+    tasks = TaskQueue.new
+    tasks.concat remove_file_with_example('config','database.yml')
+    tasks.add_msg "Committing..."
+    tasks.add_cmd "svn commit #{RAILS_ROOT} -m 'Remove and ignore config/database.yml'"
+    tasks.run(options)
+  end
+
+  desc "Remove and ignore config/deploy.rb"
+  task :remove_deploy_rb do
+    tasks = TaskQueue.new
+    tasks.concat remove_file_with_example('config','deploy.rb')
+    tasks.add_msg "Committing..."
+    tasks.add_cmd "svn commit #{RAILS_ROOT} -m 'Remove and ignore config/deploy.rb'"
+    tasks.run(options)
+  end
+  
+  desc "Remove and ignore files from tmp/ (recursively, keep dirs)"
+  task :remove_tmp do
+    tasks = TaskQueue.new
+    tasks.concat recursive_delete_and_ignore(File.join(RAILS_ROOT,'tmp'))
+    tasks.add_msg "Committing..."
+    tasks.add_cmd "svn commit #{RAILS_ROOT} -m 'Remove and ignore files from tmp/ (recursively, keep dirs)'"
+    tasks.run(options)
+  end
+  
+  desc "Remove and ignore files from log/ (recursively, keep dirs)"
+  task :remove_log do
+    tasks = TaskQueue.new
+    tasks.concat recursive_delete_and_ignore(File.join(RAILS_ROOT,'log'))
+    tasks.add_msg "Committing..."
+    tasks.add_cmd "svn commit #{RAILS_ROOT} -m 'Remove and ignore files from log/ (recursively, keep dirs)'"
+    tasks.run(options)
+  end
+  
+  desc "Remove and ignore db/*.sqlite3"
+  task :remove_sqlite3_database do
+    tasks = TaskQueue.new
+    tasks.concat remove_glob('db','*.sqlite3')
+    tasks.add_msg "Committing..."
+    tasks.add_cmd "svn commit #{RAILS_ROOT} -m 'Remove and ignore db/*.sqlite3'"
+    tasks.run(options)
+  end
+  
+  desc "Remove and ignore .git* (just in the root of the app)"
+  task :remove_git do
+    tasks = TaskQueue.new
+    tasks.concat remove_glob('.','.git*')
+    tasks.add_msg "Committing..."
+    tasks.add_cmd "svn commit #{RAILS_ROOT} -m 'Remove and ignore .git* (just in the root of the app)'"
+    tasks.run(options)
+  end
+  
+  desc "Run each of the config file removal tasks"
+  task :remove_config => ['remove_site_keys_rb','remove_database_yml','remove_deploy_rb']
+  
+  desc "Run all of the svn remove and ignore rake tasks"
+  task :setup => ['remove_config','remove_tmp','remove_log','remove_sqlite3_database','remove_git']
+  
+  task :default => ['setup']
+  
+end
+
+class TaskQueue < Array
+  class Task < String 
+    def message
+      @command = false
+      @message = true
+      self
+    end
+
+    def command
+      @message = false
+      @command = true
+      self
+    end
+
+    def message?
+      @message
+    end
+
+    def command?
+      @command
+    end
+
+    def to_vs
+      (command? ? "Command: " : "Message: ") + self.to_s
+    end
+  end
+  
+  def add_msg(task)
+    self << Task.new(task).message
+  end
+
+  def add_cmd(task)
+    self << Task.new(task).command
+  end
+
+  def run(opt = nil)
+    self.each do |t|
+      if t.command?
+        puts t.to_vs if opt[:verbose]
+        system(t) unless opt[:simulate]
+      else
+        puts opt[:verbose] ? t.to_vs : t.to_s
+      end
+    end
+  end
+end
+
+# recursively delete then ignore files
+def recursive_delete_and_ignore(dir)
+  tasks = TaskQueue.new
+  tasks.add_msg "Removing and ignoring files from #{dir}"
+  if File.directory?(dir)
+    Dir.glob(dir + '/*').each do |d|
+      if File.directory?(d) 
+        tasks.concat recursive_delete_and_ignore(d)
+      else
+        tasks.add_cmd("svn rm --keep-local '#{d}'")
+      end
+    end
+    tasks.add_cmd "svn propset svn:ignore '*' '#{dir}'"
+  else
+    tasks.add_msg "The #{dir} directory doesn't exist"
+  end
+  tasks
+end
+
+def remove_file_with_example(d,f)
+  tasks = TaskQueue.new
+  fp = File.join(RAILS_ROOT,d,f)
+  tasks.add_msg "Copying #{f} to #{f}.example"
+  if File.exists?(fp)
+    tasks.add_cmd "svn cp #{fp} #{fp}.example"
+    tasks.add_cmd "svn rm --keep-local #{fp}"
+  else
+    tasks.add_msg "The #{f} file doesn't exist"
+  end  
+  tasks.add_msg "Ignoring #{f}"
+  ignores = [%x[svn propget svn:ignore '#{File.join(RAILS_ROOT,d)}'].strip, "#{f}"].select {|i| !i.blank? }.join('\n')
+  tasks.add_cmd "echo -e #{ignores.dump} | svn propset svn:ignore -F - '#{File.join(RAILS_ROOT,d)}'"
+  tasks
+end
+
+def remove_glob(d,f)
+  tasks = TaskQueue.new
+  fp = File.join(RAILS_ROOT,d,f)
+  tasks.add_msg "Removing #{f} from #{d}"
+  unless Dir.glob(fp).empty?
+    tasks.add_cmd "svn rm --keep-local '#{fp}'"
+  else
+    tasks.add_msg "#{f} glob doesn't exist in #{d}"
+  end
+  tasks.add_msg "Ignoring #{f} on #{d}"
+  tasks.add_cmd "svn propset svn:ignore '#{File.basename(fp)}' #{File.join(RAILS_ROOT,File.dirname(f))}"
+  tasks
+end
+
+def help_text
+  <<-help
+    This script expects that you have a new rails app, and that everything
+    has been submitted to the svn repo.
+
+    The script will do the following:
+    - recursively remove all files from log and recursively set ignore * on dirs
+    - recursively remove all files from tmp and recursively set ignore * on dirs
+    - move config/database.yml to config/database.yml.example and ignore database.yml
+    - move config/deploy.rb to config/deploy.rb.example and ignore deploy.rb
+    - remove db/*.sqlite3 and ignore them
+
+    All file removal leaves the local copy (your local file is only deleted from the repo)
+
+    Use the -s option to do a simulated run
+    Use the --verbose option for verbose (show the commands being run)
+  help
+end

data/init.rb

@@ -0,0 +1,7 @@
+# Placeholder to placate Rails.  (Stolen from rspec-rails)
+#
+# Do NOT add any require statements to this file. Doing
+# so will cause Rails to load this plugin all of the time.
+#
+# Running 'ruby script/generate svn_ignore_rails' will
+# generate the rake file.

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: pol-svn_ignore_rails
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- Pol Llovet
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Rails generator for svn ignore rake tasks
+email: pol.llovet+code@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- License.txt
+files: 
+- .document
+- generators/svn_ignore
+- generators/svn_ignore/svn_ignore_rails_generator.rb
+- generators/svn_ignore/templates/svn_ignore.rake
+- History.rdoc
+- init.rb
+- License.txt
+- Manifest.txt
+- Rakefile
+- README.rdoc
+- TODO.txt
+- Upgrade.rdoc
+has_rdoc: true
+homepage: http://github.com/pol/svn_ignore_rails
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --line-numbers
+- README
+- generators
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Rails generator for svn ignore rake tasks
+test_files: []
+