gem-check-sources 1.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## 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,41 @@
+= gem-check-sources
+
+gem-check-sources keeps your local list of gem sources in sync and removes any gem servers that might be unavailable.
+
+== Why?
+
+Imagine you work at a company that hosts its own gem server within the corporate network.  At work you need to install and update gems hosted on the corporate
+server, but when you take your laptop home and try to work on a side project all your remote gem commands fail.  
+
+So, you end up typing 'gem sources -a' and 'gem sources -r' a lot.
+
+gem-check-sources solves this problem by maintaining two list of gem servers (active and inactive).  If a server is unavailable it gets put on the inactive list and removed from your gem sources.  It will get added back when it becomes available again.
+
+== Installation
+
+  gem install gem-check-sources
+
+== Usage
+
+  gem check_sources
+
+That's it.  If something is inactive and you want to add it back just run the command again.
+
+== Links
+
+* Issue tracking: http://github.com/britt/gem-check-sources/issues
+* Code Metrics: http://getcaliper.com/caliper/project?repo=git://github.com/britt/gem-check-sources.git
+
+== 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) 2010 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-check-sources"
+    
+    gem.summary = <<-SUMMARY
+gem-check-sources keeps your local list of gem sources in sync and removes any gem servers that might be unavailable.    
+SUMMARY
+    
+    gem.description = <<-WTF
+gem-check-sources keeps your local list of gem sources in sync and removes any gem servers that might be unavailable.
+    WTF
+    
+    gem.email = "britt.v.crawford@gmail.com"
+    gem.homepage = "http://github.com/britt/gem-check-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 @@
+1.0.0

data/gem-check-sources.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gem-check-sources}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Britt Crawford"]
+  s.date = %q{2010-04-19}
+  s.description = %q{gem-check-sources keeps your local list of gem sources in sync and removes any gem servers that might be unavailable.
+}
+  s.email = %q{britt.v.crawford@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "gem-check-sources.gemspec",
+     "lib/gem_check_sources.rb",
+     "lib/gem_check_sources/commands/check_sources_command.rb",
+     "lib/gem_check_sources/sources.rb",
+     "lib/rubygems_plugin.rb",
+     "spec/gem_check_sources/commands/check_sources_command_spec.rb",
+     "spec/gem_check_sources/sources_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/britt/gem-check-sources}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{gem-check-sources keeps your local list of gem sources in sync and removes any gem servers that might be unavailable.}
+  s.test_files = [
+    "spec/gem_check_sources/commands/check_sources_command_spec.rb",
+     "spec/gem_check_sources/sources_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/gem_check_sources.rb

@@ -0,0 +1,2 @@
+require 'gem_check_sources/sources'
+require 'gem_check_sources/commands/check_sources_command'

data/lib/gem_check_sources/commands/check_sources_command.rb

@@ -0,0 +1,59 @@
+require 'rubygems/command'
+
+module Gem
+  module Commands
+    class CheckSourcesCommand < Gem::Command
+      include Gem::Sources
+      
+      def self.sources_file
+        File.join(ENV['HOME'], '.gem', 'ruby', 'sources.yml')
+      end
+      
+      def initialize
+        super('check_sources', 'Check which gem sources are currently available.')
+        defaults.merge!(:sources_to_add => [], :sources_to_remove => [], :verbose? => false)
+      end
+      
+      def execute
+        if File.exist?(CheckSourcesCommand.sources_file)  
+          check_sources
+        else
+          initialize_sources
+        end
+        list
+      end
+      
+      def initialize_sources
+        @sources = List.new(:unchecked => currently_loaded_sources)
+        @sources.verify
+        @sources.sync
+        @sources.dump(CheckSourcesCommand.sources_file)
+      end
+      
+      def check_sources        
+        sources.unchecked.concat(currently_loaded_sources)
+        sources.verify
+        sources.sync
+        sources.dump(CheckSourcesCommand.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(CheckSourcesCommand.sources_file)
+      end
+    end
+  end
+end

data/lib/gem_check_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| /http/ =~ s }
+    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) || response.is_a?(Net::HTTPFound) || response.is_a?(Net::HTTPNotModified)
+      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/rubygems_plugin.rb

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

data/spec/gem_check_sources/commands/check_sources_command_spec.rb

@@ -0,0 +1,123 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Gem::Commands::CheckSourcesCommand do
+  include Gem::Sources
+  
+  before(:each) do
+    $stdout = StringIO.new
+    # Dump the sources file in a temp dir so its easy to clean up.
+    @test_sources_file = Dir.tmpdir + "/test_gem_sources.yml"
+    Gem::Commands::CheckSourcesCommand.stub!(:sources_file).and_return(@test_sources_file)
+    
+    @command = Gem::Commands::CheckSourcesCommand.new
+  end
+  
+  after(:each) do
+    File.delete(@test_sources_file) if File.exist?(@test_sources_file)
+  end
+  
+  def stub_system_gem_sources_command(command, sources)
+    command.stub!(:currently_loaded_sources).and_return(sources)
+  end
+  
+  def stub_source_checking(command, list, &block)
+    list.stub!(:source_available?, &block)
+    Gem::Sources::List.stub!(:new).and_return(list)
+    command.stub!(:sources).and_return(list)
+  end
+  
+  describe "check" do
+    context "when the sources file does not exist" do
+      before(:each) do
+        @sources = ['http://active.example.com','http://inactive.example.com']
+        stub_system_gem_sources_command(@command, @sources)
+
+        @list = Gem::Sources::List.new(:unchecked => @sources)
+        stub_source_checking(@command, @list) { |source| source == 'http://active.example.com' }
+      end
+      
+      it "should create ~/.gem/ruby/sources.yml" do  
+        @list.stub!(:sync) 
+        @command.invoke      
+        File.exist?(@test_sources_file).should be_true
+      end
+      
+      it "should add all of the existing sources" do
+        @list.stub!(:sync)
+        @command.invoke      
+        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
+        @list.stub!(:sync) 
+        @command.invoke
+        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
+        @list.stub!(:sync) 
+        @command.invoke
+        sources = Gem::Sources::List.load_file(@test_sources_file)
+        sources.inactive.should == ['http://inactive.example.com']
+      end
+      
+      it "should synchronize the system source list with the available sources" do
+        @list.should_receive(:sync).once
+        @command.invoke
+      end      
+    end
+    
+    context "when the sources file already exists" do    
+      def invoke_with_stubbed_synchronization
+        @initial_list.stub!(:sync)         
+        @command.invoke
+        @list = Gem::Sources::List.load_file(@test_sources_file)
+      end
+      
+      before(:each) do
+        #Create a source list
+        @sources = ['http://active.example.com','http://inactive.example.com', 'http://another.example.com']
+        @initial_list = Gem::Sources::List.new(:active => ['http://active.example.com'], :inactive => ['http://inactive.example.com'])
+        @initial_list.dump(Gem::Commands::CheckSourcesCommand.sources_file)
+        
+        stub_system_gem_sources_command(@command, @sources)
+        stub_source_checking(@command, @initial_list) { |source| source == 'http://active.example.com' } 
+      end
+      
+      it "should load the sources list from ~/.gem/ruby/sources.yml" do
+        invoke_with_stubbed_synchronization
+        @list.all.should include('http://active.example.com')
+        @list.all.should include('http://inactive.example.com')
+      end
+      
+      it "should should add any new sources that have been added using 'gem source add'" do
+        invoke_with_stubbed_synchronization
+        @list.all.should include('http://another.example.com')
+      end
+
+      it "should add unavailable sources to the inactive list" do 
+        invoke_with_stubbed_synchronization
+        @list.inactive.sort.should == ['http://inactive.example.com', 'http://another.example.com'].sort
+      end
+
+      it "should add available sources to the active list" do
+        invoke_with_stubbed_synchronization
+        @list.active.should == ['http://active.example.com']
+      end
+      
+      it "should add sources to the list only once" do
+        invoke_with_stubbed_synchronization
+        @list.all.should == @list.all.uniq
+      end
+      
+      it "should synchronize the system source list with the available sources" do
+        @initial_list.should_receive(:sync).once
+        @command.invoke
+      end      
+    end
+  end
+end

data/spec/gem_check_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| /http/ =~ s }
+    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,13 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'gem_check_sources'
+require 'spec'
+require 'spec/autorun'
+require 'pp'
+require 'tmpdir'
+
+ENV['QUIET'] = 'true'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: gem-check-sources
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Britt Crawford
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-19 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: |
+  gem-check-sources keeps your local list of gem sources in sync and removes any gem servers that might be unavailable.
+
+email: britt.v.crawford@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- gem-check-sources.gemspec
+- lib/gem_check_sources.rb
+- lib/gem_check_sources/commands/check_sources_command.rb
+- lib/gem_check_sources/sources.rb
+- lib/rubygems_plugin.rb
+- spec/gem_check_sources/commands/check_sources_command_spec.rb
+- spec/gem_check_sources/sources_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/britt/gem-check-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 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: gem-check-sources keeps your local list of gem sources in sync and removes any gem servers that might be unavailable.
+test_files: 
+- spec/gem_check_sources/commands/check_sources_command_spec.rb
+- spec/gem_check_sources/sources_spec.rb
+- spec/spec_helper.rb