acts_as_ordinalized 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 mandaryn
+
+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,17 @@
+= acts_as_ordinalized
+
+This is a simple acts_as gem providing the active record models with ordinal numbers. The ordinals numbering is per query, but should work nicely with will paginate showing correct ordinal numbers on paginated results.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 mandaryn. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_ordinalized"
+    gem.summary = %Q{simple gem providing active record collections with ordinal numbers}
+    gem.description = %Q{This is a simple acts_as gem providing the active record models with ordinal numbers. The ordinals numbering is per query, but should work nicely with will paginate showing correct ordinal numbers on paginated results.}
+    gem.email = "mandaryyyn@gmail.com"
+    gem.homepage = "http://github.com/mandaryn/acts_as_ordinalized"
+    gem.authors = ["mandaryn"]
+    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
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_ordinalized #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/acts_as_ordinalized.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_ordinalized}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mandaryn"]
+  s.date = %q{2010-08-17}
+  s.description = %q{This is a simple acts_as gem providing the active record models with ordinal numbers. The ordinals numbering is per query, but should work nicely with will paginate showing correct ordinal numbers on paginated results.}
+  s.email = %q{mandaryyyn@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_ordinalized.gemspec",
+     "lib/acts_as_ordinalized.rb",
+     "test/test_ordinalized.rb"
+  ]
+  s.homepage = %q{http://github.com/mandaryn/acts_as_ordinalized}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{simple gem providing active record collections with ordinal numbers}
+  s.test_files = [
+    "test/test_ordinalized.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/acts_as_ordinalized.rb

@@ -0,0 +1,45 @@
+module ActsAsOrdinalized
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  # this acts_as extension add ordinal numbers to active record collections
+  # each collection gets new ordinal numbers starting from one
+  # paginated results should also get correct ordinal numbers on subsequent pages
+  module ClassMethods
+    def acts_as_ordinalized
+      attr_accessor :ordinal_number
+
+      #wrap find with function adding ordinal numbers to all returned models
+      if self.respond_to?(:paginate)
+        def self.paginate(*args)
+          ActsAsOrdinalized.ordinalize(super(*args))
+        end
+      else
+        def self.find(*args)
+          ActsAsOrdinalized.ordinalize(super(*args))
+        end
+      end
+    end
+  end
+
+  protected
+
+  def self.ordinalize(collection_or_object)
+    ordinal_base = 1
+    # if pagination present correct the ordinal base
+    if collection_or_object.respond_to?(:current_page) && collection_or_object.respond_to?(:per_page)
+      ordinal_base = (collection_or_object.current_page - 1) * collection_or_object.per_page + 1
+    end
+    if collection_or_object.is_a?(Array)
+      collection_or_object.each_with_index do |item, index|
+        item.ordinal_number = ordinal_base + index
+      end
+    else
+      collection_or_object.ordinal_number = ordinal_base
+    end
+    collection_or_object
+  end
+end
+
+ActiveRecord::Base.class_eval { include ActsAsOrdinalized }

data/test/test_ordinalized.rb

@@ -0,0 +1,79 @@
+require 'test/unit'
+
+require 'rubygems'
+gem 'activerecord'
+require 'active_record'
+
+require "#{File.dirname(__FILE__)}/../lib/acts_as_ordinalized"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :ordinals do |t|
+      t.column :test_order, :integer
+      t.column :switch, :boolean
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Ordinal < ActiveRecord::Base
+  acts_as_ordinalized
+end
+
+class OrdinalTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+    (1..5).each { |counter| Ordinal.create!(:test_order => "#{counter}", :switch => counter.even?) }
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_ordinalizing
+    ordinals = Ordinal.all(:order => "test_order ASC")
+    assert_equal [[1,1], [2,2], [3,3], [4,4], [5,5]], ordinals.map{|o| [o.test_order, o.ordinal_number] }
+    reversed = Ordinal.all(:order => "test_order DESC")
+    assert_equal [[5,1], [4,2], [3,3], [2,4], [1,5]], reversed.map{|o| [o.test_order, o.ordinal_number] }
+    even = Ordinal.all(:conditions => { :switch => true }, :order => "test_order ASC")
+    assert_equal [[2,1], [4,2]], even.map{|o| [o.test_order, o.ordinal_number] }
+  end
+end
+begin
+require 'will_paginate'
+WillPaginate.enable_activerecord
+
+class OrdinalWithPagination < ActiveRecord::Base
+  acts_as_ordinalized
+  set_table_name "ordinals"
+end
+
+class OrdinalWithPaginationTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+    (1..10).each { |counter| Ordinal.create!(:test_order => "#{counter}", :switch => counter.even?) }
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_ordinal_with_pagination
+    ordinals = OrdinalWithPagination.paginate(:page => 1, :per_page => 5, :order => "test_order ASC")
+    assert_equal [[1,1], [2,2], [3,3], [4,4], [5,5]], ordinals.map{|o| [o.test_order, o.ordinal_number] }
+    ordinals2 = OrdinalWithPagination.paginate(:page => 2, :per_page => 5, :order => "test_order ASC")
+    assert_equal [[6,6], [7,7], [8,8], [9,9], [10,10]], ordinals2.map{|o| [o.test_order, o.ordinal_number] }
+  end
+
+end
+rescue
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_ordinalized
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- mandaryn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: This is a simple acts_as gem providing the active record models with ordinal numbers. The ordinals numbering is per query, but should work nicely with will paginate showing correct ordinal numbers on paginated results.
+email: mandaryyyn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_ordinalized.gemspec
+- lib/acts_as_ordinalized.rb
+- test/test_ordinalized.rb
+has_rdoc: true
+homepage: http://github.com/mandaryn/acts_as_ordinalized
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: simple gem providing active record collections with ordinal numbers
+test_files: 
+- test/test_ordinalized.rb