sortability 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 579a5bb1070dd756f977a6d671a463f18b5481f4
+  data.tar.gz: 3dd04eb291ac4bd254ba440e120dee92583fc95d
+SHA512:
+  metadata.gz: 08203d0b5ba84d75481b2112d514389c8bec1dec4112b2031065769fd53216bd432c835971b960dc34b961fbcc97daef29fc4eb9dd562966dfd1f406504fe66a
+  data.tar.gz: dde8dab18591264e6f229b0f3c5c3a03a92c2e4289ebf4bce1a293a927ac62bdadca7270f4c69b2e3ab2e47f0305c415f1d70bb7944500897ce042ea836705e5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Rice University
+
+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,2 @@
+sortability
+===========

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task default: :spec

data/lib/sortability.rb

@@ -0,0 +1,6 @@
+require 'sortability/active_record/base'
+require 'sortability/active_record/connection_adapters/table_definition'
+require 'sortability/active_record/migration'
+
+module Sortability
+end

data/lib/sortability/active_record/base.rb

@@ -0,0 +1,170 @@
+module Sortability
+  module ActiveRecord
+    module Base
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # Defines methods that are used to sort records
+        # Use via sortable_belongs_to or sortable_class
+        def sortable_methods(options = {})
+          on = options[:on] || :sort_position
+          container = options[:container]
+          inverse_of = options[:inverse_of]
+          scope_array = [options[:scope]].flatten.compact
+          onname = on.to_s
+          setter_mname = "#{onname}="
+          peers_mname = "#{onname}_peers"
+          before_validation_mname = "#{onname}_before_validation"
+          next_by_mname = "next_by_#{onname}"
+          prev_by_mname = "prev_by_#{onname}"
+          compact_peers_mname = "compact_#{onname}_peers"
+
+          class_exec do
+            before_validation before_validation_mname
+
+            # Returns all the sort peers for this record, including self
+            define_method peers_mname do |force_scope_load = false|
+              return send(container).send(inverse_of) \
+                unless force_scope_load || container.nil? || inverse_of.nil?
+
+              relation = self.class.unscoped
+              scope_array.each do |s|
+                relation = relation.where(s => send(s))
+              end
+              relation
+            end
+
+            # Assigns the "on" field's value if needed
+            # Adds 1 to any conflicting fields
+            define_method before_validation_mname do
+              val = send(on)
+              scope_changed = scope_array.any? { |s|
+                                !changed_attributes[s].nil? }
+
+              return unless val.nil? || scope_changed || changes[on]
+
+              peers = send(peers_mname, scope_changed)
+              if val.nil?
+                # Assign the next available number to the record
+                max_val = (peers.loaded? ? \
+                            peers.to_a.max_by{|r| r.send(on) || 0}.try(on) : \
+                            peers.maximum(on)) || 0
+                send(setter_mname, max_val + 1)
+              elsif peers.to_a.any? { |p| p != self && p.send(on) == val }
+                # Make a gap for the record
+                peers.where{__send__(on) >= val}.reorder(nil)
+                     .update_all("#{onname} = - (#{onname} + 1)")
+                peers.where{__send__(on) < 0}.reorder(nil)
+                     .update_all("#{onname} = - #{onname}")
+
+                # Cause peers to load from the DB the next time they are used
+                peers.reset
+              end
+            end
+
+            # Gets the next record among the peers
+            define_method next_by_mname do
+              val = send(on)
+              peers = send(peers_mname)
+              peers.loaded? ? \
+                peers.to_a.detect{|p| p.send(on) > val} : \
+                peers.where{__send__(on) > val}.first
+            end
+
+            # Gets the previous record among the peers
+            define_method prev_by_mname do
+              val = send(on)
+              peers = send(peers_mname)
+              peers.loaded? ? \
+                peers.to_a.reverse.detect{|p| p.send(on) < val} : \
+                peers.where{__send__(on) < val}.last
+            end
+
+            # Renumbers the peers so that their numbers are sequential,
+            # starting at 1
+            define_method compact_peers_mname do
+              mysql = \
+                defined?(ActiveRecord::ConnectionAdapters::MysqlAdapter) && \
+                ActiveRecord::Base.connection.instance_of?(
+                  ActiveRecord::ConnectionAdapters::MysqlAdapter)
+              cend = mysql ? 'END CASE' : 'END'
+
+              peers = send(peers_mname)
+              cases = peers.to_a.collect.with_index do |p, i|
+                # Make sure "on" field in self is up to date
+                send(setter_mname, i + 1) if p == self
+
+                "WHEN #{p.send(on)} THEN #{- (i + 1)}"
+              end.join(' ')
+
+              self.class.transaction do
+                peers.reorder(nil)
+                     .update_all("#{onname} = CASE #{onname} #{cases} #{cend}")
+                peers.reorder(nil).update_all("#{onname} = - #{onname}")
+              end
+
+              # Mark self as not dirty
+              changes_applied
+              # Force peers to load from the DB the next time they are used
+              peers.reset
+            end
+          end
+        end
+
+        # Defines a sortable has_many relation on the container
+        def sortable_has_many(records, options = {})
+          on = options[:on] || :sort_position
+
+          class_exec do
+            has_many records, lambda { order(on) }, options.except(:on)
+          end
+        end
+
+        # Defines a sortable belongs_to relation on the child records
+        def sortable_belongs_to(container, options = {})
+          on = options[:on] || :sort_position
+
+          class_exec do
+            belongs_to container, options.except(:on, :scope)
+
+            reflection = reflect_on_association(container)
+            options[:scope] ||= reflection.polymorphic? ? \
+                                  [reflection.foreign_type,
+                                   reflection.foreign_key] : \
+                                  reflection.foreign_key
+            options[:inverse_of] ||= reflection.inverse_of.try(:name)
+
+            validates on, presence: true,
+                          numericality: { only_integer: true,
+                                          greater_than: 0 },
+                          uniqueness: { scope: options[:scope] }
+          end
+
+          options[:container] = container
+          sortable_methods(options)
+        end
+
+        # Defines a sortable class without a container
+        def sortable_class(options = {})
+          on = options[:on] || :sort_position
+          scope = options[:scope]
+
+          class_exec do
+            default_scope { order(on) }
+
+            validates on, presence: true,
+                          numericality: { only_integer: true,
+                                          greater_than: 0 },
+                          uniqueness: (scope.nil? ? true : { scope: scope })
+          end
+
+          sortable_methods(options)
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Sortability::ActiveRecord::Base

data/lib/sortability/active_record/connection_adapters/table_definition.rb

@@ -0,0 +1,18 @@
+module Sortability
+  module ActiveRecord
+    module ConnectionAdapters
+      module TableDefinition
+        # Adds a non-null sortable column on table creation (no index)
+        def sortable(options = {})
+          options[:null] = false if options[:null].nil?
+          on = options.delete(:on) || :sort_position
+
+          integer on, options
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::TableDefinition.send(
+  :include, Sortability::ActiveRecord::ConnectionAdapters::TableDefinition)

data/lib/sortability/active_record/migration.rb

@@ -0,0 +1,25 @@
+module Sortability
+  module ActiveRecord
+    module Migration
+      # Adds a non-null sortable column to an existing table (no index)
+      def add_sortable_column(table, options = {})
+        options[:null] = false if options[:null].nil?
+        on = options.delete(:on) || :sort_position
+
+        add_column table, on, :integer, options
+      end
+
+      # Adds a unique index covering the sort scope cols in an existing table
+      def add_sortable_index(table, options = {})
+        options[:unique] = true if options[:unique].nil?
+        scope = options.delete(:scope)
+        on = options.delete(:on) || :sort_position
+        columns = ([scope] << on).flatten.compact
+
+        add_index table, columns, options
+      end
+    end
+  end
+end
+
+ActiveRecord::Migration.send :include, Sortability::ActiveRecord::Migration

data/lib/sortability/version.rb

@@ -0,0 +1,3 @@
+module Sortability
+  VERSION = "0.0.0"
+end

data/spec/dummy/README.md

@@ -0,0 +1,4 @@
+Dummy
+-----
+
+Dummy application used to test the sortability gem.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "sortability"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end