git_rev 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7060bb3655f892aa3b0de369b5148938e9edb15d
+  data.tar.gz: e83618685c95c911d309b1230552dc21a54d811e
+SHA512:
+  metadata.gz: 78a5c406b7d5fb6f9434bb98356ac0493dde51bd2c499fea94691f59b9a04faa652ccb729e0adeeca23d08a8e1d5c1a919737ada23aecf0aca03cdba2fdcfee5
+  data.tar.gz: 3330507fa6b64877ade06f337c53d29fd817318faf20e35c7a59681e84575e255f3bdbb1af58f5dd4f938a6e83c7361daa8f01724d3f29c0b784438fc7259e59

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest do
+  # with Minitest::Spec
+  watch(%r{^spec/(.*)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ServeBox
+
+MIT License
+
+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,70 @@
+# GitRev
+
+Retrieve the SHA-1 hash of the current revision of a Git repository. GitRev
+uses the contents of the `.git` directory therefore it does not require Git to
+be installed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'git_rev'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git_rev
+
+## Usage
+
+### SHA-1
+
+By default, `GitRev::Sha` uses the current directory as the Git repository and
+caches the revision number:
+
+```ruby
+require 'git_rev'
+
+revision = GitRev::Sha.new
+
+revision.full
+#=> 1f7995f701d02f2f62b2e7faa91a1e16f3d68666
+
+revision.short
+#=> 1f7995f
+```
+
+You may specify the location of the Git repository:
+
+```ruby
+revision = GitRev::Sha.new(repository: '/path/to/repository')
+```
+
+By default, the cache is enabled, meaning GitRev will only query the filesystem
+once. If you need to ensure the revision info is reloaded each time:
+
+```ruby
+revision = GitRev::Sha.new(repository: '/path/to/repository', cache: false)
+
+revision.short
+#=> 1f7995f
+
+`git commit -m "A message"`
+
+revision.short
+# => 658f674
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/git_rev/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => [:test]

data/git_rev.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git_rev/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "git_rev"
+  spec.version       = GitRev::VERSION
+  spec.authors       = ["Jef Mathiot"]
+  spec.email         = ["jeff.mathiot@gmail.com"]
+  spec.summary       = %q{Retrieve the git revision}
+  spec.description   = %q{Get the git revision of a given repository. Does not require Git binaries}
+  spec.homepage      = "http://github.com/servebox/git_rev"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest', '~> 5.4', '>= 5.4.1'
+  spec.add_development_dependency 'minitest-implicit-subject', '~> 1.4', '>= 1.4.0'
+  spec.add_development_dependency 'rb-readline', '~> 0.5', '>= 0.5.0'
+  spec.add_development_dependency 'guard', '~> 2.11', '>= 2.11.1'
+  spec.add_development_dependency 'guard-minitest', '~> 2.3', '>= 2.3.2'
+
+end

data/lib/git_rev.rb

@@ -0,0 +1,5 @@
+require "git_rev/version"
+require "git_rev/sha"
+
+module GitRev
+end

data/lib/git_rev/sha.rb

@@ -0,0 +1,58 @@
+module GitRev
+  class Sha
+
+    def initialize(options={})
+      repository = options[:repository] || Dir.pwd
+      cache = options.has_key?(:cache) ? options[:cache] : true
+      @repository=File.expand_path(repository)
+      @cache = cache
+      ensure_repository!
+    end
+
+    def full
+      cached? && @revision || load_revision
+    end
+
+    def short
+      full[0, 7]
+    end
+
+    private
+
+    def cached?
+      !!@cache
+    end
+
+    def git_repository?
+      File.directory?(git_directory)
+    end
+
+    def git_directory
+      File.join(@repository, '.git')
+    end
+
+    def ensure_repository!
+      raise "Not a git repository #{@repository}" unless git_repository?
+    end
+
+    def load_revision
+      head=File.read(File.join(git_directory, 'HEAD')).chomp
+      # Detached head
+      if sha1?(head)
+        @revision = head
+      else
+        @revision = ref(head)
+      end
+    end
+
+    def sha1?(subject)
+      /^[0-9a-f]{40}$/ =~ subject
+    end
+
+    def ref(head)
+      ref = head.scan(/^ref:\s+(.*)$/).first
+      File.read(File.join(git_directory, ref)).chomp
+    end
+
+  end
+end

data/lib/git_rev/version.rb

@@ -0,0 +1,3 @@
+module GitRev
+  VERSION = "0.1.0"
+end

data/spec/git_rev/sha_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe GitRev::Sha do
+
+  before do
+    @tmpdir=Dir.mktmpdir
+  end
+
+  after do
+    FileUtils.rm_rf(@tmpdir)
+  end
+
+  let(:sha) do
+    subject.new( repository: @tmpdir)
+  end
+
+  let(:no_cache) do
+    subject.new( repository: @tmpdir, cache: false)
+  end
+
+  def self.assert_revisions(update_method)
+
+    def assert_and_update(subject, method)
+      subject.full.must_equal revision
+      send method, "b" * 40
+    end
+
+    it 'enables the cache by default' do
+      assert_and_update(sha, update_method)
+      sha.full.must_equal revision
+    end
+
+    it 'disables the cache' do
+      assert_and_update(no_cache, update_method)
+      no_cache.full.wont_equal revision
+    end
+
+    it 'provides the hash in short format' do
+      sha.short.must_equal "aaaaaaa"
+    end
+
+  end
+
+  it 'raises unless a git repository' do
+    ex = ->{ sha }.must_raise RuntimeError
+    ex.message.must_equal "Not a git repository #{@tmpdir}"
+  end
+
+  it 'defaults to the current directory' do
+    subject.new.short.must_equal `git describe --always`.chomp
+  end
+
+  describe 'with a fake git repository' do
+
+    before do
+      @gitdir=FileUtils.mkdir_p(File.join(@tmpdir, '.git'))
+      FileUtils.mkdir_p(File.join(@gitdir, 'refs/heads'))
+    end
+
+    let(:revision) do
+      "a" * 7 + "b" * 33
+    end
+
+    def overwrite(path, contents)
+      File.delete(path) if File.exists?(path)
+      File.open(path, 'wb') do |f|
+        f.write contents
+      end
+    end
+
+    def write_head(contents)
+      overwrite File.join(@gitdir, 'HEAD'), contents
+    end
+
+    def write_master_ref(revision)
+      overwrite File.join(@gitdir, 'refs/heads/master'), revision
+    end
+
+    describe 'on a branch' do
+
+      before do
+        write_head "ref: refs/heads/master"
+        write_master_ref revision
+      end
+
+      assert_revisions :write_master_ref
+
+    end
+
+    describe 'on a detached HEAD' do
+
+      before do
+        write_head revision
+      end
+
+      assert_revisions :write_head
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'git_rev'
+require 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest-implicit-subject'

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: git_rev
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jef Mathiot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.4.1
+- !ruby/object:Gem::Dependency
+  name: minitest-implicit-subject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+description: Get the git revision of a given repository. Does not require Git binaries
+email:
+- jeff.mathiot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- git_rev.gemspec
+- lib/git_rev.rb
+- lib/git_rev/sha.rb
+- lib/git_rev/version.rb
+- spec/git_rev/sha_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/servebox/git_rev
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Retrieve the git revision
+test_files:
+- spec/git_rev/sha_spec.rb
+- spec/spec_helper.rb
+has_rdoc: