env_pull_request 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5807ca1bb427da826ceb8d1b9920af4e128c8e1d
-  data.tar.gz: 345f5a86fb03d556437b0a7d53d20e2aeac33720
+  metadata.gz: 88106089988bc4340bab7ffd7186dd7dc57ee7f1
+  data.tar.gz: d9514dbdff941cc991a4bfb3fc6788f1340987f5
 SHA512:
-  metadata.gz: 37b0bd753acd4d291f09ed669fab8beba83a1043492f1283d90beeba0990694cba4b0dbfaa253a29716c5783c1cd8f5211eebf4ff8fed3e015571ce62b85070b
-  data.tar.gz: d99ce49b2c00a4d73ec8b91f31739fc374831677ab64944d8c4eb86e462a356949c44383d0e9e64a39be2adec2bf195d143303845d27fab7aae76daadcbc0e5d
+  metadata.gz: 0df2a6037d20214e683eac3525e489dc9e1a48162633140c896e6213db9060c0e96b9d97d4cbdf6cec21101ca69a81618430e1c2dc715fca9fa0ad8faf806c57
+  data.tar.gz: d131259be0dd51d6380b908b6741d4b673e11e6a62c33becdd76667d1d0d6a0ab5eb459f8017ade6734e64ff382ec72c370c3a9aba01ba5d4bd2a2c8d04c7d5f

data/.travis.yml

@@ -1,5 +1,9 @@
+# CAUTION: DO NOT ADD encrypted value!
+#          test/test_test_helper.rb asserts ENV.
+#          And this will show ENV accidentally in CI log.
 language: "ruby"
 rvm:
+  - "1.9"
   - "2.0"
   - "2.1"
   - "2.2"
@@ -10,3 +14,7 @@ matrix:
 before_install:
   - "gem update bundler"
   - "bin/setup"
+before_script:
+  - "printenv"
+after_script:
+  - "printenv"

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# NOTE
+
+DO NOT ADD encrypted value to environment variable on this repository!
+`test/test_test_helper.rb` asserts `ENV`.
+And this will show `ENV` accidentally in CI log.

data/Gemfile

@@ -4,6 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rubocop'
-gem 'byebug'
+gem 'byebug' if RUBY_VERSION >= '2.0.0'
 gem 'parse_gemspec-cli'
 gem 'yard'

data/README.md

@@ -63,7 +63,7 @@ And more *[details][docs-url]*.
 
 * Travis-ci
     * `ENV['TRAVIS_PULL_REQUEST']`
-    * [Environment Variables - Travis CI](http://docs.travis-ci.com/user/environment-variables/#Convenience-Variables)
+    * [Environment Variables - Travis CI](http://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables)
 * CircleCI
     * `ENV['CIRCLE_PR_NUMBER']`
     * [Environment variables - CircleCI](https://circleci.com/docs/environment-variables#building-pull-requests-that-come-from-forks)

data/changelog.md

@@ -1,3 +1,9 @@
+<a name="0.3.3"></a>
+## [0.3.3](https://github.com/packsaddle/ruby-env_pull_request/compare/v0.3.2...v0.3.3) (2015-09-28)
+
+* Improve document.
+
+
 <a name="0.3.2"></a>
 ## [0.3.2](https://github.com/packsaddle/ruby-env_pull_request/compare/v0.3.1...v0.3.2) (2015-09-27)
 

data/lib/env_pull_request/base.rb

@@ -38,7 +38,24 @@ module EnvPullRequest
 
     # Fetch pull request id from environment variables
     #
+    # travis-ci.org:
+    #   ENV['TRAVIS_PULL_REQUEST']
+    # circleci.com:
+    #   ENV['CIRCLE_PR_NUMBER']
+    # Jenkins GitHub pull request builder plugin:
+    #   ENV['ghprbPullId']
+    #
     # @return [Integer, nil] pull request id or nil
+    #
+    # @see TestHelper.stash_env_pull_request
+    # @see TestHelper.restore_env_pull_request
+    #
+    # @see http://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables
+    #   Environment Variables - Travis CI
+    # @see https://circleci.com/docs/environment-variables#building-pull-requests-that-come-from-forks
+    #   Environment variables - CircleCI
+    # @see https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin#GitHubpullrequestbuilderplugin-EnvironmentVariables
+    #   GitHub pull request builder plugin - Jenkins - Jenkins Wiki
     def fetch_pull_request_id
       if positive_integer_string? ENV['TRAVIS_PULL_REQUEST']
         ENV['TRAVIS_PULL_REQUEST'].to_i

data/lib/env_pull_request/test_helper.rb

@@ -7,8 +7,10 @@ module EnvPullRequest
       # And delete for testing.
       #
       # @example with test-unit
+      #   require 'env_pull_request/test_helper'
+      #
       #   class TestExample < Test::Unit::TestCase
-      #     extend TestHelper
+      #     extend ::EnvPullRequest::TestHelper
       #
       #     def self.startup
       #       stash_env_pull_request
@@ -16,8 +18,9 @@ module EnvPullRequest
       #   end
       #
       # @return [void]
+      #
+      # @see Base#fetch_pull_request_id
       def stash_env_pull_request
-        # NOTE: stash and restore only if exists
         @original_travis_pull_request = ENV['TRAVIS_PULL_REQUEST']
         @original_circle_pr_number = ENV['CIRCLE_PR_NUMBER']
         @original_ghprb_pull_id = ENV['ghprbPullId']
@@ -29,8 +32,10 @@ module EnvPullRequest
       # Restore original environment variables for pull request.
       #
       # @example with test-unit
+      #   require 'env_pull_request/test_helper'
+      #
       #   class TestExample < Test::Unit::TestCase
-      #     extend TestHelper
+      #     extend ::EnvPullRequest::TestHelper
       #
       #     def self.shutdown
       #       restore_env_pull_request
@@ -38,6 +43,8 @@ module EnvPullRequest
       #   end
       #
       # @return [void]
+      #
+      # @see Base#fetch_pull_request_id
       def restore_env_pull_request
         ENV['TRAVIS_PULL_REQUEST'] = @original_travis_pull_request
         ENV['CIRCLE_PR_NUMBER'] = @original_circle_pr_number

data/lib/env_pull_request/version.rb

@@ -1,3 +1,3 @@
 module EnvPullRequest
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_pull_request
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-27 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: natural_number_string
@@ -78,6 +78,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md