rake-version2 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7e427756b03ce300d7fa20251e2fa17fad1e51a4e2e430089a784634f9251ca
+  data.tar.gz: 7db1f38c597efb323371c6388364cfd53bbe33d60d0eb69d6cdd4a3bc8722f10
+SHA512:
+  metadata.gz: 1e9a54124e69ad040f9105f19842abd3ea16fc854fba3a4b7c0b100348cb4acb212271e29340cf864943a2f683b57f4e3c81ad4957914e170c6d6334e18aff0e
+  data.tar.gz: abc002fc6b978dd1f3440a7592ded4c9f96f2941393e35596bd052aae86c26bb95edfe2533c539d3fb3e179fd491a5a5837c68cd422d235740dd04f682ba7525

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'rake', '> 11.1'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rspec', '~> 3.4'
+  gem 'rspec-its', '~> 1.2'
+  gem 'bundler', '> 2.0'
+  gem 'jeweler', '~> 2.0'
+  gem 'simplecov', '~> 0.14'
+  gem 'travis-lint', '~> 2.0'
+  gem 'fakefs', '~> 0.8', require: 'fakefs/safe'
+  gem 'coveralls', '~> 0.8', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011-2018 Simon Oulevay (Alpha Hydrae)
+
+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,92 @@
+# rake-version
+
+**Simple rake tasks for version management.**
+
+[![Gem Version](https://badge.fury.io/rb/rake-version2.svg)](http://badge.fury.io/rb/rake-version2)
+
+**rake-version** helps you manage your `VERSION` file according to the rules of [semantic versioning](http://semver.org).
+It does nothing more.
+It does not create tags; it does not commit; it does not push; it does not release.
+
+Compatible with Ruby 3.2+. Use [`rake-version` v1](https://github.com/AlphaHydrae/rake-version) for older Ruby versions.
+
+## Installation
+
+Add to your Gemfile and `bundle install`:
+
+```rb
+gem "rake-version2", "~> 2.0"
+```
+
+Add the tasks to your Rakefile:
+
+```rb
+require 'rake-version'
+RakeVersion::Tasks.new
+```
+
+## Usage
+
+```bash
+# show current version
+rake version              #=> 1.0.0
+
+# bump version
+rake version:bump:patch   #=> 1.0.1
+rake version:bump:minor   #=> 1.1.0
+rake version:bump:major   #=> 2.0.0
+
+# set version
+rake "version:set[1.2.3]" #=> 1.2.3
+```
+
+### Auto-update other files
+
+When you add the rake version tasks in your Rakefile, you may specify additional files to update with the new version.
+
+```rb
+require 'rake-version'
+RakeVersion::Tasks.new do |v|
+  v.copy 'lib/my-gem.rb'          # update single file
+  v.copy 'lib/a.rb', 'lib/b.rb'   # update multiple files
+  v.copy 'lib/*.rb'               # update all files matching a glob pattern
+  v.copy /lib/                    # update all files whose path matches a regexp
+end
+```
+
+By default, **rake-version** will replace the first occurrence of a semantic version pattern (`number.number.number(-prerelease)(+build)`) with the new version.
+It will not modify the prerelease version or build metadata.
+For example, when bumping the minor version from 1.0.0, it will change the contents of this file:
+
+```rb
+class Thing
+  VERSION = '1.0.0'
+end
+```
+
+To this:
+
+```rb
+class Thing
+  VERSION = '1.1.0'
+end
+```
+
+You can customize this behavior as follows:
+
+```rb
+RakeVersion::Tasks.new do |v|
+  v.copy 'lib/my-gem.rb', all: true   # replace all occurrences
+end
+```
+
+### Semantic versioning
+
+**rake-version** partially supports [semantic versioning v2.0.0](http://semver.org/spec/v2.0.0.html).
+You can add prerelease (e.g. `-beta`) and build (e.g. `+20131313`) information to your versions,
+but there are currently no tasks to update them other than `version:set`.
+
+## Meta
+
+* **Author:** Simon Oulevay (Alpha Hydrae)
+* **License:** MIT (see [LICENSE.txt](https://raw.github.com/AlphaHydrae/rake-version/master/LICENSE.txt))

data/VERSION

@@ -0,0 +1 @@
+2.0.1

data/lib/rake-version/config.rb

@@ -0,0 +1,29 @@
+
+module RakeVersion
+
+  class Config
+
+    attr_reader :extension
+
+    def initialize
+      super
+      @copiers = []
+      @extension = 'rb'
+    end
+
+    def copy *args
+      args.unshift "src/**/*.#{@extension}" if args.empty?
+      @copiers << Copier.new(*args)
+      self
+    end
+
+    def copiers
+      Array.new @copiers
+    end
+
+    def extension= extension
+      raise "Expected extension to be alphanumerical, got #{extension.inspect}." unless extension.respond_to?(:to_s) and extension.to_s.match(/^[a-z0-9]+$/i)
+      @extension = extension.to_s
+    end
+  end
+end

data/lib/rake-version/context.rb

@@ -0,0 +1,11 @@
+
+module RakeVersion
+
+  class Context
+    attr_reader :root
+  
+    def initialize root
+      @root = root
+    end
+  end
+end

data/lib/rake-version/copier.rb

@@ -0,0 +1,67 @@
+require 'find'
+
+module RakeVersion
+
+  class Copier
+
+    def initialize *args
+      options = args.last.kind_of?(Hash) ? args.pop : {}
+
+      @file_patterns = args.collect{ |arg| check_file_pattern arg }
+      @version_pattern = Version::REGEXP
+      @replace_all = !!options[:all]
+    end
+
+    def copy version, context
+      find_all_files(context).each{ |f| copy_version f, version }
+    end
+
+    private
+
+    def check_file_pattern pattern
+      unless [ String, Regexp ].any?{ |klass| pattern.kind_of? klass }
+        raise BadFilePattern, "Expected file pattern to be a glob string or regexp, got #{pattern.class.name}."
+      end
+      pattern
+    end
+
+    def copy_version file, version
+      File.open(file, 'r+') do |f|
+        contents = f.read
+        return unless match? contents
+        f.rewind
+        f.truncate 0
+        f.write process(contents, version)
+      end
+    end
+
+    def match? contents
+      contents.match @version_pattern
+    end
+
+    def process contents, version
+      if @replace_all
+        contents.gsub(@version_pattern, version.to_s)
+      else
+        contents.sub(@version_pattern, version.to_s)
+      end
+    end
+
+    def find_all_files context
+      @file_patterns.collect{ |p| find_files p, context }.flatten
+    end
+
+    def find_files pattern, context
+      if pattern.kind_of? String
+        Dir.chdir context.root
+        Dir.glob(pattern).select{ |f| File.file? f }
+      elsif pattern.kind_of? Regexp
+        files = []
+        Find.find(context.root) do |path|
+          files << path if File.file?(path) and path.match(pattern)
+        end
+        files
+      end
+    end
+  end
+end

data/lib/rake-version/ext.rb

@@ -0,0 +1,7 @@
+
+Rake::TaskManager.class_eval do
+
+  def remove_task task_name
+    @tasks.delete task_name.to_s
+  end
+end

data/lib/rake-version/manager.rb

@@ -0,0 +1,71 @@
+
+module RakeVersion
+
+  class Manager
+
+    def initialize
+      @copiers = []
+    end
+
+    def version
+      check_context
+      RakeVersion::Version.new.from_s read_version
+    end
+
+    def set version_string
+      check_context
+      copy save(RakeVersion::Version.new.from_s(version_string))
+    end
+
+    def bump type
+      check_context
+      copy save(version.bump(type))
+    end
+
+    def config= config
+      @copiers = config.copiers
+      self
+    end
+
+    def with_context context, &block
+      @context = context
+      yield self if block_given?
+      @context = nil
+      self
+    end
+
+    private
+
+    def copy version
+      check_context
+      @copiers.each{ |c| c.copy version, @context }
+      version
+    end
+
+    def check_context
+      raise MissingContext, "A context must be given with :with_context." unless @context
+    end
+
+    def save version
+      RakeVersion.check_version version
+      write_version version
+    end
+
+    def read_version
+      raise MissingVersionFile, "Version file doesn't exist: #{version_file}" unless File.exist?(version_file)
+      File.read version_file
+    end
+
+    def write_version version
+      version.tap{ |v| File.open(version_file, 'w'){ |f| f.write version.to_s } }
+    end
+
+    def version_file
+      File.join @context.root, version_filename
+    end
+
+    def version_filename
+      @version_filename || 'VERSION'
+    end
+  end
+end

data/lib/rake-version/tasks.rb

@@ -0,0 +1,78 @@
+
+module RakeVersion
+
+  class Tasks < ::Rake::TaskLib
+    NAMES = [ 'version', 'version:bump:major', 'version:bump:minor', 'version:bump:patch', 'version:set' ]
+    OTHER_NAMES = [ 'version:write' ]
+
+    def initialize options = {}, &block
+      @manager = RakeVersion::Manager.new
+      @config = RakeVersion::Config.new
+      yield @config if block_given?
+      @manager.config = @config
+      define options
+    end
+
+    def define options = {}
+
+      clear_tasks options unless options[:clear] == false
+
+      desc 'Show the current version'
+      task :version do |t|
+        handle_missing_version{ puts @manager.version.to_s }
+      end
+
+      namespace :version do
+
+        desc 'Set the version (rake "version:set[1.2.3]")'
+        task :set, :value do |t, args|
+          puts @manager.set(args.value.to_s)
+        end
+
+        namespace :bump do
+
+          [ :major, :minor, :patch ].each do |type|
+            desc "Bump the #{type} version"
+            task type do |t|
+              handle_missing_version{ puts @manager.bump(type).to_s }
+            end
+          end
+        end
+      end
+    end
+
+    def task *args, &block
+      super *args do |t, args|
+        @manager.with_context context(t) do |m|
+          yield t, args if block_given?
+        end
+      end
+    end
+
+    def clear_tasks options = {}
+      task_names = NAMES
+      task_names += OTHER_NAMES unless options[:clear_strict]
+      task_names.each{ |task| remove_task task }
+    end
+
+    private
+
+    def handle_missing_version
+      return yield if Rake.application.options.trace
+      begin
+        yield
+      rescue MissingVersionFile => e
+        warn %|#{e.message}\nCreate it with:\n   rake "version:set[1.0.0]"|
+        exit 1
+      end
+    end
+
+    def remove_task task_name
+      Rake.application.remove_task task_name
+    end
+
+    def context task
+      RakeVersion::Context.new task.application.original_dir
+    end
+  end
+end

data/lib/rake-version/version.rb

@@ -0,0 +1,58 @@
+
+module RakeVersion
+
+  class Version
+    REGEXP = /(\d+)\.(\d+)\.(\d+)(?:\-([a-z0-9\-]+(?:\.[a-z0-9\-]+)*))?(?:\+([a-z0-9\-]+(?:\.[a-z0-9\-]+)*))?/i
+
+    attr_reader :major
+    attr_reader :minor
+    attr_reader :patch
+    attr_reader :prerelease
+    attr_reader :build
+
+    def initialize
+      @major = 0
+      @minor = 0
+      @patch = 0
+      @prerelease = nil
+      @build = nil
+    end
+
+    def bump type
+      case type
+      when :major
+        @major += 1
+        @minor = 0
+        @patch = 0
+      when :minor
+        @minor += 1
+        @patch = 0
+      when :patch
+        @patch += 1
+      else
+        raise BadBumpType, "Unknown version bump type #{type.inspect}. Expecting :major, :minor or :patch."
+      end
+      self
+    end
+
+    def from_s s
+      s.to_s.match(REGEXP).tap do |m|
+        raise BadVersionString, "Version '#{s}' expected to have format MAJOR.MINOR.PATCH(-PRERELEASE)(+BUILD)." if m.nil?
+        @major = m[1].to_i
+        @minor = m[2].to_i
+        @patch = m[3].to_i
+        @prerelease = m[4]
+        @build = m[5]
+      end
+      self
+    end
+
+    def to_s
+      String.new.tap do |s|
+        s << "#{@major}.#{@minor}.#{@patch}"
+        s << "-#{@prerelease}" if @prerelease
+        s << "+#{@build}" if @build
+      end
+    end
+  end
+end

data/lib/rake-version.rb

@@ -0,0 +1,29 @@
+
+require 'rake/tasklib'
+
+module RakeVersion
+  VERSION = '2.0.1'
+
+  class Error < StandardError; end
+  class BadVersionString < Error; end
+  class MissingContext < Error; end
+  class MissingVersionFile < Error; end
+  class BadArgument < Error; end
+  class BadContext < BadArgument; end
+  class BadVersion < BadArgument; end
+  class BadBumpType < BadArgument; end
+  class BadFilePattern < BadArgument; end
+  class BadVersionPattern < BadArgument; end
+
+  def self.check_version o
+    self.check_type o, RakeVersion::Version, BadVersion
+  end
+
+  def self.check_type o, expected_type, error_class = Error, name = nil
+    name ||= expected_type.to_s.sub(/.*::/, '')
+    name = name.downcase
+    raise error_class, "Expected #{name} to be a #{expected_type}." unless o.kind_of? expected_type
+  end
+end
+
+Dir[File.join File.dirname(__FILE__), File.basename(__FILE__, '.*'), '*.rb'].each{ |lib| require lib }

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: rake-version2
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- AlphaHydrae
+- capripot
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: travis-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Rake tasks to manage your VERSION file. No repository management (tags,
+  committing, pushing), no release management.
+email: capripot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- VERSION
+- lib/rake-version.rb
+- lib/rake-version/config.rb
+- lib/rake-version/context.rb
+- lib/rake-version/copier.rb
+- lib/rake-version/ext.rb
+- lib/rake-version/manager.rb
+- lib/rake-version/tasks.rb
+- lib/rake-version/version.rb
+homepage: https://github.com/capripot/rake-version2
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Simple rake tasks for version management.
+test_files: []