revans-gitools 0.3.0

data/CHANGELOG.rdoc

@@ -0,0 +1,8 @@
+Version 0.3.0
+  * Added command line tools
+  
+Version 0.2.0
+  * Added individual task method
+
+Version 0.1.0
+  * Initial Creation

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Robert R Evans, Code Wranglers, Inc.
+
+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/README.markdown

@@ -0,0 +1,80 @@
+# Git_tools
+
+## How to use
+
+Create a yaml file in your config/ directory and name it submodules.yml.
+
+Add the git submodules that you want to want to use in your application like so:
+
+<pre>
+  submodules:
+    rspec: git://github.com/dchelimsky/rspec.git
+    rspec_rails: git://github.com/dchelimsky/rspec-rails.git
+    geokit: git://github.com/ptb/geokit.git
+    asset_packager: git://github.com/sbecker/asset_packager.git
+    paperclip: git://github.com/thoughtbot/paperclip.git
+    will_paginate: git://github.com/mislav/will_paginate.git
+    exception_notification: git://github.com/rails/exception_notification.git
+    cucumber: git://github.com/aslakhellesoy/cucumber.git
+    ssl_requirement: git://github.com/rails/ssl_requirement.git
+    rails: git://github.com/rails/rails.git
+    active_merchant: git://github.com/Shopify/active_merchant.git
+</pre>
+
+A couple of things, it needs to follow the structure above with the name submodules and defining each below it. Use the name
+that you want the plugin to be named when checking out. Put the git location as the value.
+
+Now, create a new Rake task in lib/tasks directory. I call mine submodules.rake. Here is what my file looks like:
+
+<pre>
+  require 'gitools'
+
+  @configration = File.join(RAILS_ROOT, "config/submodules.yml")
+
+  namespace :git do
+
+    namespace :submodule do
+
+      desc "Remove Submodule cache"
+      task :remove, :submodule do |task, args|
+        GitTools::Submodule.remove(args.submodule)
+      end
+
+    end
+
+
+    namespace :update do
+
+      desc "Update all Submodules"
+      task :all => :environment do
+        GitTools::Submodule.update_all(@configration)
+      end
+
+
+      GitTools::Submodule.individual_tasks(@configration) do |name|
+        desc "Update #{name} submodule"
+        task name.to_sym => :environment do
+          GitTools::Submodule.submodule_update("#{name}")
+        end
+      end
+
+    end
+
+  end
+</pre>
+
+
+## Command Line
+
+When creating a new project, it would be nice to just write your submodule.yml file and then shoot a command off in the terminal and have all your submodules installed for you. Well, now you can! Just do:
+
+<pre>
+  gitools all
+</pre>
+
+That will install all the submodules from your config/submodule.yml file. Here are a couple more commands you can run:
+
+<pre>
+  gitools -u     # For a fresh clone that needs the submodules init/update
+  gitools rails  # To add rails as a submodule, if you have it specified in your config/submodules.yml file
+</pre>

data/bin/gitools

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'gitools'
+
+
+options = GitTools::Options.parse!(ARGV) 
+GitTools::CI.get(options)

data/lib/gitools/ci.rb

@@ -0,0 +1,18 @@
+module GitTools
+  class CI
+    
+    def self.get(options)
+      init      = new
+      @options  = options
+      @yaml     = File.join(@options.yaml, 'config/submodules.yml')
+      if @options.update
+        GitTools::Submodule.checkout
+      elsif @options.library == "all"
+        GitTools::Submodule.install_all(@yaml)
+      else
+        GitTools::Submodule.install_single(@yaml, @options.library)
+      end
+    end
+
+  end
+end

data/lib/gitools/config/submodules.yml

@@ -0,0 +1,13 @@
+submodules:
+  rspec: git://github.com/dchelimsky/rspec.git
+  rspec_rails: git://github.com/dchelimsky/rspec-rails.git
+  geokit: git://github.com/ptb/geokit.git
+  asset_packager: git://github.com/sbecker/asset_packager.git
+  paperclip: git://github.com/thoughtbot/paperclip.git
+  will_paginate: git://github.com/mislav/will_paginate.git
+  ultrasphinx: git://github.com/fauna/ultrasphinx.git
+  exception_notification: git://github.com/rails/exception_notification.git
+  open_id_authentication: git://github.com/rails/open_id_authentication.git
+  cucumber: git://github.com/aslakhellesoy/cucumber.git
+  ssl_requirement: git://github.com/rails/ssl_requirement.git
+  rails: git://github.com/rails/rails.git

