curt-comparable_ext 0.0.0

data/README.rdoc

@@ -0,0 +1,57 @@
+= Comparable Extensions
+
+A Ruby gem containing extensions that make <tt>Comparable</tt> more useful
+
+== Description
+
+Comparable Extensions extends the Ruby core libraries to make the
+<tt>Comparable</tt> module more useful. <tt>Comparable</tt> is the module that
+provides the <tt><=></tt> operator, among other things.
+
+Currently the only extension is the addition of a <tt>zthen</tt> method on the
+<tt>Integer</tt> class. The method can be used to string comparisons together
+more easily.
+
+== Examples
+
+=== Simple <tt>zthen</tt> example
+
+Include the library.
+
+  require 'comparable_ext'
+
+Define an Employee class with two attributes and an initializer.
+
+  class Employee
+    attr :name
+    attr :salary
+    def initialize(name, salary)
+      @name = name
+      @salary = salary
+    end
+  end
+
+Define an array of Employee objects.
+
+  employees = [Employee.new('Bob', 24000), Employee.new('Jill', 24000),
+    Employee.new('Bob', 32000), Employee.new('Sarah', 32000)]
+
+Sort employees by name, then salary.
+
+  employees.sort{|x, y| (x.name <=> y.name).zthen(x.salary <=> y.salary)}
+
+  # => [#<Employee:0xb7cd21cc @salary=24000, @name="Bob">, #<Employee:0xb7cd20c8 
+  # @salary=32000, @name="Bob">, #<Employee:0xb7cd2154 @salary=24000, 
+  # @name="Jill">, #<Employee:0xb7cd203c @salary=32000, @name="Sarah">]
+
+Sort employees by salary, then name.
+
+  employees.sort{|x, y| (x.salary <=> y.salary).zthen(x.name <=> y.name)}
+  
+  # => [#<Employee:0xb7cd21cc @salary=24000, @name="Bob">, #<Employee:0xb7cd2154 
+  # @salary=24000, @name="Jill">, #<Employee:0xb7cd20c8 @salary=32000, 
+  # @name="Bob">, #<Employee:0xb7cd203c @salary=32000, @name="Sarah">] 
+
+== License
+
+Copyright (c) 2008 Curt A. Gilman, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the paranoid_find plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the paranoid_find plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Comparable Extenstions'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.template = ENV['template'] ? "#{ENV['template']}.rb" : 'doc/template/horo'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/comparable_ext.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "comparable_ext"
+  s.version = "0.0.0"
+  s.date = "2008-06-23"
+  s.summary = "Extensions to make Comparable more useful"
+  s.email = "curt.gilman@reductivereason.com"
+  s.homepage = "http://github.com/curt/comparable_ext"
+  s.description = "Comparable Extensions is a Ruby library that extends the core libraries to make the Comparable module more useful."
+  s.has_rdoc = true
+  s.authors = ["Curt A. Gilman"]
+  s.files = ["README.rdoc", "Rakefile", "comparable_ext.gemspec", "lib/comparable_ext.rb", "lib/core_ext/integer/instance_methods.rb", "lib/core_ext/integer.rb"]
+  s.test_files = ["test/comparable_ext_test.rb"]
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = ["README.rdoc"]
+end

data/lib/comparable_ext.rb

@@ -0,0 +1 @@
+require 'core_ext/integer'

data/lib/core_ext/integer.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2008 Curt A. Gilman
+#
+# 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.
+
+require 'core_ext/integer/instance_methods'
+
+class Integer #:nodoc:
+  include ComparableExt::CoreExtensions::Integer::InstanceMethods
+end

data/lib/core_ext/integer/instance_methods.rb

@@ -0,0 +1,43 @@
+# Copyright (c) 2008 Curt A. Gilman
+#
+# 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.
+
+# Extensions that make Comparable more useful
+module ComparableExt
+  # Extensions to Ruby core libraries
+  module CoreExtensions
+    # Extensions to the Integer class
+    module Integer
+      # Instance methods that extend the Integer class
+      module InstanceMethods
+        # The <tt>zthen</tt> method always returns the receiver object when its
+        # value is not zero. Otherwise, it returns <tt>arg</tt>.
+        #   1.zthen(0)   # => 1
+        #   -1.zthen(1)  # => -1
+        #   0.zthen(1)   # => 1
+        #   0.zthen(-1)  # => -1
+        #   0.zthen(0)   # => 0
+        def zthen(arg)  
+          unless self.zero? then self else arg end  
+        end  
+      end
+    end
+  end
+end

data/test/comparable_ext_test.rb

@@ -0,0 +1,61 @@
+# Copyright (c) 2008 Curt A. Gilman
+#
+# 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.
+
+require 'comparable_ext'
+require 'test/unit'
+
+class ComparableExtTest < Test::Unit::TestCase
+  def test_positive_zthen_positive
+    assert_equal 1, 1.zthen(1)
+  end
+
+  def test_positive_zthen_zero
+    assert_equal 1, 1.zthen(0)
+  end
+  
+  def test_positive_zthen_negative
+    assert_equal 1, 1.zthen(-1)
+  end
+
+  def test_zero_zthen_positive
+    assert_equal 1, 0.zthen(1)
+  end
+
+  def test_zero_zthen_zero
+    assert_equal 0, 0.zthen(0)
+  end
+  
+  def test_zero_zthen_negative
+    assert_equal -1, 0.zthen(-1)
+  end
+
+  def test_negative_zthen_positive
+    assert_equal -1, -1.zthen(1)
+  end
+
+  def test_negative_zthen_zero
+    assert_equal -1, -1.zthen(0)
+  end
+  
+  def test_negative_zthen_negative
+    assert_equal -1, -1.zthen(-1)
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: curt-comparable_ext
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Curt A. Gilman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Comparable Extensions is a Ruby library that extends the core libraries to make the Comparable module more useful.
+email: curt.gilman@reductivereason.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- comparable_ext.gemspec
+- lib/comparable_ext.rb
+- lib/core_ext/integer/instance_methods.rb
+- lib/core_ext/integer.rb
+has_rdoc: true
+homepage: http://github.com/curt/comparable_ext
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Extensions to make Comparable more useful
+test_files: 
+- test/comparable_ext_test.rb