sorted-actionview 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b03e155258096d07a8880ade6143619849de9d1b
+  data.tar.gz: 7475fdd0ae7e39fa8cf5fa302531e0f749aa8a9c
+SHA512:
+  metadata.gz: ee99cff98ab4b095184562d95cc53673fc86e1a4e18f2e379789a613396f77079a5350ceac4bca9b8dc1d028c63ed01c652becac37b296555cd248048a92016d
+  data.tar.gz: 12e254d703f967ea67cd4630ef39c97075f7b0147eb96b7bc8d28bfb4c69e9717327187e239ac22a03709057030abdd2e2791ec3361ea492fb316a5163a92e8d

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.swp
+mkmf.log
+.bin
+.bundle
+.gems

data/.rubocop.yml

@@ -0,0 +1,36 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-01-31 16:31:38 +1100 using RuboCop version 0.28.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 29
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 6
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 118
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 5
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+Style/RegexpLiteral:
+  MaxSlashes: 0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sorted-actionview.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rufus Post
+
+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/README.md

@@ -0,0 +1,38 @@
+# Sorted::Actionview
+
+[![Build Status](https://travis-ci.org/mynameisrufus/sorted-actionview.svg?branch=master)](https://travis-ci.org/mynameisrufus/sorted-actionview)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sorted-actionview'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sorted-actionview
+
+## Usage
+
+Generate a sorted link with the email attribute:
+
+```ruby
+link_to_sorted "Email", :email
+```
+
+Works the same as the `link_to` method except a second argument for the
+sort attribute is needed.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sorted-actionview/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RuboCop::RakeTask.new
+
+task default: %w(rubocop spec)

data/lib/sorted/actionview/builder.rb

@@ -0,0 +1,25 @@
+require 'sorted'
+
+module Sorted
+  module ActionView
+    class Builder
+      attr_reader :params
+
+      def initialize(order, params = {})
+        @sort = ::Sorted::URIQuery.parse(params.delete(:sort))
+        @order = ::Sorted::SQLQuery.parse(order)
+        @params = params
+        set = @order.direction_intersect(@sort)
+        @params[:sort] = ::Sorted::URIQuery.encode(set)
+      end
+
+      def css
+        if @sort.keys.include? @order.keys.first
+          "sorted #{@sort.assoc(@order.keys.first).last}"
+        else
+          'sorted'
+        end
+      end
+    end
+  end
+end

data/lib/sorted/actionview/helper.rb

@@ -0,0 +1,67 @@
+require 'action_view'
+require 'sorted/actionview/builder'
+
+module Sorted
+  module ActionView
+    module Helper
+      # Creates a link tag of the given +name+ and +attribute+ creating
+      # a url using a set of +options+.
+      #
+      # ==== Examples
+      #
+      # Basic usage
+      #
+      #   link_to_sorted "Email", :email
+      #   # => <a href="/profiles?sort=email_asc" class="desc">Email</a>
+      #
+      # Or use a block
+      #
+      #   link_to_sorted :email do
+      #     <strong>Sort by email</strong> -- <span></span>
+      #   end
+      #   # => <a href="/profiles?sort=email_asc" class="desc"><strong>Sort by email</strong> -- <span></span></a>
+      #
+      def link_to_sorted(*args, &block)
+        if block_given?
+          order        = args[0]
+          options      = args[1] || {}
+          html_options = args[2] || {}
+        else
+          block        = proc { args[0].to_s }
+          order        = args[1]
+          options      = args[2] || {}
+          html_options = args[3] || {}
+        end
+
+        sorter          = ::Sorted::ActionView::Builder.new(order, ((request.get? && !params.nil?) ? params.dup : {}))
+        options[:class] = [options[:class], sorter.css].join(' ').strip
+        link_to(url_for(sorter.params), options, html_options, &block)
+      end
+
+      # Convenience method for quickly spitting out a sorting menu.
+      #
+      # ==== Examples
+      #
+      # Basic usage
+      #
+      #   sort_by :first_name, :last_name
+      #
+      # To provide a string to use instead of a column name, pass an array composed
+      # of your label string and the column name (symbol):
+      #
+      #   sortable_by :author_name, :title, ["Date of Publication", :published_at]
+      #
+      def sortable_by(*columns)
+        links = content_tag :span, 'Sort by: '
+        columns.each do |c|
+          if c.is_a? Array
+            links += link_to_sorted(c[0], c[1].to_sym)
+          else
+            links += link_to_sorted(c.to_s.titleize, c.to_sym)
+          end
+        end
+        content_tag :div, links, class: 'sortable'
+      end
+    end
+  end
+end

data/lib/sorted/actionview/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+require 'rails/railtie'
+require 'sorted/actionview/helper'
+
+module Sorted
+  module ActiveRecord
+    class Railtie < ::Rails::Railtie
+      config.after_initialize do |_app|
+        ActiveSupport.on_load(:action_view) do
+          include Sorted::ActionView::Helper
+        end
+      end
+    end
+  end
+end

data/lib/sorted/actionview/version.rb

@@ -0,0 +1,5 @@
+module Sorted
+  module Actionview
+    VERSION = '0.0.1'
+  end
+end

data/lib/sorted/actionview.rb

@@ -0,0 +1,7 @@
+require 'sorted/actionview/version'
+
+module Sorted
+  module Actionview
+    # Your code goes here...
+  end
+end

data/sorted-actionview.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sorted/actionview/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sorted-actionview'
+  spec.version       = Sorted::Actionview::VERSION
+  spec.authors       = ['Rufus Post']
+  spec.email         = ['Rufus.Post@team.telstra.com']
+  spec.summary       = 'Actionview helpers for sorted.'
+  spec.description   = 'Allows the use of the sorted gem with Actionview.'
+  spec.homepage      = ''
+  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 'sorted', '~> 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'railties', '>= 4.0.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rspec'
+end

data/spec/sorted/actionview_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'action_view'
+require 'sorted/actionview/helper'
+
+ActionView::Base.send(:include, Sorted::ActionView::Helper)
+
+describe Sorted::ActionView do
+  it 'should integrate with ActiveRecord::Base' do
+    expect(ActionView::Base.new.respond_to?(:link_to_sorted)).to eq(true)
+  end
+
+  it 'should return the default sort order and preserve the existing params' do
+    order  = :email
+    params = { page: 10 }
+    result = { page: 10, sort: 'email_asc' }
+
+    sorter = Sorted::ActionView::Builder.new order, params
+    expect(sorter.params).to eq(result)
+  end
+
+  it 'should only return the sorted css class if email has not yet been sorted' do
+    order  = :email
+    params = {}
+    result = 'sorted'
+
+    sorter = Sorted::ActionView::Builder.new order, params
+    expect(sorter.css).to eq(result)
+  end
+
+  it 'should only return the sorted css class if email has not yet been sorted' do
+    order  = :email
+    params = { sort: 'email_asc' }
+    result = 'sorted asc'
+
+    sorter = Sorted::ActionView::Builder.new order, params
+    expect(sorter.css).to eq(result)
+  end
+
+  it 'should return the default order when params are empty' do
+    order  = :email
+    result = { sort: 'email_asc' }
+
+    sorter = Sorted::ActionView::Builder.new order, {}
+    expect(sorter.params).to eq(result)
+  end
+
+  it 'should correctly toggle multiple params' do
+    order  = 'email DESC, name DESC'
+    params = { sort: 'email_asc!name_asc' }
+    result = { sort: 'email_desc!name_desc' }
+
+    sorter = Sorted::ActionView::Builder.new order, params
+    expect(sorter.params).to eq(result)
+  end
+
+  it 'should have sort order over existing params' do
+    order  = :email
+    params = { sort: 'name_asc' }
+    result = { sort: 'email_asc!name_asc' }
+
+    sorter = Sorted::ActionView::Builder.new order, params
+    expect(sorter.params).to eq(result)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: sorted-actionview
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rufus Post
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sorted
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Allows the use of the sorted gem with Actionview.
+email:
+- Rufus.Post@team.telstra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sorted/actionview.rb
+- lib/sorted/actionview/builder.rb
+- lib/sorted/actionview/helper.rb
+- lib/sorted/actionview/railtie.rb
+- lib/sorted/actionview/version.rb
+- sorted-actionview.gemspec
+- spec/sorted/actionview_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.5
+signing_key: 
+specification_version: 4
+summary: Actionview helpers for sorted.
+test_files:
+- spec/sorted/actionview_spec.rb
+- spec/spec_helper.rb