attributes_sort 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Karmen Blake
+
+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.rdoc

@@ -0,0 +1,37 @@
+= attributes_sort
+
+This gem allows you to take a collection of any type of object and sort them using the attributes of the object.
+
+Example:
+
+
+
+require 'rubygems'
+require 'attributes_sort'
+
+class Person
+
+  include AttributesSort
+
+  attr_accessor :firstname,:lastname,:age
+  
+  def initialize(firstname="", lastname="" ,age=0)
+    @firstname = firstname
+    @lastname = lastname
+    @age = age
+  end
+end
+
+people = [Person.new("joe","blow",12),Person.new("joe","blow",89),Person.new("mary","watson",32),Person.new("annie","watson",9),Person.new("bob","builder",12)]
+
+p people.attr_sort(:sort_by=>[:lastname])
+
+p people.attr_sort(:sort_by=>[:age])
+
+p people.attr_sort(:sort_by=>[:lastname,:firstname,:age])
+
+
+
+== Copyright
+
+Copyright (c) 2009 Karmen Blake. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "attributes_sort"
+    gem.summary = %Q{A slick way to sort a collection objects.}
+    gem.description = %Q{Sort a collection of objects using one or more of the attributes of your object.}
+    gem.email = "karmenblake@gmail.com"
+    gem.homepage = "http://github.com/kblake/attributes_sort"
+    gem.authors = ["Karmen Blake"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "attributes_sort #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+		gem.name = "attributes_sort"
+    gem.summary = "A slick way to sort a collection objects."
+    gem.description = "Sort a collection of objects using one or more of the attributes of your object."
+    gem.email = "karmenblake@gmail.com"
+    gem.homepage = "http://github.com/kblake/attributes_sort"
+    gem.authors = ["Karmen Blake"]			
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/attributes_sort.rb

@@ -0,0 +1,21 @@
+module AttributesSort
+  def self.included(receiver)
+    Array.class_eval do
+      def attr_sort(options = {})
+				raise "You must pass in sort_by criteria" unless options[:sort_by]
+        klass = self.first.class
+        klass.instance_eval do
+          def do_attributes_sort(collection, options={})
+            attributes = options[:sort_by].inject("["){|attribute_string, attribute| attribute_string << "object.#{attribute},"} + "]"
+            collection.sort_by{|object| eval(attributes)}
+          end
+        end
+				begin
+        	klass.do_attributes_sort(self, options)
+				rescue NoMethodError
+					raise "You must sort by an attribute that exists in the object that you are sorting"
+				end
+      end
+    end
+  end
+end

data/spec/attributes_sort_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class Person
+  include AttributesSort
+
+  attr_accessor :firstname,:lastname,:age
+  
+  def initialize(firstname="",lastname="",age=0)
+    @firstname = firstname
+    @lastname = lastname
+    @age = age
+  end
+end
+
+
+describe "AttributesSort" do
+	before(:each) do
+		@p1 = Person.new("joe","blow",89)
+		@p2 = Person.new("joe","blow",12)
+		@p3 = Person.new("mary","watson",32)
+		@p4 = Person.new("annie","watson",9)
+		@p5 = Person.new("bob","builder",12)
+		@people = [@p1, @p2, @p3, @p4, @p5]			
+	end
+
+	def test_sort(criteria, result)
+		@people.attr_sort(:sort_by => criteria).should == result		
+	end
+
+  it "object must have attr accessible attributes for sort_by to work" do
+  	p = Person.new
+		p.should respond_to(:firstname)
+		p.should respond_to(:lastname)
+		p.should respond_to(:age)
+	end
+
+	it "sort by last name" do
+		test_sort([:lastname], [@p1, @p2, @p5, @p4, @p3])
+	end
+
+	it "sort by age" do
+		test_sort([:age], [@p4, @p2, @p5, @p3, @p1])
+	end
+
+	it "sort by age then by first name" do
+		test_sort([:age, :firstname], [@p4, @p5, @p2, @p3, @p1])		
+	end
+
+	it "sort by age then by last name" do
+		test_sort([:age, :lastname], [@p4, @p2, @p5, @p3, @p1])				
+	end
+
+	it "sort by last name then by first name then by age" do
+		test_sort([:lastname,:firstname,:age], [@p2, @p1, @p5, @p4, @p3])
+	end
+
+	it "raise error if criteria is not provided" do
+		lambda {test_sort(nil, [@p1, @p2, @p5, @p4, @p3])}.should raise_error("You must pass in sort_by criteria")
+	end
+
+	it "raise error if criteria is not a valid attribute of class" do
+		lambda {test_sort([:blah], [@p1, @p2, @p5, @p4, @p3])}.should raise_error("You must sort by an attribute that exists in the object that you are sorting")		
+	end
+	
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'attributes_sort'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: attributes_sort
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Karmen Blake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Sort a collection of objects using one or more of the attributes of your object.
+email: karmenblake@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/attributes_sort.rb
+- spec/attributes_sort_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kblake/attributes_sort
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: A slick way to sort a collection objects.
+test_files: 
+- spec/attributes_sort_spec.rb
+- spec/spec_helper.rb