ordinalizatron 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+log/*
+*.db

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ordinalizatron.gemspec
+gemspec

data/License

@@ -0,0 +1,19 @@
+Copyright (C) 2011 Piotr Marciniak
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Readme.md

@@ -0,0 +1,35 @@
+Ordinalizatron
+==========
+
+Simple way to get ordinal numbers for your collections.
+
+Example
+-------
+
+Without ordinalizatron:
+
+    <% User.paginate(page: 5).each_with_index do |user,index| %>
+        <% ordinal = get_the_offset_part_helper + 1 + index %>
+        <%= "#{ordinal}. #{user.name} %>
+    <% end %>
+
+With ordinalizatron:
+
+    <% User.paginate(page: 5).each_with_ordinal_number do |user,ordinal_number| %>
+        <%= "#{ordinal_number}. #{user.name} %>
+    <% end %>
+
+Custom offset (still better than adding 1 to index and then offset):
+
+    <% User.page(5).each_with_ordinal_number(offset: get_the_offset_part_helper) do |user,ordinal_number| %>
+        <%= "#{ordinal_number}. #{user.name} %>
+    <% end %>
+
+Features
+--------
+
+Gives you easy ordinal numbers
+
+Integrates with will_paginate
+
+Doesn't integrate with Kaminari, but you can still use the custom offset method

data/lib/ordinalizatron.rb

@@ -0,0 +1,19 @@
+require "ordinalizatron/version"
+
+module Ordinalizatron
+  def each_with_ordinal_number(options = {}, &block)
+    options.reverse_merge!(offset: find_offset)
+    self.each_with_index do |element, index|
+      yield(element, options[:offset] + index + 1)
+    end
+  end
+
+  private
+  #gets the offset from WillPaginate if present
+  def find_offset
+    return self.offset if self.respond_to? :offset #detect WillPaginate
+    return 0
+  end
+end
+
+Array.send(:include, Ordinalizatron)

data/lib/ordinalizatron/version.rb

@@ -0,0 +1,3 @@
+module Ordinalizatron
+  VERSION = "0.0.1"
+end

data/ordinalizatron.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ordinalizatron/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ordinalizatron"
+  s.version     = Ordinalizatron::VERSION
+  s.authors     = ["Piotr Marciniak"]
+  s.email       = ["mandaryyyn@gmail.com"]
+  s.homepage    = "https://github.com/Mandaryn/ordinalizatron"
+  s.summary     = %q{Add orinal numbering to your collection}
+  s.description = %q{Adds each_with_ordinal_number iterator to collections.}
+
+  s.rubyforge_project = "ordinalizatron"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 2.7"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "activerecord", "~> 3.0.0"
+  s.add_development_dependency "will_paginate", "~> 3.0"
+  s.add_development_dependency "sqlite3-ruby"
+end

data/spec/ordinalizatron_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Ordinalizatron do
+  describe "array" do
+    let(:array) { ['dupa', nil, 1, Object.new] }
+    it "should add proper ordinal numbers" do
+      ordinals = (1..4).to_a
+      array.each_with_ordinal_number do |element, ordinal_number|
+        ordinal_number.should == ordinals.shift
+      end
+    end
+
+    it "should not mess with the array elements" do
+      dup = array.clone
+      array.each_with_ordinal_number do |element, ordinal_number|
+        element.should == dup.shift
+      end
+    end
+
+    it "should properly apply ordinal offset" do
+      ordinals = (5..8).to_a
+      array.each_with_ordinal_number(offset: 4) do |element, ordinal_number|
+        ordinal_number.should == ordinals.shift
+      end
+    end
+
+    it "should try guessing the offset from predefined array methods (will_paginate integration)" do
+      ordinals = (4..7).to_a
+      array.stub(:offset).and_return(3)
+      array.each_with_ordinal_number do |element, ordinal_number|
+        ordinal_number.should == ordinals.shift
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'ordinalizatron'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+def setup_database
+  root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: "#{root}/ordinalizatron.db")
+  ActiveRecord::Base.connection.create_table(:posts) do |t|
+    t.string :value
+  end
+end
+
+def cleanup_database
+  ActiveRecord::Base.connection.drop_table(:posts)
+end

data/spec/support/will_paginate/post.rb

@@ -0,0 +1,4 @@
+require 'will_paginate/active_record'
+
+class Post < ActiveRecord::Base
+end

data/spec/will_paginate_ordinalizatron_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'support/will_paginate/post'
+
+describe Ordinalizatron do
+  before(:all) do
+    setup_database
+    i = 0
+    10.times { Post.create(value: "name#{i+=1}") }
+  end
+
+  after(:all) do
+    cleanup_database
+  end
+
+  describe "will_paginate array" do
+    let(:array) { Post.paginate(page: 2, per_page: 3) }
+    it "should add proper ordinal numbers to all elements" do
+      ordinals = [4,5,6]
+      array.each_with_ordinal_number do |element, ordinal_number|
+        ordinal_number.should == ordinals.shift
+      end
+    end
+
+    it "should not mess with original elements" do
+      ordinals = [4,5,6]
+      array.each_with_ordinal_number do |element, ordinal_number|
+        element.value.should == "name#{ordinals.shift}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ordinalizatron
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Piotr Marciniak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2151827840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2151827840
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2151824560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151824560
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &2151836180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2151836180
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: &2151853280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151853280
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &2151848540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151848540
+description: Adds each_with_ordinal_number iterator to collections.
+email:
+- mandaryyyn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- lib/ordinalizatron.rb
+- lib/ordinalizatron/version.rb
+- ordinalizatron.gemspec
+- spec/ordinalizatron_spec.rb
+- spec/spec_helper.rb
+- spec/support/will_paginate/post.rb
+- spec/will_paginate_ordinalizatron_spec.rb
+homepage: https://github.com/Mandaryn/ordinalizatron
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ordinalizatron
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Add orinal numbering to your collection
+test_files:
+- spec/ordinalizatron_spec.rb
+- spec/spec_helper.rb
+- spec/support/will_paginate/post.rb
+- spec/will_paginate_ordinalizatron_spec.rb