env_pull_request 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ba38643c766d13bd2fb05c8d7d482fb59836a43
-  data.tar.gz: 35d3e3cae056c0ead8c2b311e590f85cc5154912
+  metadata.gz: 5807ca1bb427da826ceb8d1b9920af4e128c8e1d
+  data.tar.gz: 345f5a86fb03d556437b0a7d53d20e2aeac33720
 SHA512:
-  metadata.gz: f5402e2bf90a50fd71f4c70cc1ba9eb2e7207c01bf45dc5ebad53dd6ebdde73342d5c19476618b5d2eff27d24a54fac1cfa63946d425c278f1d605f5c3eac473
-  data.tar.gz: 50338038c118c3e26b036ddf056a802c760de30de82199f22a6aaee2dfd4799661354dd3069cd76b7a1a5ea73d41e2b9dc507cdf9ab0eb5b67ec3a545e82a30c
+  metadata.gz: 37b0bd753acd4d291f09ed669fab8beba83a1043492f1283d90beeba0990694cba4b0dbfaa253a29716c5783c1cd8f5211eebf4ff8fed3e015571ce62b85070b
+  data.tar.gz: d99ce49b2c00a4d73ec8b91f31739fc374831677ab64944d8c4eb86e462a356949c44383d0e9e64a39be2adec2bf195d143303845d27fab7aae76daadcbc0e5d

data/Gemfile

@@ -3,8 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in env_pull_request.gemspec
 gemspec
 
-group :development do
-  gem 'rubocop', group: :test
-  gem 'byebug', group: :test
-  gem 'parse_gemspec-cli'
-end
+gem 'rubocop'
+gem 'byebug'
+gem 'parse_gemspec-cli'
+gem 'yard'

data/README.md

@@ -1,6 +1,6 @@
 # EnvPullRequest
 
-[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url]
+[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url] [![yard docs][docs-image]][docs-url]
 
 > Get PULL_REQUEST_ID from environment variables.
 