data/lib/gitools/parse.rb

@@ -0,0 +1,43 @@
+module GitTools
+  class Options
+   
+    def self.parse!(args)
+      options           = OpenStruct.new
+      options.library   = args.first.sub(/(\s+)/, '_') unless args.first.nil?
+      options.yaml      = Dir.pwd
+      
+      opts = OptionParser.new do |opts|
+        
+        opts.banner = "\nGit Tools Usage: gitools all will install all your git submodules"
+        opts.separator "You must be in your Application Root Directory when running this command."
+        opts.separator ""
+        
+        opts.on('-u', '--update', 'Update the Submodule instead of adding it.') do |ext|
+          options.update = ext
+        end
+        
+        opts.on_tail('-v', '--version', "Show GitTools' current version.") do
+          puts "\nGit Tools is at version #{GitTools::Version}\n"
+          exit(0)
+        end
+        
+        opts.on_tail('-h', '--help', "Help Me!") do
+          puts "#{opts}\n"
+          exit(0)
+        end
+        
+        opts.on_tail do
+          if (options.library.nil? || options.library == '') && !options.udpate
+            puts "\nYou need to tell me what you want library you want to add to git submodule."
+            puts "#{opts}\n"
+            exit(0)
+          end
+        end  
+      end # OptionParser
+      
+      opts.parse!(args)
+      options
+    end # parse!
+    
+  end
+end

data/lib/gitools/submodules.rb

@@ -0,0 +1,61 @@
+module GitTools
+  
+  # TODO: Refactor Class
+  class Submodule
+    
+    def self.update_all(yaml)
+      @config = load_yaml(yaml)
+      @config.each_key do |name| 
+        message(name) { submodule_update(name) }
+      end
+    end
+    
+    def self.install_all(yaml)
+      @config = load_yaml(yaml)
+      @config.each { |plugin, repo| add(plugin, repo) }
+    end
+    
+    def self.install_single(yaml, name)
+      @config = load_yaml(yaml)
+      add(name, @config[name])
+    end
+    
+    def self.add(name, repo)
+      dir = name == "rails" ? "vendor/rails/" : "vendor/plugins/#{name}"
+      system("git submodule add #{repo} #{dir}")
+    end
+    
+    def self.checkout
+      system("git submodule init")
+      system("git submodule update")
+    end
+    
+    def self.remove(submodule)
+      system("git rm --cache vendor/plugins/#{submodule}")
+    end
+    
+    def self.submodule_update(name)
+      dir = name == "rails" ? "vendor/rails/" : "vendor/plugins/#{name}"
+      system("cd #{dir} && git remote update && git merge origin/master")
+    end
+    
+    def self.load_yaml(yaml)
+      YAML::load(File.open(yaml))['submodules']
+    end
+    
+    
+    def self.message(name, &block)
+      puts "Updating #{name.to_s}"
+      yield
+      puts "\n"
+    end
+    
+
+    def self.individual_tasks(yaml, &block)
+      @config = load_yaml(yaml)
+      @config.each_key { |name| yield name }
+    end  
+    
+  end
+  
+end

data/lib/gitools.rb

@@ -0,0 +1,12 @@
+module GitTools
+  Version = "0.3.0"
+end
+
+# Required Gems
+%w[optparse ostruct].each { |library| require library }
+
+# Gem specific Requires
+require File.dirname(__FILE__) + "/gitools/submodules.rb"
+require File.dirname(__FILE__) + "/gitools/parse.rb"
+require File.dirname(__FILE__) + "/gitools/ci.rb"
+# require File.dirname(__FILE__) + "/git_tools/"

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: revans-gitools
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Robert R Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-21 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: An easy way to manage your git submodules in a Rails Application.
+email: robert@codewranglers.org
+executables: 
+- gitools
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+- CHANGELOG.rdoc
+- LICENSE
+files: 
+- README.markdown
+- LICENSE
+- CHANGELOG.rdoc
+- Rakefile
+- bin/gitools
+- lib/gitools.rb
+- lib/gitools/submodules.rb
+- lib/gitools/config/submodules.yml
+- lib/gitools/parse.rb
+- lib/gitools/ci.rb
+has_rdoc: true
+homepage: http://codewranglers.org
+post_install_message: 
+rdoc_options: []
+
+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: gitools
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: An easy way to manage your git submodules in a Rails Application.
+test_files: []
+