saddler-reporter-support-git 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1be3da4bb0b294f83f818e1ccfc9031301483ea
-  data.tar.gz: d410d009d669ce45ff284998450034aaac1b1c60
+  metadata.gz: 791fbc59ee6f9975cc615618032da76f14a566fb
+  data.tar.gz: 874531ac3acb2e0105ec6757d33d9b4d62306031
 SHA512:
-  metadata.gz: dcbb55f3391a75a0c3b3b7b5cd296f3fb168130cd9851dded82f063043327e54bb760d8bac1af4adbc8c65f429ae0e4c2135cc0814615e675dcf4fab8fddc0b3
-  data.tar.gz: 4abdda305707fb6e4c9f365a19bf6ebecec3a3704cae5dd47737aaf7f811427670f2820df270d9e9e56ef60c5088bce44d038debf3ffa601e35713d9fd5fe03a
+  metadata.gz: d2a8572d1667f8a45ffd920b25572f7fc10bb9c2fe4a0886d42706141408bebe25d2b76f1ba4d80ef442c8360278eec8cc74435c26dea524f93d2e5030c3d7b1
+  data.tar.gz: 6ae636cc3970b888a719386fe8a1f0c7fefaf0b203f57fab8290229be6424031194505325927ec24d09f382aea4efe6153ac3bc2f4687593d282b706cd669a0c

data/.conventional-changelog.context.js

@@ -0,0 +1,17 @@
+'use strict';
+var execSync = require('child_process').execSync;
+var URI = require('urijs');
+
+var gemspec = JSON.parse(execSync('bundle exec parse-gemspec-cli saddler-reporter-support-git.gemspec'));
+var homepageUrl = gemspec.homepage;
+var url = new URI(homepageUrl);
+var host = url.protocol() + '://' + url.authority();
+var owner = url.pathname().split('/')[1];
+var repository = url.pathname().split('/')[2];
+
+module.exports = {
+  version: gemspec.version,
+  host: host,
+  owner: owner,
+  repository: repository
+};

data/.rubocop.yml

