env_branch 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59a9ebce6f2c0af2d0b221313297870deed81cf4
-  data.tar.gz: 6072601810abe9faba4117fd30caad5b34a7fe7a
+  metadata.gz: 4058b3d53fa644c1bcb92445ec4b36e399e1e81b
+  data.tar.gz: 51553be2677fd4ab107c0bcdb5898ff1f33a3b46
 SHA512:
-  metadata.gz: 4402d22e5406531ceb7cc02074f56eae04ad839028b154a64882f7c835166feee74465c493efa6f8cf3dcd58b9271a1c7766861d0a4a6bab04ef303f524bbf52
-  data.tar.gz: 0037c4575b86d0382109dd14981b795b90a20c687fe18dbd45514ea346daae95d4d58f07f558b7213a9f8475c0f4bb5d0b0c609459890dc69748548b2de73502
+  metadata.gz: a9bc77f5838ab92d6ff7172587b5aaedf5e304a4a9f3062f7aa7aad4cef6f7e43347dd116254c50a366ada75288f624418b070ec64046e533f83a96d01d60a05
+  data.tar.gz: 70703f2a07317362253dc88d26b1de3160354e38806dd8428db391b4c6f65460ef5cbb836b9b46f99dffd46268d03409812eeeb5358d4fde2292abd1a42e1f32

data/README.md

@@ -1,8 +1,78 @@
 # EnvBranch
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/env_branch`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem version][gem-image]][gem-url] [![Travis-CI Status][travis-image]][travis-url] [![yard docs][docs-image]][docs-url]
 
-TODO: Delete this and the text above, and describe your gem
+> Get BRANCH_NAME from environment variables.
+
+
+## Usage
+
+```ruby
+require 'env_branch'
+
+env_branch = EnvBranch.new
+env_branch.branch? #=> true
+env_branch.branch_name #=> 'your-branch-name'
+```
+
+### User defined block
+
+```ruby
+require 'env_branch'
+
+env_branch =
+  EnvBranch.new do
+    if ENV['USER_DEFINED_BRANCH'] &&
+       !ENV['USER_DEFINED_BRANCH'].empty?
+      ENV['USER_DEFINED_BRANCH']
+    end
+  end
+
+env_branch.branch? #=> true
+env_branch.branch_name #=> 'your-branch-name'
+```
+
+
+## API
+
+### EnvBranch.new -> Base
+
+### EnvBranch.new(&block) -> Base
+
+#### block
+
+*optional*
+
+Type: `block`
+
+User defined block for getting `branch name`.
+
+
+### Base#branch_name -> String | nil
+
+Return branch name or nil.
+
+
+### Base#branch? -> boolean
+
+Return true if this has branch name.
+
+And more *[details][docs-url]*.
+
+
+## Supported services / applications
+
+* Travis-ci
+    * `ENV['TRAVIS_BRANCH']`
+    * [Environment Variables - Travis CI](http://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables)
+* CircleCI
+    * `ENV['CIRCLE_BRANCH']`
+    * [Environment variables - CircleCI](https://circleci.com/docs/environment-variables#build-details)
+
+
+## Changelog
+
+[changelog.md](./changelog.md).
 
 ## Installation
 
@@ -20,22 +90,28 @@ Or install it yourself as:
 
     $ gem install env_branch
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/env_branch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/packsaddle/ruby-env_branch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## 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-env_branch
+[travis-image]: https://img.shields.io/travis/packsaddle/ruby-env_branch/master.svg?style=flat-square&label=build%20%28linux%29
+[gem-url]: https://rubygems.org/gems/env_branch
+[gem-image]: http://img.shields.io/gem/v/env_branch.svg?style=flat-square
+[docs-url]: http://www.rubydoc.info/gems/env_branch
+[docs-image]: https://img.shields.io/badge/yard-docs-blue.svg?style=flat-square

data/changelog.md

@@ -1,3 +1,9 @@
+<a name="0.2.1"></a>
+## [0.2.1](https://github.com/packsaddle/ruby-env_branch/compare/v0.2.0...v0.2.1) (2015-09-28)
+
+* Improve document.
+
+
 <a name="0.2.0"></a>
 # [0.2.0](https://github.com/packsaddle/ruby-env_branch/compare/v0.1.1...v0.2.0) (2015-09-28)
 

data/env_branch.gemspec

@@ -10,9 +10,9 @@ Gem::Specification.new do |spec|
   spec.email         = ['o.gata.ken@gmail.com']
 
   spec.summary       =
-    'Get BRANCH from environment variables.'
+    'Get BRANCH_NAME from environment variables.'
   spec.description   =
-    'Get BRANCH from environment variables.'
+    'Get BRANCH_NAME from environment variables.'
   spec.homepage      = 'https://github.com/packsaddle/ruby-env_branch'
   spec.license       = 'MIT'
 

data/lib/env_branch/base.rb

@@ -1,7 +1,30 @@
 module EnvBranch
+  # Branch information object from environment variable
   class Base
     attr_reader :branch_name
+    # @!attribute [r] branch_name
+    #   @return [String, nil] branch name or nil
 
+    # Build branch information object from environment variables
+    #
+    # @overload initialize
+    #   @example without user defined block
+    #     env_branch = EnvBranch::Base.new
+    #
+    #   @return [Base] Branch information object
+    #
+    # @overload initialize(&block)
+    #   @example with user defined block
+    #     env_branch =
+    #       EnvBranch::Base.new do
+    #         if ENV['USER_DEFINED_BRANCH'] &&
+    #           !ENV['USER_DEFINED_BRANCH'].empty?
+    #           ENV['USER_DEFINED_BRANCH']
+    #         end
+    #       end
+    #
+    #   @yield user defined block
+    #   @return [Base] Branch information object
     def initialize(&block)
       @branch_name =
         if block_given?
@@ -11,11 +34,18 @@ module EnvBranch
         end
     end
 
+    # Fetch branch name from environment variables
+    #
     # travis-ci.org:
     #   ENV['TRAVIS_BRANCH']
     # circleci.com:
     #   ENV['CIRCLE_BRANCH']
     #
+    # @return [String, nil] branch name or nil
+    #
+    # @see TestHelper.stash_env_branch
+    # @see TestHelper.restore_env_branch
+    #
     # @see http://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables
     #   Environment Variables - Travis CI
     # @see https://circleci.com/docs/environment-variables#build-details
@@ -28,6 +58,7 @@ module EnvBranch
       end
     end
 
+    # @return [Boolean] true if this has branch name
     def branch?
       !branch_name.nil?
     end

data/lib/env_branch/test_helper.rb

@@ -1,7 +1,25 @@
 module EnvBranch
+  # Test helper for branch with environment variables
   module TestHelper
     module_function
 
+    # Stash original environment variables for branch.
+    # And delete for testing.
+    #
+    # @example with test-unit
+    #   require 'env_branch/test_helper'
+    #
+    #   class TestExample < Test::Unit::TestCase
+    #     extend ::EnvBranch::TestHelper
+    #
+    #     def self.startup
+    #       stash_env_branch
+    #     end
+    #   end
+    #
+    # @return [void]
+    #
+    # @see Base#fetch_branch_name
     def stash_env_branch
       @original_travis_branch = ENV['TRAVIS_BRANCH']
       @original_circle_branch = ENV['CIRCLE_BRANCH']
@@ -9,6 +27,22 @@ module EnvBranch
       ENV.delete 'CIRCLE_BRANCH'
     end
 
+    # Restore original environment variables for branch.
+    #
+    # @example with test-unit
+    #   require 'env_branch/test_helper'
+    #
+    #   class TestExample < Test::Unit::TestCase
+    #     extend ::EnvBranch::TestHelper
+    #
+    #     def self.shutdown
+    #       restore_env_branch
+    #     end
+    #   end
+    #
+    # @return [void]
+    #
+    # @see Base#fetch_branch_name
     def restore_env_branch
       ENV['TRAVIS_BRANCH'] = @original_travis_branch
       ENV['CIRCLE_BRANCH'] = @original_circle_branch

data/lib/env_branch/version.rb

@@ -1,3 +1,3 @@
 module EnvBranch
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/lib/env_branch.rb

@@ -1,7 +1,28 @@
 require 'env_branch/base'
 require 'env_branch/version'
 
+# Build branch information from environment variables
 module EnvBranch
+  # Build branch information object from environment variables
+  #
+  # @overload self.new
+  #   @example without user defined block
+  #     env_branch = EnvBranch.new
+  #
+  #   @return [Base] Branch information object
+  #
+  # @overload self.new(&block)
+  #   @example with user defined block
+  #     env_branch =
+  #       EnvBranch.new do
+  #         if ENV['USER_DEFINED_BRANCH'] &&
+  #           !ENV['USER_DEFINED_BRANCH'].empty?
+  #           ENV['USER_DEFINED_BRANCH']
+  #         end
+  #       end
+  #
+  #   @yield user defined block
+  #   @return [Base] Branch information object
   def self.new(&block)
     Base.new(&block)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: env_branch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - sanemat
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Get BRANCH from environment variables.
+description: Get BRANCH_NAME from environment variables.
 email:
 - o.gata.ken@gmail.com
 executables: []
@@ -104,6 +104,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Get BRANCH from environment variables.
+summary: Get BRANCH_NAME from environment variables.
 test_files: []
 has_rdoc: