activeadmin_sortable_table 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd29005165c2b7b96948af430a6f920967e24404
-  data.tar.gz: df533c6372366c40ec3c20a90fcb6774e4b267ab
+  metadata.gz: d2780b4ee0dd39671939f4ded13128f47c2fc89d
+  data.tar.gz: a54c714008eda20f4b25324df87745e2404ebef0
 SHA512:
-  metadata.gz: f30d2d8237e4863ebca8fe0240309ba214b1ceed98ca7cd890d92c16a9ab0d0ebd6afab0b10fce80de58d41767fd9bbd10a37ff7bd3185abb576bf8ef7350ef9
-  data.tar.gz: efc33ec0a49ee5f756a56c111bad9fb456cb56f293c6031850c656952e75fa8e1ba065fe6b77b496629ed3d9b48f32fff5022b57399cb3896f787471b1376da6
+  metadata.gz: d2162c02c4475bee3b894620f56bfabb7ba0bafeccfb255abeb65d85ed148990194e825d0199933ac73349cfd36d3a8cc286d68a014afa702311106a733a77aa
+  data.tar.gz: 8d7f5ca1742a2438e1dd5b14a15c56334885a856321c50f659f1cc767591d361a8b74315d69569d97e3dfae588f2cae78ec70f4414f91d81f1a8de728c22a81c

data/.travis.yml

@@ -18,3 +18,7 @@ script:
   - bundle exec rake dummy:prepare
   - bundle exec rspec
   - bundle exec rubocop
+
+addons:
+  code_climate:
+    repo_token: 085c9fc58ac3efcd9a8b311ee77bcec0b5c048575cde8a2234f7c63550910969

data/Gemfile.lock

@@ -19,8 +19,9 @@ GIT
 PATH
   remote: .
   specs:
-    activeadmin_sortable_table (1.0.0)
+    activeadmin_sortable_table (1.1.0)
       activeadmin (>= 1.0.0.pre1)
+      uber (= 0.0.15)
 
 GEM
   remote: https://rubygems.org/
@@ -218,6 +219,7 @@ GEM
     tilt (2.0.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    uber (0.0.15)
     websocket-driver (0.6.2)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)

data/README.md

@@ -1,18 +1,23 @@
 [![Build Status](https://travis-ci.org/bolshakov/activeadmin_sortable_table.svg?branch=master)](https://travis-ci.org/bolshakov/activeadmin_sortable_table)
+[![Test Coverage](https://codeclimate.com/github/bolshakov/activeadmin_sortable_table/badges/coverage.svg)](https://codeclimate.com/github/bolshakov/activeadmin_sortable_table/coverage)
 [![Code Climate](https://codeclimate.com/github/bolshakov/activeadmin_sortable_table/badges/gpa.svg)](https://codeclimate.com/github/bolshakov/activeadmin_sortable_table)
+[![Gem Version](https://badge.fury.io/rb/activeadmin_sortable_table.svg)](http://badge.fury.io/rb/activeadmin_sortable_table)
 
 # Active Admin Sortable Table
 
 This gem extends ActiveAdmin so that your index page's table rows can be
 orderable via a drag-and-drop interface.
 
-## Prerequisites
+## Improvements over the @neo version
 
-This extension assumes that you're using one of the following on any model you want to be sortable.
+1. Test coverage 
+2. Configurable labels for handler 
+3. Move to top button allows to push any item from any page to the top of the list
+4. Sorting works on all pages ( not only on the first one)
 
-#### ActiveRecord
+## Prerequisites
 
-[acts_as_list](https://github.com/swanandp/acts_as_list)
+This extension assumes that you're using [acts_as_list](https://github.com/swanandp/acts_as_list) on any model you want to be sortable.
 
 ```ruby
 class Page < ActiveRecord::Base
@@ -22,19 +27,19 @@ end
 
 ## Usage
 
-### Add it to your Gemfile
+Add it to your Gemfile
 
 ```ruby
 gem "activeadmin_sortable_table"
 ```
 
-### Include the JavaScript in active_admin.js.coffee
+Include the JavaScript in `active_admin.js.coffee`
 
 ```coffeescript
 #= require activeadmin_sortable_table
 ```
 
-### Include the Stylesheet in active_admin.css.scss
+Include the Stylesheet in `active_admin.css.scss`
 
 ```scss
 @import "activeadmin_sortable_table"
@@ -46,16 +51,9 @@ gem "activeadmin_sortable_table"
 ActiveAdmin.register Page do
   include ActiveAdmin::SortableTable # creates the controller action which handles the sorting
   config.sort_order = 'position_asc' # assumes you are using 'position' for your acts_as_list column
-  config.paginate = false # optional; drag-and-drop across pages is not supported
-  permit_params :position # do not forget to add `position` attribute to permitted prams
 
   index do
-    handle_column # inserts a drag handle
-    # use a user-defined URL for ordering
-    handle_column url: :sort_admin_section_path
-    # alternative form with lambda
-    handle_column url: -> (resource) { compute_url_from_resource(resource) }
-    # other columns...
+    handle_column 
   end
 
   show do |c|
@@ -75,23 +73,37 @@ ActiveAdmin.register Page do
 end
 ```
 
-### Overriding handler
+### Configure handler
+
+You can override handler column symbol using handle_column options:
 
-You can override handler column symbol using CSS:
+You can configure `sort_url` using handle column options by providing static value, symbolized instance method name, or blocks. 
+
+```ruby
+handle_column sort_url: ->(category) { compute_url_for_category(category) }  
+handle_column sort_url: '/admin/categories/1/sort'
+handle_column sort_url: :sort_category  
+```
 
-```css
-/* active_admin.css.scss */
-@import "activeadmin_sortable_table";
+The same options available for `move_to_top_url`:
 
-.activeadmin_sortable_table .handle:before {
-   content: '☰';
-}
+```ruby
+handle_column move_to_top_url: '/admin/categories/1/move_to_top
+```
+
+It's also possible to override handle lables:
+
+```ruby
+handle_column sort_handle: '&#9776;'.html_safe
+handle_column move_to_top_handle: 'Move to top'
 ```
 
 ## Contributing
 
 1. Fork it
 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 new Pull Request
+3. Prepare tests database (`bundle exec rake dummy:prepare`)
+4. Make your changes and runs specs (`bundle exec rspec`)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create Pull Request

data/activeadmin_sortable_table.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ['adam@adamlogic.com', 'jcgertig@gmail.com', 'abolshakov@spbtv.com']
   gem.description   = 'Drag and drop reordering interface for ActiveAdmin tables'
   gem.summary       = 'Drag and drop reordering interface for ActiveAdmin tables'
+  gem.license       = 'MIT'
   gem.homepage      = 'https://github.com/bolshakov/activeadmin_sortable_table'
 
   gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
@@ -18,6 +19,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'activeadmin', '>= 1.0.0.pre1'
+  gem.add_dependency 'uber', '0.0.15'
   gem.add_development_dependency 'rails', '~> 4.2'
   gem.add_development_dependency 'capybara'
   gem.add_development_dependency 'rspec-rails', '~> 3.3'

data/app/assets/javascripts/activeadmin_sortable_table.js

@@ -17,7 +17,7 @@
         $.ajax({
           url: url,
           type: 'post',
-          data: $.extend(customParams, { position: ui.item.index() + 1 }),
+          data: $.extend(customParams, { position: ui.item.find('[data-position]').data('position') - 1 }),
           error: function() { console.error('Saving sortable error'); },
           success: function() {
             if (actionOnSuccess === 'noting') { return; }

data/app/assets/stylesheets/activeadmin_sortable_table.css

@@ -1,11 +1,13 @@
 .activeadmin_sortable_table .handle {
     cursor: ns-resize;
-    position: relative;
-    padding-left: 1.25em;
+    font-size: 1.5em;
 }
 
-.activeadmin_sortable_table .handle:before {
-    content: '\2630';
+.activeadmin_sortable_table .move_to_top {
+    padding-left: 1em;
+    /*cursor: pointer;*/
+    text-decoration: none;
     font-size: 1.5em;
-    position: absolute;
+    color: rgb(51, 51, 51);
 }
+

data/lib/active_admin/sortable_table.rb

@@ -0,0 +1,43 @@
+require 'activeadmin'
+
+module ActiveAdmin
+  # Include this module to registered page to enable
+  # ActiveAdmin Sortable Table extension
+  # @example
+  #
+  #  ActiveAdmin.register Category do
+  #    include ActiveAdmin::SortableTable
+  #    config.sort_order = 'position_asc'
+  #    permit_params :position
+  #
+  #    index do
+  #      handle_column
+  #      id_column
+  #    end
+  # end
+  #
+  module SortableTable
+    require 'active_admin/sortable_table/version'
+    require 'active_admin/sortable_table/engine'
+    require 'active_admin/sortable_table/handle_column'
+
+    class << self
+      # @param [ActiveAdmin::DSL] dsl
+      # @return [void]
+      #
+      def included(dsl)
+        dsl.instance_eval do
+          member_action :sort, method: :post do
+            resource.insert_at params[:position].to_i
+            head 200
+          end
+
+          member_action :move_to_top, method: :post do
+            resource.move_to_top
+            redirect_to :back
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_admin/sortable_table/handle_column.rb

@@ -1,3 +1,5 @@
+require 'uber/options'
+
 module ActiveAdmin
   #
   module SortableTable
@@ -16,28 +18,46 @@ module ActiveAdmin
     #   end
     #
     module HandleColumn
-      # @param [Hash] options
-      # @option options [Symbol, Proc, String] :url
+      DEFAULT_OPTIONS = {
+        move_to_top_url: ->(resource) { url_for([:move_to_top, :admin, resource]) },
+        move_to_top_handle: '⤒'.html_safe,
+        show_move_to_top_handle: ->(resource) { !resource.first? },
+        sort_url: ->(resource) { url_for([:sort, :admin, resource]) },
+        sort_handle: '☰'.html_safe
+      }
+
+      # @param [Hash] arguments
+      # @option arguments [Symbol, Proc, String] :sort_url
+      # @option arguments [Symbol, Proc, String] :sort_handle
+      # @option arguments [Symbol, Proc, String] :move_to_top_url
+      # @option arguments [Symbol, Proc, String] :move_to_top_handle
       #
-      def handle_column(options = {})
+      def handle_column(arguments = {})
+        defined_options = Uber::Options.new(DEFAULT_OPTIONS.merge(arguments))
+
         column '', class: 'activeadmin_sortable_table' do |resource|
-          content_tag :span, '', class: 'handle', 'data-sort-url' => sort_url(options[:url], resource)
+          options = defined_options.evaluate(self, resource)
+
+          sort_handle(options, resource.position) + move_to_top_handle(options)
         end
       end
 
       private
 
-      def sort_url(url, resource)
-        if url.is_a?(Symbol)
-          send(url, resource)
-        elsif url.respond_to?(:call)
-          url.call(resource)
-        else
-          sort_url, query_params = resource_path(resource).split('?', 2)
-          sort_url += '/sort'
-          sort_url += '?' + query_params if query_params
-          sort_url
-        end
+      def sort_handle(options, position)
+        content_tag(:span, options[:sort_handle],
+                    class: 'handle',
+                    'data-sort-url' => options[:sort_url],
+                    'data-position' => position,
+                    title: 'Drag to reorder'
+                   )
+      end
+
+      def move_to_top_handle(options)
+        link_to_if(options[:show_move_to_top_handle], options[:move_to_top_handle], options[:move_to_top_url],
+                   method: :post,
+                   class: 'move_to_top',
+                   title: 'Move to top') { '' }
       end
     end
 

data/lib/active_admin/sortable_table/version.rb

@@ -1,6 +1,6 @@
 module ActiveAdmin
   #
   module SortableTable
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/lib/activeadmin_sortable_table.rb

@@ -1,38 +1 @@
-require 'activeadmin'
-
-module ActiveAdmin
-  # Include this module to registered page to enable
-  # ActiveAdmin Sortable Table extension
-  # @example
-  #
-  #  ActiveAdmin.register Category do
-  #    include ActiveAdmin::SortableTable
-  #    config.sort_order = 'position_asc'
-  #    permit_params :position
-  #
-  #    index do
-  #      handle_column
-  #      id_column
-  #    end
-  # end
-  #
-  module SortableTable
-    require 'active_admin/sortable_table/version'
-    require 'active_admin/sortable_table/engine'
-    require 'active_admin/sortable_table/handle_column'
-
-    class << self
-      # @param [ActiveAdmin::DSL] dsl
-      # @return [void]
-      #
-      def included(dsl)
-        dsl.instance_eval do
-          member_action :sort, method: :post do
-            resource.insert_at params[:position].to_i
-            head 200
-          end
-        end
-      end
-    end
-  end
-end
+require 'active_admin/sortable_table'

data/spec/dummy/app/admin/categories.rb

@@ -1,12 +1,12 @@
 ActiveAdmin.register Category do
   include ActiveAdmin::SortableTable
-  permit_params :name, :position
+  permit_params :id, :position
   config.sort_order = 'position_asc'
+  config.per_page = 3
 
   index do
     handle_column
     id_column
-    column :name
     actions
   end
 end

data/spec/dummy/db/migrate/20150910072505_create_categories.rb

@@ -1,7 +1,6 @@
 class CreateCategories < ActiveRecord::Migration
   def change
     create_table :categories do |t|
-      t.string :name
       t.integer :position
     end
   end

data/spec/features/drag_and_drop_spec.rb

@@ -0,0 +1,64 @@
+RSpec.describe ActiveAdmin::SortableTable, 'Drag-and-Drop', type: :feature do
+  before do
+    Category.create!
+    Category.create!
+    Category.create!
+  end
+
+  def ordered_elements
+    Category.order(:position).pluck(:id)
+  end
+
+  context 'first page' do
+    it 'reorder elements by dragging vertically', js: true do
+      expect(ordered_elements).to eq([1, 2, 3])
+
+      visit admin_categories_path
+
+      expect(visible_elements).to eq([1, 2, 3])
+
+      move_higher(2)
+
+      expect(visible_elements).to eq([2, 1, 3])
+      expect(ordered_elements).to eq([2, 1, 3])
+    end
+  end
+
+  context 'second page' do
+    before do
+      Category.create!
+      Category.create!
+      Category.create!
+    end
+
+    it 'reorder elements by dragging vertically', js: true do
+      expect(ordered_elements).to eq([1, 2, 3, 4, 5, 6])
+
+      visit admin_categories_path(page: 2)
+
+      expect(visible_elements).to eq([4, 5, 6])
+
+      move_higher(5)
+
+      expect(visible_elements).to eq([5, 4, 6])
+      expect(ordered_elements).to eq([1, 2, 3, 5, 4, 6])
+    end
+  end
+
+  private
+
+  def visible_elements
+    all('.ui-sortable-handle .col-id').map(&:text).map(&:to_i)
+  end
+
+  def move_higher(element_id)
+    drag_element(element_id, dy: -200)
+  end
+
+  def drag_element(element_id, options)
+    wait_for_ajax do
+      options.reverse_merge! moves: 20
+      page.execute_script(%($("#category_#{element_id} .handle").simulate("drag", #{options.to_json} )))
+    end
+  end
+end

data/spec/features/move_to_top_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe ActiveAdmin::SortableTable, 'Move to top', type: :feature do
+  before do
+    Category.create!
+    Category.create!
+    Category.create!
+    Category.create!
+  end
+
+  def ordered_elements
+    Category.order(:position).pluck(:id)
+  end
+
+  it 'push element to top by clicking "move to top"', js: true do
+    expect(ordered_elements).to eq([1, 2, 3, 4])
+
+    # Initially only one element on the second page
+    visit admin_categories_path(page: 2)
+
+    expect(visible_elements).to contain_exactly(4)
+
+    # When I push "move to top" button
+    move_to_top(4)
+
+    # The last element from the previous page should be shown
+    # save_and_open_page
+    expect(visible_elements).to contain_exactly(3)
+
+    # And when I visit previous page
+    visit admin_categories_path(page: 1)
+
+    # I should see pushed elenent on the top
+    expect(visible_elements).to eq([4, 1, 2])
+    expect(ordered_elements).to eq([4, 1, 2, 3])
+  end
+
+  private
+
+  def visible_elements
+    all('.ui-sortable-handle .col-id').map(&:text).map(&:to_i)
+  end
+
+  def move_to_top(element_id)
+    within "#category_#{element_id}" do
+      first('.move_to_top').click
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activeadmin_sortable_table
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam McCrea
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeadmin
@@ -26,6 +26,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0.pre1
+- !ruby/object:Gem::Dependency
+  name: uber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.15
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +159,7 @@ files:
 - activeadmin_sortable_table.gemspec
 - app/assets/javascripts/activeadmin_sortable_table.js
 - app/assets/stylesheets/activeadmin_sortable_table.css
+- lib/active_admin/sortable_table.rb
 - lib/active_admin/sortable_table/engine.rb
 - lib/active_admin/sortable_table/handle_column.rb
 - lib/active_admin/sortable_table/version.rb
@@ -201,12 +216,14 @@ files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/features/activeadmin_sortable_table_spec.rb
+- spec/features/drag_and_drop_spec.rb
+- spec/features/move_to_top_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/support/wait_for_ajax.rb
 homepage: https://github.com/bolshakov/activeadmin_sortable_table
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -281,7 +298,8 @@ test_files:
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
-- spec/features/activeadmin_sortable_table_spec.rb
+- spec/features/drag_and_drop_spec.rb
+- spec/features/move_to_top_spec.rb
 - spec/rails_helper.rb
 - spec/spec_helper.rb
 - spec/support/wait_for_ajax.rb

data/spec/features/activeadmin_sortable_table_spec.rb

@@ -1,31 +0,0 @@
-RSpec.describe 'ActiveAdmin::SortableTable', type: :feature do
-  let!(:bottom) { Category.create!(name: 'bottom', position: 0) }
-  let!(:top) { Category.create!(name: 'top', position: 1) }
-  let!(:middle) { Category.create!(name: 'middle', position: 2) }
-
-  before do
-    visit admin_categories_path
-  end
-
-  it 'reorder elements by dragging vertically', js: true do
-    expect(displayed_names).to eq(%w(top middle bottom))
-
-    drag_element(middle, dy: -200)
-
-    expect(displayed_names).to eq(%w(middle top bottom))
-    expect(Category.order(:position).map(&:name)).to eq(%w(middle top bottom))
-  end
-
-  private
-
-  def displayed_names
-    all('.ui-sortable-handle .col-name').map(&:text)
-  end
-
-  def drag_element(element, options)
-    wait_for_ajax do
-      options.reverse_merge! moves: 20
-      page.execute_script(%($("#category_#{element.id} .handle").simulate("drag", #{options.to_json} )))
-    end
-  end
-end