absgit 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f26cd5efa247302f66c97d4ef3f6118d2b6a576
+  data.tar.gz: 2af40a800b06f4085875b6ae54935dfb0c97e53d
+SHA512:
+  metadata.gz: 114ada2e52cdde5bfea375e52b75721a092a71f299089a2b6bb2350b618c4a1d1a19024b796d04dd73e741924fd9e44d139f5f6a2d92220e2bc4f52d066d3ba3
+  data.tar.gz: 9e86941d8c7a81a97746faca2cbccb2bf0b52569a523d886bf241394a4abc4e66323ba76f2fc6dc7a9e326670cfa544f21486acfae18e26c91b957cc9a694a20

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+/pkg/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in absgit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    absgit (0.1.0)
+      methadone (~> 1.2.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    builder (3.0.4)
+    hashie (2.0.4)
+    methadone (1.2.6)
+      bundler
+    minitest (4.7.3)
+    minitest-reporters (0.14.17)
+      ansi
+      builder
+      minitest (>= 2.12, < 5.0)
+      powerbar
+    powerbar (1.0.11)
+      ansi (~> 1.4.0)
+      hashie (>= 1.1.0)
+    rake (10.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  absgit!
+  bundler (~> 1.3)
+  minitest (~> 4.0)
+  minitest-reporters (~> 0.14.17)
+  rake

data/LICENCE.txt

@@ -0,0 +1,4 @@
+The contents of this repository are made available under the terms of
+the MIT Licence.  See:
+
+  http://opensource.org/licenses/MIT

data/README.md

@@ -0,0 +1,22 @@
+# absgit
+
+## Introduction
+
+This is the repository for a Ruby gem
+called `absgit`.
+It provides a program of the same name
+which
+allows one to manipulate files in a Git repository,
+regardless of whether one is inside it.
+
+## Installation
+
+To install the gem, give this command:
+
+    gem install absgit
+
+Ruby 2 is required.
+
+## Documentation
+
+See [here](doc/absgit.md).

data/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler/gem_tasks'
+
+desc 'Run the test suite'
+task :test do
+  #> we need to set RUBYLIB, because the test suite
+  # invokes the application as a separate process
+
+  system(
+    {
+      'RUBYLIB' =>
+        (
+          ENV.fetch('RUBYLIB', '').split(':') +
+          [File.join(__dir__, 'lib')]
+        ).join(':')
+    },
+    FileUtils::RUBY, 'test/absgit_test.rb'
+  )
+end
+
+task :default => :test

data/absgit.gemspec

@@ -0,0 +1,51 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'absgit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "absgit"
+  spec.version       = Absgit::VERSION
+  spec.authors       = ["Ruafozy"]
+
+  spec.summary   =
+    %q{Allow manipulating Git repository files outside a repository}
+
+  spec.description       = %q{
+    This gem contains a program which allows one to
+    manipulate files in a Git repository,
+    regardless of whether one is inside it.
+  }.split.join(' ')
+
+  spec.homepage      = "https://github.com/ruafozy/absgit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{\Atest\z/})
+  spec.require_paths = ["lib"]
+
+  [
+    ['methadone', ['~> 1.2.6']],
+  ].each do |name, ver|
+    spec.add_runtime_dependency(name, ver)
+  end
+
+  [
+    ['bundler', ['~> 1.3']],
+    ['minitest', ['~> 4.0']],
+    ['minitest-reporters', ['~> 0.14.17']],
+    ['rake'],
+  ].each do |gem_info|
+    spec.add_development_dependency(*gem_info)
+  end
+
+  #> there seems to be no way to specify in the gemspec
+  # that rdoc documentation should not be generated.
+  # see http://stackoverflow.com/q/16167876
+  spec.has_rdoc = false
+end

data/bin/absgit

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'absgit'
+
+Absgit.new(ARGV).run
+
+# vim: set syntax=ruby:

data/doc/absgit.md

@@ -0,0 +1,55 @@
+## The Problem
+
+You can do this:
+
+    cd /
+    svn commit --message blah /some/absolute/path
+
+but you can't do this:
+
+    cd /
+    git commit --message blah /some/absolute/path
+
+More generally,
+Git requires you to be within the
+repository, whereas Subversion does not.
+
+## The solution
+
+A program called `absgit`.
+To use it, simply type your desired Git
+command, replacing the initial "git" with "absgit".
+For example:
+
+    absgit commit --message blah /some/absolute/path
+
+Its logic is very simple.
+It skips over the Git subcommand and iterates
+over the remaining arguments, looking
+for the first argument which contains a slash and
+names a path inside a Git repository.
+If it finds such an argument,
+it infers `GIT_DIR` and `GIT_WORK_TREE`,
+then invokes `git` with these
+variables in its environment.
+
+If it finds no such argument,
+then it simply invokes `git` with an
+unchanged environment.
+For example, the following
+two commands are essentially equivalent:
+
+    absgit log -3
+
+    git log -3
+
+## Options
+
+`absgit` accepts the `--help` and `--version` options.
+
+## Origin of name
+
+The software is commonly used in conjunction with
+absolute pathnames,
+so the prefix "abs" was chosen,
+as a short version of "absolute".

data/lib/absgit/version.rb

@@ -0,0 +1,3 @@
+class Absgit
+  VERSION = '0.1.2'
+end

data/lib/absgit.rb

@@ -0,0 +1,99 @@
+require 'absgit/version'
+require 'methadone'
+require 'optparse'
+require 'pathname'
+
+class Absgit
+  include Methadone::CLILogging
+
+  GIT_DIR_BASE = '.git'
+  PROGRAM_NAME = 'absgit'
+
+  def initialize(args)
+    @args = args
+    @options = {}
+  end
+
+  def self.get_repo_path(file_name)
+    path = Pathname.new(file_name)
+
+    if path.exist?
+      path.realpath.ascend do |path2|
+        if (path2 + '.git').exist?
+          return path2
+        end
+      end
+    end
+  end
+
+  def option_parser
+    OptionParser.new do |parser|
+      parser.program_name = PROGRAM_NAME
+      parser.banner = "Usage: #{PROGRAM_NAME} [options] [GIT_SUBCOMMAND]"
+
+      parser.on('--debug', 'Show debugging information') do
+        @options[:debug] = true
+      end
+
+      parser.on('--help', 'Show this usage summary') do
+        @options[:help] = true
+      end
+
+      parser.on('--version', 'Show program name and version') do
+        @options[:version] = true
+      end
+    end
+  end
+
+  def run
+    begin
+      option_parser.order!
+    rescue OptionParser::ParseError
+      $stderr.puts 'Error: incorrect usage'
+      $stderr.puts ''
+      $stderr.puts option_parser
+      exit(1)
+    end
+
+    if @options[:debug]
+      logger.error_level = Logger::Severity::DEBUG
+    end
+
+    debug(@options.inspect)
+    debug(@args.inspect)
+
+    if @options[:version]
+      puts "#{PROGRAM_NAME} #{VERSION}"
+    elsif @options[:help]
+      puts option_parser
+    else
+      repo_path =
+        @args[1..-1].grep(%r{/}).each_with_object(nil) { |arg|
+          repo = self.class.get_repo_path(arg)
+          break repo if !repo.nil?
+        }
+
+      env =
+        if repo_path.nil?
+          {}
+        else
+          {
+            'GIT_DIR' => (repo_path + GIT_DIR_BASE).to_s,
+            'GIT_WORK_TREE' => repo_path.to_s,
+          }
+        end
+
+      #< it seems better to use environment variables
+      # rather than "--git-dir" and "--work-tree", because
+      # environment variables will be inherited by processes
+      # spawned by git aliases.
+
+      command = ['git'] + @args
+      debug(command.inspect)
+      debug(env.inspect)
+      system(env, *command)
+    end
+  end
+end
+
+# vim: set syntax=ruby:

data/test/absgit_test.rb

@@ -0,0 +1,116 @@
+require 'rubygems'
+gem 'minitest', '~> 4.0'
+
+require 'minitest/unit'
+MiniTest::Unit.autorun
+
+require "minitest/reporters"
+MiniTest::Reporters.use!
+
+require 'absgit'
+require 'fileutils'
+require 'shellwords'
+require 'tmpdir'
+
+class AbsgitTest < MiniTest::Unit::TestCase
+  APP_PATH = File.expand_path(
+    "../../bin/#{Absgit::PROGRAM_NAME}",
+    __FILE__
+  )
+  APP_PATH_ESC = Shellwords.escape(APP_PATH)
+
+  def setup
+    @temp_dir = Dir.mktmpdir
+
+    # puts "dir: #@temp_dir"
+  end
+
+  def teardown
+    FileUtils.rm_r(@temp_dir, secure: true)
+  end
+
+  def test_symlinks_resolved
+    Dir.chdir(@temp_dir) do
+      # Given
+
+      repo = 'a1/a2/a3/repo'
+      repo_abs = File.absolute_path(repo)
+
+      repo_file = File.join(repo, 'b1/b2/b3/file')
+      repo_file_abs = File.absolute_path(repo_file)
+
+      symlink = 'd/symlink'
+
+      FileUtils.makedirs(File.dirname(repo_file))
+      FileUtils.touch(repo_file)
+
+      Dir.mkdir(File.dirname(symlink))
+      File.symlink(repo_file_abs, symlink)
+
+      system 'git', 'init', '--quiet', repo
+
+      # When & Then
+
+      assert_equal(repo_abs, Absgit.get_repo_path(symlink).to_s)
+      assert_equal(
+        repo_abs, Absgit.get_repo_path(File.absolute_path(symlink)).to_s
+      )
+    end
+  end
+
+  def test_file_not_in_repo
+    f = '/dev/null'
+
+    if !File.exist?(f)
+      skip
+    else
+      assert_nil(Absgit.get_repo_path(f))
+    end
+  end
+
+  def test_commit_does_not_require_chdir_to_repo
+    Dir.chdir(@temp_dir) do
+      # Given
+
+      repo = 'repo'
+      repo_file = File.join(repo, 'file')
+      repo_file_abs = File.absolute_path(repo_file)
+
+      Dir.mkdir(repo)
+      system 'git', 'init', '--quiet', repo
+      IO.write(repo_file, "blah\n")
+
+      # When
+
+      system(
+        "#{APP_PATH_ESC} add #{repo_file_abs.shellescape}"
+      )
+
+      system(
+        "#{APP_PATH_ESC} commit --quiet --message blah " +
+          repo_file_abs.shellescape
+      )
+
+      # Then
+
+      Dir.chdir(repo) do
+        assert_equal("1\n", `git rev-list --count HEAD`)
+      end
+    end
+  end
+
+  def test_help_message_is_output
+    assert_match(/--help\b/, `#{APP_PATH_ESC} --help`)
+  end
+
+  def test_options_for_git_are_left_alone
+    refute_match(
+      /--help\b/,
+      %x{
+        #> any program that consumes its input will do
+        # instead of "wc"
+        PAGER=wc #{APP_PATH_ESC} log --help
+      }
+    )
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: absgit
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Ruafozy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.17
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.17
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem contains a program which allows one to manipulate files in a
+  Git repository, regardless of whether one is inside it.
+email: 
+executables:
+- absgit
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENCE.txt
+- README.md
+- Rakefile
+- absgit.gemspec
+- bin/absgit
+- doc/absgit.md
+- lib/absgit.rb
+- lib/absgit/version.rb
+- test/absgit_test.rb
+homepage: https://github.com/ruafozy/absgit
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Allow manipulating Git repository files outside a repository
+test_files: []