@@ -12,6 +12,3 @@ Metrics/LineLength:
 Style/FileName:
   Exclude:
     - exe/*
-
-Style/RegexpLiteral:
-  MaxSlashes: 0

data/.travis.yml

@@ -1,15 +1,17 @@
-language: ruby
+language: "ruby"
 sudo: false
 rvm:
-  - 1.9
-  - 2.0
-  - 2.1
-  - 2.2
+  - "1.9"
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - "ruby-head"
+matrix:
+  allow_failures:
+    - rvm: "ruby-head"
 before_install:
-  - gem update bundler
+  - "gem update bundler"
+  - "bin/setup"
 notifications:
   email:
     - ogataken@gmail.com
-branches:
-  only:
-    - master

data/CHANGELOG.md

@@ -1,28 +1,37 @@
-## Change Log
+<a name="0.2.0"></a>
+# [0.2.0](https://github.com/packsaddle/ruby-saddler-reporter-support-git/compare/v0.1.8...v0.2.0) (2015-09-29)
 
-### v0.1.8 (2015/07/27 00:01 +00:00)
+* **branch:** use `env_branch`.
+
+### Bug Fixes
+
+* **endpoint:** empty string brings unexpected behavior ([94d245a](https://github.com/packsaddle/ruby-saddler-reporter-support-git/commit/94d245a))
+* **git:** remove deperecated method #master and #origin_master ([546fdaf](https://github.com/packsaddle/ruby-saddler-reporter-support-git/commit/546fdaf))
+
+
+# v0.1.8 (2015/07/27 00:01 +00:00)
 - [#16](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/16) fix(merging-sha): remove hard-corded branch name (@sanemat)
 - [#14](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/14) chore(gem): relax dependencies (@sanemat)
 - [#13](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/13) chore(changelog): use github-changes (@sanemat)
 
-### v0.1.7 (2015/03/06 08:45 +00:00)
+# v0.1.7 (2015/03/06 08:45 +00:00)
 - [#11](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/11) chore(gem): use git_clone_url (@sanemat)
 
-### v0.1.6 (2015/03/05 18:23 +00:00)
+# v0.1.6 (2015/03/05 18:23 +00:00)
 - [#10](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/10) Revert "Merge pull request #9 from packsaddle/chore/use-uri-sshgit" (@sanemat)
 
-### v0.1.5 (2015/03/05 03:44 +00:00)
+# v0.1.5 (2015/03/05 03:44 +00:00)
 - [#9](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/9) chore(gem): use uri-ssh_git instead of addressable if ssh protocol (@sanemat)
 - [#8](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/8) chore(travisci): power-assert v0.2.3 (@sanemat)
 
-### v0.1.4 (2015/02/26 05:53 +00:00)
+# v0.1.4 (2015/02/26 05:53 +00:00)
 - [#7](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/7) feat(circleci): detect circle ci branch (@sanemat)
 
-### v0.1.3 (2015/02/25 14:01 +00:00)
+# v0.1.3 (2015/02/25 14:01 +00:00)
 - [#6](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/6) feat(merging object): add merging object implementation (@sanemat)
 
-### v0.1.2 (2015/02/25 09:44 +00:00)
+# v0.1.2 (2015/02/25 09:44 +00:00)
 - [#4](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/4) Refactor/test git repo mocha (@sanemat)
 
-### v0.1.1 (2015/02/24 17:37 +00:00)
+# v0.1.1 (2015/02/24 17:37 +00:00)
 - [#1](https://github.com/packsaddle/ruby-saddler-reporter-support-git/pull/1) feat(travis): add env current branch (@sanemat)

data/Gemfile

@@ -5,3 +5,6 @@ gemspec
 
 gem 'byebug' if RUBY_VERSION >= '2.0.0'
 gem 'pry'
+gem 'rubocop'
+gem 'parse_gemspec-cli'
+gem 'yard'

data/README.md

@@ -1,7 +1,31 @@
 # Saddler::Reporter::Support::Git
 
-[![Gem Version](http://img.shields.io/gem/v/saddler-reporter-support-git.svg?style=flat)](http://badge.fury.io/rb/saddler-reporter-support-git)
-[![Build Status](http://img.shields.io/travis/packsaddle/ruby-saddler-reporter-support-git/master.svg?style=flat)](https://travis-ci.org/packsaddle/ruby-saddler-reporter-support-git)
+[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url] [![yard docs][docs-image]][docs-url]
+
+> Utilities for Saddler reporter and git repository.
+
+
+## API
+
+
+*[details][docs-url]*.
+
+
+#### Build API document
+
+##### On local file
+
+`bundle exec doc`.
+
+##### On local server
+
+`bundle exec yard server -r` and `open http://localhost:8808`.
+
+
+## Changelog
+
+[CHANGELOG.md](./CHANGELOG.md).
+
 
 ## Installation
 
@@ -19,18 +43,13 @@ Or install it yourself as:
 
     $ gem install saddler-reporter-support-git
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-### Change log
-
-```bash
-npm install -g github-changes
-github-changes -o packsaddle -r ruby-saddler-reporter-support-git --only-pulls --use-commit-body
-```
 
 ## Contributing
 
@@ -39,3 +58,17 @@ github-changes -o packsaddle -r ruby-saddler-reporter-support-git --only-pulls -
 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
+
+
+## License
+
+© [sanemat](http://sane.jp)
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[travis-url]: https://travis-ci.org/packsaddle/ruby-saddler-reporter-support-git
+[travis-image]: https://img.shields.io/travis/packsaddle/ruby-saddler-reporter-support-git/master.svg?style=flat-square&label=build%20%28linux%29
+[gem-url]: https://rubygems.org/gems/saddler-reporter-support-git
+[gem-image]: http://img.shields.io/gem/v/saddler-reporter-support-git.svg?style=flat-square
+[docs-url]: http://www.rubydoc.info/gems/saddler-reporter-support-git
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg?style=flat-square

data/Rakefile

@@ -8,3 +8,12 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task default: :test
+
+require 'yard'
+require 'yard/rake/yardoc_task'
+DOC_FILES = ['lib/**/*.rb']
+DOC_OPTIONS = ['--debug', '--verbose']
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = DOC_FILES
+  t.options = DOC_OPTIONS if Rake.application.options.trace
+end

data/bin/setup

@@ -1,7 +1,15 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
+#!/usr/bin/env ruby
 
-bundle install
-
-# Do any other automated setup that you need to do here
+require 'open3'
+unless ENV['CI']
+  out, err, status = Open3.capture3(*%w(bundle install))
+  $stdout.puts out
+  $stderr.puts err
+  exit status.exitstatus if !status.exitstatus.nil? && status.exitstatus != 0
+end
+unless ENV['CI']
+  out, err, status = Open3.capture3(*%w(npm install))
+  $stdout.puts out
+  $stderr.puts err
+  exit status.exitstatus if !status.exitstatus.nil? && status.exitstatus != 0
+end

data/lib/saddler/reporter/support/git/repository.rb

@@ -2,13 +2,21 @@ module Saddler
   module Reporter
     module Support
       module Git
+        # Git repository support utility for saddler-reporter
         class Repository
           attr_reader :git
+          # @!attribute [r] git
+          #   @return [::Git] git repository object
 
+          # Build git repository support utility object
+          #
+          # @param path [String] working_dir
+          # @param options [Hash] Git.open options (see ::Git.open)
           def initialize(path, options = {})
             @git = ::Git.open(path, options)
           end
 
+          # @return [String] `user/repo` from remote_urls
           def slug
             slug_regex = %r{\A/(?<slug>.*?)(?:\.git)?\Z}
             remote_urls.map do |url|
@@ -18,20 +26,24 @@ module Saddler
             end.compact.first
           end
 
+          # @return [Array<String>] remote urls
           def remote_urls
             @git
               .remotes
               .map(&:url)
           end
 
+          # @return [String] current branch name
           def current_branch
             env_current_branch || @git.current_branch
           end
 
+          # @return [::Git::Object] git object for `HEAD`
           def head
             @git.object('HEAD')
           end
 
+          # @return [String] merging_object's sha
           def merging_sha
             merging_object.sha
           end
@@ -40,6 +52,8 @@ module Saddler
           # if head is commit which already merged,
           # head's parent objects include merging object
           # and (master or origin/master)
+          #
+          # @return [::Git::Object] merging object
           def merging_object
             return head unless merge_commit?(head)
             commit = head.parents.select do |parent|
@@ -49,31 +63,29 @@ module Saddler
             head # fallback
           end
 
-          def master
-            warn "[DEPRECATION] `#{self.class.name}#master` is deprecated.  Please use `#tracking` instead."
-            tracking
-          end
-
+          # @return [::Git::Object] git object for `tracking_branch_name`
           def tracking
             @git.object(tracking_branch_name)
           end
 
-          def origin_master
-            warn "[DEPRECATION] `#{self.class.name}#origin_master` is deprecated.  Please use `#origin_tracking` instead."
-            origin_tracking
-          end
-
+          # @return [::Git::Object] git object for `origin/tracking_branch_name`
           def origin_tracking
             @git.object("origin/#{tracking_branch_name}")
           end
 
+          # @return [::Git::Config] git config instance
           def config
             @git.config
           end
 
-          # http://stackoverflow.com/questions/4950725/how-do-i-get-git-to-show-me-which-branches-are-tracking-what
-          # { "branch.spike/no-valid-master.merge" => "refs/heads/develop" }
-          # => "develop"
+          # @example tracking branch
+          #   # from git config
+          #   { "branch.spike/no-valid-master.merge" => "refs/heads/develop" }
+          #   => "develop"
+          #
+          # @return [String] tracking branch name
+          #
+          # @see http://stackoverflow.com/questions/4950725/how-do-i-get-git-to-show-me-which-branches-are-tracking-what
           def tracking_branch_name
             config
               .select { |k, _| /\Abranch.*merge\Z/ =~ k }
