gem-checkout 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee28067ee5184c515081a3cfad38b70eda8c9bb7
+  data.tar.gz: e3a3abe9fa00964bfa733ead7414a266baa961ac
+SHA512:
+  metadata.gz: 8a55d5ba004b3989f3020f892bf5112a1016a9d867a41ce16bc969c8e256511c674559cafa7e95d9ff3120ecbf34763c10628d5d542fafc93091a427f569ca38
+  data.tar.gz: 2ab5e1fb93f34b50f3e44899bc292765737960c99e3cc2c6060b5241fa30007d9a435376be850a2e8d5f95eb9de2ded837fc05ef02f7c51b604cb71788fb0c44

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Cezary Baginski
+
+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.md

@@ -0,0 +1,65 @@
+# Gem::Checkout
+
+RubyGems addon command ('checkout') which, given a gem, will checkout the matching sources at the same version.
+
+Why? So you no longer have to work out where the source code for a given gem is.
+
+(Which allows you to automate a LOT of tasks given just a gem name!).
+
+For example:
+
+```bash
+$ gem checkout nenv -v 0.2.0
+```
+
+will checkout the GitHub source code (into the current dir) for the `nenv` gem at `0.2.0` (commit: beb9981)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```sh
+gem install gem-checkout
+```
+
+## Usage
+
+Proof of concept right now, so open issues and/or PRs for improvements.
+
+Options:
+
+```
+-d LEVEL
+```
+sets the debug level, where 0=debug, 1=warn, and so on...
+
+```
+-v, --version VERSION
+```
+
+The version of the gem to you want to hack on - the repo and revision will be discovered.
+
+(If you don't provide this option, the latest version will be used).
+
+## FAQ
+
+None yet, so open an issue...
+
+
+## Development
+
+```
+bundle install
+bundle exec guard
+```
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/e2/gem-checkout
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/gem-checkout/logger.rb

@@ -0,0 +1,15 @@
+require 'logger'
+
+module Gem
+  module Checkout
+    class << self
+      def logger=(logger)
+        @logger = logger
+      end
+
+      def logger
+        @logger ||= ::Logger.new(STDERR).tap { |logger| logger.level = Logger::WARN }
+      end
+    end
+  end
+end

data/lib/gem-checkout/process.rb

@@ -0,0 +1,26 @@
+module Gem
+  module Checkout
+    class Process
+      class Error < RuntimeError
+        class CommandFailed < Error
+          attr_reader :exit_code
+
+          def initialize(exit_code)
+            @exit_code = exit_code
+          end
+        end
+      end
+
+      def self.run(*args)
+        pid = Kernel.spawn(*args)
+        result = ::Process.wait2(pid)
+        exit_code = result.last.exitstatus
+        fail(Error::CommandFailed, exit_code) unless exit_code.zero?
+      end
+
+      def self.capture(*args)
+        IO.popen(args).read
+      end
+    end
+  end
+end

data/lib/gem-checkout/repository.rb

@@ -0,0 +1,8 @@
+module Gem
+  module Checkout
+    module Repository
+      class Error < RuntimeError
+      end
+    end
+  end
+end

data/lib/gem-checkout/repository/git-hub.rb

@@ -0,0 +1,55 @@
+require 'gem-checkout/repository/git'
+
+
+module Gem
+  module Checkout
+    module Repository
+      class GitHub
+        class Error < Repository::Error
+          class BadURI < Error
+            class NotGitHub < BadURI
+            end
+
+            class NoProjectName < BadURI
+            end
+          end
+        end
+
+        def initialize(vague_uri)
+          uri = vague_uri.dup
+          fail Error::BadURI::NotGitHub unless uri.host == 'github.com'
+
+
+          uri.scheme = 'https'
+          uri.port = nil
+          uri.userinfo = nil
+          uri.query = nil
+          uri.fragment = nil
+          uri = URI.parse(uri.to_s)
+
+          m = /(?<org>[[:alnum:]_.-]+)\/(?<project>[[:alnum:]_.-]+)/.match(uri.path)
+
+          fail Error::BadURI::NoProjectName unless m
+          org = m[:org]
+          project = m[:project]
+          uri.path = "/#{org}/#{project}.git"
+
+          @git = Git.new(uri)
+        end
+
+        def clone(*args)
+          @git.clone(*args)
+        end
+
+        def checkout(*args)
+          @git.checkout(*args)
+        end
+
+        def get_tag_ref(*args)
+          @git.get_tag_ref(*args)
+        end
+      end
+    end
+  end
+end
+

data/lib/gem-checkout/repository/git.rb

@@ -0,0 +1,58 @@
+require 'gem-checkout/logger'
+require 'gem-checkout/process'
+require 'gem-checkout/repository'
+
+module Gem
+  module Checkout
+    module Repository
+      class Git
+        class Error < Repository::Error
+          class SingleTagNotFound < Error
+          end
+
+          class CloneFailed < Error
+          end
+
+          class CheckoutFailed < Error
+          end
+
+          class FailedToFetchTags < Error
+          end
+        end
+
+        attr_reader :uri
+        def initialize(uri)
+          @uri = uri
+        end
+
+        def clone(options)
+          dir = options[:directory]
+          Gem::Checkout.logger.debug "Cloning: #{uri.to_s}"
+          Process.run('git', 'clone', uri.to_s, dir)
+        rescue Process::Error => ex
+          fail Error::CloneFailed, "Failed to clone #{uri.to_s} (#{ex.message})"
+        end
+
+        def checkout(ref)
+          Process.run('git', 'checkout', ref)
+        rescue Process::Error => ex
+          fail Error::CheckoutFailed, "Failed to checkout #{ref} (#{ex})"
+        end
+
+        def get_tag_ref(tag)
+          Gem::Checkout.logger.debug "Looking up tag: #{tag.inspect}"
+          Gem::Checkout.logger.debug "Getting tags from : #{uri.to_s}"
+          output = Process.capture('git', 'ls-remote', '--tags', uri.to_s)
+          tag_info = output.split("\n")
+          matching = tag_info.select { |details| details =~ /refs\/tags\/#{tag}$/}
+          unless matching.size == 1
+            fail Error::SingleTagNotFound, "Expected to match 1 tag #{tag}, matched: #{matching.inspect}"
+          end
+          matching.first.split("\t").first
+        rescue Process::Error => ex
+          fail Error::FailedToFetchTags, ex.message
+        end
+      end
+    end
+  end
+end

data/lib/gem-checkout/source.rb

@@ -0,0 +1,123 @@
+require 'ostruct'
+require 'uri'
+require 'logger'
+
+require 'gem-checkout/repository/git-hub'
+require 'gem-checkout/spec'
+
+module Gem
+  module Checkout
+    class DataFinder
+      class Error < RuntimeError
+        class NoMatch < Error
+        end
+      end
+
+      class << self
+        def detect(klass, object, priorities)
+          found = nil
+          priorities.values.each do |fields|
+            found = traverse_find(klass, object, fields)
+            break if found
+          end
+          found
+        end
+
+        private
+
+        def traverse_find(klass, object, fields)
+          loop do
+            fields.each do |field|
+              url = object.public_send(field)
+              begin
+                return klass.new(url)
+              rescue Error::NoMatch
+                next
+              end
+            end
+
+            object = object.alternative
+            return nil unless object
+            next
+          end
+        end
+      end
+    end
+
+    class RepositoryInfo < DataFinder
+      PRIORITIES = {
+        recommended: %i(source_code_uri),
+        sufficient: %i(source_code_url repository_uri repository_url),
+        user_pages: %i(project_uri project_url homepage),
+        last_resort: %i(bug_tracker_uri bug_tracker_url)
+      }
+
+      def self.detect(object)
+        DataFinder.detect(self, object, PRIORITIES)
+      end
+
+      attr_reader :repository
+
+      def initialize(url)
+        fail Error::NoMatch if !url || url.empty?
+        Gem::Checkout.logger.debug "Found non-empty url: #{url}"
+        uri = URI.parse(url)
+        @repository = Repository::GitHub.new(uri)
+        Gem::Checkout.logger.debug "Detected GitHub repository url: #{uri}"
+      rescue Gem::Checkout::Repository::GitHub::Error::BadURI
+        fail Error::NoMatch
+      end
+    end
+
+    class RepositoryHash < DataFinder
+      PRIORITIES = {
+        recommended: %i(source_reference),
+        sufficient: %i(commit revision),
+      }
+
+      def self.detect(object)
+        DataFinder.detect(self, object, PRIORITIES)
+      end
+
+      attr_reader :reference
+
+      def initialize(reference)
+        fail Error::NoMatch unless (reference && !reference.empty?)
+        @reference = reference
+        Gem::Checkout.logger.debug "Found gem's commit info: #{reference}"
+      end
+    end
+
+    class Source
+      attr_reader :source_reference
+      attr_reader :repository
+
+      class Error < RuntimeError
+        class NoValidRepositoryFound
+        end
+      end
+
+      def initialize(name, version=nil)
+        Gem::Checkout.logger.debug "Gathering infor about #{name} (#{version || 'latest'})"
+        object = Spec.info(name, version)
+
+        @name = name
+
+        repository = RepositoryInfo.detect(object)
+        fail Error::NoValidRepositoryFound unless repository
+        @repository = repository.repository
+
+        reference = RepositoryHash.detect(object)
+
+        @source_reference =
+          if reference
+            reference.reference
+          else
+            Gem::Checkout.logger.warn "No metadata key with commit! Matching tag to version, which is insecure if you don't trust the repository owners!"
+            @repository.get_tag_ref("v#{object.version}")
+          end
+        # TODO: check integrity of gem vs source
+      end
+    end
+  end
+end

data/lib/gem-checkout/spec.rb

@@ -0,0 +1,238 @@
+require 'ostruct'
+require 'gems'
+
+require 'gem-checkout/logger'
+
+module Gem
+  module Checkout
+    class Spec
+      class Error < RuntimeError
+        class NoSuchGem < Error
+        end
+      end
+
+      module CommonMetadata
+        attr_reader :alternative
+        def initialize(data, alternative=nil)
+          @alternative = alternative
+          @data = OpenStruct.new(data)
+        end
+
+        def homepage
+          read(:homepage_uri)
+        end
+
+        private
+
+        def data
+          @data
+        end
+      end
+
+      class Local < Spec
+        class Metadata
+          include CommonMetadata
+
+          %i(
+            source_code_uri
+            source_code_url
+            repository_uri
+            repository_url
+            project_uri
+            project_url
+            source_reference
+            commit
+            revision
+            bug_tracker_uri
+            bug_tracker_url
+          ).each do |name|
+            define_method(name) do
+              read(name)
+            end
+          end
+
+
+          private
+
+          def read(key)
+            Gem::Checkout.logger.debug "Checking local metadata (#{key})"
+            data.public_send(key) if data.respond_to?(key)
+          end
+        end
+
+        def initialize(name, version, remote)
+          @data = find_by_name(name, version)
+          @name = name
+          @version = version
+          @remote = remote
+        end
+
+        # TODO: fake fields - just as proof of concept
+
+        %i(
+          source_code_uri
+          source_code_url
+          repository_uri
+          repository_url
+          project_uri
+          project_url
+          source_reference
+          commit
+          revision
+        ).each do |name|
+          define_method(name) do
+            read(name)
+          end
+        end
+
+        def homepage
+          read(:homepage)
+        end
+
+        def version
+          read(:version)
+        end
+
+        def alternative
+          Metadata.new(data.metadata, @remote)
+        end
+
+        private
+
+        def data
+          @data
+        end
+
+        def find_by_name(*args)
+          spec = Gem::Specification
+          return spec.find_by_name(*args) if spec.respond_to?(:find_by_name)
+          Gem.source_index.find_name(*args).last or raise Gem::LoadError
+        end
+
+        def read(key)
+          Gem::Checkout.logger.debug "Checking local info (#{key})"
+          data.public_send(key) if data.respond_to?(key)
+        end
+      end
+
+      class Remote < Spec
+        class Metadata
+          include CommonMetadata
+
+          %i(
+            source_code_uri
+            source_code_url
+            repository_uri
+            repository_url
+            project_uri
+            project_url
+            source_reference
+            commit
+            revision
+            bug_tracker_uri
+            bug_tracker_url
+          ).each do |name|
+            define_method(name) do
+              data.public_send(name) if data.respond_to?(name)
+            end
+          end
+
+          private
+
+          def read(key)
+            Gem::Checkout.logger.debug "Checking remote metadata (#{key})"
+            data.public_send(key) if data.respond_to?(key)
+          end
+        end
+
+        def initialize(name, version)
+          @data = nil
+          @name = name
+          @version = version
+
+          #  @homepage = nil_when_empty(object.homepage)
+          #  @homepage = nil_when_empty(object.homepage_uri)
+        end
+
+        %i(
+          source_code_uri
+          source_code_url
+          repository_uri
+          repository_url
+          project_uri
+          project_url
+          source_reference
+          commit
+          revision
+          bug_tracker_uri
+          bug_tracker_url
+        ).each do |name|
+          define_method(name) do
+            read(name)
+          end
+        end
+
+        def alternative
+          Metadata.new(data.metadata, nil)
+        end
+
+        def version
+          data.number
+        end
+
+        def homepage
+          base.homepage_uri
+        end
+
+        private
+
+        def base
+          @base ||=
+            begin
+              name = @name
+              Gem::Checkout.logger.debug "Looking up latest gem info ..."
+              result = Gems.info(name)
+              return OpenStruct.new(result) if result.is_a?(Hash)
+              fail Error::NoSuchGem, result
+            end
+        end
+
+        def data
+          @data ||= find_on_rubygems
+        end
+
+        def find_on_rubygems
+          name = @name
+          version = @version
+          return base if version.nil?
+
+          Gem::Checkout.logger.debug "Looking all gem versions ..."
+          versions = Gems.versions(name)
+          version = versions.detect do |info|
+            info['number'] == version
+          end
+
+          fail Error::NoSuchGem, "Could not find #{name} on rubygems.org" unless version
+          Gem::Checkout.logger.debug "Found info matching gem version #{@version}"
+          OpenStruct.new(version)
+        end
+
+        private
+
+        def read(key)
+          Gem::Checkout.logger.debug "Checking remote info (#{key})"
+          data.public_send(key) if data.respond_to?(key)
+        end
+      end
+
+      def self.info(name, version=nil)
+        remote = Spec::Remote.new(name, version)
+        Gem::Checkout.logger.debug "Checking for info locally ..."
+        Spec::Local.new(name, version, remote)
+      rescue Gem::LoadError
+        Gem::Checkout.logger.debug "Checking for info remotely ..."
+        remote
+      end
+    end
+  end
+end

data/lib/rubygems/commands/checkout_command.rb

@@ -0,0 +1,49 @@
+require 'logger'
+
+require 'gem-checkout/source'
+
+class Gem::Commands::CheckoutCommand < Gem::Command
+  def initialize
+    super 'checkout', description
+    add_option('-v', '--version VERSION', 'version to checkout') do |version, options|
+      options[:version] = version
+    end
+
+    add_option('-d', '--debug LEVEL', 'set debug mode (0=debug)') do |level, options|
+      options[:debug_level] = Integer(level)
+    end
+  end
+
+  def arguments # :nodoc:
+    "checkout        checkout the original repository at the same version"
+  end
+
+  def usage # :nodoc:
+    "#{program_name}"
+  end
+
+  def defaults_str # :nodoc:
+    ""
+  end
+
+  def description # :nodoc:
+    "Checkout a gem's repository or sources at the same version"
+  end
+
+  def execute
+    logger = Logger.new(STDERR)
+    logger.level = options[:debug_level] || Logger::WARN
+    Gem::Checkout.logger = logger
+
+    name = get_one_gem_name
+    source = Gem::Checkout::Source.new(name, options[:version])
+    repository = source.repository
+    repository.clone(directory: name)
+    Dir.chdir(name) do
+      repository.checkout(source.source_reference)
+    end
+  rescue Gem::Checkout::Repository::Error => ex
+    alert_error ex.message
+    terminate_interaction 1
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,2 @@
+require 'rubygems/command_manager'
+Gem::CommandManager.instance.register_command :checkout

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: gem-checkout
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Cezary Baginski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gems
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: Uses gem's metadata or version to work out which commit to checkout
+email:
+- cezary@chronomantic.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/gem-checkout/logger.rb
+- lib/gem-checkout/process.rb
+- lib/gem-checkout/repository.rb
+- lib/gem-checkout/repository/git-hub.rb
+- lib/gem-checkout/repository/git.rb
+- lib/gem-checkout/source.rb
+- lib/gem-checkout/spec.rb
+- lib/rubygems/commands/checkout_command.rb
+- lib/rubygems_plugin.rb
+homepage: https://github.com/e2/gem-checkout
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Gem command download and checkout repository at same version as gem
+test_files: []