has_order 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e557f1236be3b4b07640fbb1d983e1505ca8ee31
+  data.tar.gz: 0b3cd15c4df5733973286f6b7d38754708f3d2f3
+SHA512:
+  metadata.gz: b83accc8697a18904838273af96ea7851d16f2b51dbd67b61d202295330d3eb07e427965b16307488a9f02612a3ba29ec59939b8b96083a2a3836d2a5eb85e03
+  data.tar.gz: 6bcb95921c60c534e4203d90c3d0b9d6bc1d2a3581d47883bceadcfc7a8fee37c85aa57d1105173a37bff527853b896e7f329dac17c9f610000194e7020c9208

data/.editorconfig

@@ -0,0 +1,14 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+
+end_of_line = lf
+charset = utf-8
+
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+/.bundle
+/Gemfile.lock
+/pkg
+/tmp
+/coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 0.1.2
+
+- Added README.md.
+- Updated codestyle.
+- Fixed rspec deprication warnings.
+- Updated development dependencies.
+
+## 0.1.1
+
+- Fixed scopes (always using lambdas).
+
+## 0.1.0
+
+- Added `#move_to`.
+- Added `#shift_interval` option.
+- Added `#set_default_position?`.
+- Added lambda scopes support.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,73 @@
+[![Gem Version](https://badge.fury.io/rb/has_order.svg)](http://badge.fury.io/rb/has_order)
+
+# has_order
+
+Provides tree behavior to active_record models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_order'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+class Item < ActiveRecord::Base
+  # :scope           - optional, proc, symbol or an array of symbols.
+  # :position_column - optional, default 'position'.
+  # :shift_interval  - optional, default 1000.
+  has_order
+end
+
+foo, bar, baz, qux = Item.create([
+  { name: 'foo' },
+  { name: 'bar' },
+  { name: 'baz' },
+  { name: 'qux' }
+])
+
+Item.at(foo.position) # => foo
+baz.higher            # => [ qux ]
+baz.and_higher        # => [ baz, qux ]
+baz.lower             # => [ foo, bar ]
+baz.and_lower         # => [ foo, bar, baz ]
+
+baz.move_before(bar) 
+Item.ordered          # => [ foo, baz, bar, qux ]
+
+foo.move_after(qux)
+Item.ordered          # => [ baz, bar, qux, foo ]
+
+baz.move_to(qux)
+Item.ordered          # => [ bar, baz, qux, foo ]
+```
+
+## License
+
+Copyright (c) 2014 Kolesnikov Danil
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/has_order.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'has_order/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'has_order'
+  spec.version       = HasOrder::VERSION
+
+  spec.authors       = ['Kolesnikov Danil']
+  spec.email         = ['kolesnikovde@gmail.com']
+  spec.description   = 'Provides list behavior to active_record models.'
+  spec.summary       = 'Provides list behavior to active_record models.'
+  spec.homepage      = 'https://github.com/kolesnikovde/has_order'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake',    '~> 10'
+  spec.add_development_dependency 'rspec',   '~> 3'
+  spec.add_development_dependency 'sqlite3', '~> 1'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_runtime_dependency 'activerecord',  '~> 4'
+  spec.add_runtime_dependency 'activesupport', '~> 4'
+end

data/lib/has_order/version.rb

@@ -0,0 +1,3 @@
+module HasOrder
+  VERSION = '0.1.2'
+end

data/lib/has_order.rb

@@ -0,0 +1,151 @@
+require 'active_record'
+require 'has_order/version'
+
+module HasOrder
+  # options - :scope           - optional, proc, symbol or an array of symbols.
+  #           :position_column - optional, default 'position'.
+  #           :shift_interval  - optional, default 1000.
+  def has_order options = {}
+    extend  ClassMethods
+    include InstanceMethods
+
+    cattr_accessor :position_column do
+      options[:position_column] || :position
+    end
+
+    cattr_accessor :position_shift_interval do
+      options[:shift_interval] || 1000
+    end
+
+    before_save :set_default_position, if: :set_default_position?
+
+    define_list_scope(options[:scope])
+  end
+
+  module ClassMethods
+    def at(pos)
+      where(position_column => pos)
+    end
+
+    def ordered
+      order(arel_table[position_column].asc)
+    end
+
+    def shift!
+      col = position_column
+      update_all("#{col} = #{col} + #{position_shift_interval}")
+    end
+
+    def next_position
+      maximum(position_column).to_i + position_shift_interval
+    end
+  end
+
+  module InstanceMethods
+    def position
+      self[position_column]
+    end
+
+    def position=(pos)
+      self[position_column] = pos
+    end
+
+    def lower
+      where_position(:lt)
+    end
+
+    def and_lower
+      where_position(:lteq)
+    end
+
+    def higher
+      where_position(:gt)
+    end
+
+    def and_higher
+      where_position(:gteq)
+    end
+
+    def prev
+      lower.ordered.last
+    end
+
+    def next
+      higher.ordered.first
+    end
+
+    def move_to(pos)
+      ActiveRecord::Base.transaction do
+        if node = list_scope.at(pos).first
+          node.and_higher.shift!
+        end
+
+        self.position = pos
+        save!
+      end
+    end
+
+    def move_before(node)
+      node_pos = node.position
+      pos = node_pos > 0 ? node_pos - 1 : node_pos
+
+      ActiveRecord::Base.transaction do
+        if list_scope.at(pos).exists?
+          pos = node_pos
+          node.and_higher.shift!
+        end
+
+        self.position = pos
+        save!
+      end
+    end
+
+    def move_after(node)
+      node_pos = node.position
+      pos = node_pos + 1
+
+      ActiveRecord::Base.transaction do
+        if list_scope.at(pos).exists?
+          node.higher.shift!
+        end
+
+        self.position = pos
+        save!
+      end
+    end
+
+    protected
+
+    def list_scope
+      self.class.list_scope(self)
+    end
+
+    def where_position(cmp)
+      col = self.class.arel_table[position_column]
+      list_scope.where(col.send(cmp, position))
+    end
+
+    def set_default_position
+      self.position = list_scope.next_position
+    end
+
+    def set_default_position?
+      position.nil?
+    end
+  end
+
+  protected
+
+  def define_list_scope(list_scope)
+    scope :list_scope, case list_scope
+    when Proc
+      list_scope
+    when nil
+      ->(model) { self }
+    else
+      ->(model) { where(Hash[Array(list_scope).map{ |s| [ s, model[s] ] }]) }
+    end
+  end
+end
+
+ActiveRecord::Base.extend(HasOrder)

data/spec/db/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define(version: 0) do
+  create_table :items, force: true do |t|
+    t.string :name
+    t.string :category
+
+    t.integer :position
+  end
+end

data/spec/has_order_spec.rb

@@ -0,0 +1,194 @@
+require 'spec_helper'
+
+describe HasOrder do
+  before(:each) do
+    @foo, @bar, @baz, @qux = Item.create([
+      { name: 'foo', category: 'A' },
+      { name: 'bar', category: 'A' },
+      { name: 'baz', category: 'B' },
+      { name: 'qux', category: 'B' }
+    ])
+  end
+
+  def reload_items
+    [ @foo, @bar, @baz, @qux ].each(&:reload)
+  end
+
+  describe 'position column' do
+    it 'defaults to "position"' do
+      expect(Item.position_column).to eq(:position)
+    end
+
+    it 'provides accessor' do
+      item = Item.new
+      item.position = 5
+      expect(item.position).to eq(5)
+    end
+  end
+
+  describe '.at' do
+    it 'scopes position' do
+      @foo.position = 5
+      @foo.save
+
+      expect(Item.at(5).first).to eq(@foo)
+    end
+  end
+
+  describe '.ordered' do
+    it 'ranks items according to position' do
+      @foo.update_attribute(:position, 2)
+      @bar.update_attribute(:position, 1)
+      @baz.update_attribute(:position, 4)
+      @qux.update_attribute(:position, 3)
+
+      expect(Item.ordered).to eq([ @bar, @foo, @qux, @baz ])
+    end
+  end
+
+  describe '.next_position' do
+    it 'returns next available position' do
+      @quux = Item.create!(name: 'quux')
+
+      expect(@quux.position).to be < Item.next_position
+    end
+  end
+
+  describe '#lower' do
+    it 'returns items with position less or equal to the item position' do
+      expect(@qux.lower).to match_array([ @foo, @bar, @baz ])
+    end
+  end
+
+  describe '#and_lower' do
+    it 'returns items with position less than or equal to the item position' do
+      expect(@baz.and_lower).to match_array([ @foo, @bar, @baz ])
+    end
+  end
+
+  describe '#higher' do
+    it 'returns items with position greater than the item position' do
+      expect(@foo.higher).to match_array([ @bar, @baz, @qux ])
+    end
+  end
+
+  describe '#and_higher' do
+    it 'returns items with position greater than or equal to the item' do
+      expect(@bar.and_higher).to match_array([ @bar, @baz, @qux ])
+    end
+  end
+
+  describe '#prev' do
+    it 'returns previous item' do
+      expect(@baz.prev).to eq(@bar)
+    end
+  end
+
+  describe '#next' do
+    it 'returns next item' do
+      expect(@bar.next).to eq(@baz)
+    end
+  end
+
+  context 'first item' do
+    subject { @foo }
+
+    it { expect(subject.lower).to be_empty }
+    it { expect(subject.and_lower).to eq([ subject ]) }
+    it { expect(subject.prev).to be_nil }
+  end
+
+  context 'last item' do
+    subject { @qux }
+
+    it { expect(subject.higher).to be_empty }
+    it { expect(subject.and_higher).to eq([ subject ]) }
+    it { expect(subject.next).to be_nil }
+  end
+
+  describe '#move_to' do
+    it 'shifts item and higher items when the position is occupied' do
+      @foo.update_attribute(:position, 1)
+      @bar.update_attribute(:position, 2)
+      @baz.update_attribute(:position, 3)
+      @qux.update_attribute(:position, 4)
+
+      @qux.move_to(@bar.position)
+
+      reload_items
+
+      expect(Item.ordered).to eq([ @foo, @qux, @bar, @baz ])
+    end
+  end
+
+  describe '#move_before' do
+    it 'decreases item position' do
+      prev_qux_position = @qux.position
+      @qux.move_before(@foo)
+
+      expect(@qux.position).to be < prev_qux_position
+    end
+
+    it 'shifts item and higher items when the position is occupied' do
+      @foo.update_attribute(:position, 1)
+      @bar.update_attribute(:position, 2)
+      @baz.update_attribute(:position, 3)
+      @qux.update_attribute(:position, 4)
+
+      @baz.move_before(@bar)
+
+      reload_items
+
+      expect(Item.ordered).to eq([ @foo, @baz, @bar, @qux ])
+    end
+  end
+
+  describe '#move_after' do
+    it 'increases item position' do
+      prev_foo_position = @foo.position
+      @foo.move_after(@qux)
+
+      expect(@foo.position).to be > prev_foo_position
+    end
+
+    it 'shifts higher items when the position is occupied' do
+      @foo.update_attribute(:position, 1)
+      @bar.update_attribute(:position, 2)
+      @baz.update_attribute(:position, 3)
+      @qux.update_attribute(:position, 4)
+
+      @foo.move_after(@bar)
+
+      reload_items
+
+      expect(Item.ordered).to eq([ @bar, @foo, @baz, @qux ])
+    end
+  end
+
+  describe 'scoping' do
+    shared_examples 'scoped' do
+      it { expect(subject.higher).to be_empty }
+      it { expect(subject.and_lower).to match_array([ @bar, @foo ]) }
+    end
+
+    describe 'via attributes' do
+      before(:all) do
+        Item.has_order scope: :category
+      end
+
+      subject { @bar }
+
+      it_behaves_like 'scoped'
+    end
+
+    describe 'via proc' do
+      before(:all) do
+        Item.has_order scope: ->(i){ Item.where(category: i.category) }
+      end
+
+      subject { @bar }
+
+      it_behaves_like 'scoped'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+if ENV['SIMPLECOV']
+  require 'simplecov'
+  SimpleCov.start 'rails'
+end
+
+require 'fileutils'
+require 'logger'
+require 'sqlite3'
+require 'active_record'
+
+FileUtils.mkdir_p('tmp/logs/')
+ActiveRecord::Base.logger = Logger.new('tmp/logs/test.log')
+ActiveRecord::Base.logger.level = Logger::DEBUG
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Schema.verbose = false
+
+require File.expand_path('../db/schema.rb', __FILE__)
+require File.expand_path('../support/models.rb', __FILE__)
+
+RSpec.configure do |config|
+  config.around :each do |example|
+    ActiveRecord::Base.transaction do
+      example.run
+
+      raise ActiveRecord::Rollback
+    end
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,5 @@
+require 'has_order'
+
+class Item < ActiveRecord::Base
+  has_order
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: has_order
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Kolesnikov Danil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Provides list behavior to active_record models.
+email:
+- kolesnikovde@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- has_order.gemspec
+- lib/has_order.rb
+- lib/has_order/version.rb
+- spec/db/schema.rb
+- spec/has_order_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+homepage: https://github.com/kolesnikovde/has_order
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provides list behavior to active_record models.
+test_files:
+- spec/db/schema.rb
+- spec/has_order_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb