build_number 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTVkNWYxZDk0MTIyZWYzNzM4MGU4MDU3NDRkNDViYjczNjQ5NTY5Nw==
+    NzI4MTY2MTg1OGJmNDZkZjZjZjk0YjYxZTA3YTc2NDE3ZDQzOGFiOQ==
   data.tar.gz: !binary |-
-    ZThiN2JmZTBhOTJmNWU2MGQ5MzYzZDlkNTE3MjNmMDE2OTBiNjMxOA==
+    NTAwOGU4MTdiNzg3OTdiMTVhMjU3NDg0ZDYyMTVkMzFmM2ZkOGRmYg==
 SHA512:
   metadata.gz: !binary |-
-    YWZiNjIyM2QzMDY1YmNkMjExODhmMDIyYmU4NTQxMzVjZTFjN2Y4MjY2N2Qw
-    MDdkODcyY2ZjN2YxY2ZlZDExMmQ3NGRiNGM1NzBjODYxZjVlMzcyZDQ3M2Zj
-    ZmNkODE5YWM0Y2I4OTQ0M2I5OTM0NGJhMWFhNmRjNjBhNTBiNDQ=
+    MWI1YzVlZDUzZjI4OTFjMjZmMWZiYjQ3YWU3MmRhYzk4ZGU5M2VmMTc2NWZi
+    NTNkYTdhMTMyZDFmODI2NDgxOThlM2ZlN2U2NjdiNTRjZDI3MDZhNDA5ZDM1
+    NWY4MmYwOWNlZjE5ZDY1MWQ1MTNjZTc2M2M0NzZiZjhkNzdjZDM=
   data.tar.gz: !binary |-
-    ZDFlOGFhNTY4YTFiYmJjNWZhY2EwZjkwMzk1NjhlMzcxOWJlMmNhMzM5MjMw
-    ZDA2ZGRhNmNjMzY1OWUxM2Q1MjE1OTE2YjA3NGNiZTk0ZWUzMjVlOGQ3Zjcz
-    OWRlODY2Zjc4NmEyZGU0MDNlYWNiY2RiYjBhZmVjYmJlNzhlMjA=
+    NTFjOWYzYmRmYzRlYzljOTI5NWY0NmM5ZjI0N2U1M2RiMmVkMTU5MDI3YTZh
+    Mzc2MjY4YTlhMjBhNDZjNDBhY2U1MjFkOWRlMzkxZGY0NjM2ZTA3ZWFlYzJl
+    MzI5MDRlYWQyMGVjMmYyOTRlMDg0ZWZhNjBmMjViZGVlM2NkZDg=

data/.semver

@@ -1,6 +1,6 @@
 ---
 :major: 0
 :minor: 1
-:patch: 1
+:patch: 2
 :special: ''
 :metadata: ''

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    build_number (0.1.0)
+    build_number (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -28,7 +28,23 @@ In your project's Rakefile:
 require 'build_number'
 BuildNumber.set_env
 
-# ENV['BUILD_NUMBER'] is now set and incremented for the next build!
+# ENV['BUILD_NUMBER'] is now set and incremented for the next build.
+```
+
+Alternatively, you can get the value directly.  In either case, the value will be incremented only
+once per build.
+
+```ruby
+build_number = BuildNumber.current  # Reads the build number and increments the
+                                    # value for the next build. Subsequent
+                                    # calls return the same value.
+```
+
+You can also customize the name of the environment variable.
+
+```ruby
+BuildNumber.env_var_name = 'A_CUSTOM_ENV_VAR_NAME'
+BuildNumber.set_env
 ```
 
 ## Contributing

data/lib/build_number/version.rb

@@ -1,3 +1,3 @@
 module BuildNumber
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/build_number.rb

@@ -1,12 +1,22 @@
 require 'build_number/version'
 
 module BuildNumber
-  FILE_NAME = '.build_number'
+  STORAGE_FILE_NAME = '.build_number'
+  DEFAULT_ENV_VAR_NAME = 'BUILD_NUMBER'
 
+  # Reads the current build number and sets the appropriate environment variable.
   def self.set_env(dir=nil)
-    ENV['BUILD_NUMBER'] = ENV['BUILD_NUMBER'] || increment(dir).to_s
+    ENV[env_var_name] = ENV[env_var_name] || increment(dir).to_s
   end
 
+  # Returns the current build number.
+  def self.current(dir=nil)
+    set_env(dir)
+    ENV[env_var_name]
+  end
+
+  # Reads and increments the value in the storage file. Returns the
+  # current build number.
   def self.increment(dir=nil)
     file = find_or_create_file dir
 
@@ -15,40 +25,54 @@ module BuildNumber
     end
   end
 
+  # Looks for a storage file in the given directory and returns the path to it.
+  # If not provided the current working directory is used. If no file is found,
+  # parent directories are searched.
   def self.find_or_create_file(dir=nil)
     dir ||= Dir.pwd
-    file = find_file dir
-    file = create_file dir if file.nil?
-    file
+    find_file(dir) || create_file(dir)
   end
 
+  # Returns the value stored in the storage file.
   def self.read(path)
-    file = File.open(path, 'rb')
-    current = file.read.chomp.to_i
-    file.close
-    current
+    File.open(path, 'rb') do |file|
+      file.read.chomp.to_i
+    end
   end
 
-  def self.save(path, next_build_number=0)
-    open(path, 'w') { |io| io.write next_build_number.to_s }
+  # Saves the build number to the storage file.
+  def self.save(path, build_number=0)
+    open(path, 'w') do |io|
+      io.write build_number.to_s
+    end
+  end
+
+  # Gets the name of the environment variable.
+  def self.env_var_name
+    @env_var_name || DEFAULT_ENV_VAR_NAME
+  end
+
+  # Sets the name of the environment variable.
+  def self.env_var_name=(name)
+    @env_var_name = name
   end
 
   private
 
-  def self.find_file(dir=nil)
+  def self.find_file(dir)
     raise "#{dir} is not a directory" unless File.directory? dir
-    file_path = file_name dir
+    path = file_name dir
 
     Dir.chdir dir do
-      until File.exists? file_path do
-        return nil if is_root_path? file_path
-        file_path = parent_path file_path
+      until File.exists? path do
+        return nil if root_path? path
+        path = parent_path path
       end
-      return file_path
+      return path
     end
   end
 
-  def self.is_root_path?(path)
+  def self.root_path?(path)
     File.dirname(path).match(/(\w:\/|\/)$/i)
   end
 
@@ -58,12 +82,12 @@ module BuildNumber
   end
 
   def self.create_file(dir=nil)
-    file = file_name(dir)
-    save file
-    file
+    file_name(dir).tap do |file|
+      save file
+    end
   end
 
   def self.file_name(dir)
-    File.join dir, FILE_NAME
+    File.join dir, STORAGE_FILE_NAME
   end
-end
+end

data/spec/build_number_spec.rb

@@ -2,55 +2,104 @@ require 'tmpdir'
 require 'build_number'
 
 describe BuildNumber do
-  before :each do
-    @tmp_dir = Dir.mktmpdir
-  end
+  BUILD_NUMBER = 'BUILD_NUMBER'
+
+  let(:tmp_dir) { Dir.mktmpdir }
+  let(:build_number) { Random.new.rand(100) }
+  let(:build_number_path) { "#{tmp_dir}/.build_number" }
 
   after :each do
-    FileUtils.remove_entry_secure @tmp_dir
+    FileUtils.remove_entry_secure tmp_dir
+    ENV.delete(BUILD_NUMBER)
   end
 
-  it 'should create a .build_number file when none exists' do
-    path = BuildNumber.find_or_create_file @tmp_dir
-    path.should eq("#{@tmp_dir}/.build_number")
+  it 'should set the env var' do
+    BuildNumber.set_env tmp_dir
+    ENV.include?(BUILD_NUMBER).should be_true
   end
 
-  it 'should find the .build_number file in parent directory' do
-    path = BuildNumber.find_or_create_file @tmp_dir
+  it 'should return same build number' do
+    current1 = BuildNumber.current tmp_dir
+    current2 = BuildNumber.current tmp_dir
 
-    nested_dir = "#{File.dirname(path)}/deeply/nested/path"
-    FileUtils.mkdir_p nested_dir
-    BuildNumber.find_or_create_file(nested_dir).should eq(path)
+    current1.should eq(current2)
   end
 
-  it 'should save and load build number' do
-    build_number = random_build_number
-    path = BuildNumber.find_or_create_file @tmp_dir
-    BuildNumber.save path, build_number
-    BuildNumber.read(path).should eq(build_number)
-  end
+  describe 'when looking for the .build_number file' do
+    let(:path) { BuildNumber.find_or_create_file tmp_dir }
+
+    it 'should have the right name' do
+      path.should eq(build_number_path)
+    end
 
-  it 'should raise when directory does not exist' do
-    expect {
-      BuildNumber.find_or_create_file '/i/hopefully/dont/exist'
-    }.to raise_error
+    it 'should be created when it does not exist' do
+      File.exists?(path).should be_true
+    end
+
+    it 'should look in parent directories' do
+      nested_dir = "#{File.dirname(path)}/deeply/nested/path"
+      FileUtils.mkdir_p nested_dir
+
+      BuildNumber.find_or_create_file(nested_dir).should eq(path)
+    end
+
+    it 'should raise when the provided directory does not exist' do
+      expect {
+        BuildNumber.find_or_create_file '/i/hopefully/dont/exist'
+      }.to raise_error
+    end
   end
 
-  it "should set the 'BUILD_NUMBER' env var" do
-    BuildNumber.set_env @tmp_dir
-    ENV.include?('BUILD_NUMBER').should be_true
+  describe 'when the .build_number file exists' do
+    let(:path) { BuildNumber.find_or_create_file tmp_dir }
+
+    before :each do
+      BuildNumber.save path, build_number
+    end
+
+    it 'should read build number' do
+      BuildNumber.read(path).should eq(build_number)
+    end
+
+    it 'should read and increment the current build number' do
+      BuildNumber.current(tmp_dir).should eq(build_number.to_s)
+      BuildNumber.read(path).should eq(build_number + 1)
+    end
   end
 
-  it "should not create a .build_number file if the 'BUILD_NUMBER' env var is already set" do
-    ENV['BUILD_NUMBER'] = random_build_number.to_s
-    BuildNumber.set_env @tmp_dir
+  describe 'when using a custom env var name' do
+    CUSTOM_BUILD_NUMBER = 'CUSTOM_BUILD_NUM'
+
+    before :all do
+      BuildNumber.env_var_name = CUSTOM_BUILD_NUMBER
+    end
+
+    after :all do
+      BuildNumber.env_var_name = BuildNumber::DEFAULT_ENV_VAR_NAME
+    end
 
-    File.exists?("#{@tmp_dir}/.build_number").should be_false
-    ENV['BUILD_NUMBER'] = nil
+    after :each do
+      ENV.delete(CUSTOM_BUILD_NUMBER)
+    end
+
+    it 'should set a custom env var' do
+      BuildNumber.set_env tmp_dir
+      ENV.include?(CUSTOM_BUILD_NUMBER).should be_true
+    end
   end
 
-  def random_build_number
-    rng = Random.new
-    rng.rand(100)
+  describe 'when the env var is externally set' do
+    before :each do
+      ENV[BUILD_NUMBER] = build_number.to_s
+    end
+
+    it 'should not create a .build_number file' do
+      BuildNumber.set_env tmp_dir
+      File.exists?(build_number_path).should be_false
+    end
+
+    it 'should not increment the value' do
+      BuildNumber.current(tmp_dir).should eq(ENV[BUILD_NUMBER])
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: build_number
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rob Scaduto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler