asgit 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d0990c0d9e5711c07321399d20e43a162d9abdc
-  data.tar.gz: d835ab6bc39cd6b1fce0c1feb2e84d0a666a70d0
+  metadata.gz: c28ffc8cb032e8af5e3ea65f5056accba05ce982
+  data.tar.gz: 561a141bde4cf33c7202b11b742b982e1d2408b0
 SHA512:
-  metadata.gz: 9dfcd2bfc863483514cd09d289a1549b9eac37271d3f633e564eae1c152a6e91cf2fc645515f3f47862a23d960bb7be52b1637c48517ae10206d8985ccbc25da
-  data.tar.gz: 9683eaadfaad38cf876b4dd41200411e30b87836a962edc9ea45607347f99fd92a981d7bf240d5699f4697ce0c16045cef94e1432d797ac0ff0ebc02a2b8e049
+  metadata.gz: ab9a787571aba61904b6107a683ccdba5e0d835fa17163904e8ef3b05ab08b5f8f0f0d2136a8b5263932fb4e35bc8b1c96f4b1ad82363dc8b4bf42137cb7326c
+  data.tar.gz: 0fad5d6dc5debb3d57a15a0d0a5a98c8e70bd12db3fcf79bf697a3db8c4733629efc1a3f042577ea8e0a0dc30008fb2466520b05c070eeae14c12daff0369441

data/lib/asgit/project.rb

@@ -0,0 +1,31 @@
+module Asgit
+  class Project
+
+    def initialize project_details={}
+      project_details.each do |k,v|
+        begin
+          details.public_send( :"#{k}=", v )
+        rescue NoMethodError => e
+          raise ArgumentError, "unknown keyword: #{e.name.to_s.chomp('=')}"
+        end
+      end
+    end
+
+    def details
+      @_details ||= Details.new
+    end
+
+    def service
+      @_service ||= Services.fetch( details.service ).new
+    end
+
+    def urls
+      @_urls ||= Url.new details, service
+    end
+
+    class Details
+      attr_accessor :service, :organization, :project, :default_branch
+    end
+
+  end
+end

data/lib/asgit/services/bitbucket.rb

@@ -0,0 +1,29 @@
+module Asgit
+  module Services
+    class Bitbucket < Service
+
+      register_as :bitbucket
+
+      def base_url
+        "https://bitbucket.org"
+      end
+
+      def base_structure
+        "%{base_url}/%{organization}/%{project}"
+      end
+
+      def commit_uri
+        "commits/%{commit}"
+      end
+
+      def branch_uri
+        "branch/%{branch}"
+      end
+
+      def file_at_commit_uri
+        "src/%{commit}/%{file_path}?at=%{branch}"
+      end
+
+    end
+  end
+end

data/lib/asgit/services/github.rb

@@ -0,0 +1,33 @@
+module Asgit
+  module Services
+    class GitHub < Service
+
+      register_as :github
+
+      def base_url
+        "https://github.com"
+      end
+
+      def base_structure
+        "%{base_url}/%{organization}/%{project}"
+      end
+
+      def commit_uri
+        "commit/%{commit}"
+      end
+
+      def branch_uri
+        "tree/%{branch}"
+      end
+
+      def file_uri
+        "blob/%{branch}/%{file_path}%{line}"
+      end
+
+      def file_at_commit_uri
+        "blob/%{commit}/%{file_path}%{line}"
+      end
+
+    end
+  end
+end

data/lib/asgit/services/service.rb

@@ -0,0 +1,40 @@
+module Asgit
+  module Services
+    class Service
+
+      class << self
+        def register_as name
+          Services.register( self, name )
+        end
+      end
+
+      def base_url
+        raise MissingUrlStructure, "#{self.class} does not implement #{__method__}"
+      end
+
+      def base_structure
+        raise MissingUrlStructure, "#{self.class} does not implement #{__method__}"
+      end
+
+      def commit_uri
+        raise MissingUrlStructure, "#{self.class} does not implement #{__method__}"
+      end
+
+      def branch_uri
+        raise MissingUrlStructure, "#{self.class} does not implement #{__method__}"
+      end
+
+      def file_uri
+        raise MissingUrlStructure, "#{self.class} does not implement #{__method__}"
+      end
+
+      def file_at_commit_uri
+        raise MissingUrlStructure, "#{self.class} does not implement #{__method__}"
+      end
+
+      class MissingUrlStructure < StandardError
+      end
+
+    end
+  end
+end

