build_number 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OThiMmExNTkxNzUwZDQ1NzdiNGM3MDJlMTAxMjY5NWRhZGY1YzgzOQ==
+  data.tar.gz: !binary |-
+    ZWVkZDIzZDk0MWJiOGRlYzcxMzFjZWU2OTk2YzdhMjJmZGE4YTBlMw==
+SHA512:
+  metadata.gz: !binary |-
+    ZTdiZDUyMTc5OGYwYjNhYjNiMGUxM2NkMzdlMDY0MzBlNjQ5MWQwMGMyY2Fh
+    N2YyYzQwMzI4YThkNzliZjJmODFmZWZhODc2ZTNhMDBmZWJiMGU2ZjhkY2Rj
+    ZGQxYTVjMDE3MzU1ODBjZWFlNmZlYzcxNWY4ODYxYTJmOGQ2ZmQ=
+  data.tar.gz: !binary |-
+    ZGI1ODQ4MDVhMmI3OTQ3YThiM2VhMGM1ZWIzMjJhMGI3NTMwNmRiYzdiZmNj
+    YzAwY2MzNzQyNzNiM2RlYmFlNGRjNGFhNDZjYmVmYTM5ZDdiYWExNDA2ODg0
+    MGFhZGRhNjkzZjc1MmFhMmM1NWZkMWU0NDY2NWY5MzhhYTkxMmQ=

data/.gitignore

@@ -0,0 +1,41 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# RubyMine files
+.idea/
+
+# build number
+.build_number
+

data/.semver

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in build_number.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    build_number (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    semver2 (3.3.3)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  build_number!
+  bundler (~> 1.6)
+  rake
+  rspec
+  semver2

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rob Scaduto
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# build_number
+
+Creates a `.build_number` file in your current directory which will store and increment the `BUILD_NUMBER`
+environment variable.  This is useful when you want to keep track of build numbers outside of a continuous integration
+environment.
+
+If the `BUILD_NUMBER` variable is already set, it will not be incremented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'build_number'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install build_number
+
+## Usage
+
+In your project's Rakefile:
+
+```ruby
+require 'build_number'
+BuildNumber.set_env
+
+# ENV['BUILD_NUMBER'] is now set and incremented for the next build!
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/scardetto/build_number/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |c|
+  c.rspec_opts = %w(--color --format=doc)
+end

data/build_number.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'semver'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'build_number'
+  spec.version       = SemVer.find.format '%M.%m.%p'
+  spec.authors       = ['Rob Scaduto']
+  spec.email         = ['rscaduto@thirdwave.it']
+  spec.summary       = %q{Store and increment build numbers}
+  spec.description   = %q{Library for storing and incrementing a build number in your local project directory.}
+  spec.homepage      = 'http://github.com/scardetto/build_number'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'semver2'
+end

data/lib/build_number/version.rb

@@ -0,0 +1,3 @@
+module BuildNumber
+  VERSION = '0.1.0-pre'
+end

data/lib/build_number.rb

@@ -0,0 +1,69 @@
+require 'build_number/version'
+
+module BuildNumber
+  FILE_NAME = '.build_number'
+
+  def self.set_env(dir=nil)
+    ENV['BUILD_NUMBER'] = ENV['BUILD_NUMBER'] || increment(dir)
+  end
+
+  def self.increment(dir=nil)
+    file = find_or_create_file dir
+
+    read(file).tap do |current|
+      save file, current + 1
+    end
+  end
+
+  def self.find_or_create_file(dir=nil)
+    dir ||= Dir.pwd
+    file = find_file dir
+    file = create_file dir if file.nil?
+    file
+  end
+
+  def self.read(path)
+    file = File.open(path, 'rb')
+    current = file.read.chomp.to_i
+    file.close
+    current
+  end
+
+  def self.save(path, next_build_number=0)
+    open(path, 'w') { |io| io.write next_build_number.to_s }
+  end
+
+  private
+
+  def self.find_file(dir=nil)
+    raise "#{dir} is not a directory" unless File.directory? dir
+    file_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
+      end
+      return file_path
+    end
+  end
+
+  def self.is_root_path?(path)
+    File.dirname(path).match(/(\w:\/|\/)$/i)
+  end
+
+  def self.parent_path(path)
+    dir = File.join File.dirname(path), '..'
+    File.expand_path file_name(dir)
+  end
+
+  def self.create_file(dir=nil)
+    file = file_name(dir)
+    save file
+    file
+  end
+
+  def self.file_name(dir)
+    File.join dir, FILE_NAME
+  end
+end

data/spec/build_number_spec.rb

@@ -0,0 +1,51 @@
+require 'tmpdir'
+require 'build_number'
+
+describe BuildNumber do
+  before :each do
+    @tmp_dir = Dir.mktmpdir
+  end
+
+  after :each do
+    FileUtils.remove_entry_secure @tmp_dir
+  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")
+  end
+
+  it 'should find the .build_number file in parent directory' do
+    path = BuildNumber.find_or_create_file @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)
+  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
+
+  it 'should raise when directory does not exist' do
+    expect {
+      BuildNumber.find_or_create_file '/i/hopefully/dont/exist'
+    }.to raise_error
+  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
+
+    File.exists?("#{@tmp_dir}/.build_number").should be_false
+    ENV['BUILD_NUMBER'] = nil
+  end
+
+  def random_build_number
+    rng = Random.new
+    rng.rand(100)
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: build_number
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Scaduto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: semver2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library for storing and incrementing a build number in your local project
+  directory.
+email:
+- rscaduto@thirdwave.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .semver
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- build_number.gemspec
+- lib/build_number.rb
+- lib/build_number/version.rb
+- spec/build_number_spec.rb
+homepage: http://github.com/scardetto/build_number
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: Store and increment build numbers
+test_files:
+- spec/build_number_spec.rb