active_record_florder 0.0.1 → 0.1.0

checksums.yaml

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

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Chahnegelog
+
+### v0.1.0
+* FEAUTURE: Add `populate` option

data/README.md

@@ -3,52 +3,65 @@
 [![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)
+[![Inline docs](http://inch-ci.org/github/turboMaCk/active-record-florder.svg?branch=master)](http://inch-ci.org/github/turboMaCk/active-record-florder)
+[![Gem Version](https://badge.fury.io/rb/active_record_florder.svg)](https://badge.fury.io/rb/active_record_florder)
 
-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.
+Floating point ActiveRecord Models ordering for rich client apps heavily inspirated by Trello's ordering alorithm.
+ActiveRecordFlorder let client decide model's position in collection, normalize given value and resolve conflicts
+to keep your data clean. It's highly optimalized and generate as small SQL queries.
 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.
+In edge cases sanitization of all records happens and bring records back to the "Garden of Eden" state.
 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'
+gem 'active_record_florder', '~> 0.0.1'
 ```
 
-Ruby gem comming soon!
+or simply install via Ruby Gems
+
+```shell
+gem install active_record_florder
+```
 
 ## Api
 
-This gem defines new method for ActiveRecord::Base named `florder`.
+This gem defines new method for `ActiveRecord::Base` named `florder`.
 
 ### Parameters
 
-* direction {Symbol} values: `:asc` `:desc`, **required**
-* options {Hash}, optional
+* `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 *
+* `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 *
+* `return_all_affected {Boolean}` - If true `move` method will return array of all affected records instead of just `self`
 
 * *Setting this should affect performance. We recommend using default values*
 
+### Example
+
+```ruby
+class Post < ActiveRecord::Base
+  florder :desc, scope: :user, attribute: :order_position, min_delta: 0.001, step: 2**8, return_all_affected: true
+end
+```
+
 ## Usage
 
-If you're using Rails or ActiveRecordMigrations create migration for your models:
+If you're using Rails or `ActiveRecordMigrations` create new migration:
 
 ```ruby
 class AddPositionToPosts < ActiveRecord::Migration
   def change
-    add_column :posts, :position, default: 0
+    add_column :posts, :position, :float, default: 0
   end
 end
 ```
@@ -59,7 +72,7 @@ With rails you can use generator for this:
 rails g migration add_position_to_posts position:float
 ```
 
-Now migrate your databse:
+Now migrate your database:
 
 ```shell
 rake db:migrate
@@ -113,7 +126,7 @@ Client itself request position for given Model. This Gem is build with drag and
 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:
+Here is hypotetical implementation in JavaScript:
 
 ```js
 /*
@@ -139,13 +152,16 @@ 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
+  config.scope = :owner
+  config.attribute = :position_2
+  config.step = 3
+  config.min_delta = 0.1
 end
 ```
 
+## Upgrading
+Please see summary of changes for each version in [changelog](CHANGELOG.md)
+
 ## Developing
 
 Git clone repository and cd in it:

data/active_record_florder.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   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.summary       = "Floating point ActiveRecord Models 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 model's position in collection, normalize given value and resolve conflicts to keep your data clean. It's highly optimalized and generate as small SQL queries. 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 state. 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)/}) }

data/lib/active_record_florder.rb

@@ -12,48 +12,31 @@ require 'active_record_florder/version'
 module ActiveRecordFlorder
   class << self
 
-    # Configure method can be used from initializer
-    # ActiveRecordFlorder.confige do |config|
-    #   config.{attribute} {value}
-    # end
-    def configure
-      yield self if block_given?
-    end
-
-    # DB column name
-    def attribute(value)
-      @attribute = value
-    end
+    attr_writer(:attribute, :min_delta, :step, :return_all_affected)
+    attr_accessor(:scope)
 
-    def get_attribute
+    def attribute
       @attribute || :position
     end
 
-    # Position scope
-    def scope(value)
-      @scope = value
-    end
-
-    def get_scope
-      @scope || nil
-    end
-
-    # Minimal allowed delata between positions
-    def min_delta(value)
-      @min_delta = value
+    def min_delta
+      @min_delta || 0.0005
     end
 
-    def get_min_delta
-      @min_delta || 0.0005
+    def step
+      @step || 2**16
     end
 
-    # Optimal and initial delta between positions
-    def step(value)
-      @step = value
+    def return_all_affected
+      @return_all_affected || false
     end
 
-    def get_step
-      @step || 2**16
+    # Configure method can be used from initializer
+    # ActiveRecordFlorder.confige do |config|
+    #   config.{attribute} {value}
+    # end
+    def configure
+      yield self if block_given?
     end
   end
 end

data/lib/active_record_florder/base.rb

@@ -44,13 +44,13 @@ module ActiveRecordFlorder
     # @returns self {ModelInstance}
     # @api public
     def move(position)
-      position.to_f
+      position = position.to_f
 
       fail ActiveRecordFlorder::Error, 'Position param is required' unless position
       fail ActiveRecordFlorder::Error, 'Position should be > 0' unless (normalized_position = normalize_position(position)) > 0
       normalized_position = normalize_position(position)
 
-      ensure_position_solving(position, normalized_position)
+      affected = ensure_position_solving(position, normalized_position)
 
       if new_record?
         self[position_attr_name.to_sym] = normalized_position
@@ -58,6 +58,13 @@ module ActiveRecordFlorder
         update_attribute(position_attr_name.to_sym, normalized_position)
       end
 
+      # populating all affected records
+      # only if return_all_affected_by_move option is true
+      if return_all_affected_by_move
+        affected ||= []
+        return affected << self
+      end
+
       self
     end
 

data/lib/active_record_florder/configurable.rb

@@ -11,19 +11,23 @@ module ActiveRecordFlorder
       end
 
       def position_attr_name
-        @florder_config[:attribute] || ActiveRecordFlorder.get_attribute
+        @florder_config[:attribute] || ActiveRecordFlorder.attribute
       end
 
       def position_scope_attr
-        @florder_config[:scope] || ActiveRecordFlorder.get_scope
+        @florder_config[:scope] || ActiveRecordFlorder.scope
       end
 
       def min_position_delta
-        @florder_config[:min_delta] || ActiveRecordFlorder.get_min_delta
+        @florder_config[:min_delta] || ActiveRecordFlorder.min_delta
       end
 
       def next_position_step
-        @florder_config[:step] || ActiveRecordFlorder.get_step
+        @florder_config[:step] || ActiveRecordFlorder.step
+      end
+
+      def return_all_affected_by_move
+        @florder_config[:return_all_affected] || ActiveRecordFlorder.return_all_affected
       end
     end
 
@@ -48,5 +52,9 @@ module ActiveRecordFlorder
     def next_position_step
       self.class.next_position_step
     end
+
+    def return_all_affected_by_move
+      self.class.return_all_affected_by_move
+    end
   end
 end

data/lib/active_record_florder/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordFlorder
-  VERSION = "0.0.1".freeze
+  VERSION = "0.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_florder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Marek Fajkus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,14 +52,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Floating point ActiveRecord models ordering for rich client apps heavily
+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.
+  model's position in collection, normalize given value and resolve conflicts to keep
+  your data clean. It's highly optimalized and generate as small SQL queries. 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 state. It's implemented with both Rails
+  and non-Rails apps in mind and highly configurable.
 email:
 - marek.faj@gmail.com
 executables: []
@@ -71,6 +71,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -121,5 +122,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Floating point ActiveRecord ordering for rich client apps
+summary: Floating point ActiveRecord Models ordering for rich client apps
 test_files: []