version_reader 1.0.0

data/.gitignore

@@ -0,0 +1 @@
+/pkg

data/.rspec

@@ -0,0 +1 @@
+--color --format doc

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@version-reader"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.13.4 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/.watchr

@@ -0,0 +1,18 @@
+def run_spec(file)
+  unless File.exist?(file)
+    puts "#{file} does not exist"
+    return
+  end
+
+  puts "Running #{file}"
+  system "rspec #{file}"
+  puts
+end
+
+watch("spec/.*/*_spec.rb") do |match|
+  run_spec match[0]
+end
+
+watch("lib/(.*/?.*)\.rb") do |match|
+  run_spec %{spec/#{match[1]}_spec.rb}
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    version_reader (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    version_bumper (0.3.0)
+    watchr (0.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  version_bumper
+  version_reader!
+  watchr

data/README.md

@@ -0,0 +1,50 @@
+# version_reader
+
+Small Gem to read your version file.
+
+## Usage
+
+Assuming you have a file ~/CoolApp/VERSION with the content of ```0.4.2\n```.
+
+```ruby
+require 'version_reader'
+
+version_reader = VersionReader.new('~/CoolApp/VERSION')
+version_reader.normal # 0.4.2
+```
+
+## Rails integration
+
+If you add this gem to your Gemfile of a Rails application it will
+automatically define ```CoolApp::Application.version``` and fill in a VersionReader instance.
+
+It will also load some Rails flavor.
+
+## Flavors
+
+Flavors are an easy way to extend a VersionReader object with additional informations.
+
+### Rails
+
+The Rails flavor adds some additional methods which also show some information about the current Rails-Environment.
+
+#### rails_env
+
+Always adds the current Rails-Environment to the version. Maybe useful to see whether this is staging or not :)
+
+```ruby
+ruby CoolApp::Application.version.rails_env
+```
+Output would be ```0.4.2-development```.
+
+
+#### rails_env_without
+
+Adds the current Rails-Environment if it does not match one of the given environments.
+
+```ruby
+CoolApp::Application.version.rails_env_without(:production,:staging)
+```
+ 
+Output would be ```0.4.2-development``` or ```0.4.2``` for staging and production.
+ 

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'version_bumper'

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/version_reader.rb

@@ -0,0 +1,42 @@
+class VersionReader
+
+  class FileError < RuntimeError; end
+
+  autoload :Flavor, 'version_reader/flavor'
+
+  attr_accessor :raise_errors
+  attr_accessor :no_version_string
+
+  def initialize(version_file)
+    @version_file = version_file
+    @raise_errors = true
+    @no_version_string = "Versionfile #{@version_file} not found"
+  end
+
+  def normal
+    version
+  end
+
+  private
+  def version
+    @version ||= read_version.strip
+  end
+
+  def read_version
+    File.read(@version_file)
+  rescue Errno::ENOENT => @error
+    handle_error
+  end
+
+  def handle_error
+    if @raise_errors
+      raise VersionReader::FileError, @error.to_s
+    else
+      @no_version_string
+    end
+  end
+
+end
+
+require 'version_reader/railtie' if defined?(Rails)
+

data/lib/version_reader/flavor.rb

@@ -0,0 +1,5 @@
+class VersionReader
+  module Flavor
+    autoload :Rails, 'version_reader/flavor/rails'
+  end
+end

data/lib/version_reader/flavor/rails.rb

@@ -0,0 +1,26 @@
+class VersionReader
+  module Flavor
+    module Rails
+
+      attr_writer :env
+
+      def rails_env
+        "#{version}-#{env}"
+      end
+
+      def rails_env_without(*environments)
+        if environments.map { |env| env.to_sym }.include?(env)
+          version
+        else
+          rails_env
+        end
+      end
+
+      private
+      def env
+        (@env ||= ::Rails.env).to_sym
+      end
+
+    end
+  end
+end

data/lib/version_reader/railtie.rb

@@ -0,0 +1,17 @@
+class VersionReader
+  class Railtie < Rails::Railtie
+
+    initializer "version_reader.add_app_version_variable" do |app|
+      app.class.class_eval do
+        attr_accessor :version
+      end unless app.respond_to?(:version)
+    end
+
+    initializer "version_reader.set_app_version" do |app|
+      app.version = VersionReader.new(File.join(::Rails.root, 'VERSION'))
+      app.version.extend(VersionReader::Flavor::Rails)
+      app.version.raise_errors = false
+    end
+
+  end
+end

data/spec/integration/version_reader_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'version_reader'
+
+describe VersionReader do
+
+  subject do
+    VersionReader.new(version_file)
+  end
+
+  context "version file exists" do
+    let(:version_file) do
+      File.expand_path('../../../VERSION', __FILE__)
+    end
+
+    its(:normal) { should =~ /\A\d\.\d\.\d\z/ }
+  end
+
+  context "version file does not exist" do
+    let(:version_file) do
+      'this-should-really-not-exist-' + rand.to_s
+    end
+
+    it "railses an VersionReader error" do
+      expect { subject.normal }.to raise_error(VersionReader::FileError)
+    end
+  end
+
+end

data/spec/version_reader/flavor/rails_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'version_reader/flavor/rails'
+
+describe VersionReader::Flavor::Rails do
+
+  subject do
+    reader = mock()
+    reader.should_receive(:version).and_return('0.4.2')
+    reader.extend(VersionReader::Flavor::Rails)
+  end
+
+  [:test, :development, :staging, :production].each do |rails_env|
+    it "adds #{rails_env} to the end of the version" do
+      subject.env = rails_env
+      subject.rails_env.should eq("0.4.2-#{rails_env}")
+    end
+  end
+
+  it "does not add the specfied environment to the version" do
+    subject.env = :production
+    subject.rails_env_without(:production).should eq("0.4.2")
+  end
+
+  it "does not add the specfied environments to the version" do
+    subject.env = :production
+    subject.rails_env_without(:development, :production, :staging).should eq("0.4.2")
+  end
+
+end

data/spec/version_reader_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'version_reader'
+
+describe VersionReader do
+
+  subject do
+    VersionReader.new('VERSION')
+  end
+
+  context "version file exists" do
+    before do
+      File.should_receive(:read).with('VERSION').and_return("0.4.2\n")
+    end
+
+    its(:normal) { should eq('0.4.2') }
+
+  end
+
+  context "version file does not exist" do
+    before do
+      File.should_receive(:read).with('VERSION').and_raise(Errno::ENOENT)
+    end
+
+    it "raises an VersionReader error" do
+      expect { subject.normal }.to raise_error(VersionReader::FileError)
+    end
+
+    it "returns an empty string if error raising has been disabled" do
+      subject.raise_errors = false
+      subject.normal.should eq('Versionfile VERSION not found')
+    end
+
+  end
+
+end

data/version_reader.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/version_reader', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Raffael Schmid"]
+  gem.email         = ["raffael@yux.ch"]
+  gem.description   = %q{Easily read your VERSION file and display it in different formats}
+  gem.summary       = %q{Reads your VERSION file and gives the ability to display it in an easy way}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "version_reader"
+  gem.require_paths = ["lib"]
+  gem.version       = VersionReader.new(File.expand_path('../VERSION', __FILE__)).normal
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'watchr'
+  gem.add_development_dependency 'version_bumper'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: version_reader
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Raffael Schmid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: watchr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: version_bumper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily read your VERSION file and display it in different formats
+email:
+- raffael@yux.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .watchr
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- lib/version_reader.rb
+- lib/version_reader/flavor.rb
+- lib/version_reader/flavor/rails.rb
+- lib/version_reader/railtie.rb
+- spec/integration/version_reader_spec.rb
+- spec/spec_helper.rb
+- spec/version_reader/flavor/rails_spec.rb
+- spec/version_reader_spec.rb
+- version_reader.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Reads your VERSION file and gives the ability to display it in an easy way
+test_files:
+- spec/integration/version_reader_spec.rb
+- spec/spec_helper.rb
+- spec/version_reader/flavor/rails_spec.rb
+- spec/version_reader_spec.rb