semvruler 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e551a21ff24c378974f06f05b6a356beda50c5b5671ea5b0bd69ccbf31a86c96
+  data.tar.gz: 90a0d2bbcdc832cb3ace11b30fef608e324b54a537ce988089231bf39ff17a26
+SHA512:
+  metadata.gz: b542d08f2d4bd2483ad9eedef974fb11409309ebdb2adf0a41877232ebbeb81a8228f2a2d551179b457e027e9379a9755fb510d1d7497082f56548c1f8943c64
+  data.tar.gz: 429d14e8e8729e35f88579aa71918096bdb55c838ab823728e077f3aab4c6cf79b6490063b95efd8939e56de4608e8cf6ce1e308b2e39047c7e0519ca9c27ecc

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2.1
+jobs:
+  build:
+    docker:
+      - image: ruby:2.7.0
+    steps:
+      - checkout
+      - run:
+          name: Run the default task
+          command: |
+            gem install bundler -v 2.2.19
+            bundle install
+            bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.1] - 2021-07-04
+### Added
+- Version parsing and destructuring
+- Rules parsing & modification
+- Version comparison and matching

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in semvruler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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,100 @@
+# Semvruler
+
+Provides some utility classes to read, compare and match [semantic versions](https://semver.org/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'semvruler'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install semvruler
+
+## Usage
+
+### Creating versions 
+
+```ruby
+
+    # Creates and destructure version string
+    version = Semvruler.version('2.2.5-pr.0')
+
+    version.major # => 2 
+    version.minor # => 2 
+    version.patch # => 5
+    version.build # => nil
+    version.prerelease # => ['pr','0']
+
+    # You can put back together the original string
+    version.to_s # => '2.2.5-pr.0'
+
+    # Returns an array when multiple versions passed
+    versions = Semvruler.versions(['3.4.5', '2.2.5', '1.1.1', '1.1.1-pr.0'])
+```
+
+### Comparable versions
+
+Versions implement ruby's comparable interface and '~>' operator as well.
+
+```ruby
+    versions = Semvruler.versions(['3.4.5', '2.2.5', '1.1.1', '1.1.1-pr.0'])
+    versions.sort # => ["1.1.1-pr.0", "1.1.1", "2.2.5", "3.4.5"]
+
+    ver1 = version[0]
+    ver2 = version[1]
+
+    ver1 != ver2 # => true
+    ver1 == ver2 # => false
+    ver1 > ver2 # => true
+    ver1 >= ver2 # => true
+    ver1 < ver2 # => false
+    ver1 <= ver2 # => false
+```
+
+### Rules instantiation
+
+```ruby
+    rule = Semvruler.rule('~> 2.0.2')
+    rule.to_s # => '~> 2.0.2'
+
+    # Rules can be adjusted
+    rule.add('< 10.0.1')
+    rule.remove('< 10.0.1')
+    rule.merge(rule2)
+```
+
+### Rules Matching
+
+```ruby
+    rule = Semvruler.rule('!= 2.0.2')
+    rule.match?('2.0.2') # => false
+    rule.match?('2.3.2') # => true
+
+    # Rules respond to to_proc
+    rule = Semvruler.rule('~> 2.0.2')
+    ['3.2.1', '1.2.3', '2.1.1'].find(&rule) # => '2.1.1'
+    ['3.2.1', '1.2.3', '2.1.1'].select(&rule) # => ['2.1.1']
+    ['3.2.1', '1.2.3', '2.1.1'].reject(&rule) # => ['3.2.1', '1.2.3']
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nika-kirosh/semvruler
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'semvruler'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/semvruler.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'set'
+require_relative 'semvruler/version'
+require_relative 'semvruler/order'
+require_relative 'semvruler/semversion'
+require_relative 'semvruler/constraint'
+require_relative 'semvruler/rule'
+
+module Semvruler
+  class Error < StandardError; end
+
+  class << self
+    %i[versions version].each do |method_name|
+      define_method(method_name) do |value|
+        Semversion.parse(value)
+      end
+    end
+
+    def rule(*value)
+      Rule.parse(value)
+    end
+  end
+end

data/lib/semvruler/constraint.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Semvruler
+  class Constraint
+    FORMAT = /^((?<type>=|!=|~>|>=|>|<=|<)\s*)?(?<version>.*)$/.freeze
+
+    class FormatError < StandardError
+      def initialize(msg = 'Invalid format for version')
+        super
+      end
+    end
+
+    class << self
+      def parse(value, safe: true)
+        if value.respond_to?(:map)
+          value.map { |item| cast(item, safe) }
+        else
+          cast(value, safe)
+        end
+      end
+
+      private
+
+      def cast(value, safe)
+        capture = FORMAT.match(value)
+        assert_format(capture, safe)
+      end
+
+      def assert_format(capture, safe)
+        version = Semversion.parse(capture[:version], safe: safe) if capture
+        if capture && version
+          new(capture[:type], version)
+        else
+          raise FormatError unless safe
+
+          nil
+        end
+      end
+    end
+
+    attr_reader :version
+
+    def to_s
+      "#{type_as_string}#{version}"
+    end
+
+    def initialize(type, version)
+      @type = type
+      @version = version
+    end
+
+    def type
+      @type || '='
+    end
+
+    def match?(other)
+      other = Semversion.parse(other, safe: false)
+      other.send(operation, version)
+    end
+
+    protected
+
+    def operation
+      type == '=' ? '==' : type
+    end
+
+    private
+
+    def type_as_string
+      "#{@type} " if @type
+    end
+  end
+end

data/lib/semvruler/order.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Semvruler
+  class Order
+    def initialize(*chain)
+      @chain = chain
+    end
+
+    def <=>(other)
+      index = (0..2).find { |idx| compare_at(other, idx) != 0 }
+      return compare_at(other, index) if index
+      return compare_missed_lenght(other) if compare_missed_lenght(other) != 0
+
+      index = (3..[size, other.size].max).find { |idx| compare_at(other, idx) != 0 }
+      return compare_at(other, index) if index
+
+      no_difference_found
+    end
+
+    protected
+
+    attr_reader :chain
+
+    def no_difference_found
+      0
+    end
+
+    def compare_missed_lenght(other)
+      if size == 3 || other.size == 3
+        (size <=> other.size) * -1
+      else
+        no_difference_found
+      end
+    end
+
+    def compare_at(other, idx)
+      is_numeric = int_at?(idx) || other.int_at?(idx)
+
+      current = is_numeric ? read_int_at(idx) : self[idx].to_s
+      nxt = is_numeric ? other.read_int_at(idx) : other[idx].to_s
+
+      current <=> nxt
+    end
+
+    def [](idx)
+      chain[idx]
+    end
+
+    def read_int_at(idx)
+      if int_at?(idx)
+        self[idx].to_i
+      else
+        self[idx].nil? ? -1 : Float::INFINITY
+      end
+    end
+
+    def int_at?(idx)
+      /^\d+/.match?(self[idx].to_s)
+    end
+
+    def size
+      chain.size
+    end
+  end
+end

data/lib/semvruler/rule.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Semvruler
+  class Rule
+    class << self
+      def parse(value)
+        constraints = Array(Constraint.parse(value, safe: false))
+        new(constraints)
+      end
+    end
+
+    def initialize(constraints)
+      @constraints = Hash[constraints.map { |c| [c.to_s, c] }]
+    end
+
+    def [](idx)
+      constraints[idx]
+    end
+
+    def size
+      constraints.size
+    end
+
+    def add(value)
+      constraint = Constraint.parse(value)
+      constraints[constraint.to_s] = constraint
+    end
+
+    def remove(value)
+      constraint = Constraint.parse(value)
+      constraints.delete(constraint.to_s)
+    end
+
+    def merge(other)
+      new_constraints = [*constraints.values, *other.constraints.values]
+      self.class.new(new_constraints)
+    end
+
+    def match?(version)
+      constraints.values.all? { |c| c.match?(version) }
+    end
+
+    def to_proc
+      ->(version) { match?(version) }
+    end
+
+    protected
+
+    attr_reader :constraints
+  end
+end

data/lib/semvruler/semversion.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Semvruler
+  class Semversion
+    include Comparable
+
+    FORMAT = /
+      ^
+      (?<major>0|[1-9]\d*)\.
+      (?<minor>0|[1-9]\d*)
+      (\.(?<patch>0|[1-9]\d*))?
+      (-(?<prerelease>(0|[1-9]\d*|\d*[a-z-][0-9a-z-]*)(\.(0|[1-9]\d*|\d*[a-z-][0-9a-z-]*))*))?
+      (\+(?<build>[0-9a-z-]+(\.[0-9a-z-]+)*))?
+      $
+    /xi.freeze
+
+    class FormatError < StandardError
+      def initialize(msg = 'Invalid format for version')
+        super
+      end
+    end
+
+    class << self
+      def parse(value, safe: true)
+        if value.respond_to?(:map)
+          value.map { |item| cast(item, safe) }
+        else
+          cast(value, safe)
+        end
+      end
+
+      private
+
+      def cast(value, safe)
+        captures = FORMAT.match(value)
+
+        if captures
+          new(captures)
+        else
+          raise FormatError unless safe
+
+          nil
+        end
+      end
+    end
+
+    attr_reader :major, :minor, :patch, :prerelease, :build
+
+    def to_s
+      "#{core_as_string}#{prerelease_as_string}#{build_as_string}"
+    end
+
+    def initialize(format)
+      @major = format[:major].to_i
+      @minor = format[:minor].to_i
+      @patch = format[:patch].to_i
+      @build = format[:build]
+      @prerelease = format[:prerelease]&.split('.') || []
+      @order = Order.new(@major, @minor, @patch, *@prerelease)
+    end
+
+    def <=>(other)
+      order <=> other.order
+    end
+
+    define_method('~>') do |other|
+      ceil_major = other.patch.positive? ? other.major : other.major + 1
+      ceil_minor = other.patch.positive? ? other.minor + 1 : 0
+      self < self.class.new(major: ceil_major, minor: ceil_minor, patch: 0) && self >= other
+    end
+
+    protected
+
+    attr_reader :order
+
+    private
+
+    def core_as_string
+      "#{major}.#{minor}.#{patch}"
+    end
+
+    def prerelease_as_string
+      return if prerelease.empty?
+
+      str = prerelease.join('.')
+      "-#{str}"
+    end
+
+    def build_as_string
+      return unless build
+
+      "+#{build}"
+    end
+  end
+end

data/lib/semvruler/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Semvruler
+  VERSION = '0.1.1'
+end

data/semvruler.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/semvruler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'semvruler'
+  spec.version       = Semvruler::VERSION
+  spec.authors       = ['Monica L. Quiros']
+  spec.email         = ['nika.kirosh@gmail.com']
+
+  spec.summary       = 'Utility to match and compare semantic versions in ruby'
+  spec.homepage      = 'https://github.com/nika-kirosh/semvruler'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/nika-kirosh/semvruler/blob/main/CHANGELOG.md'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Dependencies
+
+  spec.add_development_dependency  'pry', '~> 0.14.0'
+  spec.add_development_dependency  'rake', '~> 13.0'
+  spec.add_development_dependency  'rspec', '~> 3.0'
+  spec.add_development_dependency  'rubocop', '~> 1.7'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: semvruler
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Monica L. Quiros
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description:
+email:
+- nika.kirosh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/semvruler.rb
+- lib/semvruler/constraint.rb
+- lib/semvruler/order.rb
+- lib/semvruler/rule.rb
+- lib/semvruler/semversion.rb
+- lib/semvruler/version.rb
+- semvruler.gemspec
+homepage: https://github.com/nika-kirosh/semvruler
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nika-kirosh/semvruler
+  source_code_uri: https://github.com/nika-kirosh/semvruler
+  changelog_uri: https://github.com/nika-kirosh/semvruler/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Utility to match and compare semantic versions in ruby
+test_files: []