@@ -86,30 +98,36 @@ module Saddler
               .shift
           end
 
+          # @param commit [::Git::Object]
+          #
+          # @return [Boolean] true if commit is a merge commit
           def merge_commit?(commit)
             commit.parents.count == 2
           end
 
+          # @return [String] push endpoint (defaults to: 'github.com')
           def push_endpoint
             (env_push_endpoint || 'github.com').chomp('/')
           end
 
-          # e.g. 'github.com'
-          # git@github.com:packsaddle/ruby-saddler-reporter-support-git.git
+          # @example via ssh
+          #   'git@github.com:packsaddle/ruby-saddler-reporter-support-git.git'
+          #   #=> 'github.com'
+          #
+          # @return [String, nil] push endpoint from env
           def env_push_endpoint
-            if ENV['PUSH_ENDPOINT']
-              ENV['PUSH_ENDPOINT']
-            end
+            ENV['PUSH_ENDPOINT'] if ENV['PUSH_ENDPOINT'] && !ENV['PUSH_ENDPOINT'].empty?
           end
 
+          # @return [String, nil] current branch name from env
           def env_current_branch
-            if ENV['CURRENT_BRANCH']
-              ENV['CURRENT_BRANCH']
-            elsif ENV['TRAVIS_BRANCH']
-              ENV['TRAVIS_BRANCH']
-            elsif ENV['CIRCLE_BRANCH']
-              ENV['CIRCLE_BRANCH']
+            env_branch = EnvBranch.new do
+              if ENV['CURRENT_BRANCH'] &&
+                 !ENV['CURRENT_BRANCH'].empty?
+                ENV['CURRENT_BRANCH']
+              end
             end
+            env_branch.branch_name
           end
         end
       end

data/lib/saddler/reporter/support/git/version.rb

@@ -2,7 +2,7 @@ module Saddler
   module Reporter
     module Support
       module Git
-        VERSION = '0.1.8'
+        VERSION = '0.2.0'
       end
     end
   end

data/lib/saddler/reporter/support/git.rb

@@ -1,13 +1,14 @@
 require 'git'
 require 'git_clone_url'
+require 'env_branch'
 require 'saddler/reporter/support/git/version'
 require 'saddler/reporter/support/git/repository'
 
 module Saddler
   module Reporter
     module Support
+      # Git support utility for saddler-reporter
       module Git
-        # Your code goes here...
       end
     end
   end

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "conventional-changelog": "^0.4.3",
+    "npm-check-updates": "^2.2.4",
+    "urijs": "^1.16.1"
+  },
+  "scripts": {
+    "changelog": "conventional-changelog -i CHANGELOG.md --overwrite --preset angular --context .conventional-changelog.context.js",
+    "ncu": "ncu -u"
+  }
+}

data/saddler-reporter-support-git.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'git'
   spec.add_runtime_dependency 'git_clone_url'
+  spec.add_runtime_dependency 'env_branch'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: saddler-reporter-support-git
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: env_branch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".conventional-changelog.context.js"
 - ".gitignore"
 - ".rubocop.yml"
 - ".tachikoma.yml"
@@ -116,6 +131,7 @@ files:
 - lib/saddler/reporter/support/git.rb
 - lib/saddler/reporter/support/git/repository.rb
 - lib/saddler/reporter/support/git/version.rb
+- package.json
 - saddler-reporter-support-git.gemspec
 homepage: https://github.com/packsaddle/ruby-saddler-reporter-support-git
 licenses:
@@ -142,3 +158,4 @@ signing_key:
 specification_version: 4
 summary: Utilities for Saddler reporter and git repository.
 test_files: []
+has_rdoc: