peek-git 1.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0
+
+* Initial release
+
+# 1.0.1
+
+* Added support for GIT_SHA and GIT_BRANCH env variables instead of shelling out to fetch them.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Garrett Bjerkhoel
+
+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,72 @@
+# Peek::Git
+
+Take a peek into the Git info of your Rails application.
+
+Things this peek view provides:
+
+- View the current branch name
+- Compare the diff of the current revision on your GitHub repo
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'peek-git'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install peek-git
+
+## Usage
+
+Add the following to your `config/initializers/peek.rb`:
+
+```ruby
+Peek.into Peek::Views::Git
+```
+
+You will need to set the GitHub project's name with owner if you plan on
+comparing the current ref against your default branch on GitHub.
+
+```ruby
+# nwo - name with owner - owner/name
+Peek.into Peek::Views::Git, :nwo => 'dewski/json_builder'
+```
+
+You can also manually set each of the following optional options:
+
+- SHA
+- Default Branch (master by default)
+- Branch Name
+- Domain Name (github.com by default)
+- Protocol (https by default)
+
+```ruby
+Peek.into Peek::Views::Git, \
+  :sha => '740f6b7b11b8717efaf51ddb98ce23394544f7e0',
+  :default_branch => 'rails4.0',
+  :branch_name => 'integration',
+  :domain => 'github.com',
+  :protocol => 'https'
+```
+
+## Using Peek::Git on Heroku
+
+Unfortunately Heroku [removes](https://devcenter.heroku.com/articles/slug-compiler#compilation)
+the .git directory during slug compilation which doesn't make it possible to
+view the current deployed SHA or branch.
+
+The one workaround is to set the GIT_SHA and GIT_BRANCH ENV variables within
+your deploy process.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/views/peek/views/_git.html.erb

@@ -0,0 +1,10 @@
+<div class="bucket">
+  <%= view.branch_name %>
+  <span class="hidden">
+    <% if view.nwo? %>
+      <a href="<%= view.compare_url %>" target="_blank"><%= view.short_sha %></a>
+    <% else %>
+      <%= view.short_sha %>
+    <% end %>
+  </span>
+</div>

data/lib/peek-git.rb

@@ -0,0 +1,3 @@
+require 'peek/views/git'
+require 'peek-git/version'
+require 'peek-git/railtie'

data/lib/peek-git/railtie.rb

@@ -0,0 +1,6 @@
+module Peek
+  module Git
+    class Railtie < ::Rails::Engine
+    end
+  end
+end

data/lib/peek-git/version.rb

@@ -0,0 +1,5 @@
+module Peek
+  module Git
+    VERSION = '1.0.1'
+  end
+end

data/lib/peek/views/git.rb

@@ -0,0 +1,48 @@
+module Peek
+  module Views
+    class Git < View
+      # A view to get some insight into the current state of git
+      # for your project. It gives you the sha, branch, and compare
+      # url.
+      #
+      # nwo             - The repository (name with owner).
+      # default_branch  - master may not be your default branch.
+      # branch_name     - The current branch name (Optional).
+      # sha             - The current SHA for git (Optional).
+      # domain          - Domain name of the location of the repository (Default: github.com).
+      # protocol        - The protocol to use in the compare_url (Default: https).
+      #
+      # Returns Peek::Views::Git
+      def initialize(options = {})
+        @nwo = options.delete(:nwo)
+        @default_branch = options.fetch(:default_branch, 'master')
+        @branch_name = options.delete(:branch_name)
+        @sha = options.delete(:sha)
+        @domain = options.fetch(:domain, 'github.com')
+        @protocol = options.fetch(:protocol, 'https')
+      end
+
+      def nwo?
+        !!@nwo
+      end
+
+      # Fetch the current branch name.
+      def branch_name
+        @branch_name ||= ENV['GIT_BRANCH'] || `git rev-parse --abbrev-ref HEAD`.chomp
+      end
+
+      # Fetch the current sha if one isn't present.
+      def sha
+        @sha ||= ENV['GIT_SHA'] || `git rev-parse HEAD`.chomp
+      end
+
+      def short_sha
+        sha[0..6]
+      end
+
+      def compare_url
+        "#{@protocol}://#{@domain}/#{@nwo}/compare/#{@default_branch}...#{sha}"
+      end
+    end
+  end
+end

data/peek-git.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'peek-git/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'peek-git'
+  gem.version       = Peek::Git::VERSION
+  gem.authors       = ['Garrett Bjerkhoel']
+  gem.email         = ['me@garrettbjerkhoel.com']
+  gem.description   = %q{Take a peek into the Git info of your Rails application.}
+  gem.summary       = %q{Take a peek into the Git info of your Rails application.}
+  gem.homepage      = 'https://github.com/peek/peek-git'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'peek'
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: peek-git
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Garrett Bjerkhoel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: peek
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Take a peek into the Git info of your Rails application.
+email:
+- me@garrettbjerkhoel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/peek/views/_git.html.erb
+- lib/peek-git.rb
+- lib/peek-git/railtie.rb
+- lib/peek-git/version.rb
+- lib/peek/views/git.rb
+- peek-git.gemspec
+homepage: https://github.com/peek/peek-git
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Take a peek into the Git info of your Rails application.
+test_files: []