curt-comparable_ext 0.0.0 → 0.0.1

data/comparable_ext.gemspec

@@ -1,14 +1,14 @@
 Gem::Specification.new do |s|
   s.name = "comparable_ext"
-  s.version = "0.0.0"
-  s.date = "2008-06-23"
+  s.version = "0.0.1"
+  s.date = "2008-06-24"
   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.files = ["README.rdoc", "Rakefile", "comparable_ext.gemspec", "lib/comparable_ext.rb", "lib/core_ext/integer/instance_methods.rb", "lib/core_ext/array/instance_methods.rb", "lib/core_ext/integer.rb", "lib/core_ext/array.rb", "test/comparable_ext_test.rb"]
   s.test_files = ["test/comparable_ext_test.rb"]
   s.rdoc_options = ["--main", "README.rdoc"]
   s.extra_rdoc_files = ["README.rdoc"]

data/lib/comparable_ext.rb

@@ -1 +1,3 @@
 require 'core_ext/integer'
+require 'core_ext/array'
+

data/lib/core_ext/array.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/array/instance_methods'
+
+class Array #:nodoc:
+  include ComparableExt::CoreExtensions::Array::InstanceMethods
+end

data/lib/core_ext/array/instance_methods.rb

@@ -0,0 +1,84 @@
+# 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 Array
+      # Instance methods that extend the Integer class
+      module InstanceMethods
+        # The <tt>sort_by_attributes</tt> method sorts an array based on a
+        # comparison of the attributes of the objects it contains. The arguments
+        # of the method are the attributes to be called. An attribute can be any
+        # method that takes no arguments.
+        # 
+        #   class Person
+	      #     attr_accessor :id
+	      #     attr_accessor :name
+	      #     attr_accessor :type
+        # 	
+	      #     def initialize(id, name, type)
+		    #       @id = id
+		    #       @name = name
+		    #       @type = type
+	      #     end
+        #   end
+        # 
+        #   objs = [Person.new(1, 'Andy', 'a'),
+		    #           Person.new(2, 'Zach', 'a'),
+		    #           Person.new(2, 'Andy', 'z')]
+        # 
+        #   objs.sort_by_attributes(:name, :type, :id)
+        # 
+        #   # => [#<Person:0xb7cbc9e4 @type="a", @name="Andy", @id=1>, 
+        #   # #<Person:0xb7cbc96c @type="z", @name="Andy", @id=2>, 
+        #   # #<Person:0xb7cbc9a8 @type="a", @name="Zach", @id=2>]
+        def sort_by_attributes(*args)
+          self.sort do |arg0, arg1|
+            sorter_by_attributes args, arg0, arg1
+          end 
+        end
+        
+        # The <tt>sort_by_attributes!</tt> method behaves similarly to 
+        # <tt>sort_by_attributes</tt>, except that it sorts <em>self</em>.
+        def sort_by_attributes!(*args)
+          self.sort! do |arg0, arg1|
+            sorter_by_attributes args, arg0, arg1
+          end 
+        end
+        
+        private
+        
+        def sorter_by_attributes(args, arg0, arg1)  
+          comp = 0
+          args.each do |arg|
+            attr0 = arg0.method(arg).call
+            attr1 = arg1.method(arg).call
+            comp = comp.zthen(attr0 <=> attr1)
+          end
+          comp
+        end
+      end
+    end
+  end
+end

data/lib/core_ext/integer/instance_methods.rb

@@ -29,6 +29,7 @@ module ComparableExt
       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
@@ -36,7 +37,7 @@ module ComparableExt
         #   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

@@ -22,7 +22,7 @@
 require 'comparable_ext'
 require 'test/unit'
 
-class ComparableExtTest < Test::Unit::TestCase
+class IntegerZthenTest < Test::Unit::TestCase
   def test_positive_zthen_positive
     assert_equal 1, 1.zthen(1)
   end
@@ -59,3 +59,84 @@ class ComparableExtTest < Test::Unit::TestCase
     assert_equal -1, -1.zthen(-1)
   end
 end
+
+class EnumerableSortByAttributesTest < Test::Unit::TestCase
+	def setup
+		klass = Class.new do
+			attr_accessor :id
+			attr_accessor :name
+			attr_accessor :type
+			
+			def initialize(id, name, type)
+				@id = id
+				@name = name
+				@type = type
+			end
+		end
+		
+		@objs = [klass.new(1, 'Andy', 'a'),
+				 klass.new(2, 'Zach', 'a'),
+				 klass.new(2, 'Andy', 'z')]
+	end
+	
+	def test_length
+		sorted = @objs.sort_by_attributes :id
+
+		assert_equal 3, sorted.size
+	end
+
+	def test_sort_id_name_type
+		sorted = @objs.sort_by_attributes :id, :name, :type
+
+		assert_equal 1, sorted[0].id
+		assert_equal 'Zach', sorted[2].name
+		assert_equal 'z', sorted[1].type
+	end
+
+	def test_sort_name_type_id
+		sorted = @objs.sort_by_attributes :name, :type, :id
+
+		assert_equal 1, sorted[0].id
+		assert_equal 'Zach', sorted[2].name
+		assert_equal 'z', sorted[1].type
+	end
+
+	def test_sort_type_id_name
+		sorted = @objs.sort_by_attributes :type, :id, :name
+
+		assert_equal 1, sorted[0].id
+		assert_equal 'Zach', sorted[1].name
+		assert_equal 'z', sorted[2].type
+	end
+	
+	def test_length_in_place
+		@objs.sort_by_attributes! :id
+
+		assert_equal 3, @objs.size
+	end
+
+	def test_sort_id_name_type_in_place
+		@objs.sort_by_attributes! :id, :name, :type
+
+		assert_equal 1, @objs[0].id
+		assert_equal 'Zach', @objs[2].name
+		assert_equal 'z', @objs[1].type
+	end
+
+	def test_sort_name_type_id_in_place
+		@objs.sort_by_attributes! :name, :type, :id
+
+		assert_equal 1, @objs[0].id
+		assert_equal 'Zach', @objs[2].name
+		assert_equal 'z', @objs[1].type
+	end
+
+	def test_sort_type_id_name_in_place
+		@objs.sort_by_attributes! :type, :id, :name
+
+		assert_equal 1, @objs[0].id
+		assert_equal 'Zach', @objs[1].name
+		assert_equal 'z', @objs[2].type
+	end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: curt-comparable_ext
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Curt A. Gilman
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-23 00:00:00 -07:00
+date: 2008-06-24 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -27,7 +27,10 @@ files:
 - comparable_ext.gemspec
 - lib/comparable_ext.rb
 - lib/core_ext/integer/instance_methods.rb
+- lib/core_ext/array/instance_methods.rb
 - lib/core_ext/integer.rb
+- lib/core_ext/array.rb
+- test/comparable_ext_test.rb
 has_rdoc: true
 homepage: http://github.com/curt/comparable_ext
 post_install_message: 
@@ -51,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.0.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Extensions to make Comparable more useful