rails_git_version 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,66 @@
+# Rails Git Version ![travis-ci](http://travis-ci.org/jcf/rails_git_version.png)
+
+## Description
+
+If you are using Git to manage your Rails apps' source code this gem
+will make it possible to find a description of what is deployed from
+within your browser.
+
+## Installation
+
+To add this functionality to your Rails 3 app add it to your Gemfile.
+
+``` ruby
+gem 'rails_git_version' '~> 0.1'
+```
+
+Bundle install the new gem, and decide where you want to access your
+description of what's currently live.
+
+If you want to use `http://example.com/_deployed` as I do you need to
+add set this up in your routes.rb file like so.
+
+``` ruby
+Rails.application.routes.draw do
+  mount RailsGitVersion::Engine => '/_deployed'
+end
+```
+
+## Configuration
+
+By default, RailGitVersion will assume your git repository is in the
+same directory as `Rails.root`. If this is not the case you can tell
+RailsGitVersion where to look for a `.git` directory by adding the
+following line to your config/application.rb file.
+
+``` ruby
+module Dummy
+  class Application < Rails::Application
+    config.encoding = 'utf-8'
+    config.filter_parameters += [:password]
+    config.assets.enabled = true
+    config.assets.version = '1.0'
+
+    # And all of your other configuration...
+
+    # Add this line with a path to the directory containing the .git
+    # directory.
+    config.rails_git_version.root = File.expand_path('..', __FILE__)
+  end
+end
+```
+
+## Troubleshooting
+
+When you start your Rails application, RailsGitVersion will attempt to
+find the SHA of the most recent commit using [Grit][]. If the repository
+can be accessed, and the commit found it will be logged to your
+Rails.logger.
+
+If for some reason Grit can't find your .git directory a quiet message
+will be printed to explain something has gone wrong.
+
+Try running `Grit::Repo.new(path)` within `rails console` replacing path
+with the full path logged after something went wrong.
+
+[Grit]: https://github.com/mojombo/grit

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'bundler/setup'
+
+Dir['tasks/**/*.rake'].each &method(:load)
+
+desc 'Run RSpec & Cucumber'
+task :default => [:spec, :features]
+
+Bundler::GemHelper.install_tasks

data/app/controllers/rails_git_version/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsGitVersion
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/rails_git_version/description_controller.rb

@@ -0,0 +1,11 @@
+module RailsGitVersion
+  class DescriptionController < ApplicationController
+    respond_to :html, :text
+
+    def index
+      respond_with(@repo = RailsGitVersion.repo) do |format|
+        format.text { render text: @repo.commits.first.id }
+      end
+    end
+  end
+end

data/app/helpers/rails_git_version/application_helper.rb

@@ -0,0 +1,9 @@
+module RailsGitVersion
+  module ApplicationHelper
+    def highlight_commit(commit)
+      abbrev = commit.id_abbrev
+      rest = commit.id[abbrev.length..-1]
+      content_tag(:b, abbrev, class: 'abbrev') + content_tag(:span, rest, class: 'rest')
+    end
+  end
+end

data/app/views/layouts/rails_git_version/application.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RailsGitVersion</title>
+  <style>
+    body {
+      font: 14px 'helvetica', sans-serif; color: #444;
+      padding: 0;
+      margin: 0;
+    }
+    p.deployed {
+      margin: 0;
+      padding: 10px;
+    }
+    span.rest { color: #999; }
+  </style>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/rails_git_version/description/index.html.erb

@@ -0,0 +1,3 @@
+<p class="deployed">
+  <%= highlight_commit(@repo.commits.first) %>
+</p>

data/config/routes.rb

@@ -0,0 +1,4 @@
+RailsGitVersion::Engine.routes.draw do
+  get '/.txt' => 'description#index', format: 'txt'
+  root to: 'description#index'
+end

data/lib/rails_git_version.rb

@@ -0,0 +1,31 @@
+require 'grit'
+require 'rails_git_version/config'
+require 'rails_git_version/engine'
+
+module RailsGitVersion
+  extend self
+
+  class << self
+    attr_reader :repo
+  end
+
+  def setup
+    config.root ||= Rails.root
+
+    @repo = Grit::Repo.new(config.root.to_s)
+    log_success
+  rescue Grit::InvalidGitRepositoryError
+    @repo = nil
+    log_failure
+  end
+
+  private
+
+  def log_success
+    Rails.logger.info "RailsGitVersion: Found version #{@repo.commits.first.id_abbrev}."
+  end
+
+  def log_failure
+    Rails.logger.warn "RailsGitVersion: Failed to access git repo in #{config.root}."
+  end
+end

data/lib/rails_git_version/config.rb

@@ -0,0 +1,20 @@
+require 'active_support/configurable'
+
+module RailsGitVersion
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor :root
+  end
+
+  def self.configure
+    yield @config ||= RailsGitVersion::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  configure do |config|
+    # config.root = Rails.root
+  end
+end

data/lib/rails_git_version/engine.rb

@@ -0,0 +1,11 @@
+module RailsGitVersion
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsGitVersion
+
+    config.rails_git_version = RailsGitVersion.config
+
+    initializer 'load RailsGitVersion' do
+      RailsGitVersion.setup
+    end
+  end
+end

data/lib/rails_git_version/version.rb

@@ -0,0 +1,3 @@
+module RailsGitVersion
+  VERSION = "0.0.1"
+end

data/lib/tasks/rails_git_version_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_git_version do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: rails_git_version
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Conroy-Finn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: cucumber-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Find your git version within your running Rails application
+email:
+- james@logi.cl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/rails_git_version/application_controller.rb
+- app/controllers/rails_git_version/description_controller.rb
+- app/helpers/rails_git_version/application_helper.rb
+- app/views/layouts/rails_git_version/application.html.erb
+- app/views/rails_git_version/description/index.html.erb
+- config/routes.rb
+- lib/rails_git_version/config.rb
+- lib/rails_git_version/engine.rb
+- lib/rails_git_version/version.rb
+- lib/rails_git_version.rb
+- lib/tasks/rails_git_version_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://jamesconroyfinn.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -336369872854003235
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -336369872854003235
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Find your git version within your running Rails application
+test_files: []