with-version 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a78fa4c49e7ff1cc9d33f1a9344cbe9d7ce95224693b4bf9b4e3d41ea436a40a
+  data.tar.gz: 65d8a5357cef1b1a69aeff518f1ca1d0e35d55920166bc2ae5b6f2484982d283
+SHA512:
+  metadata.gz: 6b153188b7ad108b454044f7a8717420788d61e382c8feee963361525d0933316a19793357bfbb3d5d2c99ac5f82d6f6185cb6035cda2f4a09f48dfef7543f94
+  data.tar.gz: 1f42d854e9183a0cec864e5e48e1aa8de205646bce8ef792ceed275b13396e251e8c12c755b4c9e070cc450073892d6a33f7a200a9bf43c6357a9518fe1be66c

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (1/13/2020)
+
+* Initial public release - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to With::Version
+
+This project is work of [many contributors](https://github.com/dblock/with-version/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/with-version/pulls), [propose features and discuss issues](https://github.com/dblock/with-version/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/with-version) and check out your copy.
+
+```
+git clone https://github.com/contributor/with-version.git
+cd with-version
+git remote add upstream https://github.com/dblock/with-version.git
+```
+
+### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Contribute Code
+
+### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+
+Make sure that `bundle exec rake` completes without errors.
+
+### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
+
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+### Push
+
+```
+git push origin my-feature-branch
+```
+
+### Make a Pull Request
+
+Go to https://github.com/contributor/with-version and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/with-version/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :development, :test do
+  gem 'rspec'
+  gem 'rubocop', '0.79.0'
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    with-version (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  rubocop (= 0.79.0)
+  with-version!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Daniel Doubrovkine.
+
+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,48 @@
+With::Version
+==========
+
+[![Gem Version](http://img.shields.io/gem/v/with-version.svg)](http://badge.fury.io/rb/with-version)
+[![Build Status](http://img.shields.io/travis/dblock/with-version.svg)](https://travis-ci.org/dblock/with-version)
+
+Syntax sugar for version checks. Inspired by [usage in hashie](https://github.com/hashie/hashie/search?q=with_minimum_ruby&unscoped_q=with_minimum_ruby).
+
+## Usage
+
+### Ruby::Version
+
+Use `with_minimum_ruby` to check against a Ruby version at class load time, instead of runtime.
+
+```ruby
+require 'with-version'
+
+class Example
+  include With::Version::Ruby
+
+  with_minimum_ruby '2.4.0' do
+    # only declared with Ruby 2.4.0 or newer
+    def dig(*keys)
+      puts "Digging #{keys.join(', ')} ..."
+    end
+  end
+end
+```
+
+```ruby 
+# Ruby 2.3.0
+undefined method `dig' for #<Example:0x00007fca9388a8a0> (NoMethodError)
+```
+
+```ruby
+# Ruby 2.4.0
+Digging x, y ...
+```
+
+## Contributing
+
+You're encouraged to contribute to this gem. See [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Copyright and License
+
+Copyright (c) 2020, Daniel Doubrovkine and [Contributors](CHANGELOG.md).
+
+This project is licensed under the [MIT License](LICENSE.md).

data/RELEASING.md

@@ -0,0 +1,67 @@
+# Releasing With::Version
+
+There're no hard rules about when to release with-version. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/with-version) for all supported platforms.
+
+Increment the version, modify [lib/with-version/version.rb](lib/with-version/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.2.1` to `0.2.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.2.1` to `0.3.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.2.2 (7/10/2015)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add README.md CHANGELOG.md lib/with-version/version.rb
+git commit -m "Preparing for release, 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+with-version 0.2.2 built to pkg/with-version-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed with-version 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+Next Release
+============
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/with-version/version.rb](lib/with-version/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/with-version/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/lib/with-version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'with-version/version'
+require 'with-version/ruby'

data/lib/with-version/ruby.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'ruby/version'
+
+module With
+  module Version
+    module Ruby
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def with_minimum_ruby(version)
+          if With::Version::Ruby::Version.new(RUBY_VERSION) >= With::Version::Ruby::Version.new(version)
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/with-version/ruby/version.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# Copyright (c) Chad Fowler, Rich Kilmer, Jim Weirich and others.
+# Portions copyright (c) Engine Yard and Andre Arko
+#
+# 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.
+
+module With
+  module Version
+    module Ruby
+      class Version
+        include Comparable
+
+        attr_accessor :segments
+
+        def initialize(version)
+          @segments = split_to_segments(version)
+        end
+
+        def <=>(other)
+          lhsegments = segments
+          rhsegments = other.segments
+
+          lhsize = lhsegments.size
+          rhsize = rhsegments.size
+          limit  = (lhsize > rhsize ? lhsize : rhsize) - 1
+
+          i = 0
+
+          while i <= limit
+            lhs = lhsegments[i] || 0
+            rhs = rhsegments[i] || 0
+            i += 1
+
+            next      if lhs == rhs
+            return -1 if lhs.is_a?(String) && rhs.is_a?(Numeric)
+            return  1 if lhs.is_a?(Numeric) && rhs.is_a?(String)
+
+            return lhs <=> rhs
+          end
+
+          0
+        end
+
+        private
+
+        def split_to_segments(version)
+          version.scan(/[0-9]+|[a-z]+/i).map do |segment|
+            /^\d+$/ =~ segment ? segment.to_i : segment
+          end.freeze
+        end
+      end
+    end
+  end
+end

data/lib/with-version/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module With
+  module Version
+    VERSION = '0.1.0'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'with-version'
+
+RSpec.configure(&:raise_errors_for_deprecations!)

data/spec/with-version/ruby_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe With::Version::Ruby do
+  include With::Version::Ruby
+
+  NEXT_VERSION = Gem::Version.new(RUBY_VERSION).bump.to_s
+  PREV_VERSION = Gem::Version.new('1.9.3').to_s
+
+  context '#with_minimum_ruby' do
+    before :all do
+      @versions = []
+    end
+
+    context NEXT_VERSION do
+      with_minimum_ruby(NEXT_VERSION) do
+        it 'never runs' do
+          raise NEXT_VERSION
+        end
+      end
+    end
+
+    context RUBY_VERSION do
+      with_minimum_ruby(RUBY_VERSION) do
+        it 'includes the current version' do
+          @versions << RUBY_VERSION
+        end
+      end
+    end
+
+    context PREV_VERSION do
+      with_minimum_ruby(PREV_VERSION) do
+        it 'includes the current version' do
+          @versions << PREV_VERSION
+        end
+      end
+    end
+
+    after :all do
+      expect(@versions.sort).to eq([PREV_VERSION, RUBY_VERSION])
+    end
+  end
+end

data/spec/with-version/version_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe With::Version do
+  it 'has a version' do
+    expect(With::Version::VERSION).not_to be_nil
+  end
+end

data/with-version.gemspec

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'with-version/version'
+
+Gem::Specification.new do |s|
+  s.name = 'with-version'
+  s.version = With::Version::VERSION
+  s.authors = ['Daniel Doubrovkine']
+  s.email = 'dblock@dblock.org'
+  s.platform = Gem::Platform::RUBY
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = Dir['**/*']
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/dblock/with-version'
+  s.licenses = ['MIT']
+  s.summary = 'Syntax sugar for version checks.'
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: with-version
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Doubrovkine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- RELEASING.md
+- Rakefile
+- lib/with-version.rb
+- lib/with-version/ruby.rb
+- lib/with-version/ruby/version.rb
+- lib/with-version/version.rb
+- spec/spec_helper.rb
+- spec/with-version/ruby_spec.rb
+- spec/with-version/version_spec.rb
+- with-version.gemspec
+homepage: http://github.com/dblock/with-version
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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: 1.3.6
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Syntax sugar for version checks.
+test_files: []