versioner 0.1.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/dummy/log
+spec/dummy/config/versioner.yml

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ChaiONE
+
+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,73 @@
+# versioner
+
+This gem allows you to easily add, update, and retrieve a version number for your Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'versioner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install versioner
+
+Then run the installer:
+
+    $ rails generate versioner:install
+
+This adds these files:
+
+* **[RAILS_ROOT]/config/versioner.yml** - This is where the version number is stored.
+* **[RAILS_ROOT]/config/initializers/versioner.rb** - This is where you can configure options. The only option available right now is **storage_path**, which allows you to change the location of versioner.yml.
+
+## Usage
+
+Version numbers follow the format *Major.Minor.Patch*.
+
+Force a new version number like this:
+
+    $ rake versioner:force[1,0,3]
+
+Then you can update it:
+
+    $ rake versioner:increment_major
+    $ rake versioner:increment_minor
+    $ rake versioner:increment_patch
+
+And get it:
+
+    $ rake versioner:version
+
+Within your Rails app, you can use the following to get your app's version as a string:
+
+    Versioner.version
+
+## Details
+
+Right now, the version is stored in YAML format, by default under config/versioner.yml. This location can be changed in config/initializers/versioner.rb.
+
+More storage back-end options are coming.
+
+## Roadmap
+
+* Fully support [Semantic Versioning](http://semver.org)
+* More storage back-ends
+* Extract the core into a new gem, versioner
+* More gems for other frameworks (e.g., Sinatra)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/generators/versioner/install/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rbconfig'
+
+module Versioner
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    DEFAULT_SHEBANG = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
+
+    def create_version_file
+      template 'config/versioner.yml.erb', 'config/versioner.yml'
+    end
+
+    def create_initializer
+      template 'config/initializers/versioner.rb.erb', 'config/initializers/versioner.rb'
+    end
+  end
+end

data/lib/generators/versioner/install/templates/config/initializers/versioner.rb.erb

@@ -0,0 +1,3 @@
+Versioner.configure do |config|
+  config.storage_path = Rails.root.join "config", "versioner.yml"
+end

data/lib/generators/versioner/install/templates/config/versioner.yml.erb

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 0
+:patch: 0

data/lib/railtie.rb

@@ -0,0 +1,7 @@
+module Versioner
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.join('versioner', 'tasks.rb')
+    end
+  end
+end

data/lib/tasks/versioner.rake

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'versioner', 'tasks'))

data/lib/versioner/tasks.rb

@@ -0,0 +1,26 @@
+namespace :versioner do
+  desc "Get the app's version number"
+  task :version => :environment do
+    puts Versioner.version
+  end
+
+  desc "Increment the major version number by 1"
+  task :increment_major => :environment do
+    puts Versioner.increment_major
+  end
+
+  desc "Increment the minor version number by 1"
+  task :increment_minor => :environment do
+    puts Versioner.increment_minor
+  end
+
+  desc "Increment the patch version number by 1"
+  task :increment_patch => :environment do
+    puts Versioner.increment_patch
+  end
+
+  desc "Force a new version number (required: major, minor, patch)"
+  task :force, [:major, :minor, :patch] => :environment do |t, args|
+    puts Versioner.force args.major.to_i, args.minor.to_i, args.patch.to_i
+  end
+end

data/lib/versioner/versioner_yaml.rb

@@ -0,0 +1,80 @@
+require 'yaml'
+
+module Versioner
+  class YamlBackend
+    def initialize(path)
+      self.path = path
+      read
+    end
+
+    def version
+      "#{major}.#{minor}.#{patch}"
+    end
+
+    def major
+      data[:major]
+    end
+
+    def major=(num)
+      data[:major] = num
+      write
+    end
+
+    def minor
+      data[:minor]
+    end
+
+    def minor=(num)
+      data[:minor] = num
+      write
+    end
+
+    def patch
+      data[:patch]
+    end
+
+    def patch=(num)
+      data[:patch] = num
+      write
+    end
+
+    def force(major, minor, patch)
+      self.major = major
+      self.minor = minor
+      self.patch = patch
+      version
+    end
+
+    def increment_major
+      self.major = major + 1
+      version
+    end
+
+    def increment_minor
+      self.minor = minor + 1
+      version
+    end
+
+    def increment_patch
+      self.patch = patch + 1
+      version
+    end
+
+    private
+
+    attr_accessor :data, :path
+
+    def read
+      File.open(path, 'r') do |file|
+        data = file.read
+        self.data = YAML.load(data)
+      end
+    end
+
+    def write
+      File.open(path, 'w') do |file|
+        YAML.dump(data, file)
+      end
+    end
+  end
+end

data/lib/versioner.rb

@@ -0,0 +1,50 @@
+require 'railtie'
+require 'versioner/versioner_yaml'
+
+module Versioner
+  class << self
+    def api
+      @api = YamlBackend.new(storage_path)
+    end
+
+    def version
+      api.version
+    end
+
+    def force(major, minor, patch)
+      api.force major, minor, patch
+    end
+
+    def increment_major
+      api.increment_major
+    end
+
+    def increment_minor
+      api.increment_minor
+    end
+
+    def increment_patch
+      api.increment_patch
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield config
+    end
+
+    delegate :storage_path, :to => :config
+  end
+
+  class Configuration
+    def storage_path
+      @storage_path ||= Rails.root.join("config", "versioner.yml")
+    end
+
+    def storage_path=(path)
+      @storage_path = path
+    end
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+
+if defined?(Bundler)
+  Bundler.require(*Rails.groups(:assets => %w(development test)))
+end
+
+module Dummy
+  class Application < Rails::Application
+    config.encoding = "utf-8"
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,10 @@
+Dummy::Application.configure do
+  config.cache_classes = true
+
+  config.whiny_nils = true
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  
+  config.active_support.deprecation = :log
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/fixtures/versioner.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 0
+:patch: 0

