attr_comparable 0.0.2 → 0.2.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4298a8f8bf1a126196d9bedaeca3e22a91b3a33c6c862b5355436c1120675fc8
+  data.tar.gz: eb72be741397d6f77ff7bd45e80175fc08e9cd0d00b1fae4327486a27b07e974
+SHA512:
+  metadata.gz: 46bdc2c502aa48134ce9b8484099311b69ccc8a6361bcd4743d8d8159d3d50a6b64fd668cbff092456677642529977c76eae827c2cd820ee16adfb20faede4d9
+  data.tar.gz: 533d118ee77b4041a197faa6c86f3558a6e3be4c70685200fd2edddbd1dff0cef0573d82a537daeef040b8cee5db1646073a1b1365f18fa6982283111f17acae

data/.gitignore

@@ -1,2 +1,4 @@
 .idea
 pkg
+
+test/reports/*

data/.ruby-version

@@ -0,0 +1 @@
+2.6.1

data/Gemfile

@@ -1,6 +1,12 @@
-# ruby '1.8.7'
+# ruby '2.4.2'
 
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in attr_default.gemspec
 gemspec
+
+group :development do
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'rake', '>=0.9'
+end

data/Gemfile.lock

@@ -1,18 +1,30 @@
 PATH
   remote: .
   specs:
-    attr_comparable (0.0.2)
-      minitest
+    attr_comparable (0.2.0.pre.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.0.6)
-    rake (10.1.0)
+    ansi (1.5.0)
+    builder (3.2.3)
+    minitest (5.13.0)
+    minitest-reporters (1.4.2)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (13.0.1)
+    ruby-progressbar (1.10.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   attr_comparable!
+  minitest
+  minitest-reporters
   rake (>= 0.9)
+
+BUNDLED WITH
+   1.17.2

data/Jenkinsfile

@@ -0,0 +1,56 @@
+#!/usr/bin/groovy
+@Library('jenkins-pipeline@v0.4.4')
+import com.invoca.docker.*;
+
+pipeline {
+  agent { 
+    kubernetes {
+      defaultContainer 'ruby'
+      yaml '''
+apiVersion: v1
+kind: Pod
+metadata:
+  labels:
+    jenkins/attr-comparable: true
+  namespace: jenkins
+  name: attr-comparable
+spec:
+  containers:
+  - name: ruby
+    image: ruby:2.6.1
+    tty: true
+    command:
+    - cat
+'''
+    }
+  }
+  stages {
+    stage('Unit Tests') {
+      environment { 
+        GITHUB_KEY = credentials('github_key') 
+      }
+
+      steps {
+        script {
+          sh '''
+            # get SSH setup inside the container
+            eval `ssh-agent -s`
+            echo "$GITHUB_KEY" | ssh-add -
+            mkdir -p /root/.ssh
+            ssh-keyscan -t rsa github.com > /root/.ssh/known_hosts
+
+            # run tests
+            bundle install --path vendor/bundle
+            bundle exec rake test
+          '''
+        }
+      }
+
+      post {
+        always { junit 'test/reports/*.xml' }
+      }
+    }
+  }
+
+  post { always { notifySlack(currentBuild.result) } }
+}

data/README.md

@@ -31,6 +31,11 @@ class FullName
         (middle <=> other.middle).nonzero? ||
           suffix <=> other.suffix
   end
+  
+  def to_s
+    no_suffix = [first.presence, middle.presence, last.presence].compact.join(' ')
+    [no_suffix, suffix.presence].compact.join(', ')
+  end
 end
 ```
 You can see that the `<=>` method isn't very DRY, and as shown it doesn't even work with `nil`.
@@ -70,6 +75,6 @@ Example Usage
 >> junior = FullName.new("John", "Q.", "Public", "Jr.")
 >> junior > dad
 => true
->> [mom, dad, junior].sort.map &:to_s
+>> [junior, mom, dad].sort.map &:to_s
 => ["Kathy Doe", "John Q. Public", "John Q. Public, Jr."]
 ```

data/Rakefile

@@ -1,9 +1,9 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 task :default => :test
 
-desc "Run unit tests."
-task :test do
-  ruby "test/attr_comparable_test.rb"
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
 end

data/attr_comparable.gemspec

@@ -1,15 +1,16 @@
 require File.expand_path('../lib/attr_comparable/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_dependency 'minitest' # Included in Ruby 1.9, but we want the latest.
-  gem.add_development_dependency 'rake', '>=0.9'
-
   gem.authors       = ["Colin Kelley"]
   gem.email         = ["colindkelley@gmail.com"]
   gem.description   = %q{AttrComparable}
   gem.summary       = %q{Mix-in to make a value class Comparable. Simply declare the order of attributes to compare and the <=> (as needed by Comparable) is generated for you, including support for nil. Includes Comparable.}
   gem.homepage      = "https://github.com/RingRevenue/attr_comparable"
 
+  gem.metadata = {
+    'allowed_push_host' => 'https://rubygems.org'
+  }
+
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/.*\.rb})

data/lib/attr_comparable.rb

@@ -11,35 +11,35 @@ module AttrComparable
   module ClassMethods
     # like <=> but handles nil values
     # returns the code in string form to be eval'd
-    # code will return nil instead of 0 for equal iff return_nil_on_equal is truthy
-    def compare_with_nil_code(left, right, return_nil_on_equal)
+    def compare_with_nil_code(left, right)
       <<-EOS
         if #{ left }.nil?
           if #{ right }.nil?
-            #{ return_nil_on_equal ? 'nil' : '0' }
+            0
           else
             -1
           end
         elsif #{ right }.nil?
           1
         else
-          (#{ left } <=> #{ right })#{ '.nonzero?' if return_nil_on_equal }
+          if (cmp_result = (#{ left } <=> #{ right })).nil?
+            return nil
+          end
+          cmp_result
         end
       EOS
     end
 
-    def attr_compare(*attributes_arg)
-      attributes = attributes_arg.flatten
-
-      remaining_attrs = attributes.size;
-      attr_exprs = attributes.map do |attribute|
-        remaining_attrs -= 1
-        compare_with_nil_code("self.#{attribute}", "rhs.#{attribute}", remaining_attrs.nonzero?).strip
+    def attr_compare(*attributes)
+      attr_exprs = (attributes.flatten).map do |attribute|
+        '(' + compare_with_nil_code("self.#{attribute}", "rhs.#{attribute}").strip + ')'
       end
 
       class_eval <<-EOS
         def <=>(rhs)
-          #{ attr_exprs.join(" || ") }
+          unless rhs.nil?
+            #{ attr_exprs.join(".nonzero? || ") }
+          end
         end
       EOS
     end

data/lib/attr_comparable/version.rb

@@ -1,3 +1,3 @@
 module AttrComparable
-  VERSION = '0.0.2'
+  VERSION = '0.2.0.pre.1'
 end

data/semaphore_ci/setup.sh

@@ -0,0 +1,3 @@
+#!/bin/sh -x
+
+bundle install --path vendor/bundle

data/test/attr_comparable_test.rb

@@ -1,8 +1,5 @@
+require_relative './test_helper'
 require File.expand_path('../../lib/attr_comparable',  __FILE__)
-require 'bundler'
-Bundler.require(:default)
-require 'minitest/autorun'
-
 
 class ComparableTestOneParameter
   include AttrComparable
@@ -97,4 +94,52 @@ describe 'AttrComparable' do
       assert @d2 != @d3
     end
   end
+
+  describe "parameters that are incompatible to order" do
+    it "should return nil when the objects contain incompatible attributes" do
+      d1 = ComparableTestOneParameter.new(false)
+      d2 = ComparableTestOneParameter.new(true)
+      d3 = ComparableTestManyParameters.new(false, 'D')
+      d4 = ComparableTestManyParameters.new(true, 'D')
+      d5 = ComparableTestManyParameters.new('Kelly', false)
+      d6 = ComparableTestManyParameters.new('Kelly', true)
+
+      assert_nil d1 <=> d2
+      assert_nil d3 <=> d4
+      assert_nil d5 <=> d6
+    end
+
+    # For ComparableTestManyParameters the objects are compared by last_name then first_name
+    # If the comparison of last_names returns nil, that should immediately return nil,
+    # and not compare the remaining attributes. This code tests that by raising a runtime error
+    # if the first_name attribute (later in the compare order) is acessed
+
+    it "should return immediately return nils, not evaulate further attributes" do
+      incompatible_first_attribute = ComparableTestManyParameters.new('Kelly', false)
+      compatible_first_and_second_attribute = ComparableTestManyParameters.new(true, 'D')
+
+      d7 = Minitest::Mock.new
+      d8 = Minitest::Mock.new
+
+      2.times { d7.expect :last_name, false, [] } # :last_name is used exactly twice per <=> call
+      d7.expect :nil?, false, [] # :nil? is used exactly once per <=> call
+      assert_nil incompatible_first_attribute <=> d7
+
+      2.times { d8.expect :last_name, true, [] }
+      2.times { d8.expect :first_name, 'D', [] }
+      d8.expect :nil?, false, []
+      assert_equal 0, compatible_first_and_second_attribute <=> d8
+
+      d7.verify
+      d8.verify
+    end
+
+    it "should return nil if the rhs is nil" do
+      d1 = ComparableTestOneParameter.new(false)
+      d2 = ComparableTestManyParameters.new('Kelly', false)
+
+      assert_nil d1 <=> nil
+      assert_nil d2 <=> nil
+    end
+  end
 end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require "minitest/reporters"
+Minitest::Reporters.use! [
+  Minitest::Reporters::DefaultReporter.new,
+  Minitest::Reporters::JUnitReporter.new
+]

metadata

@@ -1,95 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: attr_comparable
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.2.0.pre.1
 platform: ruby
-authors: 
+authors:
 - Colin Kelley
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-08-10 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  name: minitest
-  requirement: *id001
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
-  name: rake
-  requirement: *id002
-  prerelease: false
+date: 2020-04-08 00:00:00.000000000 Z
+dependencies: []
 description: AttrComparable
-email: 
+email:
 - colindkelley@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
+- Jenkinsfile
 - README.md
 - Rakefile
 - attr_comparable.gemspec
 - lib/attr_comparable.rb
 - lib/attr_comparable/version.rb
+- semaphore_ci/setup.sh
 - test/attr_comparable_test.rb
-has_rdoc: true
+- test/test_helper.rb
 homepage: https://github.com/RingRevenue/attr_comparable
 licenses: []
-
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 3.0.1
 signing_key: 
-specification_version: 3
-summary: Mix-in to make a value class Comparable. Simply declare the order of attributes to compare and the <=> (as needed by Comparable) is generated for you, including support for nil. Includes Comparable.
-test_files: 
+specification_version: 4
+summary: Mix-in to make a value class Comparable. Simply declare the order of attributes
+  to compare and the <=> (as needed by Comparable) is generated for you, including
+  support for nil. Includes Comparable.
+test_files:
 - test/attr_comparable_test.rb
+- test/test_helper.rb