gitable 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+gbin
+coverage
+rdoc
+pkg
+vendor/gems
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,16 @@
+source 'http://gemcutter.org'
+ 
+bin_path 'gbin'
+disable_system_gems
+
+gem 'addressable', :require_as => 'addressable/uri'
+ 
+only :test do
+  gem 'jeweler'
+  gem 'bundler'
+  gem 'rspec', :require_as => 'spec'
+  gem 'ZenTest'
+  gem 'rake'
+  gem 'rcov'
+  gem 'ruby-debug'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Martin Emde
+
+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,20 @@
+= Gitable
+
+Like Addressable::URI but for Git
+
+    require 'gitable/uri'
+    uri = Gitable::URI.parse('git@github.com:martinemde/gitable.git')
+
+    uri.path # => 'martinemde/gitable.git'
+    uri.user # => 'git'
+    uri.host # => 'github.com'
+
+Works with any valid Git uri.
+
+== That's it?
+
+yep. What else did you expect?
+
+== Copyright
+
+Copyright (c) 2010 Martin Emde. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gitable"
+    gem.summary = %Q{Like Addressable::URI but for Git}
+    gem.description = %Q{Use this like an Addressable::URI that understands the various git URI formats.}
+    gem.email = "martin.emde@gmail.com"
+    gem.homepage = "http://github.com/martinemde/gitable"
+    gem.authors = ["Martin Emde"]
+  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
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+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.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 1
+

data/gitable.gemspec

@@ -0,0 +1,55 @@
+# 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{gitable}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Emde"]
+  s.date = %q{2010-01-12}
+  s.description = %q{Use this like an Addressable::URI that understands the various git URI formats.}
+  s.email = %q{martin.emde@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "gitable.gemspec",
+     "lib/gitable.rb",
+     "lib/gitable/scp_uri.rb",
+     "lib/gitable/uri.rb",
+     "spec/gitable_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/martinemde/gitable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Like Addressable::URI but for Git}
+  s.test_files = [
+    "spec/gitable_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
+    else
+    end
+  else
+  end
+end
+

data/lib/gitable/scp_uri.rb

@@ -0,0 +1,31 @@
+require 'gitable/uri'
+
+module Gitable
+  class ScpURI < Gitable::URI
+    # Keep URIs like this relative:
+    #
+    #     git@github.com:martinemde/gitable.git
+    #
+    # Without breaking URIs like these:
+    # 
+    #     git@host.com:/home/martinemde/gitable.git
+    #
+    def path=(new_path)
+      super
+      if new_path[0..0] != "/"
+        @path = path.sub(%r|^/|,'')
+      end
+      path
+    end
+
+    def to_s
+      @uri_string ||= begin
+                        uri_string = "#{authority}:#{path.to_s}"
+                        if uri_string.respond_to?(:force_encoding)
+                          uri_string.force_encoding(Encoding::UTF_8)
+                        end
+                        uri_string
+                      end
+    end
+  end
+end

data/lib/gitable/uri.rb

@@ -0,0 +1,32 @@
+require 'addressable/uri'
+
+module Gitable
+  class URI < Addressable::URI
+    SCP_URI_REGEXP = /^([^:\/?#]+):([^?#]*)$/
+     
+    def self.parse(uri)
+      return uri if uri.nil? || uri.kind_of?(self)
+
+      # addressable::URI.parse always returns an instance of Addressable::URI.
+      add = super(uri) # >:(
+
+      scan = uri.scan(SCP_URI_REGEXP)
+      fragments = scan[0]
+      authority = fragments && fragments[0]
+
+      if add.host.nil? && authority
+        Gitable::ScpURI.new(
+          :authority  => authority,
+          :path       => add.path
+        )
+      else
+        new(add.omit(:password,:query,:fragment).to_hash)
+      end
+    end
+
+    # guesses a project name
+    def project_name
+      basename.sub(/\.git$/,'')
+    end
+  end
+end

data/lib/gitable.rb

@@ -0,0 +1,4 @@
+module Gitable
+  autoload :URI, 'gitable/uri'
+  autoload :ScpURI, 'gitable/scp_uri'
+end

data/spec/gitable_spec.rb

@@ -0,0 +1,380 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Gitable::URI do
+  before do
+    @uri = "ssh://git@github.com/martinemde/gitable.git"
+  end
+
+  def self.describe_uri(uri, &block)
+    describe "with uri: #{uri.inspect}" do
+      before { @uri = uri }
+      subject { Gitable::URI.parse(@uri) }
+      URIChecker.new(self, &block)
+    end
+  end
+
+  class URIChecker
+    def initialize(example_group, &block)
+      @example_group = example_group
+      instance_eval(&block)
+    end
+
+    def it_sets(parts)
+      parts.each do |part, value|
+        it "sets #{part} to #{value.inspect}" do
+          subject.send(part).should == value
+        end
+      end
+    end
+
+    def method_missing(*args, &block)
+      @example_group.send(*args, &block)
+    end
+  end
+
+  # Valid Git URIs according to git-clone documentation at this url:
+  # http://www.kernel.org/pub/software/scm/git/docs/git-clone.html#_git_urls_a_id_urls_a
+  #
+  # rsync://host.xz/path/to/repo.git/
+  # http://host.xz[:port]/path/to/repo.git/
+  # https://host.xz[:port]/path/to/repo.git/
+  # git://host.xz[:port]/path/to/repo.git/
+  # git://host.xz[:port]/~user/path/to/repo.git/
+  # ssh://[user@]host.xz[:port]/path/to/repo.git/
+  # ssh://[user@]host.xz/path/to/repo.git/
+  # ssh://[user@]host.xz/~user/path/to/repo.git/
+  # ssh://[user@]host.xz/~/path/to/repo.git
+  #
+  # (from the git docs)
+  # SSH is the default transport protocol over the network. You can optionally specify which user to log-in as, and an alternate, scp-like syntax is also supported. Both syntaxes support username expansion, as does the native git protocol, but only the former supports port specification. The following three are identical to the last three above, respectively:
+  #
+  # [user@]host.xz:/path/to/repo.git/
+  # [user@]host.xz:~user/path/to/repo.git/
+  # [user@]host.xz:path/to/repo.git
+  #
+  # To sync with a local directory, you can use:
+  #
+  # /path/to/repo.git/
+  # file:///path/to/repo.git/
+  # 
+  expected = {
+    :user         => nil,
+    :password     => nil,
+    :host         => "host.xz",
+    :port         => nil,
+    :path         => "/path/to/repo.git/",
+    :basename     => "repo.git",
+    :query        => nil,
+    :fragment     => nil,
+    :project_name => "repo"
+  }
+
+  describe ".parse" do
+    it "returns a Gitable::URI" do
+      Gitable::URI.parse(@uri).should be_a_kind_of(Gitable::URI)
+    end
+
+    it "returns nil when passed a nil uri" do
+      Gitable::URI.parse(nil).should be_nil
+    end
+
+    it "returns the same uri when passed a Gitable::URI" do
+      gitable = Gitable::URI.parse(@uri)
+      Gitable::URI.parse(gitable).should be_eql(gitable)
+    end
+
+    it "raises a TypeError on bad type" do
+      lambda {
+        Gitable::URI.parse(5)
+      }.should raise_error(TypeError)
+    end
+
+    describe_uri "rsync://host.xz/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme       => "rsync",
+        :project_name => "repo"
+      })
+    end
+
+    describe_uri "rsync://host.xz/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "rsync",
+      })
+    end
+
+    describe_uri "http://host.xz/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "http",
+      })
+    end
+
+    describe_uri "http://host.xz:8888/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "http",
+        :port     => 8888,
+      })
+    end
+
+    describe_uri "https://host.xz/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "https",
+      })
+    end
+
+    describe_uri "https://host.xz:8888/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "https",
+        :port     => 8888,
+      })
+    end
+
+    describe_uri "git://host.xz/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "git",
+      })
+    end
+
+    describe_uri "git://host.xz:8888/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "git",
+        :port     => 8888,
+      })
+    end
+
+    describe_uri "git://host.xz/~user/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "git",
+        :path     => "/~user/path/to/repo.git/",
+      })
+    end
+
+    describe_uri "git://host.xz:8888/~user/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "git",
+        :path     => "/~user/path/to/repo.git/",
+        :port     => 8888,
+      })
+    end
+
+    describe_uri "ssh://host.xz/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "ssh",
+      })
+    end
+
+    describe_uri "ssh://user@host.xz/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "ssh",
+        :user     => "user",
+      })
+    end
+
+    describe_uri "ssh://host.xz/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "ssh",
+      })
+    end
+
+    describe_uri "ssh://host.xz:8888/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "ssh",
+        :port     => 8888,
+      })
+    end
+
+    describe_uri "ssh://user@host.xz/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :user     => "user",
+        :scheme   => "ssh",
+      })
+    end
+
+    describe_uri "ssh://user@host.xz:8888/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "ssh",
+        :user     => "user",
+        :port     => 8888,
+      })
+    end
+
+    describe_uri "ssh://host.xz/~user/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "ssh",
+        :user     => nil,
+        :path     => "/~user/path/to/repo.git/",
+      })
+    end
+
+    describe_uri "ssh://user@host.xz/~user/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "ssh",
+        :user     => "user",
+        :path     => "/~user/path/to/repo.git/",
+      })
+    end
+
+    describe_uri "ssh://host.xz/~/path/to/repo.git" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "ssh",
+        :path     => "/~/path/to/repo.git",
+      })
+    end
+
+    describe_uri "ssh://user@host.xz/~/path/to/repo.git" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "ssh",
+        :user     => "user",
+        :path     => "/~/path/to/repo.git",
+      })
+    end
+
+    describe_uri "host.xz:/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => nil,
+        :user     => nil,
+        :path     => "/path/to/repo.git/",
+      })
+    end
+
+    describe_uri "user@host.xz:/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => nil,
+        :user     => "user",
+        :path     => "/path/to/repo.git/",
+      })
+    end
+
+    describe_uri "host.xz:~user/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => nil,
+        :user     => nil,
+        :path     => "~user/path/to/repo.git/",
+      })
+    end
+
+    describe_uri "user@host.xz:~user/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => nil,
+        :user     => "user",
+        :path     => "~user/path/to/repo.git/",
+      })
+    end
+
+    describe_uri "host.xz:path/to/repo.git" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => nil,
+        :user     => nil,
+        :path     => "path/to/repo.git",
+      })
+    end
+
+    describe_uri "user@host.xz:path/to/repo.git" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => nil,
+        :user     => "user",
+        :path     => "path/to/repo.git",
+      })
+    end
+
+    describe_uri "/path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => nil,
+        :host     => nil,
+        :path     => "/path/to/repo.git/",
+      })
+    end
+
+    describe_uri "file:///path/to/repo.git/" do
+      it { subject.to_s.should == @uri }
+      it_sets expected.merge({
+        :scheme   => "file",
+        :host     => "", # I don't really like this but it doesn't hurt anything.
+        :path     => "/path/to/repo.git/",
+      })
+    end
+
+    describe_uri "ssh://git@github.com/martinemde/gitable.git" do
+      it { subject.to_s.should == @uri }
+      it_sets({
+        :scheme   => "ssh",
+        :user     => "git",
+        :password => nil,
+        :host     => "github.com",
+        :port     => nil,
+        :path     => "/martinemde/gitable.git",
+        :fragment => nil,
+        :basename => "gitable.git",
+      })
+    end
+
+    describe_uri "http://github.com/martinemde/gitable.git" do
+      it { subject.to_s.should == @uri }
+      it_sets({
+        :scheme   => "http",
+        :user     => nil,
+        :password => nil,
+        :host     => "github.com",
+        :port     => nil,
+        :path     => "/martinemde/gitable.git",
+        :fragment => nil,
+        :basename => "gitable.git",
+      })
+    end
+
+    describe_uri "git://github.com/martinemde/gitable.git" do
+      it { subject.to_s.should == @uri }
+      it_sets({
+        :scheme   => "git",
+        :user     => nil,
+        :password => nil,
+        :host     => "github.com",
+        :port     => nil,
+        :path     => "/martinemde/gitable.git",
+        :fragment => nil,
+        :basename => "gitable.git",
+      })
+    end
+
+    describe_uri "git@github.com:martinemde/gitable.git" do
+      it { subject.to_s.should == @uri }
+      it_sets({
+        :scheme       => nil,
+        :user         => "git",
+        :password     => nil,
+        :host         => "github.com",
+        :port         => nil,
+        :path         => "martinemde/gitable.git",
+        :fragment     => nil,
+        :basename     => "gitable.git",
+        :project_name => "gitable",
+      })
+    end
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: gitable
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Martin Emde
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-12 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Use this like an Addressable::URI that understands the various git URI formats.
+email: martin.emde@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- gitable.gemspec
+- lib/gitable.rb
+- lib/gitable/scp_uri.rb
+- lib/gitable/uri.rb
+- spec/gitable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/martinemde/gitable
+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: Like Addressable::URI but for Git
+test_files: 
+- spec/gitable_spec.rb
+- spec/spec_helper.rb