active_record_florder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11ac613fa7e6033d57f64ea0683b2be779b6a867
+  data.tar.gz: 67b8618a3afef2a25282ba300fd618419a93d790
+SHA512:
+  metadata.gz: 8a3ad68f6039ea985554d101393ef0f84cf6fe122ae74c32190a130a4dbe407f260fe6ac3ad71ec88c96bda8e6d99dadc48e9e2a5ae1e05a23d2b1bb53533d65
+  data.tar.gz: 2d6e20bc6515dde13191cac087547d7f96abf7e6920bd50cd09d80e5297f55304c586d0e56aef9edcebc604c6cee125e04a1fd192b9b2ea5672758395f7dac28

data/.editorconfig

@@ -0,0 +1,9 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,5 @@
+/db/config.yml
+/.bundle/
+
+*.sqlite3
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+
+sudo: false
+
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2.3
+  - 2.3.0
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+
+install: bundle install --path=vendor/bundle --retry=3 --jobs=3
+
+before_script:
+  - cp db/config.travis.yml db/config.yml
+
+script:
+  - bundle exec rake db:migrate --trace
+  - bundle exec rake db:test:prepare
+  - bundle exec rake
+
+addons:
+  code_climate:
+    repo_token: 79db524674654c4815f1923c6d5384922226942410c2fa25c5e5cbf9f3f7b372

data/Gemfile

@@ -0,0 +1,13 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'activesupport', '~> 4.0'
+gem 'activerecord', '~> 4.0.0'
+
+group :test do
+  gem 'rake'
+  gem 'sqlite3'
+  gem 'active_record_tasks', '~> 1.1.0'
+  gem 'rspec'
+  gem 'codeclimate-test-reporter', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    active_record_tasks (1.1.0)
+      activerecord (>= 4.0)
+      rainbow
+      rake
+    activemodel (4.0.13)
+      activesupport (= 4.0.13)
+      builder (~> 3.1.0)
+    activerecord (4.0.13)
+      activemodel (= 4.0.13)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.13)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.4)
+    activesupport (4.0.13)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.2)
+    builder (3.1.4)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (4.7.5)
+    multi_json (1.11.2)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      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.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sqlite3 (1.3.11)
+    thread_safe (0.3.5)
+    tzinfo (0.3.46)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record_tasks (~> 1.1.0)
+  activerecord (~> 4.0.0)
+  activesupport (~> 4.0)
+  codeclimate-test-reporter
+  rake
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Marek Fajkus
+
+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,186 @@
+# ActiveRecordFlorder
+
+[![Build Status](https://travis-ci.org/turboMaCk/active-record-florder.svg)](https://travis-ci.org/turboMaCk/active-record-florder)
+[![Code Climate](https://codeclimate.com/github/turboMaCk/active-record-florder/badges/gpa.svg)](https://codeclimate.com/github/turboMaCk/active-record-florder)
+[![Test Coverage](https://codeclimate.com/github/turboMaCk/active-record-florder/badges/coverage.svg)](https://codeclimate.com/github/turboMaCk/active-record-florder/coverage)
+
+Floating point ActiveRecord models ordering for rich client apps heavily inspirated by Trello's ordering alorithm.
+ActiveRecordFlorder let client decide position of model in collection normalize given value and resolve conflicting positions in collection
+to keep your data clean. It's highly optimalized and generate as small SQL queries as possible.
+The whole philosophy is to load and update as little records as possible so in 99% it runs just one SELECT and one UPDATE.
+In edge cases sanitization of all records happens and bring records back to the Garden of Eden.
+It's implemented with both Rails and non-Rails apps in mind and highly configurable.
+
+THIS SOFTWARE IS STILL IN BETA!
+
+## Installation
+
+add to your Gemfile if you're using Bundler
+
+```ruby
+gem 'active_record_florder', git: 'https://github.com/turboMaCk/active-record-florder.git'
+```
+
+Ruby gem comming soon!
+
+## Api
+
+This gem defines new method for ActiveRecord::Base named `florder`.
+
+### Parameters
+
+* direction {Symbol} values: `:asc` `:desc`, **required**
+* options {Hash}, optional
+
+### Options
+
+* scope {Symbol} - ordering scope (should be relationship or any other model property)
+* attribute {Sumbol} - position column name, **default:** position
+* min_delta {Number} - Minimal allowed position delata, affect position normalization *
+* step: {Number} - Optimal (init) delta between positions *
+
+* *Setting this should affect performance. We recommend using default values*
+
+## Usage
+
+If you're using Rails or ActiveRecordMigrations create migration for your models:
+
+```ruby
+class AddPositionToPosts < ActiveRecord::Migration
+  def change
+    add_column :posts, :position, default: 0
+  end
+end
+```
+
+With rails you can use generator for this:
+
+```shell
+rails g migration add_position_to_posts position:float
+```
+
+Now migrate your databse:
+
+```shell
+rake db:migrate
+```
+
+To use ActiveRecordFlorder add this line to your model:
+
+```ruby
+class Post < ActiveRecord::Base
+  florder :desc
+end
+```
+
+Now you can start using it:
+
+```ruby
+# Get ordered Posts
+Post.ordered
+
+# change position of first post
+Post.first.move(123.123)
+```
+
+### Migrating Existing Data
+
+ActiveRecordFlorder adds new before save model hook create position for new records. To make this work correctly you will need to initialize
+positions for your existing data. ActiveRecordFlorder provides simple class method for this. You can define rake task or call it right inside your migration.
+
+```ruby
+Posts.reinit_positions
+```
+
+This method also should be used for optimalizing or repairing positions. It will not affect order of records just generate optimal positions for current order.
+
+### ASCending vs DESCending ordering
+
+The only required parameter for each model is `:asc` or `:desc` order param.
+Each of them is optimalised for one of the cases - creating new models as first or last.
+Basically created model has highest position value in collection. Because of this whole interval is increased with each new record.
+Negative values are not allowed so creating new models with lowest position will decrese number of possible positions and increase possibility in conflicts.
+This is why this is desibled by default.
+
+#### Simply use one of this:
+
+* **Use ASC ordering when you want to create new models as last**
+* **Use DESC ordering when you want to create new models as first**
+
+### Front-End Implementation
+
+Client itself request position for given Model. This Gem is build with drag and drop interfaces in first place in mind.
+Calculation on is simple - you just need to now position of two sibling to place model in middle of them.
+For first and last position simply use hiher/lower value than first / last.
+
+Here is teoretical implementation in javascript:
+
+```js
+/*
+ * Calculate new requested position for model
+ * @param abovePosition {number}
+ * @param belowPosition {number}
+ * @returns {number}
+ */
+function calculateNewPosition(abovePosition, belowPosition) {
+  if (!abovePosition) {
+    return bellowPosition ? bellowPosition * 2 : false;
+  } else if (!bellowPosition) {
+    return abovePosition / 2;
+  }
+
+  return (bellowPosition + abovePosition) / 2;
+}
+```
+
+## Configuration
+
+You can use initializer to overwrite default settings like this:
+
+```Ruby
+ActiveRecordFlorder.configure do |config|
+  config.scope :owner
+  config.attribute :position_2
+  config.step 3
+  config.min_delta 0.1
+end
+```
+
+## Developing
+
+Git clone repository and cd in it:
+
+```shell
+git clone git@github.com:turboMaCk/active-record-florder.git
+cd active-record-florder
+```
+
+Copy configuration:
+
+```shell
+cp db/config.example.yml db/config.yml
+```
+
+Install dependencies:
+
+```shell
+bundle install
+```
+
+Run tests:
+
+```shell
+bundle exec rspec
+```
+
+or
+
+```shell
+bundle exec rake spec
+```
+
+That's it! We can't wait for your PR!
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,23 @@
+require "active_record_tasks"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+ActiveRecordTasks.configure do |config|
+  # These are all the default values
+  config.db_dir = 'db'
+  config.db_config_path = 'db/config.yml'
+  config.env = 'test'
+end
+
+begin
+  # Run this AFTER you've configured
+  ActiveRecordTasks.load_tasks
+
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/active_record_florder.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_florder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_record_florder"
+  spec.version       = ActiveRecordFlorder::VERSION
+  spec.authors       = ["Marek Fajkus"]
+  spec.email         = ["marek.faj@gmail.com"]
+
+  spec.summary       = "Floating point ActiveRecord ordering for rich client apps"
+  spec.description   = "Floating point ActiveRecord models ordering for rich client apps heavily inspirated by Trello's ordering alorithm. ActiveRecordFlorder let client decide position of model in collection normalize given value and resolve conflicting positions in collection to keep your data clean. It's highly optimalized and generate as small SQL queries as possible. The whole philosophy is to load and update as little records as possible so in 99% it runs just one SELECT and one UPDATE. In edge cases sanitization of all records happens and bring records back to the Garden of Eden. It's implemented with both Rails and non-Rails apps in mind and highly configurable."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bundler", "bundler")

data/bin/cc-tddium-post-worker

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'cc-tddium-post-worker' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("codeclimate-test-reporter", "cc-tddium-post-worker")

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "covered_percent": 95.86
+  }
+}