kelredd-gemsconfig 0.1.1

data/README.rdoc

@@ -0,0 +1,106 @@
+= Gemsconfig
+
+== Description
+
+A gem to manage gem configuration for a project, similar to Rails' config.gem (but in a very simple, dumb way)
+
+== Installation
+
+    sudo gem install kelredd-gemsconfig --source http://gems.github.com
+
+== Usage  
+    (in any main project ruby file that is loaded on project start)
+    require 'rubygems'
+    require 'config/gems.rb'      # custom Gemsconfig configuration for your project
+    Gemsconfig::load
+
+The file 'config/gems.rb' should require in 'gemsconfig', call Gemsconfig::init, and specify the gem
+configurations (see example in 'Configuration' below).  Gemsconfig::load will attempt to load each
+gem configured.  Any load errors will be thrown and alerted.
+
+== Rake Usage
+Gemsconfig comes with a rake task that will attempt to install any gems not yet installed.  To use it, be sure to install
+rake and have a Rakefile that contains something like this:
+
+    # Rakefile example
+    require 'rubygems'
+    require 'config/gems.rb'      # custom Gemsconfig configuration for your project
+    require 'gemsconfig/tasks/rake'
+    
+Now to use the install task:
+
+    (in terminal)
+    rake -T                   # make sure gemsconfig:install task is loaded and available
+    rake gemsconfig:install   # attemp to install any gems not yet installed
+
+== Capistrano Usage
+
+So it would be really awesome to have a cap task like 'cap deploy:gems' that would do a capistrano deploy and run 'rake gemsconfig:install'
+as part of said deploy.  I'll add this someday...
+
+== Configuration
+
+Gemsconfig expects to be initialized with configuration entries for each gem that needs to be configured for your project.  This
+initialization is typically done in a configuration file that is required in to the main app file.  Here's an example:
+
+    # gems.rb example
+    require 'gemsconfig'
+
+    Gemsconfig::init do |config|
+      config.gem 'sinatra'
+    
+      config.gem 'kelredd-useful',
+        :lib => 'useful/ruby_extensions',
+        :source => 'http://gems.github.com'
+    
+      config.gem 'kelredd-useful',
+        :lib => 'useful/sinatra_helpers',
+        :source => 'http://gems.github.com'
+
+      config.gem 'kelredd-activerecord-sinatra',
+        :lib => 'activerecord_sinatra',
+        :source => 'http://gems.github.com'
+
+      config.gem 'kelredd-sprockets-sinatra',
+        :lib => 'sprockets_sinatra',
+        :version => '0.2.1',
+        :source => 'http://gems.github.com'
+
+      config.gem 'kelredd-repository',
+        :lib => 'repository/filesystem',
+        :source => 'http://gems.github.com'
+    end
+    
+== Gotchas
+
+* Sinatra: I would be careful configuring the Sinatra gem using Gemsconfig.  Sinatra expects to be required in the main app.rb
+file.  If you only configure the sinatra gem in your Gemsconfig, it gets required from one of Gemsconfig's lib files and
+this messes up the Sinatra::Application.root variable (among other things I'm sure).  A best practice would be to go ahead
+and configure sinatra in Gemsconfig (as in the example above), AND require it in your main app.rb file BEFORE requiring your
+Gemsconfig.  This way sinatra gets required like it expects, and when Gemsconfig attempts to require it, nothing will happen,
+and you still get the rake task benefit from having Sinatra in the Gemsconfig.
+  
+== License
+
+Copyright (c) 2009 Kelly Redding
+
+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/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/gemsconfig/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'gemsconfig'
+  s.version          = Gemsconfig::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "A gem to manage gem configuration for a project, similar to Rails' config.gem (but in a very simple, dumb way)"
+  s.author           = 'Kelly Redding'
+  s.email            = 'kelly@kelredd.com'
+  s.homepage         = ''
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  # s.executables      = ['gemsconfig']
+
+  # s.add_dependency('gem_name', '~> 0.0.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/gemsconfig.rb

@@ -0,0 +1,31 @@
+$:.unshift File.dirname(__FILE__)
+require 'gemsconfig/config'
+
+module Gemsconfig
+  
+  def self.init
+    @@config = Config.new
+    yield @@config
+  end
+  
+  def self.load
+    check_config(:load)
+    @@config.entries.each do |entry|
+      entry.load
+    end
+  end
+  
+  def self.install
+    check_config(:install)
+    @@config.entries.each do |entry|
+      entry.install unless entry.loaded?
+    end
+  end
+  
+  protected
+  
+  def self.check_config(method)
+    raise "You need to initialize Gemsconfig with Gemsconfig::init before you #{method} your gemsconfig." unless @@config
+  end
+  
+end

data/lib/gemsconfig/config.rb

@@ -0,0 +1,18 @@
+$:.unshift File.dirname(__FILE__)
+require 'entry'
+
+module Gemsconfig
+  
+  class Config
+    attr_reader :entries
+    
+    def initialize
+      @entries = []
+    end
+    
+    def gem(name, opts={})
+      @entries << Entry.new(name, opts)
+    end
+    
+  end
+end

data/lib/gemsconfig/entry.rb

@@ -0,0 +1,68 @@
+module Gemsconfig
+  
+  class Entry
+    
+    attr_reader :name, :lib, :version, :source
+    
+    def initialize(name, attrs)
+      attrs ||= {}
+      @name = name
+      @lib = attrs[:lib] || attrs['lib']
+      @version = attrs[:version] || attrs['version']
+      @source = attrs[:source] || attrs['source']
+    end
+    
+    def load
+      begin
+        gem name, version_spec if @version
+        require (@lib || @name)
+      rescue LoadError => err
+        raise LoadError, "\nGemsconfig: could not load configured gem '#{@name}'#{" (#{@lib})" if @lib} - #{err.message}\n\nTry:\nrake gemsconfig:install\n--or--\n#{install_gem_command}\n\n"
+      end
+    end
+    
+    def loaded?
+      %x(#{gem_command} #{list_command.join(' ')}).split("\n").detect{|listing| listing =~ Regexp.new("#{name}\s+.+#{Regexp.escape(@version) if @version}.+")}
+    end
+    
+    def install
+      cmd = install_gem_command
+      puts cmd
+      puts %x(#{cmd})
+    end
+    
+    protected
+    
+    def install_gem_command
+      "#{gem_command} #{install_command.join(' ')}"
+    end
+    
+    def gem_command
+      case RUBY_PLATFORM
+        when /win32/
+          'gem.bat'
+        when /java/
+          'jruby -S gem'
+        else
+          'gem'
+      end
+    end
+    
+    def list_command
+      %w(list --local)
+    end
+
+    def install_command
+      cmd = %w(install) << name
+      cmd << "--version" << version_spec if @version
+      cmd << "--source"  << @source  if @source
+      cmd
+    end
+    
+    def version_spec
+      "=#{@version}"
+    end
+    
+  end
+  
+end

data/lib/gemsconfig/tasks/cap.rb

@@ -0,0 +1 @@
+# TODO: define cap task to allow you to deploy and run 'rake gemsconfig:install' before restart similar to deploy:migrations for Rails

data/lib/gemsconfig/tasks/rake.rb

@@ -0,0 +1,10 @@
+namespace :gemsconfig do
+
+  desc 'Install all configured gems'
+  task :install do
+    puts "Gemsconfig: installing configured gems"
+    Gemsconfig::install    
+    puts "Gemsconfig: All configured gems are installed and ready"
+  end
+
+end

data/lib/gemsconfig/version.rb

@@ -0,0 +1,13 @@
+module Gemsconfig
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 1
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/test/test_helper.rb

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

data/test/unit/gemsconfig_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class GemsconfigTest < Test::Unit::TestCase
+
+  describe "An instance of the Gemsconfig class" do
+
+    it "should flunk" do
+      flunk "Please provide some tests"
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: kelredd-gemsconfig
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Kelly Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: kelly@kelredd.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/gemsconfig
+- lib/gemsconfig/config.rb
+- lib/gemsconfig/entry.rb
+- lib/gemsconfig/tasks
+- lib/gemsconfig/tasks/cap.rb
+- lib/gemsconfig/tasks/rake.rb
+- lib/gemsconfig/version.rb
+- lib/gemsconfig.rb
+- test/test_helper.rb
+- test/unit
+- test/unit/gemsconfig_test.rb
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: A gem to manage gem configuration for a project, similar to Rails' config.gem (but in a very simple, dumb way)
+test_files: []
+