basic_table_sorter 0.0.1.beta → 0.0.2.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d450654560793ee8c97eecee62988c0a3fdecf5
+  data.tar.gz: f3b7532e3634887b6d8ce3cab5c61707cac32e69
+SHA512:
+  metadata.gz: f240ff897add0bb33a8bb3820b9dbb635cc43a88ae6ed87ea07ae72586368fdb1c1a00b737c760d16ec3344039d6220bed25cf68297ca43af3e5fcae1244ab5a
+  data.tar.gz: f47e149a85990db0991c1be32dbafad1a5b1e46a7bdb46cab62d40476e32cc5d2a7a064b23b63cc7a13fe3f38d64a062f52e38847c43aaa590f7b46275c98250

data/Guardfile

@@ -1,6 +1,8 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
+notification :notifysend
+
 guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb"}

data/basic_table_sorter.gemspec

@@ -4,20 +4,21 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'basic_table_sorter/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "basic_table_sorter"
-  gem.version       = BasicTableSorter::VERSION
-  gem.authors       = ["Daniel Grawunder, Christian Mierich"]
-  gem.email         = ["gramie.sw@gmail.com"]
-  gem.description   = %q{A Ruby on Rails basic table sorter gem}
-  gem.summary       = %q{An easy to use basic table sorter for Ruby on Rails.}
-  gem.license       = "EPL 1.0"
+  gem.name = "basic_table_sorter"
+  gem.version = BasicTableSorter::VERSION
+  gem.authors = ["Daniel Grawunder, Christian Mierich"]
+  gem.email = ["gramie.sw@gmail.com"]
+  gem.homepage = "https://github.com/gramie-sw/basic_table_sorter"
+  gem.description = %q{A Ruby on Rails basic table sorter gem}
+  gem.summary = %q{An easy to use basic table sorter for Ruby on Rails.}
+  gem.license = "EPL 1.0"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "activesupport", "~>3.2"
-  gem.add_development_dependency "guard-rspec", "~>2.6.0"
+  gem.add_development_dependency "rspec", "~>2.13.0"
+  gem.add_development_dependency "actionpack", "~>3.2"
+  gem.add_development_dependency "guard-rspec", "~>3.0.1"
 end

data/lib/basic_table_sorter/controller_additions.rb

@@ -14,15 +14,15 @@ module BasicTableSorter
     end
 
     def table_sort_order
-      Array(params[:table_sort]).join(' ' + table_sort_direction + ', ') + ' ' + table_sort_direction
+      custom_table_sort? ? "#{Array(params[:table_sort]).join(" #{table_sort_direction}, ")} #{table_sort_direction}" : nil
     end
 
-    def authorize_sort_params
+    def authorize_table_sort_params
       if params[:table_sort]
-        sort_params_permission_service = SortParamsPermissionService.create
+        sort_params_permission_service = BasicTableSorterPermissionService.create
         Array(params[:table_sort]).each do |value|
-          unless sort_params_permission_service.allowed_sort_value?(params[:controller], params[:action], value)
-            render_500 and return
+          unless sort_params_permission_service.allowed_sort_param?(params[:controller], params[:action], value)
+            raise TableSortParamNotAuthorized, "param table_sort = '#{params[:table_sort]}' not allowed"
           end
         end
       end

data/lib/basic_table_sorter/exceptions.rb

@@ -0,0 +1,3 @@
+module BasicTableSorter
+  class TableSortParamNotAuthorized < StandardError; end
+end

data/lib/basic_table_sorter/matchers.rb

@@ -1,5 +1,5 @@
-RSpec::Matchers.define :allow_sort_value do |*args|
+RSpec::Matchers.define :allow_sort_param do |controller, action, value|
   match do |sort_params_permission_service|
-    sort_params_permission_service.allowed_sort_value?(*args).should be_true
+    sort_params_permission_service.allowed_sort_param?(controller, action, value.to_s).should be_true
   end
 end

data/lib/basic_table_sorter/{sort_params_permission_service_additions.rb → permission_service_additions.rb}

@@ -1,12 +1,12 @@
 module BasicTableSorter
-  module SortParamsPermissionServiceAdditions
+  module PermissionServiceAdditions
 
-    def allowed_sort_value? controller, action, value
+    def allowed_sort_param? controller, action, value
       allowed = @allowed_sort_values && @allowed_sort_values[[controller.to_s, action.to_s]]
       allowed ? allowed.include?(value) : allowed
     end
 
-    def allow_sort_values controllers, actions, param_values
+    def allow_sort_params controllers, actions, param_values
       @allowed_sort_values ||= {}
       Array(controllers).each do |controller|
         Array(actions).each do |action|

data/lib/basic_table_sorter/railtie.rb

@@ -3,5 +3,8 @@ module BasicTableSorter
     initializer "basic_table_sorter.controller_additions" do
       ActionController::Base.send :include, ControllerAdditions
     end
+    initializer "basic_table_sorter.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
   end
 end

data/lib/basic_table_sorter/version.rb

@@ -1,3 +1,3 @@
 module BasicTableSorter
-  VERSION = "0.0.1.beta"
+  VERSION = "0.0.2.beta"
 end

data/lib/basic_table_sorter/view_helpers.rb

@@ -0,0 +1,23 @@
+module BasicTableSorter
+  module ViewHelpers
+
+    def sortable(columns, title, additional_params = {})
+
+      column_selected = Array(columns).map(&:to_s).eql? Array(params[:table_sort])
+
+      sort_direction = (column_selected && "asc" == table_sort_direction) ? "desc" : "asc"
+      icon_class = sort_direction == 'asc' ? 'icon-chevron-up' : 'icon-chevron-down'
+
+      link_params = {table_sort: columns, table_sort_direction: sort_direction}.merge(additional_params)
+
+      if column_selected
+        #link_to takes automatically current controller and action from params if missing in arguments
+        link_to link_params, class: 'selected-column' do
+          content_tag(:span, title) + tag(:i, class: icon_class)
+        end
+      else
+        link_to title, link_params
+      end
+    end
+  end
+end

data/lib/basic_table_sorter.rb

@@ -1,5 +1,7 @@
 require "basic_table_sorter/version"
 require "basic_table_sorter/controller_additions"
-require "basic_table_sorter/sort_params_permission_service_additions"
+require "basic_table_sorter/view_helpers"
+require "basic_table_sorter/permission_service_additions"
+require "basic_table_sorter/exceptions"
 require "basic_table_sorter/railtie" if defined? (Rails)
 

data/spec/basic_table_sorter/controller_additions_spec.rb

@@ -61,35 +61,36 @@ describe 'ControllerAdditions' do
       @controller.stub(:params).and_return({table_sort: ['last_name', 'first_name'], table_sort_direction: 'desc'})
       @controller.table_sort_order.should eq "last_name desc, first_name desc"
     end
+
+    it 'should return nil when no param :table_sort present' do
+      @controller.stub(:params).and_return({})
+      @controller.table_sort_order.should be_nil
+    end
   end
 
-  describe '#authorize_sort_params' do
+  describe '#authorize_table_sort_params' do
 
-    it 'should call allowed_sort_value? if param with value table_sort exits' do
-      @controller.stub(:params).and_return(table_sort: 'last_name')
-      @controller.stub(:render_500)
-      SortParamsPermissionService.any_instance.should_receive(:allowed_sort_value?)
-      @controller.authorize_sort_params
+    it 'should call allowed_sort_param? if param with value table_sort exits' do
+      @controller.stub(:params).and_return(controller: 'users', action: 'index', table_sort: 'last_name')
+      BasicTableSorterPermissionService.
+          any_instance.should_receive(:allowed_sort_param?).
+          with('users', 'index', 'last_name').
+          and_return(true)
+      @controller.authorize_table_sort_params
     end
 
-    it 'should call render_500 if allowed_sort_value? returns false' do
+    it 'should raise BasicTableSorter::TableSortParamNotAuthorized if allowed_sort_param? returns false' do
       @controller.stub(:params).and_return(table_sort: 'last_name')
-      SortParamsPermissionService.any_instance.stub(:allowed_sort_value?).and_return false
-      @controller.should_receive(:render_500)
-      @controller.authorize_sort_params
+      BasicTableSorterPermissionService.any_instance.stub(:allowed_sort_param?).and_return false
+      expect {
+        @controller.authorize_table_sort_params
+      }.to raise_error BasicTableSorter::TableSortParamNotAuthorized,  "param table_sort = 'last_name' not allowed"
     end
 
-    it 'should not call render_500 if params has no value table sort' do
+    it 'should not call authorize_table_sort_params if params has no value table_sort' do
       @controller.stub(:params).and_return({})
-      @controller.should_not_receive(:render_500)
-      @controller.authorize_sort_params.should eq nil
-    end
-
-    it 'should not call render_500 if allowed_sort_value? is true' do
-      @controller.stub(:params).and_return(table_sort: ['last_name', 'first_name'])
-      SortParamsPermissionService.any_instance.stub(:allowed_sort_value?).and_return true
-      @controller.should_not_receive(:render_500)
-      @controller.authorize_sort_params
+      @controller.should_not_receive(:allowed_sort_param?)
+      @controller.authorize_table_sort_params
     end
   end
 end

data/spec/basic_table_sorter/matchers_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 
 describe 'allow_sort_value' do
 
-  it 'should delegate to allowed_sort_value?' do
+  it 'should delegate to allowed_sort_param?' do
     object = Object.new
-    object.should_receive(:allowed_sort_value?).once.with(:comments, :index, :email).and_return(true)
-    object.should allow_sort_value(:comments, :index, :email)
+    object.should_receive(:allowed_sort_param?).once.with(:comments, :index, 'email').and_return(true)
+    object.should allow_sort_param(:comments, :index, :email)
   end
 end

data/spec/basic_table_sorter/{sort_params_permission_service_additions_spec.rb → permission_service_additions_spec.rb}

@@ -1,68 +1,68 @@
 require 'spec_helper'
 
-describe 'SortParamsPermissionServiceAdditions' do
+describe BasicTableSorter::PermissionServiceAdditions do
 
   before :each do
-    @sort_params_permission_service = SortParamsPermissionService.create
+    @sort_params_permission_service = BasicTableSorterPermissionService.create
   end
 
   describe '::included' do
 
     it 'should extend included class with module ClassMethods' do
       clazz = Class.new
-      clazz.should_receive(:extend).with(BasicTableSorter::SortParamsPermissionServiceAdditions::ClassMethods)
-      clazz.send(:include, BasicTableSorter::SortParamsPermissionServiceAdditions)
+      clazz.should_receive(:extend).with(BasicTableSorter::PermissionServiceAdditions::ClassMethods)
+      clazz.send(:include, BasicTableSorter::PermissionServiceAdditions)
     end
   end
 
   describe '::create' do
 
-    it 'should create a SortParamsPermissionService instance object' do
-      @sort_params_permission_service.should be_an_instance_of(SortParamsPermissionService)
+    it 'should create a BasicTableSorterPermissionService instance object' do
+      @sort_params_permission_service.should be_an_instance_of(BasicTableSorterPermissionService)
     end
 
     it 'should call configure_permissions' do
-      SortParamsPermissionService.any_instance.should_receive(:configure_permissions)
-      SortParamsPermissionService.create
+      BasicTableSorterPermissionService.any_instance.should_receive(:configure_permissions)
+      BasicTableSorterPermissionService.create
     end
   end
 
-  describe '#allowed_sort_value?' do
+  describe '#allowed_sort_param?' do
 
     it 'should return false if @allowed_sort_values is nil' do
       @sort_params_permission_service.instance_variable_set(:@allowed_sort_values, nil)
-      @sort_params_permission_service.allowed_sort_value?(nil, nil, nil).should be_false
+      @sort_params_permission_service.allowed_sort_param?(nil, nil, nil).should be_false
     end
 
     it 'should return false if @allowed_sort_value does not have given value' do
       allowed_sort_values = {}
       allowed_sort_values[['customer', 'index']] = ['last_name']
       @sort_params_permission_service.instance_variable_set(:@allowed_sort_values, allowed_sort_values)
-      @sort_params_permission_service.allowed_sort_value?('customer', 'index', 'first_name').should be_false
+      @sort_params_permission_service.allowed_sort_param?('customer', 'index', 'first_name').should be_false
     end
 
     it 'should return true if @allowed_sort_value does have given value' do
       allowed_sort_values = {}
       allowed_sort_values[['customer', 'index']] = ['first_name']
       @sort_params_permission_service.instance_variable_set(:@allowed_sort_values, allowed_sort_values)
-      @sort_params_permission_service.allowed_sort_value?('customer', 'index', 'first_name').should be_true
+      @sort_params_permission_service.allowed_sort_param?('customer', 'index', 'first_name').should be_true
     end
   end
 
-  describe '#allow_sort_values' do
+  describe '#allow_sort_params' do
 
     it 'should insert value into @allow sort values' do
-      @sort_params_permission_service.allow_sort_values('customer', 'index', 'last_name')
+      @sort_params_permission_service.allow_sort_params('customer', 'index', 'last_name')
       @sort_params_permission_service.instance_variable_get(:@allowed_sort_values)[['customer', 'index']].should eq ['last_name']
     end
 
     it 'should insert values into @allow sort values' do
-      @sort_params_permission_service.allow_sort_values('customer', 'index', ['first_name', 'last_name'])
+      @sort_params_permission_service.allow_sort_params('customer', 'index', ['first_name', 'last_name'])
       @sort_params_permission_service.instance_variable_get(:@allowed_sort_values)[['customer', 'index']].should eq ['first_name', 'last_name']
     end
 
     it 'should insert value for two keys' do
-      @sort_params_permission_service.allow_sort_values(['customer', 'person'], ['index', 'edit'], 'first_name')
+      @sort_params_permission_service.allow_sort_params(['customer', 'person'], ['index', 'edit'], 'first_name')
       @sort_params_permission_service.instance_variable_get(:@allowed_sort_values)[['customer', 'index']].should eq ['first_name']
       @sort_params_permission_service.instance_variable_get(:@allowed_sort_values)[['person', 'index']].should eq ['first_name']
       @sort_params_permission_service.instance_variable_get(:@allowed_sort_values)[['customer', 'edit']].should eq ['first_name']

data/spec/basic_table_sorter/view_helpers_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe BasicTableSorter::ViewHelpers do
+
+  let(:helper) do
+    helper_class = Class.new
+    helper_class.send(:include, BasicTableSorter::ViewHelpers)
+    helper_class.send(:include, ActionView::Helpers::TagHelper)
+    helper_class.new
+  end
+
+  describe '#sortable' do
+
+    context 'column selected' do
+
+      it 'should create link with title and icon' do
+        helper.stub(:params).and_return({table_sort: 'title'})
+        helper.stub(:table_sort_direction).and_return('asc')
+
+        expected_link_params = {table_sort: :title, table_sort_direction: 'desc'}
+        helper.should_receive(:link_to).with(expected_link_params, class: 'selected-column') do |&block|
+          block.call.should match /<span>Title<\/span><i class="icon-.*" \/>/
+        end
+        helper.sortable(:title, 'Title')
+      end
+
+      context 'column sorted asc' do
+
+        before :each do
+          helper.stub(:table_sort_direction).and_return('asc')
+          helper.stub(:params).and_return({controller: 'users', action: 'index', table_sort: 'name'})
+        end
+
+        it 'should have link to sort desc' do
+          helper.should_receive(:link_to).with({:table_sort => :name, :table_sort_direction => "desc"}, {:class => "selected-column"})
+          helper.sortable(:name, 'Name')
+        end
+
+        it 'should have icon-chevron-down' do
+
+          helper.should_receive(:link_to).with(any_args) do |&block|
+            block.call.should include('icon-chevron-down')
+          end.once
+
+          helper.sortable(:name, 'Name')
+        end
+      end
+
+      context 'column sorted desc' do
+
+        before :each do
+          helper.stub(:table_sort_direction).and_return('desc')
+          helper.stub(:params).and_return({controller: 'users', action: 'index', table_sort: 'name'})
+        end
+
+        it 'should have link to sort asc' do
+          helper.should_receive(:link_to).with({:table_sort => :name, :table_sort_direction => "asc"}, {:class => "selected-column"})
+          helper.sortable(:name, 'Name')
+        end
+
+        it 'should have icon-arrow-up' do
+          helper.should_receive(:link_to).with(any_args) do |&block|
+            block.call.should include('icon-chevron-up')
+          end.once
+
+          helper.sortable(:name, 'Name')
+        end
+      end
+    end
+
+    context 'column not selected' do
+
+      it 'should return link with title' do
+        helper.stub(:params).and_return({table_sort: 'first_name'})
+        helper.should_receive(:link_to).with('Name', {table_sort: :last_name, table_sort_direction: 'asc'})
+        helper.sortable(:last_name, 'Name')
+      end
+    end
+
+    it 'should merge additional arguments' do
+      helper.stub(:params).and_return({table_sort: 'title'})
+      helper.should_receive(:link_to).with('Name', {table_sort: :last_name, table_sort_direction: 'asc', extra_param: 'extra_param'})
+      helper.sortable(:last_name, 'Name', extra_param: 'extra_param')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,9 @@
+require 'action_view'
 require 'basic_table_sorter'
 require 'basic_table_sorter/matchers'
 
-class SortParamsPermissionService
-  include BasicTableSorter::SortParamsPermissionServiceAdditions
+class BasicTableSorterPermissionService
+  include BasicTableSorter::PermissionServiceAdditions
 
   def configure_permissions
 

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: basic_table_sorter
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta
-  prerelease: 6
+  version: 0.0.2.beta
 platform: ruby
 authors:
 - Daniel Grawunder, Christian Mierich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,19 +41,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 3.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 3.0.1
 description: A Ruby on Rails basic table sorter gem
 email:
 - gramie.sw@gmail.com
@@ -77,41 +70,44 @@ files:
 - epl-v10.html
 - lib/basic_table_sorter.rb
 - lib/basic_table_sorter/controller_additions.rb
+- lib/basic_table_sorter/exceptions.rb
 - lib/basic_table_sorter/matchers.rb
+- lib/basic_table_sorter/permission_service_additions.rb
 - lib/basic_table_sorter/railtie.rb
-- lib/basic_table_sorter/sort_params_permission_service_additions.rb
 - lib/basic_table_sorter/version.rb
+- lib/basic_table_sorter/view_helpers.rb
 - spec/basic_table_sorter/controller_additions_spec.rb
 - spec/basic_table_sorter/matchers_spec.rb
-- spec/basic_table_sorter/sort_params_permission_service_additions_spec.rb
+- spec/basic_table_sorter/permission_service_additions_spec.rb
+- spec/basic_table_sorter/view_helpers_spec.rb
 - spec/spec_helper.rb
-homepage: 
+homepage: https://github.com/gramie-sw/basic_table_sorter
 licenses:
 - EPL 1.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An easy to use basic table sorter for Ruby on Rails.
 test_files:
 - spec/basic_table_sorter/controller_additions_spec.rb
 - spec/basic_table_sorter/matchers_spec.rb
-- spec/basic_table_sorter/sort_params_permission_service_additions_spec.rb
+- spec/basic_table_sorter/permission_service_additions_spec.rb
+- spec/basic_table_sorter/view_helpers_spec.rb
 - spec/spec_helper.rb