sorting_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0b53202a195f03e728498aa65dbb4ef679ac38e
+  data.tar.gz: 464a0a28652e258a2fab8f587f49c27cc7a93e48
+SHA512:
+  metadata.gz: daf4f07a85718c717a461dd4a389680219fef89aa41d20840a080938a2bf2f0959b7bebbbf5793d2e1ae1a0279abfc79e686339a456d444e2347349a2e688b4f
+  data.tar.gz: f8bf227c2fb7c4e6a2f546dc711bce072e15d5882a10f7b8f24bafcf0483472d889e4f8f55fae53e4e7e7d95bd819c5e6bf94f9e1119d9cec98e82f031689dc0

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle
+/Gemfile.lock
+/coverage
+/pkg/
+/tmp/
+*.gem
+/log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=doc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,81 @@
+# SortingHelper
+
+Rails helpers for building "sort by column" links.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sorting_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sorting_helper
+
+## Usage
+
+```ruby
+# app/controllers/users_controller.rb
+def index
+  @users = User.order(sorting)
+end
+
+...
+
+protected
+
+  def sorting
+    column = sorting_column
+
+    if %w[email name].include?(column)
+      "#{column} #{sorting_direction}"
+    end
+  end
+```
+
+Example view:
+```html
+<table>
+  <tr>
+    <th><%= sorting_link :email, 'Email' %></th>
+    <th><%= sorting_link :name, 'Name' %></th>
+  </tr>
+  <% @users.each do |user| %>
+    <tr>
+      <td><%= user.email %></td>
+      <td><%= user.name %></td>
+    </tr>
+  <% end %>
+</table>
+```
+
+## License
+
+Copyright (c) 2014 Okhlopkov Anatoly
+
+MIT License
+
+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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sorting_helper.rb

@@ -0,0 +1,33 @@
+require 'sorting_helper/version'
+require 'active_support/all'
+
+module SortingHelper
+  def sorting_column
+    params[:sort][/^\-?(.+)/, 1] if params[:sort].present?
+  end
+
+  def sorting_direction
+    params[:sort] =~ /^\-/ ? :desc : :asc if params[:sort].present?
+  end
+
+  def sorting_url(column, direction = nil, &blk)
+    direction = sorting_direction || :asc
+
+    column = column.to_s
+    column.prepend('-') if direction == :asc
+
+    blk.call(url_for(sort: column), direction)
+  end
+
+  def sorting_link(column, label)
+    sorting_url(column) do |url, direction|
+      link = link_to(label, url)
+
+      if column.to_s == sorting_column
+        link += direction == :asc ? ' ▴' : ' ▾'
+      end
+
+      raw link
+    end
+  end
+end

data/lib/sorting_helper/version.rb

@@ -0,0 +1,3 @@
+module SortingHelper
+  VERSION = '0.1.0'
+end

data/sorting_helper.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'sorting_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sorting_helper"
+  spec.version       = SortingHelper::VERSION
+  spec.authors       = ["Okhlopkov Anatoly"]
+  spec.email         = ["ohlopkov0211@gmail.com"]
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/VortexGrenade/sorting_helper'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '>= 3'
+  spec.add_dependency 'rails', '>= 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'rspec-rails'
+end

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'sorting_helper'
+
+describe ApplicationController, type: [:controller, :request] do
+  describe '#sorting_column' do
+    it 'returns column name without direction prefix' do
+      controller.params[:sort] = '-column'
+      expect(controller.sorting_column).to eq('column')
+    end
+
+    it 'returns nil if sort is not specified' do
+      expect(controller.sorting_column).to eq(nil)
+    end
+  end
+
+  describe '#sorting_direction' do
+    it 'returns direction type based on column prefix' do
+      controller.params[:sort] = '-column'
+      expect(controller.sorting_direction).to eq(:desc)
+
+      controller.params[:sort] = 'column'
+      expect(controller.sorting_direction).to eq(:asc)
+    end
+
+    it 'returns nil if sort is not specified' do
+      expect(controller.sorting_direction).to eq(nil)
+    end
+  end
+end

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  include SortingHelper
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../boot', __FILE__)
+require 'action_controller/railtie'
+Bundler.require(*Rails.groups)
+require 'sorting_helper'
+
+module Dummy
+  class Application < Rails::Application
+    config.secret_key_base = 'dummy_key'
+    config.session_store :cookie_store, key: '_dummy_session'
+    config.cache_classes = true
+    config.eager_load = false
+    config.consider_all_requests_local = true
+    config.action_dispatch.show_exceptions = false
+    config.action_controller.perform_caching = false
+    config.action_controller.allow_forgery_protection = false
+    config.active_support.deprecation = :stderr
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../application', __FILE__)
+
+Rails.application.initialize!

data/spec/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get '/', to: 'application#index', as: :root
+end

data/spec/helpers/sorting_helper_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'sorting_helper'
+
+describe SortingHelper, type: [:helper] do
+  before do
+    def controller.default_url_options
+      { controller: :application }
+    end
+  end
+
+  describe '#sorting_url' do
+    it 'pass reversed sorting url and current direction to given block' do
+      controller.params[:sort] = '-column'
+
+      helper.sorting_url(:column) do |url, direction|
+        expect(url).to eq('/?sort=column')
+        expect(direction).to eq(:desc)
+      end
+
+      controller.params[:sort] = 'column'
+
+      helper.sorting_url(:column) do |url, direction|
+        expect(url).to eq('/?sort=-column')
+        expect(direction).to eq(:asc)
+      end
+    end
+
+    it 'default direction is asc' do
+      helper.sorting_url(:column) do |url, direction|
+        expect(url).to eq('/?sort=-column')
+        expect(direction).to eq(:asc)
+      end
+    end
+  end
+
+  describe '#sorting_link' do
+    it 'generates html link for given column and label' do
+      expect(helper.sorting_link(:column, 'label')).to eq('<a href="/?sort=-column">label</a>')
+    end
+
+    it 'inverts sorting for current column' do
+      controller.params[:sort] = 'column'
+      expect(helper.sorting_link(:column, 'label')).to eq('<a href="/?sort=-column">label</a> ▴')
+
+      controller.params[:sort] = '-column'
+      expect(helper.sorting_link(:column, 'label')).to eq('<a href="/?sort=column">label</a> ▾')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+require 'rspec/rails'
+
+require 'dummy/app/controllers/application_controller'
+require 'dummy/config/routes'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: sorting_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Okhlopkov Anatoly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- ohlopkov0211@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- lib/sorting_helper.rb
+- lib/sorting_helper/version.rb
+- sorting_helper.gemspec
+- spec/controllers/application_controller_spec.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/routes.rb
+- spec/helpers/sorting_helper_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/VortexGrenade/sorting_helper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/controllers/application_controller_spec.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/routes.rb
+- spec/helpers/sorting_helper_spec.rb
+- spec/spec_helper.rb