peek-git 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/CHANGELOG.md ADDED
@@ -0,0 +1,7 @@
1
+ # 1.0
2
+
3
+ * Initial release
4
+
5
+ # 1.0.1
6
+
7
+ * Added support for GIT_SHA and GIT_BRANCH env variables instead of shelling out to fetch them.
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in peek-git.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Garrett Bjerkhoel
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,72 @@
1
+ # Peek::Git
2
+
3
+ Take a peek into the Git info of your Rails application.
4
+
5
+ Things this peek view provides:
6
+
7
+ - View the current branch name
8
+ - Compare the diff of the current revision on your GitHub repo
9
+
10
+ ## Installation
11
+
12
+ Add this line to your application's Gemfile:
13
+
14
+ gem 'peek-git'
15
+
16
+ And then execute:
17
+
18
+ $ bundle
19
+
20
+ Or install it yourself as:
21
+
22
+ $ gem install peek-git
23
+
24
+ ## Usage
25
+
26
+ Add the following to your `config/initializers/peek.rb`:
27
+
28
+ ```ruby
29
+ Peek.into Peek::Views::Git
30
+ ```
31
+
32
+ You will need to set the GitHub project's name with owner if you plan on
33
+ comparing the current ref against your default branch on GitHub.
34
+
35
+ ```ruby
36
+ # nwo - name with owner - owner/name
37
+ Peek.into Peek::Views::Git, :nwo => 'dewski/json_builder'
38
+ ```
39
+
40
+ You can also manually set each of the following optional options:
41
+
42
+ - SHA
43
+ - Default Branch (master by default)
44
+ - Branch Name
45
+ - Domain Name (github.com by default)
46
+ - Protocol (https by default)
47
+
48
+ ```ruby
49
+ Peek.into Peek::Views::Git, \
50
+ :sha => '740f6b7b11b8717efaf51ddb98ce23394544f7e0',
51
+ :default_branch => 'rails4.0',
52
+ :branch_name => 'integration',
53
+ :domain => 'github.com',
54
+ :protocol => 'https'
55
+ ```
56
+
57
+ ## Using Peek::Git on Heroku
58
+
59
+ Unfortunately Heroku [removes](https://devcenter.heroku.com/articles/slug-compiler#compilation)
60
+ the .git directory during slug compilation which doesn't make it possible to
61
+ view the current deployed SHA or branch.
62
+
63
+ The one workaround is to set the GIT_SHA and GIT_BRANCH ENV variables within
64
+ your deploy process.
65
+
66
+ ## Contributing
67
+
68
+ 1. Fork it
69
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
70
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
71
+ 4. Push to the branch (`git push origin my-new-feature`)
72
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,10 @@
1
+ <div class="bucket">
2
+ <%= view.branch_name %>
3
+ <span class="hidden">
4
+ <% if view.nwo? %>
5
+ <a href="<%= view.compare_url %>" target="_blank"><%= view.short_sha %></a>
6
+ <% else %>
7
+ <%= view.short_sha %>
8
+ <% end %>
9
+ </span>
10
+ </div>
data/lib/peek-git.rb ADDED
@@ -0,0 +1,3 @@
1
+ require 'peek/views/git'
2
+ require 'peek-git/version'
3
+ require 'peek-git/railtie'
@@ -0,0 +1,6 @@
1
+ module Peek
2
+ module Git
3
+ class Railtie < ::Rails::Engine
4
+ end
5
+ end
6
+ end
@@ -0,0 +1,5 @@
1
+ module Peek
2
+ module Git
3
+ VERSION = '1.0.1'
4
+ end
5
+ end
@@ -0,0 +1,48 @@
1
+ module Peek
2
+ module Views
3
+ class Git < View
4
+ # A view to get some insight into the current state of git
5
+ # for your project. It gives you the sha, branch, and compare
6
+ # url.
7
+ #
8
+ # nwo - The repository (name with owner).
9
+ # default_branch - master may not be your default branch.
10
+ # branch_name - The current branch name (Optional).
11
+ # sha - The current SHA for git (Optional).
12
+ # domain - Domain name of the location of the repository (Default: github.com).
13
+ # protocol - The protocol to use in the compare_url (Default: https).
14
+ #
15
+ # Returns Peek::Views::Git
16
+ def initialize(options = {})
17
+ @nwo = options.delete(:nwo)
18
+ @default_branch = options.fetch(:default_branch, 'master')
19
+ @branch_name = options.delete(:branch_name)
20
+ @sha = options.delete(:sha)
21
+ @domain = options.fetch(:domain, 'github.com')
22
+ @protocol = options.fetch(:protocol, 'https')
23
+ end
24
+
25
+ def nwo?
26
+ !!@nwo
27
+ end
28
+
29
+ # Fetch the current branch name.
30
+ def branch_name
31
+ @branch_name ||= ENV['GIT_BRANCH'] || `git rev-parse --abbrev-ref HEAD`.chomp
32
+ end
33
+
34
+ # Fetch the current sha if one isn't present.
35
+ def sha
36
+ @sha ||= ENV['GIT_SHA'] || `git rev-parse HEAD`.chomp
37
+ end
38
+
39
+ def short_sha
40
+ sha[0..6]
41
+ end
42
+
43
+ def compare_url
44
+ "#{@protocol}://#{@domain}/#{@nwo}/compare/#{@default_branch}...#{sha}"
45
+ end
46
+ end
47
+ end
48
+ end
data/peek-git.gemspec ADDED
@@ -0,0 +1,21 @@
1
+ # -*- encoding: utf-8 -*-
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'peek-git/version'
5
+
6
+ Gem::Specification.new do |gem|
7
+ gem.name = 'peek-git'
8
+ gem.version = Peek::Git::VERSION
9
+ gem.authors = ['Garrett Bjerkhoel']
10
+ gem.email = ['me@garrettbjerkhoel.com']
11
+ gem.description = %q{Take a peek into the Git info of your Rails application.}
12
+ gem.summary = %q{Take a peek into the Git info of your Rails application.}
13
+ gem.homepage = 'https://github.com/peek/peek-git'
14
+
15
+ gem.files = `git ls-files`.split($/)
16
+ gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
17
+ gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
18
+ gem.require_paths = ['lib']
19
+
20
+ gem.add_dependency 'peek'
21
+ end
metadata ADDED
@@ -0,0 +1,73 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: peek-git
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.1
5
+ prerelease:
6
+ platform: ruby
7
+ authors:
8
+ - Garrett Bjerkhoel
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+ date: 2013-03-28 00:00:00.000000000 Z
13
+ dependencies:
14
+ - !ruby/object:Gem::Dependency
15
+ name: peek
16
+ requirement: !ruby/object:Gem::Requirement
17
+ none: false
18
+ requirements:
19
+ - - ! '>='
20
+ - !ruby/object:Gem::Version
21
+ version: '0'
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - ! '>='
28
+ - !ruby/object:Gem::Version
29
+ version: '0'
30
+ description: Take a peek into the Git info of your Rails application.
31
+ email:
32
+ - me@garrettbjerkhoel.com
33
+ executables: []
34
+ extensions: []
35
+ extra_rdoc_files: []
36
+ files:
37
+ - .gitignore
38
+ - CHANGELOG.md
39
+ - Gemfile
40
+ - LICENSE.txt
41
+ - README.md
42
+ - Rakefile
43
+ - app/views/peek/views/_git.html.erb
44
+ - lib/peek-git.rb
45
+ - lib/peek-git/railtie.rb
46
+ - lib/peek-git/version.rb
47
+ - lib/peek/views/git.rb
48
+ - peek-git.gemspec
49
+ homepage: https://github.com/peek/peek-git
50
+ licenses: []
51
+ post_install_message:
52
+ rdoc_options: []
53
+ require_paths:
54
+ - lib
55
+ required_ruby_version: !ruby/object:Gem::Requirement
56
+ none: false
57
+ requirements:
58
+ - - ! '>='
59
+ - !ruby/object:Gem::Version
60
+ version: '0'
61
+ required_rubygems_version: !ruby/object:Gem::Requirement
62
+ none: false
63
+ requirements:
64
+ - - ! '>='
65
+ - !ruby/object:Gem::Version
66
+ version: '0'
67
+ requirements: []
68
+ rubyforge_project:
69
+ rubygems_version: 1.8.23
70
+ signing_key:
71
+ specification_version: 3
72
+ summary: Take a peek into the Git info of your Rails application.
73
+ test_files: []