record_neighbors 0.0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25501764dbb2ff2fff6805c81d0ea361aa453caa
+  data.tar.gz: 3dc463e600659173204b7e3b3f19481c8bd02d7e
+SHA512:
+  metadata.gz: 09df179a6087569d19dec297316b62daa34247ea6693ccfbf398b001fe8be53bb433c04bf5a1cd3faf2c3f1b6b22bcb1479eac99a9e53354b80ae4f761ce2a45
+  data.tar.gz: e6b6343e8f9c7cb4c3027bf52d6d93d3d571b948120e2b72e9ff677da1e6465178ed261fdb05b06d3c993d1f0bb5637a96a3df8ce3bb04cb99115b4f00f8bed0

data/CHANGE.log

@@ -0,0 +1,20 @@
+2014-11-29 Ancalima Silme <ancalimasilme@gmail.com>
+
+  * Написал README.md
+  * Убрал у метода `all_without` атрибут.
+
+2014-11-29 Ancalima Silme <ancalimasilme@gmail.com>
+
+  * Переместил БД с тестовыми данными в RAM
+  * Добавил тесты
+
+2014-11-29 Ancalima Silme <ancalimasilme@gmail.com>
+
+  * Подключены модули ActiveRecord, SQLite3, RSpec для тестирования плагина
+  * Создала БД с тестовыми данными
+  * Написано несколько базовых тестов
+
+2014-11-26 Ancalima Silme <ancalimasilme@gmail.com>
+
+  * Для всех функций добавлена возможность указать атрибут, по которому будет отсортирована выборка и на основе которого будет
+    определен следующий/предыдущий, первый/последний элемент.

data/README.md

@@ -0,0 +1,72 @@
+# RecordNeighbors
+
+Это простой плагин для Ruby/Ruby on Rails, расширяющий возможность ActiveRecord
+
+### Установка
+
+##### Для Ruby c ActiveRecord
+
+```
+gem install 'record_neighbors'
+```
+
+```
+# my_app.rb
+require 'active_record'
+require 'record_neighbors'
+```
+
+##### Для Ruby on Rails
+
+    # Gemfile
+    gem 'record_neighbors'
+
+### Список методов
+
+* first?
+* last?
+* next
+* previous
+* all_after
+* all_before
+* all_without
+
+В качестве параметра методам можно передать название столбца. Выборка будет отсортирована по переданному атрибуту.
+
+#### Подробнее о методах  "first?" и last?
+
+Методы **first?** и **last?** возращают TRUE если элемент является первым/последним в выборке.
+Пример использования:
+
+    Post.find(1).first?                          #=> true
+    Post.find_by(position: 1).first?(:position)  #=> true
+
+    Post.find(10).last?                          #=> true
+    Post.find_by(position: 1).first?(:position)  #=> true
+
+#### Подробнее о методах  "next" и "previous"
+
+Как следует из названия, методы **next** и **previous** возращают следующий/предыдущий объект в выборке.
+Пример использования:
+
+    Post.find(1).next      #=> #<Post id: 2, position: 3>
+    Post.find(5).previous  #=> #<Post id: 4, position: 10>
+
+    post.find_by(position: 1).next(:position)       #=> #<Post id: 1, position: 2>
+    post.find_by(position: 5).previous(:position)   #=> #<Post id: 10, position: 4>
+
+#### Подробнее о методах  "all_before и "all_after"
+
+Методы **all_before** и **all_after** возвращают коллекцию объектов до/после текущего. Текущий элемент не включается.
+
+    Post.find(5).all_before
+    Post.find(5).all_after
+
+    Post.find_by(position: 5).all_before(:position)
+    Post.find_by(position: 5).all_after(:position)
+
+#### Подробнее о методах  "all_without"
+
+Методы **all_without** возвращают коллекцию объектов без текущего элемента.
+
+    Post.find(5).all_without.pluck(:id)   #=> [1, 2, 3, 4, 6, 7, 8, 9, 10]

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/lib/record_neighbors.rb

@@ -0,0 +1,4 @@
+require 'record_neighbors/base_extension'
+
+module RecordNeighbors
+end

data/lib/record_neighbors/base_extension.rb

@@ -0,0 +1,35 @@
+require 'active_support/concern'
+
+module BaseExtension
+  extend ActiveSupport::Concern
+
+  def last?(attribute = "id")
+    self == self.class.order("#{attribute} ASC").last
+  end
+
+  def first?(attribute = "id")
+    self == self.class.order("#{attribute} ASC").first
+  end
+
+  def next(attribute = "id")
+    self.class.where("#{attribute} > #{self.send(attribute)}").order("#{attribute} ASC").limit(1).first
+  end
+
+  def previous(attribute = "id")
+    self.class.where("#{attribute} < #{self.send(attribute)}").order("#{attribute} DESC").limit(1).first
+  end
+
+  def all_after(attribute = "id")
+    self.class.where("#{attribute} > #{self.send(attribute)}").order("#{attribute} ASC")
+  end
+
+  def all_before(attribute = "id")
+    self.class.where("#{attribute} < #{self.send(attribute)}").order("#{attribute} ASC")
+  end
+
+  def all_without
+    self.class.where.not(id: self.id)
+  end
+
+  ActiveRecord::Base.send(:include, BaseExtension)
+end

data/lib/record_neighbors/version.rb

@@ -0,0 +1,3 @@
+module RecordNeighbors
+  VERSION = "0.0.2.1"
+end

data/spec/database_spec.rb

@@ -0,0 +1,117 @@
+require_relative 'spec_helper.rb'
+require_relative 'support/test_database.rb'
+require_relative '../lib/record_neighbors/base_extension.rb'
+
+
+# post title 1 - 2
+# post title 2 - 3
+# post title 3 - 1
+# post title 4 - 10
+# post title 5 - 9
+# post title 6 - 6
+# post title 7 - 5
+# post title 8 - 7
+# post title 9 - 8
+# post title 10 - 4
+
+
+RSpec.describe 'next()' do
+    it "Должен вернуть следующий объект" do
+      expect(Post.find(5)).to eql(Post.find(4).next)
+    end
+
+    it "Должен вернуть nil если следующего элемента нет" do
+      expect(Post.find(10).next).to be_nil
+    end
+
+    it "Должен вернуть следующий объект из отсортированного списка по переданному атрибуту" do
+      expect(Post.find(7).next('position')).to eql(Post.find(6))
+    end
+end
+
+RSpec.describe 'previous()' do
+    it "Должен вернуть предыдущий объект" do
+      expect(Post.find(5)).to eql(Post.find(6).previous)
+    end
+
+    it "Должен вернуть nil если предыдущего элемента нет" do
+      expect(Post.find(1).previous).to be_nil
+    end
+
+    it "Должен вернуть предыдущий объект из отсортированного списка по переданному атрибуту" do
+      expect(Post.find(7).previous('position')).to eql(Post.find(10))
+    end
+end
+
+RSpec.describe 'last?()' do
+    it "Должен вернуть истину, если объект является последним" do
+      expect(Post.find(10).last?).to be_truthy
+    end
+
+    it "Должен вернуть ложь, если объект не является последним" do
+      expect(Post.find(5).last?).to be_falsey
+    end
+
+    it "Должен вернуть истину, если объект является последним в отсортированном, по атрибуту, списке" do
+      expect(Post.find(4).last?('position')).to be_truthy
+    end
+
+    it "Должен вернуть ложь, если объект не является последним в отсортированном, по атрибуту, списке" do
+      expect(Post.find(10).last?('position')).to be_falsey
+    end
+end
+
+RSpec.describe 'first?()' do
+    it "Должен вернуть истину, если объект является первым" do
+      expect(Post.find(1).first?).to be_truthy
+    end
+
+    it "Должен вернуть ложь, если объект не является первым" do
+      expect(Post.find(5).first?).to be_falsey
+    end
+
+    it "Должен вернуть истину, если объект является первым в отсортированном, по атрибуту, списке" do
+      expect(Post.find(3).first?('position')).to be_truthy
+    end
+
+    it "Должен вернуть ложь, если объект не является первым в отсортированном, по атрибуту, списке" do
+      expect(Post.find(1).first?('position')).to be_falsey
+    end
+end
+
+RSpec.describe 'all_before()' do
+  it "Все ID должны быть меньше 5" do
+    expect(Post.find(5).all_before.map { |p| p.id }).to all(be < 5)
+  end
+
+  it "Все Position должны быть меньше 5" do
+    expect(Post.find_by(position: 5).all_before('position').map { |p| p.position }).to all(be < 5)
+  end
+end
+
+RSpec.describe 'all_after()' do
+  it "Все ID должны быть больше 5" do
+    expect(Post.find(5).all_after.map { |p| p.id }).to all(be > 5)
+  end
+
+  it "Все Position должны быть больше 5" do
+    expect(Post.find_by(position: 5).all_after('position').map { |p| p.position }).to all(be > 5)
+  end
+end
+
+RSpec.describe 'all_without()' do
+  it "Количество элементв должно быть model.length - 1" do
+    expect(Post.find(5).all_without.size).to eql(Post.all.size - 1)
+  end
+
+  it "В результате не должно быть объекта с ID == 5" do
+    expect(Post.find(5).all_without).to_not include(Post.find(5))
+  end
+end
+
+
+RSpec.describe ActiveRecord::Base do
+  it "Должен включать все методы плагина" do
+    expect(ActiveRecord::Base.instance_methods).to include(:next, :previous, :first?, :last?, :all_before, :all_after, :all_without)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+end

data/spec/support/test_database.rb

@@ -0,0 +1,20 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+class Post < ActiveRecord::Base
+  scope :on_position, -> { order(position: :asc) }
+end
+
+ActiveRecord::Schema.define do
+  create_table :posts do |t|
+    t.column :position, :indeger
+  end
+end
+
+[2, 3, 1, 10, 9, 6, 5, 7, 8, 4].each_with_index do |position, index|
+  Post.create!(position: position)
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: record_neighbors
+version: !ruby/object:Gem::Version
+  version: 0.0.2.1
+platform: ruby
+authors:
+- Ancalima Silme
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-29 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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'
+description: Make possible get neighbors for ActiveRecord object.
+email:
+- ancalimasilme@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGE.log
+- README.md
+- Rakefile
+- lib/record_neighbors.rb
+- lib/record_neighbors/base_extension.rb
+- lib/record_neighbors/version.rb
+- spec/database_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_database.rb
+homepage: 
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Neighbors of ActiveRecord object
+test_files:
+- spec/database_spec.rb
+- spec/support/test_database.rb
+- spec/spec_helper.rb