acts_as_manual_list 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b9339c36ec588ac8f2747aa4051d15433e4f7d2511f63bdf8ddb1a35b260bb1
+  data.tar.gz: 8415269162afd50c21afb3af3c0ffe512796e655467169cc529395b7fe99fa8c
+SHA512:
+  metadata.gz: 71692f8f11058110b17360d44fe64f323c0b0f073a234e038986d2646ff204390036bc95e094acd2b766e7e4f53d0d5d0538b005e36f1ac96eeda6a77ce5ff77
+  data.tar.gz: 275748d836531bb96f1a51f69ecb6258f3f5060cc44f3c8578e6cc9c664dc21a9690228dace01d92fd36339770739ea8ecae6424ecda0b77eb22c33e11e50653

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 DMM.com
+
+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,30 @@
+[![Build Status](https://travis-ci.org/iknow/acts_as_manual_list.svg?branch=master)](https://travis-ci.org/iknow/acts_as_manual_list)
+
+# ActsAsManualList
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_manual_list'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install acts_as_manual_list
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsManualList'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/acts_as_manual_list.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'lazily'
+require 'iknow_list_utils'
+
+module ActsAsManualList
+  using IknowListUtils
+
+  POSITION_GETTER = ->(el)    { el.send(:position) }
+  POSITION_SETTER = ->(el, v) { el.send(:position=, v) }
+
+  # Takes an list of elements in a desired order. Elements have an inherent
+  # float position, obtainable via `position_getter`, which may be nil if the
+  # element previously was not a list member. For each element whose position
+  # is not in order (i.e. between the positions of its neighbours), calls
+  # `position_setter` to update the position to a new float value.
+  # Returns the count of elements whose positions were changed.
+  def self.update_positions(elements,
+                            position_getter: POSITION_GETTER,
+                            position_setter: POSITION_SETTER)
+
+    # calculate index for each previously existing position
+    position_indices = elements
+                       .lazy
+                       .with_index
+                       .map    { |el, i| [position_getter.(el), i] }
+                       .reject { |p, _i| p.nil? }
+                       .to_a
+
+    # TODO: we haven't dealt with collisions
+
+    # Calculate stable points in the element array which don't need to have
+    # positions updated:
+    # * before the beginning of the ordered subsequence
+    # * a subsequence of elements which are already in order
+    # * after the end of the ordered subsequence.
+    stable_position_indices = Lazily.concat([[nil, -1]],
+                                            position_indices.longest_rising_sequence_by(&:first),
+                                            [[nil, elements.size]])
+
+    # For each possible range of indices that are not stable (i.e. for every
+    # adjacent pair of stable indices), assign new positions distributed
+    # between the stable positions.
+    changed_positions = 0
+    stable_position_indices.each_cons(2) do |(start_pos, start_index), (end_pos, end_index)|
+      range = (start_index + 1)..(end_index - 1)
+      next if range.size.zero?
+
+      changed_positions += range.size
+      new_positions = select_positions(start_pos, end_pos, range.size)
+
+      new_positions.each.with_index(1) do |new_pos, offset|
+        position_setter.(elements[start_index + offset], new_pos)
+      end
+    end
+
+    changed_positions
+  end
+
+  # Select `count` positions in order between the provided `start_pos` and `end_pos`
+  def self.select_positions(start_pos, end_pos, count)
+    case
+    when start_pos.nil? && end_pos.nil?
+      # all elements are unpositioned, assign sequentially
+      1.upto(count).map(&:to_f)
+    when start_pos.nil?
+      # before first fixed element
+      count.downto(1).map { |i| end_pos - i }
+    when end_pos.nil?
+      # after last fixed element
+      1.upto(count).map { |i| start_pos + i }
+    else
+      delta = (end_pos - start_pos) / (count + 1)
+      1.upto(count).map { |i| start_pos + (delta * i) }
+    end
+  end
+end
+
+# Install into ActiveRecord
+require 'acts_as_manual_list/base'
+require 'acts_as_manual_list/list_member'
+
+if defined?(Rails::Railtie)
+  class Railtie < Rails::Railtie
+    initializer 'acts_as_manual_list.insert_into_active_record' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send(:include, ActsAsManualList::Base)
+      end
+    end
+  end
+elsif defined?(ActiveRecord)
+  ActiveRecord::Base.send(:include, ActsAsManualList::Base)
+end

data/lib/acts_as_manual_list/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_record'
+
+module ActsAsManualList::Base
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def acts_as_manual_list(scope:, attribute: :position)
+      include ActsAsManualList::ListMember
+      self.acts_as_list_scope = scope
+      self.acts_as_list_attribute = attribute
+    end
+  end
+end

data/lib/acts_as_manual_list/list_member.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_record'
+
+module ActsAsManualList::ListMember
+  extend ActiveSupport::Concern
+
+  included do
+    class << self
+      attr_accessor :acts_as_list_scope, :acts_as_list_attribute
+    end
+  end
+
+  module ClassMethods
+    # TODO: inject something like this into the scope class
+    # def reorder_#{association}(children)
+    #   ChildType.set_positions(self, children)
+    # end
+
+    def set_positions(_parent, children)
+      # TODO: validate that the children are all children of the parent.
+
+      # Optimization: if a child record is already `changed?`, then it's going
+      # to be written no matter what. If we don't consider changed records for
+      # selecting stable positions (i.e. ignore their previous `position` field)
+      # we can maximize the chance of avoiding updates to otherwise untouched
+      # rows.
+      get_pos = ->(el) do
+        if el.changed?
+          nil
+        else
+          el.public_send(acts_as_list_attribute)
+        end
+      end
+
+      set_pos = ->(el, p) { el.public_send(:"#{acts_as_list_attribute}=", p) }
+
+      ActsAsManualList.update_positions(children, position_getter: get_pos, position_setter: set_pos)
+    end
+  end
+
+  # TODO... list motion, append/prepend/etc
+  # append from list
+  # insert at position
+  # remove from list # will need to move from list to list
+end

data/lib/acts_as_manual_list/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActsAsManualList
+  VERSION = '0.1.2'
+end

data/lib/iknow_list_utils.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module IknowListUtils
+  refine Array do
+    def bsearch_max(min = nil, max = nil)
+      if (idx = self.bsearch_max_index(min, max) { |x| yield(x) })
+        self[idx]
+      end
+    end
+
+    def bsearch_max_index(min = nil, max = nil)
+      # lo and hi are valid array indexes
+      lo = min || 0
+      hi = max || self.count - 1
+
+      # Empty range does not contain any values satisfying predicate
+      return nil if hi < lo
+
+      # Lowest value has to pass predicate
+      return nil unless yield(self[lo])
+
+      # body invariant established: lo is always satisfied
+
+      while lo < hi
+        # when hi = lo + 1, mid = hi; which
+        #  - either passes and sets lo' = lo + 1 (= hi) (singleton)
+        #  - fails and sets hi' = lo (singleton)
+        # otherwise mid is between both, and the range will be limited appropriately
+        mid = lo + (hi - lo + 1) / 2
+        if yield(self[mid])
+          # midpoint satisfies predicate, reduce bounds, keep satisfying value
+          lo = mid
+        else
+          # midpoint doesn't satisfy predicate, restrict below non-satsifying value
+          hi = mid - 1
+        end
+      end
+
+      lo
+    end
+
+    # TODO: make this operate on Enumerables instead of directly accessible
+    # collections.
+    def longest_rising_sequence(&compare)
+      # https://en.wikipedia.org/wiki/Longest_increasing_subsequence
+
+      compare ||= ->(x, y) { x <=> y }
+
+      preds = Array.new(self.length)
+      ends = Array.new(self.length + 1)
+
+      max_length = 0
+
+      (0..self.length - 1).each do |i|
+        # bsearch ends for a subsequence to append to, if not found, start
+        # new sequence of length 1
+        existing_sequence_length =
+          ends.bsearch_max_index(1, max_length) do |e|
+            compare.(self[e], self[i]) < 0
+          end
+
+        new_length = (existing_sequence_length || 0) + 1
+        max_length = new_length if max_length < new_length
+        preds[i] = ends[new_length - 1]
+        ends[new_length] = i
+      end
+
+      result = []
+      k = ends[max_length]
+      max_length.downto(1) do |x|
+        result[x - 1] = self[k]
+        k = preds[k]
+      end
+
+      result
+    end
+
+    def longest_rising_sequence_by
+      self.longest_rising_sequence { |x, y| yield(x) <=> yield(y) }
+    end
+  end
+end

data/lib/tasks/acts_as_manual_list_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :acts_as_manual_list do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_manual_list
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- iKnow Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: lazily
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !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: byebug
+  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: minitest
+  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: rake
+  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'
+description: ''
+email:
+- dev@iknow.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/acts_as_manual_list.rb
+- lib/acts_as_manual_list/base.rb
+- lib/acts_as_manual_list/list_member.rb
+- lib/acts_as_manual_list/version.rb
+- lib/iknow_list_utils.rb
+- lib/tasks/acts_as_manual_list_tasks.rake
+homepage: ''
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Barebones acts_as_list
+test_files: []