paginate_alphabetically 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) 2010 Eden Development
+
+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.textile

@@ -0,0 +1,40 @@
+h2. PaginateAlphabetically
+
+An easy way to paginate a list of ActiveRecord objects alphabetically by any given attribute.
+
+
+h2. Example
+
+h3. Model
+
+bc. class User < ActiveRecord::Base
+  paginate_alphabetically :by => :surname
+end
+
+h3. Controller
+
+bc. class UsersController < ApplicationController
+  def index
+    @users = User.alphabetical_group(params[:letter])
+  end
+end
+
+h3. View (haml example)
+  
+bc. %ul.pagination
+  - User.pagination_letters.each do |letter|
+    %li= link_to letter, users_path(:letter => letter)
+%ul.users
+  - @users.each do |user|
+    %li= user.surname
+
+
+h2. Testing
+
+The tests use a sqlite3 in-memory database to be able to run separately from your application.
+
+bc. rake test
+  
+
+
+Copyright (c) 2010 Eden Development, released under the MIT license

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "paginate_alphabetically"
+    gem.summary = %Q{An easy way to paginate a list of ActiveRecord objects alphabetically by any given attribute.}
+    gem.description = %Q{Provides a list of available letters, and a way of fetching the records for each letter.}
+    gem.email = "dev+gems@edendevelopment.co.uk"
+    gem.homepage = "http://github.com/edendevelopment/paginate_alphabetically"
+    gem.authors = ["Eden Development"]
+    gem.add_development_dependency "activerecord", ">= 2.3.5"
+    gem.add_development_dependency "sqlite3-ruby", "1.2.5"
+    # 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 = "paginate_alphabetically #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/init.rb

@@ -0,0 +1,3 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'lib/paginate_alphabetically'))
+
+ActiveRecord::Base.extend(PaginateAlphabetically)

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/paginate_alphabetically.rb

@@ -0,0 +1,22 @@
+module PaginateAlphabetically
+  def paginate_alphabetically(params)
+    @attribute = params[:by]
+    self.extend ClassMethods
+  end
+
+  module ClassMethods
+    def pagination_letters
+      all.sort_by{|obj| obj.send(@attribute)}.group_by {|group| group.send(@attribute)[0].chr.upcase}.keys
+    end
+
+    def first_letter
+      first_instance = find(:first, :order => @attribute)
+      return 'A' if first_instance.nil?
+      first_instance.send(@attribute)[0].chr.upcase
+    end
+
+    def alphabetical_group(letter = nil)
+      find(:all, :conditions => ["#{@attribute.to_s} LIKE ?", "#{letter || first_letter}%"], :order => @attribute)
+    end
+  end
+end

data/test/db/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define do
+  create_table "things", :force => true do |t|
+    t.column "name",  :text
+  end
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'test/unit'
+require 'sqlite3'
+require 'active_record'
+require File.expand_path(File.join(File.dirname(__FILE__), '../init.rb'))
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "sqlite3",
+  :database => ":memory:"
+)
+
+load File.expand_path(File.join(File.dirname(__FILE__), 'db/schema.rb'))

data/test/test_paginate_alphabetically.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
+
+class Thing < ActiveRecord::Base
+  paginate_alphabetically :by => :name
+end
+
+class Numpty < ActiveRecord::Base
+end
+
+class PaginateAlphabeticallyTest < ActiveSupport::TestCase
+  def setup
+    %w(One Two Three Four Five Six).map {|name| Thing.create!(:name => name)}
+  end
+
+  def test_pagination_letters
+    assert_equal ['F', 'O', 'S', 'T'], Thing.pagination_letters
+  end
+
+  def test_first_letter
+    assert_equal 'F', Thing.first_letter
+  end
+
+  def test_first_letter_when_there_are_no_things
+    Thing.destroy_all
+    assert_equal 'A', Thing.first_letter
+  end
+
+  def test_alphabetical_group_without_specifying_letter
+    assert_equal ['Five', 'Four'], Thing.alphabetical_group.map(&:name)
+  end
+
+  def test_alphabetical_group_specifying_letter
+    assert_equal ['Three', 'Two'], Thing.alphabetical_group('t').map(&:name)
+  end
+
+  def test_class_without_pagination_has_no_pagination_methods
+    assert_raise NoMethodError do
+      Numpty.alphabetical_group
+    end
+  end
+
+  def teardown
+    Thing.destroy_all
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: paginate_alphabetically
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eden Development
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-25 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  type: :development
+  version_requirements: *id002
+description: Provides a list of available letters, and a way of fetching the records for each letter.
+email: dev+gems@edendevelopment.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/paginate_alphabetically.rb
+- test/db/schema.rb
+- test/helper.rb
+- test/test_paginate_alphabetically.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/edendevelopment/paginate_alphabetically
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: An easy way to paginate a list of ActiveRecord objects alphabetically by any given attribute.
+test_files: 
+- test/db/schema.rb
+- test/helper.rb
+- test/test_paginate_alphabetically.rb