semantic-version 2.0.0.pre.alpha.1 → 2.0.0.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f9241c69186fc00e63fefb4d11d5bbbbe36b4e2
-  data.tar.gz: ca581b70fc94866659effd01c5a83d23a8e38b21
+  metadata.gz: 8ab245c417014558c7034b5692dc17532fc0d253
+  data.tar.gz: 660f07bf67170be21faf606cd622c1afea2b0366
 SHA512:
-  metadata.gz: 3de5e410f84e2445dfaf639f9e1827b262dd7bdd74425e923820a9d7d79fd49e73ff021cbd7e79abede01551cfd9c3f26a1de713976851ad8ccaa080fa6d4f79
-  data.tar.gz: 5cde7fcc9a7f6f212d8475d314cd6c116a0ee28c4792d83d2540ce3b34059d73948ae789c186502f8a6f840e810c9bbcc7e6294018f5f652635a0d55ce75bb7d
+  metadata.gz: ac2b2458ce74a1c4ce9c02f9c2e0b6cd9d4a486f64135d03ff73842858fcadf1b9bae9923931cc1a5f2fafd70d2c56df72cef1845c90dfceb241f8182725f291
+  data.tar.gz: 649f48151f9703142f692ae84140c67e65a953325eceb41df557584f682047577d68e11140bb9413099201bd9dd8136c973c4b7c7386f606085373299dea2787

data/README.md

@@ -3,10 +3,11 @@ Semantic::Version
 
 > *Semantic version objects for Ruby.*
 
-  A utility library that provides a `Semantic::Version` value object.
+A utility library that provides a `Semantic::Version` value object.
 
 
-  You can parse strings into version objects or construct them by hand. Any module, class, or object can be given a version through a helper. All version objects properly handle instantiation, duplication, cloning, accessors, mutators, stringification, and comparison; and come with helpful predicate methods.
+You can parse strings into version objects or construct them by hand. Any module, class, or object can be given a version through a helper. All version objects properly handle instantiation, duplication, cloning, accessors, mutators, stringification, and comparison; and come with helpful predicate methods.
+
 
 Installation
 ------------
@@ -23,24 +24,25 @@ And then execute:
 bundle
 ```
 
-Or version your gem with it like so:
+You can also version your gem with it.
 
 1. Create or modify your version file:
 
-  ```ruby
-  # my_gem/version.rb
+  ```diff
+  # lib/my_gem/version.rb
 
-  require 'semantic/version'
+  +require 'semantic/version'
 
   module MyGem
-    extend Semantic::Version::Helper
-    version '0.0.1'
+  -  VERSION = '0.0.1'
+  +  extend Semantic::Version::Helper
+  +  version '0.0.1'
   end
   ```
 
 2. Modify your gemspec:
 
-  ```ruby
+  ```diff
   # my_gem.gemspec
 
   #...
@@ -48,29 +50,22 @@ Or version your gem with it like so:
 
   Gem::Specification.new do |spec|
     #...
-    spec.version = MyGem.version
+  -   spec.version = MyGem::VERSION
+  +   spec.version = MyGem.version
     #...
     spec.add_dependency "semantic-version", "~> 2.0.0"
     #...
   end
   ```
 
-3. Update your `Gemfile.lock`:
+3. Update your `Gemfile.lock` by executing:
 
   ```sh
   bundle
   ```
 
-4. Add the relevant rake tasks *optional*:
-
-  ```ruby
-  # Rakefile
-
-  #...
-  require 'semantic/version/tasks'
-  ```
+There is currently no advantage to using `Semantic::Version` objects in your gemspec, except to declare to the world that your gem is semantic versioning compliant. There is also a `semantic-version-tasks` Rakefile plugin.
 
-There is currently no advantage to using `Semantic::Version` objects in your gemspec, outside of using the provided rake tasks, except to declare to the world that your gem is semantic versioning compliant.
 
 Usage
 -----
@@ -164,6 +159,16 @@ version.meta.to_s
 
 version.to_s
 #=> "1.0.1-alpha.12+build.2981.sha.e796e5da1f40820dcf5dab85487dd9e9a32f27e8"
+version.bump.to_s
+#=> "1.0.2"
+version.bump(preserve: :prerelease).to_s
+#=> "1.0.2-alpha.12"
+version.bump(preserve: :meta).to_s
+#=> "1.0.2+build.2981.sha.e796e5da1f40820dcf5dab85487dd9e9a32f27e8"
+version.bump(preserve: %i[prerelease meta]).to_s
+#=> "1.0.2-alpha.12+build.2981.sha.e796e5da1f40820dcf5dab85487dd9e9a32f27e8"
+version.bump(preserve: :all).to_s
+#=> "1.0.2-alpha.12+build.2981.sha.e796e5da1f40820dcf5dab85487dd9e9a32f27e8"
 ```
 
 Most importantly, they are properly comparable per the Semantic Version spec:
@@ -242,6 +247,70 @@ api1 < api2
 Take care to never use `attr_accessor` in conjunction with `version` when using this helper, or the coercion magic will be ruined.
 
 
+Tasks
+-----
+
+By adding a version file to your gem's root directory you can use rake tasks to manage your versioning.
+
+1. Add the helper tasks to your Rakefile:
+
+  ```ruby
+  #...
+  require 'semantic/version/tasks'
+  ```
+
+2. Create a new version file for your project by executing:
+
+  ```sh
+  rake version:install
+  ```
+
+3. Reconfigure your gem to use the version file:
+
+  ```diff
+  # lib/my_gem/version.rb
+
+  require 'semantic/version'
+
+  module MyGem
+    extend Semantic::Version::Helper
+  -  version '0.0.1'
+  +  version from: 'my_gem.version'
+  end
+  ```
+
+High-level tasks are visible in your task list:
+
+```bash
+rake -T
+rake version:install[version]  # Generates a .version file in the project root
+                               #  'version' defaults to what's in your gemspec or 0.0.1
+rake version                   # Show version number in semantic-version.version (v2.0.0-alpha.2)
+rake version:release           # Removes prerelease data or bumps patch level (to v2.0.0)
+rake version:bump              # Bump patch version by 1 (to v2.0.1)
+rake version:bump:minor        # Bump minor version by 1 (to v2.1.0)
+rake version:bump:major        # Bump major version by 1 (to v3.0.0)
+```
+
+There are also hidden tasks for querying and manipulating the version number, namely:
+
+```bash
+rake version:number                             # Shows version number only
+rake version:(prerelease|meta)                  # Shows data type only
+rake version:(prerelease|meta):clear            # Clears out data
+rake version:(prerelease|meta):set[to]          # Changes data
+rake version:(prerelease|meta):append[element]  # Appends element to data
+```
+
+Finally, lower-level number manipulation tasks are available following the formula:
+
+```bash
+rake version:(bump|jump):(patch|minor|major):(by|to)[num] # default num is 1
+```
+
+So, `rake version:bump:major:by[2]` will take you from `v2.0.0-alpha.2` to `v4.0.0`, and `rake version:jump:minor:to` will take you from `v2.0.0-alpha.2` to `v2.1.0`.
+
+
 Contributing
 ------------
 

data/Rakefile

@@ -1,4 +1,5 @@
 require 'bundler/gem_tasks'
+require 'semantic/version/tasks'
 
 desc 'Open a pry console preloaded with this library'
 task console: 'console:pry'

data/lib/semantic/version/tasks.rb

@@ -0,0 +1,236 @@
+require 'rake'
+
+require 'highline/import'
+require 'semantic/version'
+
+
+module Semantic
+  class Version
+    module Tasks
+
+      def levels
+        %i[major minor patch]
+      end
+      def types
+        {bump: :by, jump: :to}
+      end
+
+      def default_level
+        :patch
+      end
+      def default_type
+        :bump
+      end
+      def default_incrementor
+        :by
+      end
+      def default_num
+        1
+      end
+
+
+      def version
+        @version ||= Semantic::Version.read version_filepath
+      end
+
+      def version_filepath
+        @version_filepath ||= Pathname.new find_version_file
+      end
+
+      def find_version_file
+        ENV['VERSION_FILE'] ||= begin
+          candidates = Dir['*.version']
+          case candidates.length
+          when 0
+            ask [
+              'Specify a version file to read from.',
+              'In the future you can avoid this by running `rake version:install`,',
+              'or setting ENV["VERSION_FILE"] to a custom .version file location in your Rakefile.',
+              ' > ',
+            ].join("\n")
+          when 1
+            candidates.first
+          else
+            choose do |menu|
+              menu.prompt = "Multiple possible version files found. Please select one."
+              (0..candidates.length).each do |number|
+                selection = candidates[number]
+                menu.choice "#{number}: #{selection}" do
+                  say "(In the future you can avoid this by setting ENV['VERSION_FILE'] in your Rakefile.)\n > "
+                  selection
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def update_version(type, level = default_level, incrementor = default_incrementor, num = default_num)
+        say "#{type.to_s.capitalize.chomp('e')}ing #{version} to #{updated_version(type, level, incrementor, num)}..."
+        File.write version_filepath, updated_version(type, level, incrementor, num)
+      end
+
+      def updated_version(type, level = default_level, incrementor = default_incrementor, num = default_num)
+        if type == :release
+          version.tap do |v|
+            if version.prerelease?
+              version.prerelease = nil
+            else
+              version.bump :patch
+            end
+          end
+        else
+          version.bump(level, incrementor => num)
+        end
+      end
+
+      def generate_description(type, level = default_level, incrementor = default_incrementor, num = default_num)
+        if type == :release
+          [
+            'Removes prerelease data or bumps patch level',
+            version ? "(to v#{updated_version(type)})" : nil,
+          ].compact.join(' ')
+        else
+          [
+            "#{type.to_s.capitalize} #{level} level",
+            (incrementor == :by and num == 1) ? nil : "#{incrementor} #{num}",
+            version ? "(to v#{updated_version(type, level, incrementor, num)})" : nil,
+          ].compact.join(' ')
+        end
+      end
+
+    end
+  end
+end
+
+include Semantic::Version::Tasks
+
+desc [
+  'Show version number in',
+  version_filepath ? version_filepath : '.version',
+  version ? "(v#{version})" : nil,
+].compact.join(' ')
+task :version do
+  say "#{version}"
+end
+
+namespace :version do
+
+  desc 'Generates a .version file in the project root.'
+  task :install, :version do |_, opts|
+
+    gemspec_file = ENV['GEMSPEC_FILE'] ||= begin
+      candidates = Dir['*.gemspec']
+      case candidates.length
+      when 0
+        say [
+          'No .gemspec file found.',
+          'To auto-load gemspec information in future runs of `rake version:install`,',
+          'set ENV["GEMSPEC_FILE"] to a .gemspec file location in your Rakefile.',
+        ].join("\n")
+      when 1
+        candidates.first
+      else
+        choose do |menu|
+          menu.prompt = "Multiple gemspec files found to name your .version file after. Please select one."
+          (0..candidates.length).each do |number|
+            selection = candidates[number]
+            menu.choice "#{number}: #{selection}" do
+              say ' > '
+              selection
+            end
+          end
+        end
+      end
+    end
+
+    version_file = ENV['VERSION_FILE'] ||= if gemspec_file
+      version_file = File.basename(gemspec_file, '.*') + '.version'
+    else
+      version_file = ask [
+        'Specify a version file to create.',
+        ' > ',
+      ].join("\n")
+    end
+
+    version = opts[:version] ||= if gemspec_file
+      load gemspec_file
+      Gem::Specification.find_by_name(File.basename(gemspec_file, '.*')).version
+    else
+      '0.0.1'
+    end
+
+    File.write version_file, version
+  end
+
+  types.each do |type, incrementor|
+
+    desc generate_description(type, default_level, types[default_type], default_num) if type == default_type
+    task type do
+      update_version(type, default_level, types[type], default_num)
+    end
+
+    namespace type do
+
+      %i[major minor patch].each do |level|
+
+        desc generate_description(type, level, types[type], default_num) if type == default_type and level != default_level
+        task level do
+          update_version(type, level, types[type], default_num)
+        end
+
+        namespace level do
+          desc generate_description(type, level, types[type], 'the specified number') unless true # type == default_type
+          task types[type], :num do |_, opts|
+            update_version(type, level, types[type], Integer(opts[:num]))
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+  desc generate_description(:release)
+  task :release do
+    update_version(:release)
+  end
+
+  task :number do
+    say version.number
+  end
+
+  %i[prerelease meta].each do |data|
+
+    task data do
+      say version.send data
+    end
+
+    namespace data do
+
+      task :clear do
+        updated_version = version.tap do |v|
+          v.send :"#{data}=", nil
+        end
+        File.write version_filepath, updated_version
+      end
+
+      task :set, :to do |_, opts|
+        updated_version = version.tap do |v|
+          v.send :"#{data}=", *opts[:to].split('.')
+        end
+        File.write version_filepath, updated_version
+      end
+
+      task :append, :element do |_, opts|
+        updated_version = version.tap do |v|
+          v.send(:"#{data}") << opts[:element]
+        end
+        File.write version_filepath, updated_version
+      end
+
+    end
+  end
+
+end

data/lib/semantic/version.rb

@@ -13,9 +13,6 @@ module Semantic
 
     class << self
 
-      extend Forwardable
-      def_delegators :number, :major, :minor, :patch, :stable?
-
       def pattern
         /(?<number>\d+\.\d+\.\d+)(\-(?<prerelease>[^+]+))?(\+(?<meta>.+))?/
       end
@@ -40,13 +37,21 @@ module Semantic
       super Number.new(major, minor, patch), Data.new(*prerelease), Data.new(*meta)
     end
 
+    extend Forwardable
+    def_delegators :number, :major, :minor, :patch, :stable?
+
     def bump(*args)
       clone.bump!(*args)
     end
 
-    def bump!(*args)
+    def bump!(*args, preserve: [], **opts)
       tap do |version|
         version.number.bump!(*args)
+        preserve = Array(preserve)
+        unless preserve.include? :all
+          version.prerelease = nil unless preserve.include? :prerelease
+          version.meta = nil unless preserve.include? :meta
+        end
       end
     end
 
@@ -55,7 +60,7 @@ module Semantic
     end
 
     def prerelease= *array
-      self[:prerelease] = Data.new(*array)
+      self[:prerelease] = array.flatten.compact.empty? ? nil : Data.new(*array.flatten)
     end
 
     def meta?
@@ -63,7 +68,7 @@ module Semantic
     end
 
     def meta= *array
-      self[:meta] = Data.new(*array)
+      self[:meta] = array.flatten.compact.empty? ? nil : Data.new(*array.flatten)
     end
 
     def to_s

data/semantic-version.version

@@ -1 +1 @@
-2.0.0-alpha.1
+2.0.0-alpha.2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic-version
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.1
+  version: 2.0.0.pre.alpha.2
 platform: ruby
 authors:
 - Chris Keele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-17 00:00:00.000000000 Z
+date: 2015-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -87,6 +87,7 @@ files:
 - lib/semantic/version/data.rb
 - lib/semantic/version/helper.rb
 - lib/semantic/version/number.rb
+- lib/semantic/version/tasks.rb
 - lib/semantic/version/to_string.rb
 - semantic-version.gemspec
 - semantic-version.version