version-serializer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10a94eb3cccbbe20cb85b93dded6f33d131ef39f
-  data.tar.gz: f3fa06eacc12e06e94b64459e4091ae63ab59703
+  metadata.gz: 4ed6b796906bba1905dcab7f248a3d57d45ee52b
+  data.tar.gz: 6c20492d42f639bbebac50dbfc8df4aaf165ce43
 SHA512:
-  metadata.gz: 3fb67fd64dff9ee815c00c937b56324793372005d1b43d09ea9f9a88db4e6a51c365cf734420dae176c2a3f017402cb1bef0fa9204a10b2c695504f71af94d96
-  data.tar.gz: f94a398b2e2842b0ada602bc5ca8e954eaa3b7eeb20b2a60d988bf725384e2b493aa0c51e986a441726606ab8f3467ced96f2427219d6351726703af6e1446af
+  metadata.gz: 707796012d0dd5f87dbc68bbfb2fb72ffc8c2854b5c024be2cb0af1c38b3e71066e48f2c730fbd4fba0c6b5a8bdaf30a0a64367a67f88deeccf93f63d9b979ee
+  data.tar.gz: ce6c58f585107e05decc1551ee92242edc7e6437fa49a1e4921568fb92c0d2cfd079156dd647dd14788ee399e4bbc429e1b50d37b7969e5a062147f9d3718edf

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 
 group :testing do
   gem "pry"
+  gem "pry-nav"
   gem "pry-doc"
 
   gem "guard"
@@ -15,4 +16,4 @@ group :testing do
   gem "terminal-notifier-guard"
 
   gem 'simplecov', :require => false
-end
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    version-serializer (1.0.0)
+    version-serializer (1.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -39,6 +39,8 @@ GEM
     pry-doc (0.6.0)
       pry (~> 0.9)
       yard (~> 0.8)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
     rake (10.3.2)
     rb-fsevent (0.9.4)
     rb-inotify (0.9.4)
@@ -64,6 +66,7 @@ DEPENDENCIES
   guard-yard
   pry
   pry-doc
+  pry-nav
   rake
   rb-fsevent
   simplecov
@@ -71,4 +74,4 @@ DEPENDENCIES
   version-serializer!
 
 BUNDLED WITH
-   1.12.3
+   1.14.3

data/README.md

@@ -1,6 +1,7 @@
 # VersionSerializer
 
-TODO: Write a gem description
+Serializes semantic versions and adds compatibility methods to check if a given
+instance is compatible with a certain version by specifying a range.
 
 ## Installation
 
@@ -16,14 +17,19 @@ Or install it yourself as:
 
     $ gem install version_serializer
 
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
 
-## Contributing
+# Model Definition
+class YourModel < ActiveRecord::Base
+  include VersionSerializer::RangeCompatibility
+  serialize :min_version, VersionSerializer::SemanticVersion
+  serialize :max_version, VersionSerializer::SemanticVersion
+end
 
-1. Fork it ( http://github.com/<my-github-username>/version_serializer/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# Compatibility
+m = YourModel.create(min_version: "1.0.1", max_version: "2.3.4")
+m.compatible? "2.0"
+```

data/lib/version_serializer.rb

@@ -1,53 +1,3 @@
 require "version_serializer/version"
-
-module VersionSerializer
-  class Version
-    attr_accessor :major, :minor
-
-    def initialize major, minor
-      @major = major
-      @minor = minor
-    end
-
-    def self.load (data)
-      return nil if data.nil?
-      self.new(*('%.3f' % data).split('.').map(&:to_i))
-    end
-
-    def self.dump (object)
-      return nil if object.nil?
-
-      if object.respond_to?(:major)
-        ("%d.%03d" % [object.major, object.minor]).to_f
-      else
-        object
-      end
-    end
-
-    def self.from_string data
-      return nil if data.nil?
-      self.new(*data.to_s.split('.').map(&:to_i))
-    end
-
-    def self.range min, max
-      self.dump(min) .. self.dump(max)
-    end
-
-    include Comparable
-    def <=> other
-      return nil if other.nil?
-
-      [major, minor] <=> [other.major, other.minor]
-    end
-
-    def as_json options = {}
-      to_s
-    end
-
-    def to_s
-      return nil if major.nil? || minor.nil?
-
-      "%d.%d" % [major, minor]
-    end
-  end
-end
+require "version_serializer/semantic_version"
+require "version_serializer/range_compatibility"

data/lib/version_serializer/range_compatibility.rb

@@ -0,0 +1,16 @@
+module VersionSerializer
+  module RangeCompatibility
+    def has_version?
+      min_version || max_version
+    end
+
+    def compatible? version
+      return true unless has_version?
+
+      version = SemanticVersion.new(version) if version.is_a? String
+
+      (min_version.nil? || min_version && version >= min_version) &&
+      (max_version.nil? || max_version && version <= max_version)
+    end
+  end
+end

data/lib/version_serializer/semantic_version.rb

@@ -0,0 +1,13 @@
+module VersionSerializer
+  class SemanticVersion < Gem::Version
+    def self.load (data)
+      return nil if data.nil?
+      self.new(data)
+    end
+
+    def self.dump (object)
+      return nil if object.nil?
+      object.to_s
+    end
+  end
+end

data/lib/version_serializer/version.rb

@@ -1,3 +1,53 @@
 module VersionSerializer
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
+
+  class Version
+    attr_accessor :major, :minor
+
+    def initialize major, minor
+      @major = major
+      @minor = minor
+    end
+
+    def self.load (data)
+      return nil if data.nil?
+      self.new(*('%.3f' % data).split('.').map(&:to_i))
+    end
+
+    def self.dump (object)
+      return nil if object.nil?
+
+      if object.respond_to?(:major)
+        ("%d.%03d" % [object.major, object.minor]).to_f
+      else
+        object
+      end
+    end
+
+    def self.from_string data
+      return nil if data.nil?
+      self.new(*data.to_s.split('.').map(&:to_i))
+    end
+
+    def self.range min, max
+      self.dump(min) .. self.dump(max)
+    end
+
+    include Comparable
+    def <=> other
+      return nil if other.nil?
+
+      [major, minor] <=> [other.major, other.minor]
+    end
+
+    def as_json options = {}
+      to_s
+    end
+
+    def to_s
+      return nil if major.nil? || minor.nil?
+
+      "%d.%d" % [major, minor]
+    end
+  end
 end

data/test/unit/range_compatibility_test.rb

@@ -0,0 +1,40 @@
+require 'version_serializer'
+require 'test_helper'
+
+
+class CompatibilityTest < MiniTest::Test
+
+  class TestResource
+    include VersionSerializer::RangeCompatibility
+
+    attr_accessor :min_version, :max_version
+
+    def initialize(min_version=nil, max_version=nil)
+      @min_version = VersionSerializer::SemanticVersion.new(min_version) if min_version
+      @max_version = VersionSerializer::SemanticVersion.new(max_version) if max_version
+    end
+
+  end
+
+  def test_compatible
+    binding.pry
+    [
+      ["1.2", "1.5"],
+      [nil, "1.5"],
+      ["1.2.1", nil],
+      [nil, nil]
+    ].each do |min, max|
+      assert TestResource.new(min, max).compatible?("1.2.2")
+    end
+  end
+
+  def test_incompatible
+    [
+      ["1.2", "1.5"],
+      [nil, "1.2"],
+      ["1.7.7", nil]
+    ].each do |min, max|
+      assert !TestResource.new(min, max).compatible?("1.6")
+    end
+  end
+end

data/test/unit/semantic_version_test.rb

@@ -0,0 +1,21 @@
+require 'version_serializer'
+require 'test_helper'
+
+class SemanticVersionTest < MiniTest::Test
+  def test_load
+    assert_equal VersionSerializer::SemanticVersion.new("2.4.0"), VersionSerializer::SemanticVersion.load("2.4.0")
+  end
+
+  def test_dump
+    version = VersionSerializer::SemanticVersion.new("2.4.0")
+    assert_equal version.to_s, VersionSerializer::SemanticVersion.dump(version)
+  end
+
+  def test_nil_load
+    assert_nil VersionSerializer::SemanticVersion.load(nil)
+  end
+
+  def test_nil_dump
+    assert_nil VersionSerializer::SemanticVersion.dump(nil)
+  end
+end

data/test/unit/version_test.rb

@@ -2,7 +2,6 @@ require 'version_serializer'
 require 'test_helper'
 
 class VersionTest < MiniTest::Test
-  # test "Should serialize version" do
   def test_serialize_version
     assert_equal 3.002, VersionSerializer::Version.dump(VersionSerializer::Version.new(3, 2))
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: version-serializer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - NDrive DevOps Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2017-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,12 @@ files:
 - README.md
 - Rakefile
 - lib/version_serializer.rb
+- lib/version_serializer/range_compatibility.rb
+- lib/version_serializer/semantic_version.rb
 - lib/version_serializer/version.rb
 - test/test_helper.rb
+- test/unit/range_compatibility_test.rb
+- test/unit/semantic_version_test.rb
 - test/unit/version_test.rb
 - version_serializer.gemspec
 homepage: http://www.ndrive.com
@@ -76,11 +80,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Serialize version
 test_files:
 - test/test_helper.rb
+- test/unit/range_compatibility_test.rb
+- test/unit/semantic_version_test.rb
 - test/unit/version_test.rb
 has_rdoc: