rails_sortable 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f71d0f09c228e23feab8feb87bdfb86ef381ab87
-  data.tar.gz: 60cb4a0ac744d60116e3315b7ed2f443d995bd62
+  metadata.gz: f87ea45db075e7775fe975f17a4efba046cc6390
+  data.tar.gz: 3e363558e6544afadf50af11e3f327d196db5b7b
 SHA512:
-  metadata.gz: 51c26d72c68ecda96ef5f4100f7b809404d1eb95b61467b556155e8742040c5e4d611a039676b9c744d46b5a82c7bb328e24990369fcb8368f93c72e55993839
-  data.tar.gz: bb71c5d7176570a81c7f91e4ad886fb3e025a3b456ad75bef7b22268f2cbc4ec1a5702d2945e8b52c033ed16a78c33bd02db532690d3a4203a1577c9af515bc8
+  metadata.gz: fa5ae363dfd93a2bf1d28f9f9e4808a10b3dcb00e51efa37daa73c5c14603aa3086ca46af130648c59a318ce7b7bb7a0dc2dcd0b0c5bf18182a309497ed7a7f6
+  data.tar.gz: 527606581cafb9e132d87419bf146a0aad09b232daaa6c21c6675f16074bcb3a83480914a93f418d5d140b63a7f04b79e0eb2f6c895ff9ba378ffc70e8350ddb

data/README.md

@@ -1,31 +1,35 @@
 # RailsSortable
+[![Build Status](https://travis-ci.org/itmammoth/rails_sortable.svg?branch=use_travis_ci)](https://travis-ci.org/itmammoth/rails_sortable)
 
-RailsSortable is a simple Rails gem that allows you to create a listing view with drag & drop sorting.
+RailsSortable is a simple Rails gem that allows you to create a listing view with drag & drop sorting. The arranged order will be persisted in the table without any pain.
 
 ![RailsSortable](https://raw.githubusercontent.com/itmammoth/rails_sortable/master/rails_sortable.gif "RailsSortable")
 
-## Setup
+# Setup
 
-Add it to your Gemfile then run bundle to install it.
+Add the following to your `Gemfile` then run bundle to install them.
 ```
+gem 'jquery-rails'
 gem 'jquery-ui-rails'
 gem 'rails_sortable'
 ```
 
-And then add it to the Asset Pipeline in the application.js file:
+And then add the following to the asset pipeline in the `application.js`:
 ```
+//= require jquery
+//= require jquery_ujs
 //= require jquery-ui/widgets/sortable
 //= require rails_sortable
 ```
 
-## Usage
+# Usage
 
-RailsSortable requires specific column on ActiveRecord Model for own implementation.
+RailsSortable requires a specific column on the ActiveRecord Model for its implementation.
 
-For instance, the following migration indicates the case that you are attemtting to make Item model sortable.
+For instance, the following migration indicates the case that you are attemtting to make `Item` model sortable.
 
 ```ruby
-class CreateItems < ActiveRecord::Migration
+class CreateItems < ActiveRecord::Migration[5.1]
   def change
     create_table :items do |t|
       t.string :title
@@ -36,22 +40,31 @@ class CreateItems < ActiveRecord::Migration
   end
 end
 ```
-and Item model is
+and `Item` model as
 ```ruby
-class Item < ActiveRecord::Base
+class Item < ApplicationRecord
   include RailsSortable::Model
-  set_sortable :sort  # indicate sort column
-  # If you don't want timestamps to be updated with sorting, use following option. 
-  # set_sortable :sort, silence_recording_timestamps: true
+  set_sortable :sort  # Indicate a sort column
+  # If you do NOT want timestamps to be updated on sorting, use the following option.
+  # set_sortable :sort, without_updating_timestamps: true
+end
+```
+and `ItemsController` as
+```ruby
+class ItemsController < ApplicationController
+  def index
+    @items = Item.order(:sort).all
+  end
 end
 ```
 
-and its listing view (typically - index.html.erb) is
+and the listing view (typically - index.html.erb) as
 ```erb
 ...
-<tbody class="sortable">  <!-- sortable target -->
-    <% sortable_fetch(@items) do |item, id_tag| %>  <!-- RailsSortable helper -->
-      <tr id="<%= id_tag %>">  <!-- you must write it -->
+<table>
+  <tbody class="sortable">  <!-- sortable target -->
+    <% @items.each_with_sortable_id do |item, sortable_id| %>
+      <tr id="<%= sortable_id %>">  <!-- Needs id tag on sorting elements -->
         <td><%= item.title %></td>
         <td><%= item.sort %></td>
         <td><%= link_to 'Show', item %></td>
@@ -64,14 +77,38 @@ and its listing view (typically - index.html.erb) is
 ...
 ```
 
-finally, you apply sortable with Javascript.
+finally, apply sortable with Javascript.
+
+```javascript
+$(function() {
+  $('.sortable').railsSortable();
+});
+```
+
+# Javascript options
+jQuery plugin `railsSortable` is just a wrapper of `jquery.ui.sortable`. therefore it accepts all of `sortbale` options.
+
+see the [http://api.jqueryui.com/sortable/](http://api.jqueryui.com/sortable/) to get the details.
+
+# Contribution
+
+Fork it, then install required gems like below.
+```bash
+$ bundle install --path=vender/bundle
+$ appraisal install
+```
+
+Please give me a PR freely.
+
+### Testing
+```bash
+# Run server with rails 5.1 (rails42 & rails50 are also available)
+$ appraisal rails51 spec/dummy/bin/rails s
 
-```coffeescript
-jQuery ->
-  $(".sortable").railsSortable()
+# Run rspec for all rails versions
+$ appraisal rspec
 ```
 
-## Javascript options
-jquery plugin `railsSortable` is just a wrapper `jquery.ui.sortable`. therefore it accepts all of `sortbale` options.
+# Licence
 
-see the [http://api.jqueryui.com/sortable/](http://api.jqueryui.com/sortable/) to get detail.
+MIT Licence.

data/app/helpers/sortable_helper.rb

@@ -1,9 +1,7 @@
 module SortableHelper
-
   def sortable_fetch(models, &block)
-    raise "You must call with block!" unless block_given?
-    models.each do |object|
-      yield object, "#{object.class}_#{object.id}"
-    end
+    warn "[DEPRECATION] `sortable_fetch` is deprecated. Please use Enumerable#each_with_sortable_id instead."
+    raise "Must be called with block!" unless block_given?
+    models.each_with_sortable_id(&block)
   end
-end
+end

data/app/models/rails_sortable/model.rb

@@ -6,7 +6,7 @@ module RailsSortable
   # ex)
   # class SampleModel < ActiveRecord::Base
   #   include RailsSortable::Model
-  #   set_sortable :sort, silence_recording_timestamps: true
+  #   set_sortable :sort, without_updating_timestamps: true
   # end
   #
   module Model
@@ -20,7 +20,10 @@ module RailsSortable
     def update_sort!(new_value)
       write_attribute sort_attribute, new_value
       if self.class.sortable_options[:silence_recording_timestamps]
-        silence_recording_timestamps { save! }
+        warn "[DEPRECATION] `silence_recording_timestamps` is deprecated. Please use `without_updating_timestamps` instead."
+        without_updating_timestamps { save! }
+      elsif self.class.sortable_options[:without_updating_timestamps]
+        without_updating_timestamps { save! }
       else
         save!
       end
@@ -33,7 +36,7 @@ module RailsSortable
       write_attribute sort_attribute, max_sort
     end
 
-    def silence_recording_timestamps
+    def without_updating_timestamps
       raise ArgumentError unless block_given?
       original_record_timestamps = self.class.record_timestamps
       self.class.record_timestamps = false
@@ -52,8 +55,8 @@ module RailsSortable
     module ClassMethods
       #
       # allowed options
-      # - silence_recording_timestamps
-      #     When it is true, timestamp(updated_at) will be NOT modified with reordering.
+      # - without_updating_timestamps
+      #     When it is true, timestamp(updated_at) will be NOT touched on reordering.
       #
       def set_sortable(attribute, options = {})
         self.define_singleton_method(:sort_attribute) { attribute }

data/lib/rails_sortable/core_ext/enumerable.rb

@@ -0,0 +1,6 @@
+module Enumerable
+  def each_with_sortable_id(&block)
+    raise "Must be called with block!" unless block_given?
+    each { |e| yield e, "#{e.class}_#{e.id}" }
+  end
+end

data/lib/rails_sortable/core_ext.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.expand_path('core_ext/*.rb', File.dirname(__FILE__))).each do |path|
+  require path
+end

data/lib/rails_sortable/version.rb

@@ -1,3 +1,3 @@
 module RailsSortable
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/lib/rails_sortable.rb

@@ -1,4 +1,5 @@
 require "rails_sortable/engine"
+require "rails_sortable/core_ext"
 
 module RailsSortable
 end

data/spec/dummy/app/models/sequenced_item.rb

@@ -1,6 +1,6 @@
 class SequencedItem < ActiveRecord::Base
   include RailsSortable::Model
-  set_sortable :sequence, silence_recording_timestamps: true
+  set_sortable :sequence, without_updating_timestamps: true
 
   default_scope -> { order(:sequence) }
 end

data/spec/dummy/app/views/items/index.html.erb

@@ -13,8 +13,8 @@
   </thead>
 
   <tbody class="sortable">
-    <% sortable_fetch(@items) do |item, id_tag| %>
-      <tr id="<%= id_tag %>">
+    <% @items.each_with_sortable_id do |item, sortable_id| %>
+      <tr id="<%= sortable_id %>">
         <td><%= item.title %></td>
         <td><%= item.sort %></td>
         <td><%= item.updated_at %></td>

data/spec/dummy/app/views/sequenced_items/index.html.erb

@@ -13,8 +13,8 @@
   </thead>
 
   <tbody class="sortable">
-    <% sortable_fetch(@sequenced_items) do |sequenced_item, id_tag| %>
-      <tr id="<%= id_tag %>">
+    <% @sequenced_items.each_with_sortable_id do |sequenced_item, sortable_id| %>
+      <tr id="<%= sortable_id %>">
         <td><%= sequenced_item.title %></td>
         <td><%= sequenced_item.sequence %></td>
         <td><%= sequenced_item.updated_at %></td>

data/spec/dummy/config/application.rb

@@ -24,5 +24,7 @@ module Dummy
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
   end
+
+  MigrationClass = Gem::Version.new(Rails.version) < Gem::Version.new(5) ? ActiveRecord::Migration : ActiveRecord::Migration[4.2]
 end
 

data/spec/dummy/db/migrate/20131223124841_create_items.rb

@@ -1,4 +1,4 @@
-class CreateItems < ActiveRecord::Migration
+class CreateItems < Dummy::MigrationClass
   def change
     create_table :items do |t|
       t.string :title

data/spec/dummy/db/migrate/20170414031946_create_sequenced_items.rb

@@ -1,4 +1,4 @@
-class CreateSequencedItems < ActiveRecord::Migration
+class CreateSequencedItems < Dummy::MigrationClass
   def change
     create_table :sequenced_items do |t|
       t.string :title

data/spec/dummy/db/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.