gem-manage-sources 0.2.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gemspec
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Britt Crawford
+
+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.rdoc

@@ -0,0 +1,49 @@
+= gem-manage-sources
+
+Manage your gem sources so that you can use sources that are not always available without having to 'gem sources -a' and 'gem sources -r' all the time.
+
+This is useful if you have a corporate gem server that lives within
+a firewall and is not always accessible.
+
+== Installation
+
+  gem install gem-manage-sources
+
+== Usage
+
+First you have to create a sources.yml file using:
+
+  gem manage_sources --init
+
+Now whenever you switch networks or want to check whether some of your sources are available use:
+
+  gem manage_sources --check
+
+To add a source:
+
+  gem manage_sources --add http://source.com
+
+To remove a source
+
+  gem manage_sources --remove http://source.com
+
+== TODO
+
+* Sources are not being removed when they go active...doh.
+* Documentation
+* JRuby (and *Ruby) support
+* Find a better name
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Britt Crawford. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gem-manage-sources"
+    
+    gem.summary = <<-SUMMARY
+Manage your gem sources so that you can use sources that are not always available without having to 'gem sources -a' and 'gem sources -r' all the time.
+    SUMMARY
+    
+    gem.description = <<-WTF
+Manage your gem sources so that you can use sources that are not always available without having to 'gem sources -a' and 'gem sources -r' all the time.  This is especially useful if you have a gem server that lives within a firewall.    
+    WTF
+    
+    gem.email = "britt.v.crawford@gmail.com"
+    gem.homepage = "http://github.com/britt/gem-manage-sources"
+    gem.authors = ["Britt Crawford"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/lib/gem_manage_sources/commands/manage_sources_command.rb

@@ -0,0 +1,103 @@
+require 'rubygems/command'
+require 'gem_manage_sources/sources'
+
+module Gem
+  module Commands
+    class ManageSourcesCommand < Gem::Command
+      include Gem::Sources
+      
+      def self.sources_file
+        File.join(ENV['HOME'], '.gem', 'ruby', 'sources.yml')
+      end
+      
+      def initialize
+        super('manage-sources', 'Manage the sources RubyGems use to search for gems. (USE INSTEAD OF: sources)')
+        defaults.merge!(:sources_to_add => [], :sources_to_remove => [], :check_sources? => false, :init? => false)
+        
+        add_option('-a', '--add SOURCE_URL', 'Add a gem source') do |value, options|
+          options[:sources_to_add] << value
+        end
+        
+        add_option('-r', '--remove SOURCE_URL', 'Remove a gem source') do |value, options|
+          options[:sources_to_remove] << value
+        end
+        
+        add_option('-c', '--check', 'Check gem sources. This will add or remove sources depending on availability.') do |value, options|
+          options[:check_sources?] = true
+        end
+        
+        add_option('-i', '--init', 'Generate the sources.yml file from your existing gem sources.') do |value, options|
+          options[:init?] = true
+        end
+      end
+      
+      def execute
+        if options[:init?]
+          initialize_sources 
+        elsif options[:check_sources?]
+          check_sources
+        elsif !options[:sources_to_add].empty?
+          add_sources(options[:sources_to_add])
+        elsif !options[:sources_to_remove].empty?
+          remove_sources(options[:sources_to_remove])
+        else
+          list
+        end
+      end
+      
+      def initialize_sources
+        unless File.exist?(ManageSourcesCommand.sources_file)   
+          @sources = List.new(:unchecked => currently_loaded_sources)
+          @sources.verify
+          @sources.dump(ManageSourcesCommand.sources_file)
+        end
+        list
+      end
+      
+      def check_sources
+        sources.unchecked.concat(currently_loaded_sources)
+        sources.verify
+        sources.sync
+        sources.dump(ManageSourcesCommand.sources_file)
+        list
+      end
+      
+      def add_sources(sources_to_add)
+        sources_to_add.each do |source| 
+          if sources.add(source) 
+            puts "Added #{source} to gem sources."
+          else
+            puts "** #{source} Unavailable ** Added to the list of inactive sources. "
+          end
+        end
+        sources.dump(ManageSourcesCommand.sources_file)
+      end
+      
+      def remove_sources(sources_to_remove)
+        sources_to_remove.each do |source| 
+          sources.remove(source)
+          puts "Removed #{source} from gem sources."
+        end
+        sources.dump(ManageSourcesCommand.sources_file)
+      end
+      
+      def list
+        puts "*** CURRENT SOURCES ***"
+        puts ""
+        puts "** ACTIVE SOURCES **"
+        puts ""
+        sources.active.each { |source| puts source }
+        puts ""
+        puts "** INACTIVE SOURCES **"
+        puts ""
+        sources.inactive.each { |source| puts source }
+      end
+      
+      private
+      
+      def sources
+        @sources ||= Gem::Sources::List.load_file(ManageSourcesCommand.sources_file)
+      end
+    end
+  end
+end

data/lib/gem_manage_sources/sources.rb

@@ -0,0 +1,88 @@
+require 'uri'
+require 'net/http'
+
+module Gem
+  module Sources
+    def currently_loaded_sources
+      `gem sources`.split("\n").select { |s| s.start_with?('http') }
+    end
+    
+    class List    
+      include Gem::Sources
+        
+      attr_accessor :active, :inactive, :unchecked
+    
+      def self.load_file(file_name)
+        List.new(YAML.load_file(file_name))
+      end
+      
+      def initialize(sources = {})
+        self.active = sources[:active] || []
+        self.inactive = sources[:inactive] || []
+        self.unchecked = sources[:unchecked] || []
+      end
+    
+      def verify
+        @active, @inactive = all.partition { |source| source_available?(source) }
+      end
+    
+      def sync
+        current_sources = currently_loaded_sources
+        (active - current_sources).each { |source| add_system_source(source) }
+        (inactive & current_sources).each { |source| remove_system_source(source) }
+      end
+    
+      def add(source)
+        available = source_available?(source)
+        if available
+          self.active << source
+        else
+          self.inactive << source
+        end
+        available
+      end
+      
+      def remove(source)
+        [@active, @unchecked, @inactive].each { |list| list.delete(source) }
+      end
+    
+      def all
+        (active + inactive + unchecked).uniq
+      end
+      
+      def to_h
+        {:active => active, :inactive => inactive}
+      end
+      
+      def dump(file_name)
+        File.open(file_name, 'w') do |sources_file|
+          YAML.dump(to_h, sources_file)
+        end
+      end
+      
+      def size
+        all.size
+      end
+      
+      private
+      
+      def source_available?(host)        
+        uri = URI.parse(host)
+        gemspec_path = uri.path[-1,1] == '/' ? "specs.4.8.gz" : "/specs.4.8.gz"
+        response = nil  
+        Net::HTTP.start(uri.host, uri.port) {|http| response = http.head(uri.path + gemspec_path)}
+        response.is_a?(Net::HTTPOK)
+      rescue
+        false
+      end
+      
+      def add_system_source(source)
+        system("gem source -a #{source}")
+      end
+
+      def remove_system_source(source)
+        system("gem source -r #{source}")
+      end
+    end
+  end
+end

data/lib/gem_manage_sources.rb

@@ -0,0 +1,2 @@
+require 'gem_manage_sources/sources'
+require 'gem_manage_sources/commands/manage_sources_command'

data/lib/rubygems_plugin.rb

@@ -0,0 +1,6 @@
+require 'gem_manage_sources'
+require 'rubygems/command_manager'
+
+Gem::CommandManager.instance.register_command :manage_sources
+
+

data/spec/gem_manage_sources/commands/manage_sources_command_spec.rb

@@ -0,0 +1,155 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Gem::Commands::ManageSourcesCommand do
+  include Gem::Sources
+  
+  before(:each) do
+    @test_sources_file = Dir.tmpdir + "/test_gem_sources.yml"
+    @command = Gem::Commands::ManageSourcesCommand.new
+    Gem::Commands::ManageSourcesCommand.stub!(:sources_file).and_return(@test_sources_file)
+  end
+  
+  after(:each) do
+    File.delete(@test_sources_file) if File.exist?(@test_sources_file)
+  end
+  
+  describe "options" do
+    before(:each) do
+      @command.when_invoked {}
+    end
+    
+    describe "add" do  
+      it "should be -a, --add" do
+        @command.invoke("-a", "http://gems.example.com")
+        @command.invoke("--add", "http://gems.example.com")
+        
+        @command.options[:args].should be_empty
+      end
+      
+      it "should add the given source to :sources_to_add" do
+        @command.invoke("-a", "http://gems.example.com")
+        @command.options[:sources_to_add].should include("http://gems.example.com")
+      end
+    end
+    
+    describe "remove" do  
+      it "should be -r, --remove" do
+        @command.invoke("-r", "http://gems.example.com")
+        @command.invoke("--remove", "http://gems.example.com")
+        
+        @command.options[:args].should be_empty
+      end
+      
+      it "should add the given source to :sources_to_add" do
+        @command.invoke("-r", "http://gems.example.com")
+        @command.options[:sources_to_remove].should include("http://gems.example.com")
+      end
+    end
+    
+    describe "check" do  
+      it "should be -c, --check" do
+        @command.invoke("-c")
+        @command.invoke("--check")
+        
+        @command.options[:args].should be_empty
+      end      
+      
+      it "check_sources? should be true" do
+        @command.invoke("-c")
+    
+        @command.options[:check_sources?].should be_true
+      end
+    end
+    
+    describe "init" do  
+      it "should be -i, --init" do
+        @command.invoke("-i")
+        @command.invoke("--init")
+        
+        @command.options[:args].should be_empty
+      end  
+      
+      it "init? should be true" do
+        @command.invoke("-i")
+        
+        @command.options[:init?].should be_true
+      end    
+    end    
+  end
+
+  describe "init" do
+    context "when there is no existing sources file" do
+      before(:each) do
+        Gem::Commands::ManageSourcesCommand.stub!(:sources_file).and_return(@test_sources_file)
+        File.exist?(@test_sources_file).should be_false
+
+        @sources = ['http://active.example.com','http://inactive.example.com']
+        @list = Gem::Sources::List.new(:unchecked => @sources)
+
+        @list.stub!(:source_available?) do |source|
+          source == 'http://active.example.com'
+        end
+        
+        Gem::Sources::List.stub!(:new).and_return(@list)
+
+        @command.stub!(:currently_loaded_sources).and_return(@sources)
+        @command.stub!(:sources).and_return(@list)
+        @command.invoke('-i')
+      end
+      
+      it "should create ~/.gem/ruby/sources.yml" do        
+        File.exist?(@test_sources_file).should be_true
+      end
+      
+      it "should add all of the existing sources" do
+        sources = Gem::Sources::List.load_file(@test_sources_file)
+        @sources.each do |source|
+          sources.all.should include(source)
+        end
+      end
+            
+      it "should add unavailable sources to the inactive list" do
+        sources = Gem::Sources::List.load_file(@test_sources_file)
+        sources.active.should == ['http://active.example.com']
+      end
+      
+      it "should add available sources to the active list" do
+        sources = Gem::Sources::List.load_file(@test_sources_file)
+        sources.inactive.should == ['http://inactive.example.com']
+      end
+    end
+  end
+
+  describe "check" do
+    before(:each) do
+      @sources = ['http://active.example.com','http://inactive.example.com']
+      @list = Gem::Sources::List.new(:unchecked => @sources)
+      
+      @list.stub!(:sync)
+      @list.stub!(:source_available?) do |source|
+        source == 'http://active.example.com'
+      end
+      @list.verify
+      @list.dump(@test_sources_file)
+      
+      @sources << 'http://another.example.com'
+      @command.stub!(:currently_loaded_sources).and_return(@sources)
+      @command.stub!(:sources).and_return(@list)
+      
+      @command.invoke('-c')
+      @list = Gem::Sources::List.load_file(@test_sources_file)    
+    end
+    
+    it "should should add any new sources that have been added using 'gem source add'" do
+      @list.all.should include('http://another.example.com')
+    end
+    
+    it "should add unavailable sources to the inactive list" do 
+      @list.inactive.sort.should == ['http://inactive.example.com', 'http://another.example.com'].sort
+    end
+    
+    it "should add available sources to the active list" do
+      @list.active.should == ['http://active.example.com']
+    end
+  end
+end

data/spec/gem_manage_sources/sources_spec.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Gem::Sources do
+  include Gem::Sources
+  
+  describe "#currently_loaded_sources" do
+    it "should load all of the sources from 'gem sources'" do
+      currently_loaded_sources.should == `gem sources`.split("\n").select { |s| s.start_with?('http') }
+    end
+  end
+    
+  describe Gem::Sources::List do
+    before(:each) do
+      @sources = {
+        :active => ['http://active.example.com'],
+        :inactive => ['http://inactive.example.com']
+      }
+      @list = Gem::Sources::List.new(@sources)
+    end
+    
+    describe "##load_file" do
+      it "should load the given YAML" do
+        @test_sources_file = Dir.tmpdir + "/test_gem_sources.yml"        
+        File.open(@test_sources_file, 'w+') {|out| YAML.dump(@sources, out) }
+        
+        file_list = Gem::Sources::List.load_file(@test_sources_file)
+        file_list.active.should == @list.active
+        file_list.inactive.should == @list.inactive
+        
+        File.delete @test_sources_file
+      end
+    end
+    
+    describe "#all" do
+      it "should include both active and inactive sources" do
+        @list.all.sort.should == ['http://active.example.com', 'http://inactive.example.com'].sort
+      end
+    end
+    
+    describe "#to_h" do
+      it "should serialize to a hash" do
+        @list.to_h.should == @sources
+      end
+    end
+    
+    describe "#dump" do
+      it "should dump the hash representation to the given file" do
+        io = mock('FILE')
+        File.stub(:open).and_yield(io)
+        YAML.should_receive(:dump).once.with(@list.to_h, io)
+        @list.dump('file')
+      end
+    end
+    
+    describe "#verify" do
+      it "should check all sources" do
+        @list.should_receive(:source_available?).exactly(@list.size).times.and_return(true)
+        @list.verify
+      end
+      
+      it "should sort the sources into active and inactive" do
+        @list.stub!(:source_available?).and_return(true, false)
+        @list.verify
+        @list.active.should_not be_empty
+        @list.inactive.should_not be_empty
+      end
+    end
+    
+    describe "#add" do
+      it "should check if the source is available it to the appropriate list" do
+        @list.stub!(:source_available?).and_return(false)
+        @list.add('http://yas.example.com')
+        @list.inactive.should include('http://yas.example.com')
+        @list.active.should_not include('http://yas.example.com')
+      end
+    end
+    
+    describe "#remove" do
+      it "should remove the source from all lists" do
+        @list.remove('http://active.example.com')
+        @list.all.should_not include('http://active.example.com')
+      end
+    end
+    
+    describe "#sync" do
+      before(:each) do
+        @list.stub!(:currently_loaded_sources).and_return(['http://inactive.example.com'])
+      end
+      
+      it "should add all active sources that are not currently loaded" do
+        @list.should_receive(:add_system_source).once.with('http://active.example.com')
+        @list.stub!(:remove_system_source)
+        @list.sync
+      end
+      
+      it "should remove any inactive sources that are currently loaded" do
+        @list.should_receive(:remove_system_source).once.with('http://inactive.example.com')
+        @list.stub!(:add_system_source)
+        @list.sync
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'gem_manage_sources'
+require 'spec'
+require 'spec/autorun'
+require 'pp'
+require 'tmpdir'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: gem-manage-sources
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Britt Crawford
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-29 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |
+  Manage your gem sources so that you can use sources that are not always available without having to 'gem sources -a' and 'gem sources -r' all the time.  This is especially useful if you have a gem server that lives within a firewall.    
+
+email: britt.v.crawford@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/gem_manage_sources.rb
+- lib/gem_manage_sources/commands/manage_sources_command.rb
+- lib/gem_manage_sources/sources.rb
+- lib/rubygems_plugin.rb
+- spec/gem_manage_sources/commands/manage_sources_command_spec.rb
+- spec/gem_manage_sources/sources_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/britt/gem-manage-sources
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Manage your gem sources so that you can use sources that are not always available without having to 'gem sources -a' and 'gem sources -r' all the time.
+test_files: 
+- spec/gem_manage_sources/commands/manage_sources_command_spec.rb
+- spec/gem_manage_sources/sources_spec.rb
+- spec/spec_helper.rb