@@ -15,9 +15,49 @@ env_pull.pull_request? #=> true
 env_pull.pull_request_id #=> 800
 ```
 
+### User defined block
+
+```ruby
+require 'env_pull_request'
+require 'natural_number_string'
+
+env_pull =
+  EnvPullRequest.new do
+    if NaturalNumberString.positive_integer_string? ENV['PULL_REQUEST_ID']
+      ENV['PULL_REQUEST_ID'].to_i
+    end
+  end
+env_pull.pull_request? #=> true
+env_pull.pull_request_id #=> 800
+```
+
 
 ## API
 
+### EnvPullRequest.new -> Base
+
+### EnvPullRequest.new(&block) -> Base
+
+#### block
+
+*optional*
+
+Type: `block`
+
+User defined block for getting `pull request id`.
+
+
+### Base#pull_request_id -> Integer | nil
+
+Return pull request id or nil.
+
+
+### Base#pull_request? -> boolean
+
+Return true if this is pull request.
+
+And more *[details][docs-url]*.
+
 
 ## Supported services / applications
 
@@ -76,3 +116,5 @@ The gem is available as open source under the terms of the [MIT License](http://
 [travis-image]: https://img.shields.io/travis/packsaddle/ruby-env_pull_request/master.svg?style=flat-square&label=build%20%28linux%29
 [gem-url]: https://rubygems.org/gems/env_pull_request
 [gem-image]: http://img.shields.io/gem/v/env_pull_request.svg?style=flat-square
+[docs-url]: http://www.rubydoc.info/gems/env_pull_request
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg?style=flat-square

data/Rakefile

@@ -7,3 +7,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/changelog.md

@@ -1,3 +1,9 @@
+<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)
+
+* Improve document.
+
+
 <a name="0.3.1"></a>
 ## [0.3.1](https://github.com/packsaddle/ruby-env_pull_request/compare/v0.3.0...v0.3.1) (2015-09-26)
 

data/lib/env_pull_request.rb

@@ -3,7 +3,28 @@ require 'natural_number_string'
 require 'env_pull_request/base'
 require 'env_pull_request/version'
 
+# Build pull request information from environment variables
 module EnvPullRequest
+  # Build pull request information object from environment variables
+  #
+  # @overload self.new
+  #   @example without user defined block
+  #     env_pull = EnvPullRequest.new
+  #
+  #   @return [Base] Pull request information object
+  #
+  # @overload self.new(&block)
+  #   @example with user defined block
+  #     env_pull =
+  #       EnvPullRequest.new do
+  #         if NaturalNumberString
+  #              .positive_integer_string? ENV['PULL_REQUEST_ID']
+  #           ENV['PULL_REQUEST_ID'].to_i
+  #         end
+  #       end
+  #
+  #   @yield user defined block
+  #   @return [Base] Pull request information object
   def self.new(&block)
     Base.new(&block)
   end

data/lib/env_pull_request/base.rb

@@ -1,8 +1,32 @@
 module EnvPullRequest
+  # Pull request information object from environment variables
   class Base
     include NaturalNumberString
+
     attr_reader :pull_request_id
+    # @!attribute [r] pull_request_id
+    #   @return [Integer, nil] pull request id or nil
 
+    # Build pull request information object from environment variables
+    #
+    # @overload initialize
+    #   @example without user defined block
+    #     env_pull = EnvPullRequest::Base.new
+    #
+    #   @return [Base] pull request information object
+    #
+    # @overload initialize(&block)
+    #   @example with user defined block
+    #     env_pull =
+    #       EnvPullRequest::Base.new do
+    #         if NaturalNumberString
+    #              .positive_integer_string? ENV['PULL_REQUEST_ID']
+    #           ENV['PULL_REQUEST_ID'].to_i
+    #         end
+    #       end
+    #
+    #   @yield user defined block
+    #   @return [Base] pull request information object
     def initialize(&block)
       @pull_request_id =
         if block_given?
@@ -12,6 +36,9 @@ module EnvPullRequest
         end
     end
 
+    # Fetch pull request id from environment variables
+    #
+    # @return [Integer, nil] pull request id or nil
     def fetch_pull_request_id
       if positive_integer_string? ENV['TRAVIS_PULL_REQUEST']
         ENV['TRAVIS_PULL_REQUEST'].to_i
@@ -22,6 +49,7 @@ module EnvPullRequest
       end
     end
 
+    # @return [Boolean] true if this is pull request
     def pull_request?
       !pull_request_id.nil?
     end

data/lib/env_pull_request/test_helper.rb

@@ -1,18 +1,47 @@
 module EnvPullRequest
+  # Test helper for pull request with environment variables
   module TestHelper
-    def stash_env_pull_request
-      @original_travis_pull_request = ENV['TRAVIS_PULL_REQUEST']
-      @original_circle_pr_number = ENV['CIRCLE_PR_NUMBER']
-      @original_ghprb_pull_id = ENV['ghprbPullId']
-      ENV.delete 'TRAVIS_PULL_REQUEST'
-      ENV.delete 'CIRCLE_PR_NUMBER'
-      ENV.delete 'ghprbPullId'
-    end
+    module_function
 
-    def restore_env_pull_request
-      ENV['TRAVIS_PULL_REQUEST'] = @original_travis_pull_request
-      ENV['CIRCLE_PR_NUMBER'] = @original_circle_pr_number
-      ENV['ghprbPullId'] = @original_ghprb_pull_id
-    end
+      # Stash original environment variables for pull request.
+      # And delete for testing.
+      #
+      # @example with test-unit
+      #   class TestExample < Test::Unit::TestCase
+      #     extend TestHelper
+      #
+      #     def self.startup
+      #       stash_env_pull_request
+      #     end
+      #   end
+      #
+      # @return [void]
+      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']
+        ENV.delete 'TRAVIS_PULL_REQUEST'
+        ENV.delete 'CIRCLE_PR_NUMBER'
+        ENV.delete 'ghprbPullId'
+      end
+
+      # Restore original environment variables for pull request.
+      #
+      # @example with test-unit
+      #   class TestExample < Test::Unit::TestCase
+      #     extend TestHelper
+      #
+      #     def self.shutdown
+      #       restore_env_pull_request
+      #     end
+      #   end
+      #
+      # @return [void]
+      def restore_env_pull_request
+        ENV['TRAVIS_PULL_REQUEST'] = @original_travis_pull_request
+        ENV['CIRCLE_PR_NUMBER'] = @original_circle_pr_number
+        ENV['ghprbPullId'] = @original_ghprb_pull_id
+      end
   end
 end

data/lib/env_pull_request/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: env_pull_request
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - sanemat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: natural_number_string
@@ -120,3 +120,4 @@ signing_key:
 specification_version: 4
 summary: Get PULL_REQUEST_ID from environment variables.
 test_files: []
+has_rdoc: