with_order 0.1.0

data/spec/dummy/db/migrate/20120127203225_create_nobel_prize_winners.rb

@@ -0,0 +1,30 @@
+class CreateNobelPrizeWinners < ActiveRecord::Migration
+  def change
+    create_table :nobel_prize_winners do |t| 
+      t.string  :first_name
+      t.string  :last_name
+      t.string  :category
+      t.integer :year
+    end 
+
+    [   
+      {first_name: 'Norman',   last_name: 'Borlaug',     category: 'Peace',                  year: 1970},
+      {first_name: 'Paul',     last_name: 'Flory',       category: 'Chemistry',              year: 1974},
+      {first_name: 'Albert',   last_name: 'Eintein',     category: 'Physics',                year: 1921},
+      {first_name: 'Samuel',   last_name: 'Beckett',     category: 'Literature',             year: 1969},
+      {first_name: 'Niels',    last_name: 'Bohr',        category: 'Physics',                year: 1922},
+      {first_name: 'Erwin',    last_name: 'Schrodinger', category: 'Physics',                year: 1933},
+      {first_name: 'Paul',     last_name: 'Dirac',       category: 'Physics',                year: 1933},
+      {first_name: 'Enrico',   last_name: 'Fermi',       category: 'Physics',                year: 1938},
+      {first_name: 'Richard',  last_name: 'Feynman',     category: 'Physics',                year: 1965},
+      {first_name: 'Marie',    last_name: 'Curie',       category: 'Chemistry',              year: 1911},
+      {first_name: 'James',    last_name: 'Watson',      category: 'Physiology or Medicine', year: 1962},
+      {first_name: 'Bertrand', last_name: 'Russell',     category: 'Literature',             year: 1950},
+      {first_name: 'John',     last_name: 'Steinbeck',   category: 'Literature',             year: 1962},
+      {first_name: 'Nelson',   last_name: 'Mandela',     category: 'Peace',                  year: 1993},
+      {first_name: 'Jacques',  last_name: 'Monod',       category: 'Physiology or Medicine', year: 1965}
+    ].each do |winner|
+      NobelPrizeWinner.create(winner)
+    end 
+  end
+end

data/spec/dummy/db/migrate/20120203212237_create_nobel_prizes.rb

@@ -0,0 +1,34 @@
+class CreateNobelPrizes < ActiveRecord::Migration
+  def up
+    create_table :nobel_prizes do |t|
+      t.integer :nobel_prize_winner_id
+      t.string  :category
+      t.integer :year
+    end
+
+    execute(
+      'INSERT INTO nobel_prizes("nobel_prize_winner_id", "category", "year") ' +
+      'SELECT id, category, year ' +
+      'FROM nobel_prize_winners'
+    )
+
+    NobelPrizeWinner.find_by_first_name_and_last_name('Marie', 'Curie').nobel_prizes.create(category: 'Physics', year: 1903)
+
+    remove_column :nobel_prize_winners, :category, :year
+  end
+
+  def down
+    add_column :nobel_prize_winners, :category, :string
+    add_column :nobel_prize_winners, :year, :integer
+
+    NobelPrizeWinner.find_by_first_name_and_last_name('Marie', 'Curie').nobel_prizes.order(:year).first.delete
+
+    execute(
+      'UPDATE nobel_prize_winners ' +
+      'SET category = (SELECT nobel_prizes.category FROM nobel_prizes WHERE nobel_prize_winners.id = nobel_prizes.nobel_prize_winner_id), ' +
+        'year = (SELECT nobel_prizes.year FROM nobel_prizes WHERE nobel_prize_winners.id = nobel_prizes.nobel_prize_winner_id)'
+    )
+
+    drop_table :nobel_prizes
+  end
+end

data/spec/dummy/db/migrate/20120214172946_fix_einstein.rb

@@ -0,0 +1,9 @@
+class FixEinstein < ActiveRecord::Migration
+  def up
+    npw = NobelPrizeWinner.find_by_first_name('Albert')
+    npw.update_attribute(:last_name, 'Einstein')
+  end
+
+  def down
+  end
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20120214172946) do
+
+  create_table "nobel_prize_winners", :force => true do |t|
+    t.string "first_name"
+    t.string "last_name"
+  end
+
+  create_table "nobel_prizes", :force => true do |t|
+    t.integer "nobel_prize_winner_id"
+    t.string  "category"
+    t.integer "year"
+  end
+
+end

data/spec/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/hash_extraction_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe WithOrder::HashExtraction do
+  describe '#extract_hash_value(hash, key)' do
+    let(:params) {{
+      'fizz' => 'buzz',
+      foo:       'bar',
+      one:      {two: {three: 3}}
+    }}
+    subject {
+      class TestHashExtraction
+        include WithOrder::HashExtraction
+      end
+      TestHashExtraction.new
+    }
+
+    context 'where a regular hash key is used' do
+      context 'where the value is a Symbol' do
+        it 'returns the value from the hash' do
+          subject.extract_hash_value(params, :foo).should == params[:foo]
+        end
+      end
+
+      context 'where the value is a String' do
+        it 'returns the value from the hash' do
+          subject.extract_hash_value(params, 'fizz').should == params['fizz']
+        end
+      end
+
+      context 'where the value is not found' do
+        it 'returns nil' do
+          subject.extract_hash_value(params, 'yo').should be nil
+        end
+      end
+    end
+
+    context 'where a nested hash key is used' do
+      it 'returns the value from the hash' do
+        subject.extract_hash_value(params, 'one[:two][:three]').should == params[:one][:two][:three]
+      end
+
+      context 'where the value is not found' do
+        it 'returns nil' do
+          subject.extract_hash_value(params, 'yo[:one]').should be nil
+        end
+      end
+    end
+  end
+end

data/spec/helpers/action_view_extension_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe WithOrder::ActionViewExtension do
+  describe '#link_with_order(*args, &block)' do
+    context 'the current field ordered on is "first_name"' do
+      it 'reverses the existing direction if the field is "first_name"' do
+        helper.stub!(:params).and_return({order: 'first_name-asc'})
+        npw = NobelPrizeWinner.with_order(helper.params)
+        helper.link_with_order(
+          (npw.current_order[:field] == :first_name and npw.current_order[:dir] == :asc) ? 'DESC' : 'ASC',
+          npw,
+          :first_name
+        ).should == '<a href="/assets?order=first_name-desc">DESC</a>'
+      end
+
+      it 'creates an "asc" order for fields other than "first_name"' do
+        helper.stub!(:params).and_return({order: 'first_name-asc'})
+        npw = NobelPrizeWinner.with_order(helper.params)
+        helper.link_with_order(
+          (npw.current_order[:field] == :last_name and npw.current_order[:dir] == :asc) ? 'DESC' : 'ASC',
+          npw,
+          :last_name
+        ).should == '<a href="/assets?order=last_name-asc">ASC</a>'
+      end
+
+      it 'defaults to "desc" if no direction is given' do
+        helper.stub!(:params).and_return({order: 'first_name'})
+        npw = NobelPrizeWinner.with_order(helper.params)
+        helper.link_with_order(
+          (npw.current_order[:field] == :first_name and npw.current_order[:dir] == :asc) ? 'DESC' : 'ASC',
+          npw,
+          :first_name
+        ).should == '<a href="/assets?order=first_name-desc">DESC</a>'
+      end
+    end
+
+    context 'options' do
+      context ':dir' do
+        it 'locks in the direction of the param value' do
+          helper.stub!(:params).and_return({order: 'first_name-asc'})
+          npw = NobelPrizeWinner.with_order(helper.params)
+          helper.link_with_order(
+            'ASC',
+            npw,
+            :first_name,
+            {dir: :asc}
+          ).should == '<a href="/assets?order=first_name-asc">ASC</a>'
+        end
+      end
+
+      it 'passes other options to #link_to' do
+        helper.stub!(:params).and_return({order: 'first_name-asc'})
+        npw = NobelPrizeWinner.with_order(helper.params)
+        helper.link_with_order(
+          'ASC',
+          npw,
+          :first_name,
+          {dir: :asc, remote: true}
+        ).should == '<a href="/assets?order=first_name-asc" data-remote="true">ASC</a>'
+      end
+    end
+
+    context '#current_order on the scope includes a :param_namespace' do
+      it 'namespaces the :order param' do
+        helper.stub!(:params).and_return({foo: {order: 'first_name-asc'}})
+        npw = NobelPrizeWinner.with_order(helper.params, {param_namespace: :foo})
+        helper.link_with_order(
+          (npw.current_order[:field] == :first_name and npw.current_order[:dir] == :asc) ? 'DESC' : 'ASC',
+          npw,
+          :first_name
+        ).should == '<a href="/assets?foo%5Border%5D=first_name-desc">DESC</a>'
+      end
+
+      it 'works when no params are given' do
+        helper.stub!(:params).and_return({})
+        npw = NobelPrizeWinner.with_order(helper.params, {param_namespace: :foo})
+        helper.link_with_order(
+          (npw.current_order[:field] == :first_name and npw.current_order[:dir] == :asc) ? 'DESC' : 'ASC',
+          npw,
+          :first_name
+        ).should == '<a href="/assets?foo%5Border%5D=first_name-asc">ASC</a>'
+      end
+    end
+
+    it 'accepts blocks' do
+      helper.stub!(:params).and_return({order: 'first_name-asc'})
+      npw = NobelPrizeWinner.with_order(helper.params)
+      output = helper.link_with_order(npw, :first_name, {remote: true}) do
+        (npw.current_order[:field] == :first_name and npw.current_order[:dir] == :asc) ? 'DESC' : 'ASC'
+      end
+      output.should == '<a href="/assets?order=first_name-desc" data-remote="true">DESC</a>'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+
+require 'rspec/rails'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/with_order.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/with_order/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'with_order'
+  gem.version     = WithOrder::VERSION
+
+  gem.authors     = ['Aaron Lasseigne']
+  gem.email       = ['aaron.lasseigne@gmail.com']
+  gem.summary     = %q{Add ordering to lists, tables, etc.}
+  gem.description = %q{Add ordering to lists, tables, etc.}
+  gem.homepage    = 'https://github.com/AaronLasseigne/with_order'
+
+  gem.rubyforge_project = 'with_order'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'rails', '>= 3.1'
+
+  gem.add_development_dependency 'rspec-rails'
+  gem.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: with_order
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Lasseigne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70225821556240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70225821556240
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70225821555820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70225821555820
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70225821555360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70225821555360
+description: Add ordering to lists, tables, etc.
+email:
+- aaron.lasseigne@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- changelog.markdown
+- lib/with_order.rb
+- lib/with_order/action_view_extension.rb
+- lib/with_order/active_record_extension.rb
+- lib/with_order/active_record_model_extension.rb
+- lib/with_order/engine.rb
+- lib/with_order/hash_extraction.rb
+- lib/with_order/version.rb
+- spec/active_record_model_extension_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.gitkeep
+- spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/nobel_prize.rb
+- spec/dummy/app/models/nobel_prize_winner.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/migrate/20120127203225_create_nobel_prize_winners.rb
+- spec/dummy/db/migrate/20120203212237_create_nobel_prizes.rb
+- spec/dummy/db/migrate/20120214172946_fix_einstein.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/lib/assets/.gitkeep
+- spec/dummy/log/.gitkeep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/hash_extraction_spec.rb
+- spec/helpers/action_view_extension_spec.rb
+- spec/spec_helper.rb
+- with_order.gemspec
+homepage: https://github.com/AaronLasseigne/with_order
+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'
+      segments:
+      - 0
+      hash: -4155710535676147031
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4155710535676147031
+requirements: []
+rubyforge_project: with_order
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Add ordering to lists, tables, etc.
+test_files:
+- spec/active_record_model_extension_spec.rb
+- spec/dummy/README.rdoc
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/javascripts/application.js
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/mailers/.gitkeep
+- spec/dummy/app/models/.gitkeep
+- spec/dummy/app/models/nobel_prize.rb
+- spec/dummy/app/models/nobel_prize_winner.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/database.yml
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/secret_token.rb
+- spec/dummy/config/initializers/session_store.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/locales/en.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/db/migrate/20120127203225_create_nobel_prize_winners.rb
+- spec/dummy/db/migrate/20120203212237_create_nobel_prizes.rb
+- spec/dummy/db/migrate/20120214172946_fix_einstein.rb
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
+- spec/dummy/lib/assets/.gitkeep
+- spec/dummy/log/.gitkeep
+- spec/dummy/public/404.html
+- spec/dummy/public/422.html
+- spec/dummy/public/500.html
+- spec/dummy/public/favicon.ico
+- spec/dummy/script/rails
+- spec/hash_extraction_spec.rb
+- spec/helpers/action_view_extension_spec.rb
+- spec/spec_helper.rb