app_revision 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ed2215f23235f03ade7fd73df421c04df6a4acad7cb94202ea388c38b2fd258
+  data.tar.gz: 8dab5494ff477d771de7aaf4068b6285ff5c1b87018434897d4049e58aa4a1f2
+SHA512:
+  metadata.gz: 48b4fff69ad74d66e4879650555faad8e0da532600584c391f823c9deb2794f99f6d52b2e8c8598d9d854533f6d43d26ab12131a61301851fbc3ced112ca2b66
+  data.tar.gz: 1f13fb5fe11351c137c4a93b55f78535f462617c1b7de5f30634d3953feaf36d1f0d29333af0aeea9e730caa2152ada0ff6788b8ce0207b5344949b7297165da

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 WeTransfer
+
+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,35 @@
+# AppRevision
+
+Returns the current application git commit SHA. Will look first in the APP_REVISION
+environment variable, then in the REVISION file written by Capsitrano, then
+in the Git history and lastly will return 'unknown' will be returned
+ 
+# Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'app_revision'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+AppRevision.current #=> "43ec44d89706ca948daea5124fdcc62694a87f43"
+```
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WeTransfer/app_revision.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app_revision.gemspec

@@ -0,0 +1,23 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "app_revision/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "app_revision"
+  spec.version       = AppRevision::VERSION
+  spec.authors       = ["Julik Tarkhanov"]
+  spec.email         = ["me@julik.nl"]
+
+  spec.summary       = %q{Finds a way to get at your git commit SHA}
+  spec.description   = %q{Finds a way to get at your git commit SHA}
+  spec.homepage      = "https://github.com/WeTransfer/app_revision"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/app_revision/version.rb

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

data/lib/app_revision.rb

@@ -0,0 +1,59 @@
+require "app_revision/version"
+
+# Returns the current application git commit SHA. Will look first in the APP_REVISION
+# environment variable, then in the REVISION file written by Capsitrano, then
+# in the Git history and lastly will return 'unknown' will be returned
+module AppRevision
+  ENV_VARS = ['APP_REVISION', 'HEROKU_REVISION']
+
+  # Calls `determine_current` with memoization.
+  def self.current
+    @current ||= determine_current
+  end
+
+  # Performs version detection in the following order:
+  # APP_REVISION -> REVISION file -> git -> "unknown"
+  # and returns the current commit/revision SHA as a String
+  def self.determine_current
+    detected_rev_str = read_from_env || read_from_revision_file || determine_from_git_rev || unknown_revision
+    up_to_newline(detected_rev_str)
+  end
+
+  private
+
+  def self.up_to_newline(str)
+    str.scan(/[a-z0-9\-]+/)[0]
+  end
+
+  def self.unknown_revision
+    'unknown'
+  end
+  
+  def self.determine_from_git_rev
+    cmd_output = `git rev-parse --verify HEAD`.strip
+    return cmd_output if cmd_output =~ /^[a-f\d]{40}$/
+  end
+
+  def self.read_from_env
+    ENV_VARS.each do |envvar|
+      envvar_value = ENV.fetch(envvar, '').strip
+      return envvar_value unless envvar_value.empty?
+    end
+    nil
+  end
+
+  def self.read_from_revision_file
+    my_directory = File.dirname(__FILE__)
+    my_location = File.split(File.expand_path(my_directory))
+    begin
+      File.read(File.join(my_location + ['REVISION'])).chomp
+    rescue Errno::ENOENT
+      my_location.pop # Remove the last path part and try again
+      if my_location.empty?
+        return nil
+      else
+        retry
+      end
+    end
+  end
+end

data/spec/app_revision_spec.rb

@@ -0,0 +1,58 @@
+RSpec.describe AppRevision do
+  it "has a version number" do
+    expect(AppRevision::VERSION).not_to be nil
+  end
+
+  before :each do
+    @app_revision_location = AppRevision.method(:current).source_location[0]
+  end
+
+  it 'always provides a string value from .current' do
+    expect(AppRevision.current).to be_kind_of(String)
+  end
+
+  it 'is set in the APP_REVISION environment variable on startup' do
+    ENV['APP_REVISION'] = 'some-customized-rev'
+    expect(AppRevision.determine_current).to eq('some-customized-rev')
+    ENV.delete('APP_REVISION')
+  end
+
+
+  describe 'with each environment variable that can be used' do
+    AppRevision::ENV_VARS.each do |ev|
+      it "only uses the SHA component from #{ev} up to but excluding the newline" do
+        ENV[ev] = "43ec44d89706ca948daea5124fdcc62694a87f43\na85f99a"
+        expect(AppRevision.determine_current).to eq('43ec44d89706ca948daea5124fdcc62694a87f43')
+        ENV.delete(ev)
+      end
+
+      it "does not use #{ev} if it is empty" do
+        ENV[ev] = "   "
+        expect(AppRevision.determine_current).not_to be_empty
+        ENV.delete(ev)
+      end
+    end
+  end
+
+  it 'returns "unknown" if all version detection methods return nil' do
+    expect(AppRevision).to receive(:read_from_env).and_return(nil)
+    expect(AppRevision).to receive(:read_from_revision_file).and_return(nil)
+    expect(AppRevision).to receive(:determine_from_git_rev).and_return(nil)
+
+    expect(AppRevision.determine_current).to eq('unknown')
+  end
+
+  it 'returns the contents of the REVISION without the newline' do
+    ENV.delete('APP_REVISION')
+    revision_file_path = File.dirname(File.dirname(@app_revision_location)) + "/REVISION"
+
+    begin
+      File.open(revision_file_path, "w") do |f|
+        f << "43ec44d89706ca948daea5124fdcc62694a87f43\na85f99a"
+      end
+      expect(AppRevision.determine_current).to eq('43ec44d89706ca948daea5124fdcc62694a87f43')
+    ensure
+      File.unlink(revision_file_path)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "app_revision"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: app_revision
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Finds a way to get at your git commit SHA
+email:
+- me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app_revision.gemspec
+- lib/app_revision.rb
+- lib/app_revision/version.rb
+- spec/app_revision_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/WeTransfer/app_revision
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Finds a way to get at your git commit SHA
+test_files: []