activesorting 0.5.0

data/gemfiles/50.gemfile.lock

@@ -0,0 +1,163 @@
+PATH
+  remote: ../
+  specs:
+    activesorting (0.5.0)
+      activerecord (>= 4.0.0)
+      railties (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.0.beta3)
+      actionpack (= 5.0.0.beta3)
+      nio4r (~> 1.2)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.0.beta3)
+      actionpack (= 5.0.0.beta3)
+      actionview (= 5.0.0.beta3)
+      activejob (= 5.0.0.beta3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (5.0.0.beta3)
+      actionview (= 5.0.0.beta3)
+      activesupport (= 5.0.0.beta3)
+      rack (~> 2.x)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.0.beta3)
+      activesupport (= 5.0.0.beta3)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (5.0.0.beta3)
+      activesupport (= 5.0.0.beta3)
+      globalid (>= 0.3.6)
+    activemodel (5.0.0.beta3)
+      activesupport (= 5.0.0.beta3)
+    activerecord (5.0.0.beta3)
+      activemodel (= 5.0.0.beta3)
+      activesupport (= 5.0.0.beta3)
+      arel (~> 7.0)
+    activesupport (5.0.0.beta3)
+      concurrent-ruby (~> 1.0)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (7.0.0)
+    builder (3.2.2)
+    concurrent-ruby (1.0.1)
+    coveralls (0.8.13)
+      json (~> 1.8)
+      simplecov (~> 0.11.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (~> 1.6.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nio4r (1.2.1)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    rack (2.0.0.alpha)
+      json
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.0.beta3)
+      actioncable (= 5.0.0.beta3)
+      actionmailer (= 5.0.0.beta3)
+      actionpack (= 5.0.0.beta3)
+      actionview (= 5.0.0.beta3)
+      activejob (= 5.0.0.beta3)
+      activemodel (= 5.0.0.beta3)
+      activerecord (= 5.0.0.beta3)
+      activesupport (= 5.0.0.beta3)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.0.beta3)
+      sprockets-rails (>= 2.0.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.0.beta3)
+      actionpack (= 5.0.0.beta3)
+      activesupport (= 5.0.0.beta3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sprockets (3.5.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.0.4)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tins (1.6.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler (~> 1.11)
+  coveralls
+  rails (= 5.0.0.beta3)
+  rake (~> 10.0)
+  rspec
+  sqlite3
+  activesorting!
+
+BUNDLED WITH
+   1.11.2

data/lib/active_sorting/engine.rb

@@ -0,0 +1,7 @@
+module ActiveSorting
+  class Engine < Rails::Engine # :nodoc:
+    ActiveSupport.on_load(:active_record) do
+      ActiveRecord::Base.send(:include, ActiveSorting::Model)
+    end
+  end
+end

data/lib/active_sorting/model.rb

@@ -0,0 +1,159 @@
+module ActiveSorting
+  module Model # :nodoc:
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    # Patches ActiveRecord models
+    module ClassMethods
+      # Track all sortable arguments
+      attr_accessor :active_sorting_options
+
+      # Sets the sortable options
+      #
+      # +name+ sortable field name
+      # Accepts a Hash of options:
+      # +order+ sorting direction, defaults to :asc
+      # +step+ stepping value, defaults to 500
+      # +scope+ scope field name, defaults to []
+      def sortable(name, opts = {})
+        self.active_sorting_options = active_sorting_default_options.merge(opts)
+        active_sorting_options[:name] = name
+        active_sorting_check_options
+        validates active_sorting_options[:name], presence: true
+        before_validation :active_sorting_callback_before_validation
+      end
+
+      # Default sorting options
+      def active_sorting_default_options
+        {
+          order: :asc,
+          step: 500,
+          scope: []
+        }
+      end
+
+      # Check provided options
+      def active_sorting_check_options
+        unless columns_hash[active_sorting_field.to_s].type == :integer
+          raise ArgumentError, 'Sortable field should be of type Integer'
+        end
+        unless active_sorting_step.is_a?(Fixnum)
+          raise ArgumentError, 'Sortable step should be of type Fixnum'
+        end
+      end
+
+      # Calculate the least possible changes required to
+      # reorder items in +old_list+ to match +new_list+ order
+      # by comparing two proposals from
+      # +active_sorting_calculate_changes+
+      def active_sorting_changes_required(old_list, new_list)
+        changes = []
+        if old_list.count != new_list.count
+          raise ArgumentError, "Size mismatch between new (#{new_list.count}) and old (#{old_list.count}) array of items"
+        end
+        proposal1 = active_sorting_calculate_changes(old_list.dup, new_list.dup)
+        if proposal1.count >= (new_list.count / 4)
+          proposal2 = active_sorting_calculate_changes(old_list.reverse, new_list.reverse)
+          changes = proposal1.count < proposal2.count ? proposal1 : proposal2
+        else
+          changes = proposal1
+        end
+        changes
+      end
+
+      # Calculate the possible changes required to
+      # reorder items in +old_list+ to match +new_list+ order
+      def active_sorting_calculate_changes(old_list, new_list, changes = [])
+        new_list.each_with_index do |id, index|
+          next unless old_list[index] != id
+          # This item has changed
+          changes << id
+          # Remove it from both lists, rinse and repeat
+          new_list.delete(id)
+          old_list.delete(id)
+          # Recur...
+          active_sorting_calculate_changes(old_list, new_list, changes)
+          break
+        end
+        changes
+      end
+
+      # Commit changes to database
+      def active_sorting_make_changes(new_list, changes)
+        new_list.each_with_index do |id, index|
+          next unless changes.include?(id)
+          if index == new_list.count.pred
+            # We're moving an item to last position,
+            # increase the count of last item's position
+            # by the step
+            n1 = find(index.pred).active_sorting_value
+            n2 = n1 + active_sorting_step
+          elsif index == 0
+            # We're moving an item to first position
+            # Calculate the gap between following 2 items
+            n1 = find(index.next).active_sorting_value
+            n2 = find(index.next.next).active_sorting_value
+          else
+            # We're moving a non-terminal item
+            n1 = find(index.pred).active_sorting_value
+            n2 = find(index.next).active_sorting_value
+          end
+          find(id).active_sorting_center_item(n1, n2)
+        end
+      end
+
+      def active_sorting_field
+        active_sorting_options[:name]
+      end
+
+      def active_sorting_step
+        active_sorting_options[:step]
+      end
+
+      def active_sorting_order
+        active_sorting_options[:order]
+      end
+    end
+
+    def active_sorting_value
+      send(self.class.active_sorting_field)
+    end
+
+    def active_sorting_value=(new_value)
+      send("#{self.class.active_sorting_field}=", new_value)
+    end
+
+    # Centers an item between the given two positions
+    def active_sorting_center_item(n1, n2)
+      delta = (n1 - n2).abs
+      smaller = [n1, n2].min
+      if delta == 1
+        new_position = smaller + delta
+      elsif delta > 1
+        new_position = smaller + (delta / 2)
+      end
+      self.active_sorting_value = new_position
+      save!
+      self
+    end
+
+    # Generate the next stepping
+    def active_sorting_next_step
+      # Get the maximum value for the sortable field name
+      # TODO: scopes
+      max = self.class.unscoped.maximum(self.class.active_sorting_field)
+      # First value will always be 0
+      return 0 if max.nil?
+      # Increment by the step value configured
+      max + self.class.active_sorting_step
+    end
+
+    ## Callbacks
+    # Generates a new code based on given options
+    def active_sorting_callback_before_validation
+      field_name = self.class.active_sorting_field
+      send("#{field_name}=", active_sorting_next_step) if send(field_name).nil?
+    end
+  end
+end

data/lib/active_sorting/version.rb

@@ -0,0 +1,3 @@
+module ActiveSorting
+  VERSION = '0.5.0'.freeze
+end

data/lib/active_sorting.rb

@@ -0,0 +1,5 @@
+require 'rails/engine'
+require 'active_record'
+require 'active_sorting/version'
+require 'active_sorting/model'
+require 'active_sorting/engine'

data/lib/activesorting.rb

@@ -0,0 +1 @@
+require 'active_sorting'

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: activesorting
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Omar Abdel-Wahab
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: sqlite3
+  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: coveralls
+  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: appraisal
+  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: 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: railties
+  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
+description: 
+email:
+- owahab@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".coveralls.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activesorting.gemspec
+- bin/console
+- bin/setup
+- gemfiles/40.gemfile
+- gemfiles/40.gemfile.lock
+- gemfiles/41.gemfile
+- gemfiles/41.gemfile.lock
+- gemfiles/42.gemfile
+- gemfiles/42.gemfile.lock
+- gemfiles/50.gemfile
+- gemfiles/50.gemfile.lock
+- lib/active_sorting.rb
+- lib/active_sorting/engine.rb
+- lib/active_sorting/model.rb
+- lib/active_sorting/version.rb
+- lib/activesorting.rb
+homepage: http://github.com/owahab/active_sorting
+licenses:
+- MIT
+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: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Adds ability to sort models using a custom field
+test_files: []