data/spec/generators/versioner/install/install_generator_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+# Generators are not automatically loaded by Rails
+require 'generators/versioner/install/install_generator'
+
+describe Versioner::InstallGenerator do
+  # Tell the generator where to put its output
+  destination File.expand_path("../../../../../tmp", __FILE__)
+
+  before { prepare_destination }
+
+  describe 'no arguments' do
+    before { run_generator }
+
+    describe 'config/versioner.yml' do
+      subject { file('config/versioner.yml') }
+      it { should exist }
+      it { should contain ":major: 0" }
+      it { should contain ":minor: 0" }
+      it { should contain ":patch: 0" }
+    end
+
+    describe 'config/initializers/versioner.rb' do
+      subject { file('config/initializers/versioner.rb') }
+      it { should exist }
+      it { should contain "Versioner.configure do |config|" }
+      it { should contain "storage_path"}
+    end
+  end
+end

data/spec/lib/versioner_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Versioner do
+  describe "getting a version if none is set" do
+    subject { Versioner.version }
+    it { should == "0.0.0" }
+  end
+
+  describe "forcing the version" do
+    before { Versioner.force 1, 0, 0 }
+    subject { Versioner.version }
+    it { should == "1.0.0" }
+  end
+
+  describe "incrementing the major version" do
+    before do
+      Versioner.force 1, 0, 1
+      Versioner.increment_major
+    end
+    subject { Versioner.version }
+    it { should == "2.0.1" }
+  end
+
+  describe "incrementing the minor version" do
+    before do
+      Versioner.force 1, 0, 1
+      Versioner.increment_minor
+    end
+    subject { Versioner.version }
+    it { should == "1.1.1" }
+  end
+
+  describe "incrementing the patch version" do
+    before do
+      Versioner.force 2, 3, 1
+      Versioner.increment_patch
+    end
+    subject { Versioner.version }
+    it { should == "2.3.2" }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# rails
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+
+# versioner
+require "fileutils"
+require "versioner"
+Versioner.configure do |config|
+  config.storage_path = Rails.root.join "config", "versioner.yml"
+end
+
+# copy over new versioner config
+fixture_path = File.expand_path("../fixtures/versioner.yml", __FILE__)
+storage_path = File.expand_path("../dummy/config/versioner.yml", __FILE__)
+FileUtils.cp fixture_path, storage_path
+
+require "rspec/rails"
+require "rspec/autorun"
+
+require "ammeter/init"

data/versioner.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "versioner"
+  gem.version       = "0.1.0"
+  gem.authors       = ["ChaiONE"]
+  gem.email         = ["joshua.rieken@chaione.com"]
+  gem.summary       = %q{Super simple versioning for Rails apps}
+  gem.description   = %q{This gem makes it easy to add and update a version number for your Rails app via rake tasks.
+The version is stored in a YAML file within your app.}
+  gem.homepage      = "https://github.com/chaione/versioner"
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "railties", "~> 3.0"
+  gem.add_dependency "actionpack", "~> 3.0"
+
+  gem.add_development_dependency "rspec-rails", "~> 2.11.4"
+  gem.add_development_dependency "guard", "~> 1.1.1"
+  gem.add_development_dependency "guard-rspec", "~> 1.1.0"
+  gem.add_development_dependency "growl", "~> 1.0.3"
+  gem.add_development_dependency "ammeter", "~> 0.2.8"
+  gem.add_development_dependency "tzinfo", "~> 0.3.33"
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: versioner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- ChaiONE
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.4
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.8
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.33
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.33
+description: ! 'This gem makes it easy to add and update a version number for your
+  Rails app via rake tasks.
+
+  The version is stored in a YAML file within your app.'
+email:
+- joshua.rieken@chaione.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/versioner/install/install_generator.rb
+- lib/generators/versioner/install/templates/config/initializers/versioner.rb.erb
+- lib/generators/versioner/install/templates/config/versioner.yml.erb
+- lib/railtie.rb
+- lib/tasks/versioner.rake
+- lib/versioner.rb
+- lib/versioner/tasks.rb
+- lib/versioner/versioner_yaml.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/fixtures/versioner.yml
+- spec/generators/versioner/install/install_generator_spec.rb
+- spec/lib/versioner_spec.rb
+- spec/spec_helper.rb
+- versioner.gemspec
+homepage: https://github.com/chaione/versioner
+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'
+      segments:
+      - 0
+      hash: -4121593038799895324
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4121593038799895324
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Super simple versioning for Rails apps
+test_files:
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/test.rb
+- spec/fixtures/versioner.yml
+- spec/generators/versioner/install/install_generator_spec.rb
+- spec/lib/versioner_spec.rb
+- spec/spec_helper.rb