data/lib/asgit/services.rb

@@ -1,32 +1,30 @@
 module Asgit
   module Services
 
-    DATA = {
-      github: {
-        base_url: 'https://github.com',
-        base_structure: "%{base_url}/%{organization}/%{project}",
-        commit_uri: "commit/%{commit}",
-        branch_uri: "tree/%{branch}",
-        file_uri: "blob/%{branch}/%{file_path}%{line}"
-      }
-    }
-
-    DATA.each_key do |service|
-      define_singleton_method(service) do
-        instance_variable_get("@_#{service}") || instance_variable_set("@_#{service}", Service.new( DATA[service] ))
+    class << self
+
+      def registered
+        @_registered ||= {}
       end
-    end
 
-    class Service
+      def register service, key
+        registered[key] = service
+      end
 
-      def initialize data
-        data.each do |attr, val|
-          self.class.send(:define_method, attr) { val }
+      def fetch service
+        registered.fetch(service) do
+          raise UndefinedService, "undefined service #{service}"
         end
-        return self.freeze
       end
 
     end
 
+    class UndefinedService < StandardError
+    end
+
   end
-end
+end
+
+require_relative 'services/service'
+require_relative 'services/github'
+require_relative 'services/bitbucket'

data/lib/asgit/url.rb

@@ -1,43 +1,53 @@
 module Asgit
-  module Url
+  class Url
 
-    class << self
+    attr_reader :details, :service
 
-      def project
-        Asgit.config.service.base_structure % {
-          base_url: Asgit.config.service.base_url,
-          organization: Asgit.config.organization,
-          project: Asgit.config.project
-        }
-      end
+    def initialize details, service
+      @details = details
+      @service = service
+    end
 
-      def commit sha
-        File.join( project, Asgit.config.service.commit_uri % { commit: sha } )
-      end
+    def project
+      service.base_structure % {
+        base_url: service.base_url,
+        organization: details.organization,
+        project: details.project
+      }
+    end
 
-      def branch name
-        File.join( project, Asgit.config.service.branch_uri % { branch: name } )
-      end
+    def commit sha
+      File.join( project, service.commit_uri % { commit: sha } )
+    end
 
-      def file file_path, options={}
-        file_path = file_path.gsub( /^\//, '' )
-        branch    = options.fetch(:branch) { Asgit.config.default_branch }
-        line      = options.has_key?(:line) ? format_lines(options[:line]) : ''
+    def branch name
+      File.join( project, service.branch_uri % { branch: name } )
+    end
 
-        File.join( project, Asgit.config.service.file_uri % { file_path: file_path, branch: branch, line: line } )
-      end
+    def file file_path, options={}
+      file_path = file_path.gsub( /^\//, '' )
+      branch    = options.fetch(:branch) { details.default_branch }
+      line      = options.has_key?(:line) ? format_lines(options[:line]) : ''
 
-      private
+      File.join( project, service.file_uri % { file_path: file_path, branch: branch, line: line } )
+    end
 
-        def format_lines input
-          if input.respond_to?(:begin) && input.respond_to?(:end)
-            return "#L#{input.begin}-L#{input.end}"
-          else
-            return "#L#{input}"
-          end
-        end
+    def file_at_commit file_path, commit=commit, options={}
+      file_path = file_path.gsub( /^\//, '' )
+      line      = options.has_key?(:line) ? format_lines(options[:line]) : ''
 
+      File.join( project, service.file_at_commit_uri % { file_path: file_path, commit: commit, line: line } )
     end
 
+    private
+
+      def format_lines input
+        if input.respond_to?(:begin) && input.respond_to?(:end)
+          return "#L#{input.begin}-L#{input.end}"
+        else
+          return "#L#{input}"
+        end
+      end
+
   end
 end

data/lib/asgit/version.rb

@@ -1,3 +1,3 @@
 module Asgit
-  VERSION = "0.0.7"
+  VERSION = "0.1.0"
 end

data/lib/asgit.rb

@@ -1,7 +1,7 @@
 require_relative 'asgit/shell'
 require_relative 'asgit/url'
-require_relative 'asgit/config'
 require_relative 'asgit/services'
+require_relative 'asgit/project'
 
 module Asgit
   class << self

data/spec/lib/asgit/project_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Asgit::Project do
+
+  let(:default_details) do
+    {
+      service: :github,
+      organization: 'stevenosloan',
+      project: 'asgit',
+      default_branch: 'master'
+    }
+  end
+
+  let(:default_project) { described_class.new( default_details ) }
+
+  describe "#initialize" do
+    it "sets detail's attributes" do
+      details_double = instance_double( "Asgit::Project::Details" )
+      allow( Asgit::Project::Details ).to receive(:new).and_return(details_double)
+
+      expect( details_double ).to receive(:service=).with(:github)
+      expect( details_double ).to receive(:organization=).with('stevenosloan')
+      expect( details_double ).to receive(:project=).with('asgit')
+      expect( details_double ).to receive(:default_branch=).with('master')
+
+      described_class.new( default_details )
+    end
+
+    it "raises an ArgumentError if an out-of-scope arg is passed" do
+      expect{
+        described_class.new( foo: 'bar' )
+      }.to raise_error ArgumentError, 'unknown keyword: foo'
+    end
+  end
+
+  describe "#details" do
+    it "returns a Details instance" do
+      expect( default_project.details.is_a? Asgit::Project::Details ).to be_truthy
+    end
+
+    it "returns the same instance on each call" do
+      expect( default_project.details ).to eq default_project.details
+    end
+  end
+
+  describe "#service" do
+    it "returns a Service instance with defined service" do
+      expect( default_project.service.is_a? Asgit::Services::GitHub ).to be_truthy
+    end
+  end
+
+  describe "#urls" do
+    it "returns a Url instance" do
+      expect( default_project.urls.is_a? Asgit::Url ).to be_truthy
+    end
+
+    it "creates Url instance with #details and #service" do
+      expect( Asgit::Url ).to receive(:new).with( default_project.details, default_project.service )
+
+      default_project.urls
+    end
+  end
+
+end

data/spec/lib/asgit/services_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe Asgit::Services do
+
+  before :all do
+    class Foo; end
+  end
+
+  before :each do
+    if described_class.instance_variable_defined?(:@_registered)
+      described_class.send(:remove_instance_variable, :@_registered)
+    end
+  end
+
+  after :all do
+    Asgit::Services.register( Asgit::Services::GitHub, :github )
+    Asgit::Services.register( Asgit::Services::Bitbucket, :bitbucket )
+  end
+
+  describe "::registered" do
+    it "returns a Hash" do
+      expect( described_class.registered ).to be_a Hash
+    end
+  end
+
+  describe "::register" do
+
+    it "adds a service to the registered" do
+      expect{ described_class.register(Foo,:foo) }.to change{ Asgit::Services.registered.keys.count }.by(1)
+    end
+
+    it "adds service with provided key" do
+      described_class.register(Foo,:foo)
+      expect( described_class.registered[:foo] ).to eq Foo
+    end
+  end
+
+  describe "#fetch" do
+    it "returns a Service if that service is registered" do
+      described_class.register( Foo, :github )
+      expect( described_class.fetch(:github) ).to eq Foo
+    end
+
+    it "raises UndefinedService if service is not defined" do
+      expect{
+        described_class.fetch(:foo)
+      }.to raise_error Asgit::Services::UndefinedService
+    end
+  end
+
+end

data/spec/lib/asgit/url_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Asgit::Url do
+
+  before :all do
+    class NullService < Asgit::Services::Service
+      register_as :null
+    end
+  end
+
+  let(:service) { Asgit::Services.fetch(:github).new.dup }
+  let(:null_service) { Asgit::Services.fetch(:null).new.dup }
+  let(:details) do
+    instance_double( "Asgit::Project::Details",
+      organization: 'stevenosloan',
+      project: 'asgit',
+      default_branch: 'master'
+    )
+  end
+
+  let(:subject) { described_class.new( details, service ) }
+  let(:null_subject) { described_class.new( details, null_service ) }
+
+  describe "#initialize" do
+    it "sets the details & service attributes" do
+      expect( subject.details ).to eq details
+      expect( subject.service ).to eq service
+    end
+  end
+
+  describe "#project" do
+    it "returns expected url" do
+      expect( subject.project ).to eq 'https://github.com/stevenosloan/asgit'
+    end
+    it "raises MissingUrlStructure if service doesn't implement #base_structure" do
+      expect{
+        null_subject.project
+      }.to raise_error Asgit::Services::Service::MissingUrlStructure
+    end
+  end
+
+  describe "#commit" do
+    it "returns url of commit" do
+      expect( subject.commit 'commit_sha' ).to eq 'https://github.com/stevenosloan/asgit/commit/commit_sha'
+    end
+    it "raises MissingUrlStructure if service doesn't implement #commit_uri" do
+      expect{
+        null_subject.commit 'commit_sha'
+      }.to raise_error Asgit::Services::Service::MissingUrlStructure
+    end
+  end
+
+  describe "#branch" do
+    it "returns url of the branch" do
+      expect( subject.branch 'branch_name' ).to eq 'https://github.com/stevenosloan/asgit/tree/branch_name'
+    end
+    it "raises MissingUrlStructure if service doesn't implement #branch_uri" do
+      expect{
+        null_subject.branch 'branch_name'
+      }.to raise_error Asgit::Services::Service::MissingUrlStructure
+    end
+  end
+
+  describe '#file' do
+    it "returns url for the file" do
+      expect( subject.file 'lib/asgit.rb' ).to eq 'https://github.com/stevenosloan/asgit/blob/master/lib/asgit.rb'
+    end
+    it "adjusts for paths with leading slash" do
+      expect( subject.file '/lib/asgit.rb' ).to eq 'https://github.com/stevenosloan/asgit/blob/master/lib/asgit.rb'
+    end
+    it "returns url for the file on a specific branch" do
+      expect( subject.file 'lib/asgit.rb', branch: 'branch_name' ).to eq 'https://github.com/stevenosloan/asgit/blob/branch_name/lib/asgit.rb'
+    end
+    it "returns url for the file with a line number" do
+      expect( subject.file 'lib/asgit.rb', line: '15' ).to eq 'https://github.com/stevenosloan/asgit/blob/master/lib/asgit.rb#L15'
+    end
+    it "returns url for the file with a range of line numbers" do
+      expect( subject.file 'lib/asgit.rb', line: (15..18) ).to eq 'https://github.com/stevenosloan/asgit/blob/master/lib/asgit.rb#L15-L18'
+    end
+    it "raises MissingUrlStructure if service doesn't implement #file_uri" do
+      expect{
+        null_subject.file 'lib/asgit.rb'
+      }.to raise_error Asgit::Services::Service::MissingUrlStructure
+    end
+  end
+
+  describe "#file_at_commit" do
+    it "returns url for file at commit_sha" do
+      expect( subject.file_at_commit 'lib/asgit.rb', 'commit_sha' ).to eq 'https://github.com/stevenosloan/asgit/blob/commit_sha/lib/asgit.rb'
+    end
+    it "returns url for file at commit_sha with line numbers" do
+      expect( subject.file_at_commit 'lib/asgit.rb', 'commit_sha', line: '15' ).to eq 'https://github.com/stevenosloan/asgit/blob/commit_sha/lib/asgit.rb#L15'
+    end
+    it "returns url for file at commit_sha with range of line numbers" do
+      expect( subject.file_at_commit 'lib/asgit.rb', 'commit_sha', line: (15..18) ).to eq 'https://github.com/stevenosloan/asgit/blob/commit_sha/lib/asgit.rb#L15-L18'
+    end
+    it "raises MissingUrlStructure if service doesn't implement #file_at_commit_uri" do
+      expect{
+        null_subject.file_at_commit 'lib/asgit.rb', 'commit_sha'
+      }.to raise_error Asgit::Services::Service::MissingUrlStructure
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asgit
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - Steven Sloan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies: []
 description: ' A simple query interface for git. '
 email:
@@ -17,16 +17,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/asgit/config.rb
+- lib/asgit/project.rb
+- lib/asgit/services/bitbucket.rb
+- lib/asgit/services/github.rb
+- lib/asgit/services/service.rb
 - lib/asgit/services.rb
 - lib/asgit/shell.rb
 - lib/asgit/url.rb
 - lib/asgit/version.rb
 - lib/asgit.rb
-- spec/asgit/config_spec.rb
-- spec/asgit/services_spec.rb
-- spec/asgit/url_spec.rb
-- spec/asgit_spec.rb
+- spec/lib/asgit/project_spec.rb
+- spec/lib/asgit/services_spec.rb
+- spec/lib/asgit/url_spec.rb
+- spec/lib/asgit_spec.rb
 - spec/spec_helper.rb
 - spec/support/eat_stdout.rb
 - spec/support/fake_stdout.rb
@@ -55,10 +58,10 @@ signing_key:
 specification_version: 4
 summary: A simple query interface for git
 test_files:
-- spec/asgit/config_spec.rb
-- spec/asgit/services_spec.rb
-- spec/asgit/url_spec.rb
-- spec/asgit_spec.rb
+- spec/lib/asgit/project_spec.rb
+- spec/lib/asgit/services_spec.rb
+- spec/lib/asgit/url_spec.rb
+- spec/lib/asgit_spec.rb
 - spec/spec_helper.rb
 - spec/support/eat_stdout.rb
 - spec/support/fake_stdout.rb

data/lib/asgit/config.rb

@@ -1,39 +0,0 @@
-module Asgit
-  class Config
-
-    attr_reader   :service
-    attr_writer   :default_branch
-    attr_accessor :organization, :project
-
-    def service= name
-      @service = Asgit::Services.send(name.to_sym)
-    end
-
-    def default_branch
-      @default_branch || 'master'
-    end
-
-    def required_attributes
-      [ :service, :organization, :project ]
-    end
-
-  end
-
-  class << self
-    def configure &block
-      yield config
-    end
-
-    def config
-      @_config ||= Config.new
-    end
-
-    def configured?
-      config.required_attributes.each do |attr|
-        return false unless config.send(attr)
-      end
-
-      true
-    end
-  end
-end

data/spec/asgit/config_spec.rb

@@ -1,76 +0,0 @@
-require 'spec_helper'
-
-describe Asgit::Config do
-
-  describe "#default_branch" do
-    context "when no branch is set" do
-      it "returns 'master'" do
-       expect( Asgit::Config.new.default_branch ).to eq 'master'
-      end
-    end
-    context "when a branch is set" do
-      it "returns the set branch" do
-        config = Asgit::Config.new
-        config.default_branch = 'foo'
-        expect( config.default_branch ).to eq 'foo'
-      end
-    end
-  end
-
-  describe "::config" do
-    it "returns a config" do
-      expect( Asgit.config.class ).to eq Asgit::Config
-    end
-  end
-
-  describe "::configure" do
-    it "yields the config" do
-      Asgit.configure do |config|
-        expect( config.class ).to eq Asgit::Config
-      end
-    end
-
-    it "sets attributes on Config" do
-      Asgit.configure do |config|
-        config.project = "woot"
-      end
-
-      expect( Asgit.config.project ).to eq "woot"
-    end
-
-    describe "#service" do
-      it "sets as an Asgit::Services::Service" do
-        Asgit.configure do |c|
-          c.service = :github
-        end
-
-        expect( Asgit.config.service.class ).to eq Asgit::Services::Service
-      end
-    end
-  end
-
-  describe "::configured?" do
-    it "returns false if configuration hasn't been set" do
-      expect( Asgit.configured? ).to be_falsy
-    end
-
-    it "returns false if config is partially set" do
-      Asgit.configure do |c|
-        c.project = 'foo'
-      end
-
-      expect( Asgit.configured? ).to be_falsy
-    end
-
-    it "returns true if configuration has been set" do
-      Asgit.configure do |c|
-        c.project      = 'foo'
-        c.organization = 'bar'
-        c.service      = :github
-      end
-
-      expect( Asgit.configured? ).to be_truthy
-    end
-  end
-
-end

data/spec/asgit/services_spec.rb

@@ -1,27 +0,0 @@
-require 'spec_helper'
-
-describe Asgit::Services do
-
-  it "returns a Service for services that exist" do
-    expect( Asgit::Services.github.class ).to eq Asgit::Services::Service
-  end
-
-  it "doesn't redefine a service if it is set" do
-    Asgit::Services.instance_variable_set("@_github", "foo")
-    expect( Asgit::Services.github ).to eq "foo"
-
-    # teardown, just to keep from poluting the rest of the tests
-    Asgit::Services.send(:remove_instance_variable, "@_github")
-  end
-
-  describe Asgit::Services::Service do
-
-    let(:github) { Asgit::Services.github }
-
-    it "returns data for each key" do
-      expect( github.base_url ).to eq "https://github.com"
-    end
-
-  end
-
-end

data/spec/asgit/url_spec.rb

@@ -1,57 +0,0 @@
-require 'spec_helper'
-
-describe Asgit::Url do
-
-  before :all do
-    Asgit.configure do |c|
-      c.organization = "wu"
-      c.project      = "tang"
-      c.service      = :github
-    end
-  end
-
-  after :all do
-    Asgit::Services.send(:remove_instance_variable, "@_github")
-  end
-
-  describe "::project" do
-    it "returns correct url for the project" do
-      expect( Asgit::Url.project ).to eq "https://github.com/wu/tang"
-    end
-  end
-
-  describe "::commit" do
-    it "returns the correct url for the provided commit" do
-      expect( Asgit::Url.commit "woot" ).to eq "https://github.com/wu/tang/commit/woot"
-    end
-  end
-
-  describe "::branch" do
-    it "returns the correct url for the provided branch" do
-      expect( Asgit::Url.branch "woot" ).to eq "https://github.com/wu/tang/tree/woot"
-    end
-  end
-
-  describe "::file" do
-    it "returns the correct url for a file" do
-      expect( Asgit::Url.file "lib/tang.rb" ).to eq "https://github.com/wu/tang/blob/master/lib/tang.rb"
-    end
-
-    it "adjust for fives given with a leading slash" do
-      expect( Asgit::Url.file "/lib/tang.rb" ).to eq "https://github.com/wu/tang/blob/master/lib/tang.rb"
-    end
-
-    it "returns the correct url for a file with a passed branch" do
-      expect( Asgit::Url.file "/lib/tang.rb", branch: 'dev' ).to eq "https://github.com/wu/tang/blob/dev/lib/tang.rb"
-    end
-
-    it "returns the correct url for a file with a line number" do
-      expect( Asgit::Url.file "/lib/tang.rb", branch: 'dev', line: "15" ).to eq "https://github.com/wu/tang/blob/dev/lib/tang.rb#L15"
-    end
-
-    it "returns the correct url for a file with a range of line numbers" do
-      expect( Asgit::Url.file "/lib/tang.rb", branch: 'dev', line: (15..18) ).to eq "https://github.com/wu/tang/blob/dev/lib/tang.rb#L15-L18"
-    end
-  end
-
-end