hikari 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eccc48c31fadc36442a5b34c330d54e5186601e3
+  data.tar.gz: f03c7c63eaf90399c37f5da6bea85e46dbf6d16a
+SHA512:
+  metadata.gz: 12763e4935029434aca9f678c4ca0ac39c6a42c0fb52612b1e1cb748f57684b7dceeb1e37998f0aa1b7a35e4303b0ecd31673e31b734bd50beb9ae242da66182
+  data.tar.gz: 655f4adcb2bdfc18b2255073fac552e41386ed9e8ec760c5ce8bc4fed9a87bb00c2c48374293bd421ac6a02d4b56d77bca700b30b01ee2384a9178f905e441a3

data/.gitignore

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

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Seth Faxon
+
+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.rdoc

@@ -0,0 +1,36 @@
+Hikari helps create sorting links for Ruby on Rails applications. It also
+allows sorting on associated models via scopes and default orders to be
+provided in the view. It pairs nicely with Kaminari, but only works with
+ActiveRecord at the moment.
+
+Simple example
+
+  class Post < ActiveRecord::Base
+    belongs_to :author, class_name: 'User'
+
+    scope :by_author_last_name, -> {
+      joins(:author).order("users.last_name")
+    }
+  end
+  class User < ActiveRecord::Base
+    has_many :posts
+  end
+
+app/controllers/posts_controller.rb
+  
+  def index
+    @posts = Post.sort(params[:sort], 'title ASC')
+  end
+
+app/views/posts/index.html.erb
+
+  <%= link_to_sorted 'Title', :title %>
+
+  <a href="/posts?sort=title_asc" class="sortable">Title</a>
+
+If a field matching the sort parameter is not found Hikari will attempt
+to apply an ActiveRecord scope that is defined on the model. To sort Posts by
+Author:
+
+  <%= link_to_sorted 'By Author', :by_author_last_name %>
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/hikari.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hikari/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hikari"
+  s.version     = Hikari::VERSION
+  s.authors     = ["Seth Faxon"]
+  s.email       = ["seth.faxon@gmail.com"]
+  s.homepage    = "https://github.com/sfaxon/hikari"
+  s.summary     = %q{Hikari is a field and scope based sorting helper for Rails.}
+  s.description = %q{Hikari allows sorting in Rails projects based on fields or scopes.
+Sorting can be done across models via scopes.}
+
+  s.rubyforge_project = "hikari"
+
+  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.extra_rdoc_files = [
+    "MIT-LICENSE",
+    "README.rdoc"
+  ]
+
+  # specify any dependencies here; for example:
+  s.add_dependency "activerecord", ">= 4.0.0"
+  s.add_dependency "actionpack",   ">= 4.0.0"
+
+  s.add_development_dependency "rspec", "~> 3.1.0"
+  s.add_development_dependency "sqlite3", "~> 1.3"
+  s.add_development_dependency "rake", ">= 0"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+end

data/lib/hikari.rb

@@ -0,0 +1,9 @@
+require 'hikari/version'
+require 'hikari/parser'
+
+module Hikari
+end
+
+if defined?(::Rails::Railtie)
+  require 'hikari/railtie'
+end

data/lib/hikari/active_record.rb

@@ -0,0 +1,32 @@
+require 'hikari'
+require 'active_support/concern'
+
+
+module Hikari
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    included do
+      def self.sort(sort_param, default_order = nil)
+        parser = ::Hikari::Parser.new(sort_param, default_order)
+        if self.column_names.include?(parser.field)
+          if parser.asc?
+            order( parser.field )
+          else
+            order( parser.field ).reverse_order
+          end
+        elsif self.respond_to?(parser.field)
+          if parser.asc?
+            self.send(parser.field)
+          else
+            self.send(parser.field).reverse_order
+          end
+        else
+          # do nothing, log error
+          all
+        end
+      end
+
+    end
+  end
+end

data/lib/hikari/parser.rb

@@ -0,0 +1,60 @@
+module Hikari
+  class Parser
+    attr_reader :field, :order
+    ASC = 'ASC'.freeze
+    DESC = 'DESC'.freeze
+
+    # Regex for safety
+    PARAMS_REGEX  = /([a-zA-Z0-9._]+)_(asc|desc)$/
+
+    def initialize(sort_param, default = nil)
+      if sort_param.is_a?(Hash) || sort_param.is_a?(Array)
+        self.field = sort_param.flatten.first.to_s
+        self.order = sort_param.flatten.last
+      else
+        sort_param ||= ''
+        match = sort_param.match(PARAMS_REGEX)
+        if match
+          self.field = match[1]
+          self.order = match[2]
+        elsif default.present?
+          default = default.split(' ')
+          self.order = default.pop
+          self.field = default.join('')
+        else
+          self.field = sort_param
+          self.order = ASC
+        end
+      end
+    end
+
+    def field=(f)
+      @field = f.to_s.downcase
+    end
+
+    def order=(o)
+      if :desc == o.downcase.to_sym
+        @order = DESC
+      else
+        @order = ASC
+      end
+    end
+
+    def asc?
+      ASC == @order
+    end
+
+    def desc?
+      DESC == @order
+    end
+
+    def swap_order!
+      asc? ? @order = DESC : @order = ASC
+      self
+    end
+
+    def to_s
+      "#{@field}_#{@order}".downcase
+    end
+  end
+end

data/lib/hikari/railtie.rb

@@ -0,0 +1,19 @@
+require 'hikari'
+
+module Hikari
+  class Railtie < Rails::Railtie
+    initializer "hikari.configure" do |app|
+      if defined? ::ActiveRecord
+        ActiveSupport.on_load :active_record do
+          require 'hikari/active_record'
+          include Hikari::ActiveRecord
+        end
+      end
+
+      ActiveSupport.on_load :action_view do
+        require 'hikari/view_helpers/action_view'
+        include Hikari::ViewHelpers::ActionView
+      end
+    end
+  end
+end

data/lib/hikari/version.rb

@@ -0,0 +1,3 @@
+module Hikari
+  VERSION = File.read(File.dirname(__FILE__) + "/../../VERSION").chomp
+end

data/lib/hikari/view_helpers/action_view.rb

@@ -0,0 +1,74 @@
+require 'action_view'
+require 'hikari'
+
+module Hikari
+  module ViewHelpers
+    module ActionView
+      class HikariViewHelper
+        attr_reader :params
+
+        def initialize(field, params = {})
+          sort = params[:sort]
+          @params = params
+          @field_parse = ::Hikari::Parser.new(field)
+          if sort
+            @sort_param_parser = ::Hikari::Parser.new(sort)
+
+            if @field_parse.field == @sort_param_parser.field
+              @params[:sort] = @sort_param_parser.swap_order!.to_s
+            else
+              @params[:sort] = @field_parse.to_s
+            end
+          else
+            @params[:sort] = @field_parse.to_s
+          end
+        end
+
+        def css(current_field)
+          if current_field.is_a?(Hash) || current_field.is_a?(Array)
+            current_field = current_field.flatten.first
+          end
+          if @sort_param_parser.try(:field) == current_field.to_s
+            "sorted-#{@field_parse.order.downcase}"
+          else
+            "sortable"
+          end
+        end
+      end
+
+      # Public: Create a sorted link
+      #
+      # args - link_to style arguments accepted
+      #
+      # Examples
+      #
+      #   link_to_sorted "Title", :title
+      #   # => <a href="/posts?sort=title_asc" class="sortable">Title</a>
+      #
+      #   link_to_sorted :title do
+      #     <strong>Title</strong>
+      #   end
+      #   # => <a href="/posts?sort=title_asc" class="sortable"><strong>Title</strong></a>
+      #
+      #   link_to_sorted "Created At", {created_at: :desc}
+      #   # => <a href="/posts?sort=created_at_desc" class="sortable">Created At</a>
+      #
+      def link_to_sorted(*args, &block)
+        if block_given?
+          field        = args[0]
+          options      = args[1] || {}
+          html_options = args[2] || {}
+        else
+          block        = proc { args[0].to_s }
+          field        = args[1]
+          options      = args[2] || {}
+          html_options = args[3] || {}
+        end
+
+        sorter          = HikariViewHelper.new(field, ((request.try(:get?) && !params.nil?) ? params.dup : {}))
+        options[:class] = [options[:class], sorter.css(field)].join(' ').strip
+        link_to(url_for(sorter.params), options, html_options, &block)
+      end
+    end
+  end
+end

data/spec/lib/action_view_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'action_controller'
+
+RSpec.describe Hikari::ViewHelpers::ActionView do
+  it 'should be loaded into ActionView' do
+    ActionView::Base.send(:include, Hikari::ViewHelpers::ActionView)
+    av = ActionView::Base.new
+    expect(av).to respond_to(:link_to_sorted)
+  end
+end
+
+RSpec.describe Hikari::ViewHelpers::ActionView::HikariViewHelper do
+  it 'should default to asc' do
+    field  = :title
+    view_helper = Hikari::ViewHelpers::ActionView::HikariViewHelper.new field, {}
+    expect(view_helper.params).to eq({sort: 'title_asc'})
+  end
+
+  it 'should set desc when given' do
+    field  = {title: :desc}
+    view_helper = Hikari::ViewHelpers::ActionView::HikariViewHelper.new field, {}
+    expect(view_helper.params).to eq({sort: 'title_desc'})
+  end
+
+  it 'should add swap sort order' do
+    field = :title
+    params = ActionController::Parameters.new(sort: "title_asc")
+    view_helper = Hikari::ViewHelpers::ActionView::HikariViewHelper.new field, params
+    expect(view_helper.params).to eq({'sort' => 'title_desc'})
+  end
+
+end

data/spec/lib/parser_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'action_controller'
+
+RSpec.describe Hikari::Parser do
+  it 'should split the given sort string' do
+    g = Hikari::Parser.new('first_name_asc')
+    expect(g.field).to eq('first_name')
+    expect(g.order).to eq('ASC')
+  end
+
+  it 'should split the default order' do
+    g = Hikari::Parser.new(nil, 'last_name ASC')
+    expect(g.field).to eq('last_name')
+    expect(g.order).to eq('ASC')
+  end
+
+  it 'should work without sort' do
+    g = Hikari::Parser.new('first_name')
+    expect(g.field).to eq('first_name')
+    expect(g.order).to eq('ASC')
+  end
+
+  it 'should take a hash' do
+    g = Hikari::Parser.new({last_name: :desc})
+    expect(g.field).to eq('last_name')
+    expect(g.order).to eq('DESC')
+  end
+end

data/spec/lib/post_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'action_controller'
+
+RSpec.describe Post, :type => :model do
+  before(:example) do
+    User.delete_all
+    Post.delete_all
+  end
+
+  describe 'field sorting' do
+    it 'should prefer params sort' do
+      p1 = Post.create(:title => "aaaa")
+      p2 = Post.create(:title => "bbbb")
+      params = ActionController::Parameters.new(sort: "title_asc")
+
+      result = Post.sort(params[:sort], 'title DESC')
+      expect(result.first).to eq(p1)
+      expect(result.last).to  eq(p2)
+    end
+
+    it 'should sort descending' do
+      p1 = Post.create(:title => "ccc")
+      p2 = Post.create(:title => "ddd")
+      params = ActionController::Parameters.new(sort: "title_desc")
+
+      result = Post.sort(params[:sort], 'title ASC')
+      expect(result.last).to eq(p1)
+      expect(result.first).to  eq(p2)
+    end
+  end
+
+  describe 'scope sorting' do
+    it 'should set default scope asc' do
+      a1 = User.create(last_name: 'aaa')
+      a2 = User.create(last_name: 'zzz')
+      p1 = Post.create(author: a1)
+      p2 = Post.create(author: a2)
+
+      result = Post.sort('', 'by_author_last_name ASC')
+      expect(result.count).to eq(2)
+      expect(result.first.author).to eq(a1)
+      expect(result.last.author).to  eq(a2)
+    end
+
+    it 'should set default scope desc' do
+      a1 = User.create(last_name: 'aaa')
+      a2 = User.create(last_name: 'zzz')
+      p1 = Post.create(author: a1)
+      p2 = Post.create(author: a2)
+
+      result = Post.sort('', 'by_author_last_name DESC')
+      expect(result.count).to eq(2)
+      expect(result.first.author).to eq(a2)
+      expect(result.last.author).to  eq(a1)
+    end
+  end
+end

data/spec/schema.rb

@@ -0,0 +1,53 @@
+require 'active_record'
+require 'sqlite3'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby' ? 'jdbcsqlite3' : 'sqlite3',
+  :database => File.join(File.dirname(__FILE__), 'test.db')
+)
+
+class CreateSchema < ActiveRecord::Migration
+  def self.up
+    create_table :posts, :force => true do |t|
+      t.integer    :author_id
+      t.string     :title
+      t.text       :body
+      t.timestamps
+    end
+
+    create_table :users, :force => true do |t|
+      t.string :first_name
+      t.string :last_name
+      t.timestamps
+    end
+
+    create_table :comments, :force => true do |t|
+      t.integer :author_id
+      t.integer :post_id
+      t.text    :body
+    end
+  end
+end
+
+CreateSchema.suppress_messages do
+  CreateSchema.migrate(:up)
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :author, class_name: 'User'
+  has_many :comments
+
+  scope :by_author_last_name, -> {
+    joins(:author).order("users.last_name")
+  }
+end
+
+class User < ActiveRecord::Base
+  has_many :posts
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :author, class_name: 'User'
+  belongs_to :post
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'bundler/setup'
+Bundler.require
+
+require 'hikari'
+require 'hikari/active_record'
+require 'hikari/view_helpers/action_view'
+require 'rspec'
+
+require 'schema'
+
+ActiveRecord::Base.send(:include, Hikari::ActiveRecord)

data/tasks/spec.rake

@@ -0,0 +1,34 @@
+ENV['BUNDLE_GEMFILE'] = File.dirname(__FILE__) + '/../Gemfile'
+
+require 'rake'
+require 'rake/testtask'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run the test suite"
+task :spec => ['spec:setup', 'spec:hikari_lib', 'spec:cleanup']
+
+namespace :spec do
+  desc "Setup the test environment"
+  task :setup do
+  end
+  
+  desc "Cleanup the test environment"
+  task :cleanup do
+    File.delete(File.expand_path(File.dirname(__FILE__) + '/../spec/test.db'))
+  end
+  
+  desc "Test hikari"
+  RSpec::Core::RakeTask.new(:hikari_lib) do |task|
+    hikari_root = File.expand_path(File.dirname(__FILE__) + '/..')
+    task.pattern = hikari_root + '/spec/lib/**/*_spec.rb'
+  end
+
+  desc "Run the coverage report"
+  RSpec::Core::RakeTask.new(:rcov) do |task|
+    hikari_root = File.expand_path(File.dirname(__FILE__) + '/..')
+    task.pattern = hikari_root + '/spec/lib/**/*_spec.rb'
+    task.rcov=true
+    task.rcov_opts = %w{--rails --exclude osx\/objc,gems\/,spec\/,features\/}
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: hikari
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Seth Faxon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: actionpack
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: |-
+  Hikari allows sorting in Rails projects based on fields or scopes.
+  Sorting can be done across models via scopes.
+email:
+- seth.faxon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- MIT-LICENSE
+- README.rdoc
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- hikari.gemspec
+- lib/hikari.rb
+- lib/hikari/active_record.rb
+- lib/hikari/parser.rb
+- lib/hikari/railtie.rb
+- lib/hikari/version.rb
+- lib/hikari/view_helpers/action_view.rb
+- spec/lib/action_view_spec.rb
+- spec/lib/parser_spec.rb
+- spec/lib/post_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- tasks/spec.rake
+homepage: https://github.com/sfaxon/hikari
+licenses: []
+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: hikari
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Hikari is a field and scope based sorting helper for Rails.
+test_files:
+- spec/lib/action_view_spec.rb
+- spec/lib/parser_spec.rb
+- spec/lib/post_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb