versionaire 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b35b90792f1bc9448598be77438f533e87a7ad04
-  data.tar.gz: a07469a9bd80e8ba46578d69c028329c31fcc6a9
+  metadata.gz: 34468329f30afcc69ad0decfe31ef293346aa16f
+  data.tar.gz: 34a6064108cc26f6d5ee3b69653962911addf75b
 SHA512:
-  metadata.gz: 2c0da5f8dae0567e5d40529c44d351dc2fd3361553187ff46e1441436679fe7cbf53b12c9a4624a3e79df571c5675ac28529589cdd29c8e6fde6b32653b8813e
-  data.tar.gz: 30235a347bdd70d65553ea29f6da8a9016fde40741497574b896562eadd180739669289d631aa2218764b65b136cb5dcc381d98e8517cc58dd4998c148981d7d
+  metadata.gz: 42567538dadd2d31ab0013bde14b6abfd58dba8617fd5c45df909c1f56fc625b1a4d6a61d4a933fc21dbae2b34bc282ba0326740f880b85839424b5f322fa193
+  data.tar.gz: 8f52ad15a86d56ea3df8bdddb12d6041f8eb9b697218d3b0ff6f78190870a18a1bffc12aa051589e02c4367b4928f65db10ddd8f78c416e3c6ef7b3690aab0d8

data/README.md

@@ -7,7 +7,7 @@
 [![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/versionaire.svg)](https://travis-ci.org/bkuhlmann/versionaire)
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
 
-Provides immutable, semantic versioning.
+Provides immutable, thread-safe, semantic versioning.
 
 <!-- Tocer[start]: Auto-generated, don't remove. -->
 
@@ -18,16 +18,19 @@ Provides immutable, semantic versioning.
 - [Requirements](#requirements)
 - [Setup](#setup)
 - [Usage](#usage)
-  - [Basic](#basic)
-  - [Math](#math)
-    - [Add](#add)
-    - [Subtract](#subtract)
-  - [Comparisons](#comparisons)
+  - [Initialization](#initialization)
   - [Equality](#equality)
-  - [Identity](#identity)
-  - [Implicit Conversions](#implicit-conversions)
-  - [Explicit Conversions](#explicit-conversions)
-  - [Conversions (Casting)](#conversions-casting)
+    - [Value (`#==`)](#value-)
+    - [Hash (`#eql?`)](#hash-eql)
+    - [Case (`#===`)](#case-)
+    - [Identity (`#equal?`)](#identity-equal)
+  - [Conversions](#conversions)
+    - [Function (Casting)](#function-casting)
+    - [Implicit](#implicit)
+    - [Explicit](#explicit)
+  - [Math](#math)
+    - [Addition](#addition)
+    - [Subtraction](#subtraction)
 - [Tests](#tests)
 - [Versioning](#versioning)
 - [Code of Conduct](#code-of-conduct)
@@ -41,14 +44,12 @@ Provides immutable, semantic versioning.
 # Features
 
 - Provides [Semantic Versioning](http://semver.org).
-- Provides immutable version instances.
-- Provides conversions (casts) from a `String`, `Array`, `Hash`, or `Version` to a new `Version`.
-- Provides impicit conversion to a `String`.
-- Provides explicit conversions to a `String`, `Array`, and a `Hash`.
+- Provides immutable, thread-safe version instances.
+- Provides conversions (casts) from a `String`, `Array`, `Hash`, or `Version` to a `Version`.
 
 # Screencasts
 
-TBD
+[![asciicast](https://asciinema.org/a/26561.png)](https://asciinema.org/a/40455)
 
 # Requirements
 
@@ -74,7 +75,7 @@ Add the following to your Gemfile:
 
 # Usage
 
-## Basic
+## Initialization
 
 A new version can be initialized in a variety of ways:
 
@@ -83,80 +84,72 @@ A new version can be initialized in a variety of ways:
     Versionaire::Version.new major: 1, minor: 2                 # "1.2.0"
     Versionaire::Version.new major: 1, minor: 2, maintenance: 3 # "1.2.3"
 
-## Math
+## Equality
 
-Versions can be added and subtracted from each other.
+### Value (`#==`)
 
-### Add
+Equality is deterimined by the state of the object. This means that a version is equal to another version as long as
+all of the values (i.e. state) are equal to each other. Example:
 
-    version_1 = Versionaire::Version.new major: 1, minor: 2, maintenance: 3
-    version_2 = Versionaire::Version.new major: 2, minor: 5, maintenance: 7
-    version_1 + version_2 # "3.7.10"
+    version_a = Versionaire::Version.new major: 1
+    version_b = Versionaire::Version.new major: 2
+    version_c = Versionaire::Version.new major: 1
 
-### Subtract
+    version_a == version_a # true
+    version_a == version_b # false
+    version_a == version_c # true
 
-    version_1 = Versionaire::Version.new major: 1, minor: 2, maintenance: 3
-    version_2 = Versionaire::Version.new major: 1, minor: 1, maintenance: 1
-    version_1 - version_2 # "0.1.2"
+Knowning this, versions can be compared against one another too:
 
-    version_1 = Versionaire::Version.new major: 1
-    version_2 = Versionaire::Version.new major: 5
-    version_1 - version_2 # Fails with a Versionaire::Errors::NegativeNumber
+    version_a > version_b                   # false
+    version_a < version_b                   # true
+    version_a.between? version_c, version_b # true
 
-## Comparisons
+### Hash (`#eql?`)
 
-Versions can be compared against other versions:
+Behaves exactly as `#==`.
 
-    version_1 = Versionaire::Version.new major: 1
-    version_2 = Versionaire::Version.new major: 5
+### Case (`#===`)
 
-    version_1 > version_2  # false
-    version_1 == version_2 # false
-    version_1 < version_2  # true
+Behaves exactly as `#==`.
 
-Versions can't be compared to similar objects:
+### Identity (`#equal?`)
 
-    version = Versionaire::Version.new major: 1
+Works like any other standard Ruby object where an object is equal only to itself.
 
-    version == "1.0.0"                              # false
-    version == [1, 0, 0]                            # false
-    version == {major: 1, minor: 0, maintenance: 0} # false
+    version_a = Versionaire::Version.new major: 1
+    version_b = Versionaire::Version.new major: 2
+    version_c = Versionaire::Version.new major: 1
 
-## Equality
+    version_a.equal? version_a # true
+    version_a.equal? version_b # false
+    version_a.equal? version_c # false
 
-Equality is based on the values that make up the version, not identity.
+## Conversions
 
-    version = Versionaire::Version.new major: 1, minor: 2, maintenance: 3
-    identical = Versionaire::Version.new major: 1, minor: 2, maintenance: 3
-    different = Versionaire::Version.new major: 3
+### Function (Casting)
 
-    version == version   # true
-    version == identical # true
-    version == different # false
+The `Versionaire::Version` function is provided for explicit casting to a version:
 
-This is the same behavior for `#eql?` method too.
-
-## Identity
-
-Identity is composed of the values that make up the version plus the class:
+    version = Versionaire::Version.new major: 1
 
-    version = Versionaire::Version.new major: 1, minor: 2, maintenance: 3
-    identical = Versionaire::Version.new major: 1, minor: 2, maintenance: 3
-    different = Versionaire::Version.new major: 3
+    Versionaire::Version "1.0.0"
+    Versionaire::Version [1, 0, 0]
+    Versionaire::Version major: 1, minor: 0, maintenance: 0
+    Versionaire::Version version
 
-    version.hash   # -4162833121614102126
-    identical.hash # -4162833121614102126
-    different.hash # -2082793513660996236
+Each of these conversions will result in a version object that represents "1.0.0". When attempting to convert an
+unsupported type, a `Versionaire::Errors::Conversion` exception will be thrown.
 
-## Implicit Conversions
+### Implicit
 
 Implicit conversion to a `String` is supported:
 
     "1.0.0".match Versionaire::Version.new(major: 1) # <MatchData "1.0.0">
 
-## Explicit Conversions
+### Explicit
 
-Explicit converting to a `String`, `Array`, or `Hash` is supported:
+Explicit conversion to a `String`, `Array`, or `Hash` is supported:
 
     version = Versionaire::Version.new
 
@@ -164,19 +157,25 @@ Explicit converting to a `String`, `Array`, or `Hash` is supported:
     version.to_a # [0, 0, 0]
     version.to_h # {major: 0, minor: 0, maintenance: 0}
 
-## Conversions (Casting)
+## Math
 
-The `Versionaire::Version` function is provided for explicit conversion (casting) to a new version:
+Versions can be added and subtracted from each other.
 
-    version = Versionaire::Version.new major: 1
+### Addition
 
-    Versionaire::Version "1.0.0"
-    Versionaire::Version [1, 0, 0]
-    Versionaire::Version major: 1, minor: 0, maintenance: 0
-    Versionaire::Version version
+    version_1 = Versionaire::Version.new major: 1, minor: 2, maintenance: 3
+    version_2 = Versionaire::Version.new major: 2, minor: 5, maintenance: 7
+    version_1 + version_2 # "3.7.10"
 
-Each of these conversions will result in a new version object that is equal to "1.0.0". When attempting to convert an
-unsupported type, a `Versionaire::Errors::Conversion` exception will be thrown.
+### Subtraction
+
+    version_1 = Versionaire::Version.new major: 1, minor: 2, maintenance: 3
+    version_2 = Versionaire::Version.new major: 1, minor: 1, maintenance: 1
+    version_1 - version_2 # "0.1.2"
+
+    version_1 = Versionaire::Version.new major: 1
+    version_2 = Versionaire::Version.new major: 5
+    version_1 - version_2 # Fails with a Versionaire::Errors::NegativeNumber
 
 # Tests
 

data/lib/versionaire/conversion.rb

@@ -2,27 +2,57 @@
 
 # The gem namespace.
 module Versionaire
-  # Conversion function for casting (strict) a value into a version.
+  # Conversion function (strict) for casting an object into a version.
   # rubocop:disable Style/MethodName
-  # rubocop:disable Metrics/MethodLength
-  # rubocop:disable Metrics/AbcSize
-  # rubocop:disable Metrics/CyclomaticComplexity
-  def Version value
-    case value
-      when String
-        fail(Errors::Conversion, Errors::Conversion.string_message) unless value =~ Version.format
-        Version.new Version.arguments(*value.tr("v", "").split(".").map(&:to_i))
-      when Array
-        fail(Errors::Conversion, Errors::Conversion.array_message) unless (0..3).cover?(value.size)
-        Version.new Version.arguments(*value.fill(0, value.size..2))
-      when Hash
-        valid = value.keys.all? { |key| Version.keys.include? key }
-        fail(Errors::Conversion, Errors::Conversion.hash_message) unless valid
-        Version.new value
-      when Version then value
-      else fail(Errors::Conversion, Errors::Conversion.primitive_message)
+  def Version object
+    aid = VersionAid.new object
+
+    case object
+      when String then aid.convert_from_string
+      when Array then aid.convert_from_array
+      when Hash then aid.convert_from_hash
+      when Version then object
+      else fail Errors::Conversion, Errors::Conversion.primitive_message
     end
   end
-
   module_function :Version
+
+  # Aids with converting objects into valid versions.
+  class VersionAid
+    def initialize value
+      @value = value
+    end
+
+    def convert_from_string
+      fail(Errors::Conversion, Errors::Conversion.string_message) unless value =~ Version.string_format
+      Version.new string_to_arguments
+    end
+
+    def convert_from_array
+      fail(Errors::Conversion, Errors::Conversion.array_message) unless (0..3).cover?(value.size)
+      Version.new array_to_arguments
+    end
+
+    def convert_from_hash
+      fail(Errors::Conversion, Errors::Conversion.hash_message) unless required_keys?
+      Version.new value
+    end
+
+    private
+
+    attr_reader :value
+
+    def string_to_arguments
+      Version.arguments(*value.tr("v", "").split(".").map(&:to_i))
+    end
+
+    def array_to_arguments
+      Version.arguments(*value.fill(0, value.size..2))
+    end
+
+    def required_keys?
+      value.keys.all? { |key| Version.keys.include? key }
+    end
+  end
+  private_constant :VersionAid
 end

data/lib/versionaire/errors/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Versionaire
   module Errors
     # The base error class for all gem-related errors.

data/lib/versionaire/errors/conversion.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Versionaire
   module Errors
     # Thrown when attempting to convert (cast) a primitive to a version.

data/lib/versionaire/errors/invalid_number.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Versionaire
   module Errors
     # Thrown when not using numbers.

data/lib/versionaire/errors/negative_number.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Versionaire
   module Errors
     # Thrown when numbers are negative.

data/lib/versionaire/identity.rb

@@ -12,7 +12,7 @@ module Versionaire
     end
 
     def self.version
-      "0.1.0"
+      "1.0.0"
     end
 
     def self.version_label

data/lib/versionaire/version.rb

@@ -11,8 +11,17 @@ module Versionaire
       %i(major minor maintenance)
     end
 
-    def self.format
-      /\Av?\d{1,}\.\d{1,}\.\d{1,}\z/
+    def self.string_format
+      /
+        \A     # Start of string.
+        v?     # Optional prefix.
+        \d{1,} # Major version.
+        \.     # Delimiter.
+        \d{1,} # Minor version.
+        \.     # Delimiter.
+        \d{1,} # Maintenance version.
+        \z     # End of string.
+      /x
     end
 
     def self.arguments major, minor, maintenance

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionaire
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
   xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
   -----END CERTIFICATE-----
-date: 2016-03-19 00:00:00.000000000 Z
+date: 2016-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,6 +158,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bond
+  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: wirb
+  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: hirb
+  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: awesome_print
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -256,7 +312,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides immutable, semantic versioning.
+description: Provides immutable, thread-safe, semantic versioning.
 email:
 - brooke@alchemists.io
 executables: []
@@ -288,9 +344,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -301,5 +357,5 @@ rubyforge_project:
 rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
-summary: Provides immutable, semantic versioning.
+summary: Provides immutable, thread-safe, semantic versioning.
 test_files: []