neo4j-will_paginate_redux 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d6a1bf407df21848542b063515f569356025079
+  data.tar.gz: 94cc9a3400af5ca7f1a5cb5f170d811cb1881b37
+SHA512:
+  metadata.gz: 1a5db13acee30b2bf14a2a6e59cf6c1cefefe2ee1b6283ae1cc219007b4d0003fb4ffdacebc3519b886e67d19c8bbd8934c033b9b5a8932a84bd58b0c1c2da02
+  data.tar.gz: 7f2cfecf532739f066b59ffc9c333d4197066158349215748f135bb6d7ee70ef44342656e5c787d67ac0b7efed1b668b7bc41deec6f86d28519f6f672069dba7

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.swp
+db/
+bin/
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - jruby
+env:
+  - JRUBY_OPTS=--1.8
+  - JRUBY_OPTS=--1.9

data/CHANGELOG

@@ -0,0 +1,14 @@
+== 0.3.2 / 2014-11-03
+* Adds `order` option.
+* Moving to the neo4j-will_paginate_redux gem officially because listing repo in Gemfile is annoying.
+
+== 0.3.1 / July 2014
+* WE'RE BACK, BABY! Updated with support for Neo4jrb 3.0.
+
+== 0.2.1 / 2013-06-22
+
+* Make per_page optional like the doc says (#5)
+
+== 0.2.0 / 2012-10-02
+
+* Upgrade to use neo4j-cypher 1.0.0 gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in neo4j-will_paginate.gemspec
+gemspec
+
+# gem 'neo4j', path: '../neo4j'

data/README.md

@@ -0,0 +1,46 @@
+Integration for Neo4j.rb and will_paginate
+============================================
+
+This gem is just a simple integration of will_paginate and neo4j.
+
+Which version do I use?
+==================
+
+Neo4j.rb 2.x: 0.2.1<br />
+Neo4j.rb 3.0 < alpha 8: 0.2.2<br />
+Neo4j.rb 3.0 > alpha 7: Latest
+
+Installation
+==================
+
+1. Add `neo4j-will_paginate` to your `Gemfile`.
+2. `require 'neo4j-will_paginate'` somewhere from your code.
+
+Using
+==================
+
+Please see the [will_paginate](https://github.com/mislav/will_paginate)
+and [neo4j.rb](https://github.com/andreasronge/neo4j) for details.
+
+But here is simple example:
+
+
+```ruby
+# Probably in the Rails controller:
+
+def index
+  # :per_page is optional
+  # :return is also optional. To return multiple objects, use an array of symbols
+  # :order is -- you guessed it -- optional, too. It accepts the same arguments as Neo4j::ActiveNode::QueryProxy's `order` method
+  @people = Person.(as: :p).where(age: 30).paginate(:page => 2, :per_page => 20, return: :p, order: :name) 
+end
+
+# Then in the view:
+paginate @people
+
+```
+
+License
+=====================
+
+MIT by Dmytrii Nagirniak, Andreas Ronge, and Chris Grigg

data/Rakefile

@@ -0,0 +1,7 @@
+srand # JRuby bug
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+task :default => 'spec'

data/lib/neo4j-will_paginate_redux.rb

@@ -0,0 +1,59 @@
+require "neo4j-will_paginate_redux/version"
+require 'will_paginate/collection'
+require 'will_paginate/per_page'
+require 'neo4j'
+
+
+module Neo4j::ActiveNode::Query
+  class QueryProxy
+
+    # The module provides the common interface for the pagination on any Enumerable class.
+    # By including the module, {Neo4j::WillPaginate::Pagination#paginate} method will be available.
+    include ::WillPaginate::CollectionMethods
+
+    # Paginates the {Enumerable} and returns {::WillPaginate::Collection} instance.
+    #
+    # @param [Hash] options a hash of options for the pagination.
+    # @option options [Symbol] :page current page for the pagination (defualts to 1).
+    # @option options [Symbol] :per_page numer of items per page (defaults to {::WillPaginate.per_page}).
+    #                           Aliases are `:per`, `:limit`.
+    # @option options [String,Array] :return an optional string or array of identifiers used earlier in the query
+    #                                 requested for return.
+    # @option options [String,Symbol] :order an optional QueryProxy `order` clause to sort your results
+    #
+    # @example Paginate on a relationship:
+    #   person.friends.paginate(:page => 5, :per_page => 10)
+    #
+    # @example Paginate the search results:
+    #   Person.all(:conditions => "name: Dmytrii*").paginate(:page => 5, :per_page => 10)
+    def paginate(options={})
+      @page         = (options[:page] || 1).to_i
+      @per_page     = (options[:per] || options[:per_page] || options[:limit] || ::WillPaginate.per_page).to_i
+      @result_order = options[:order]
+      @returns      = to_return(options[:return])
+      ::WillPaginate::Collection.create(page, per_page) { |pager| pager_return(pager) }
+    end
+
+    attr_reader :page, :per_page, :result_order, :returns
+
+    private
+
+    def pager_return(pager)
+      res = ::Neo4j::Paginated.create_from(self, page, per_page, result_order)
+      return_method = returns.nil? ? Proc.new { res.to_a } : Proc.new { res.pluck(*returns) }
+      pager.replace return_method.call
+      pager.total_entries = res.total unless pager.total_entries
+    end
+
+    def to_return(returns)
+      case returns
+      when Array
+        returns
+      when Symbol
+        [returns]
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/neo4j-will_paginate_redux/version.rb

@@ -0,0 +1,5 @@
+module Neo4j
+  module WillPaginateRedux
+    VERSION = "0.3.2"
+  end
+end

data/neo4j-will_paginate_redux.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "neo4j-will_paginate_redux/version"
+
+Gem::Specification.new do |s|
+  s.name        = "neo4j-will_paginate_redux"
+  s.version     = Neo4j::WillPaginateRedux::VERSION
+  s.authors     = ["Dmytrii Nagirniak", "Andreas Ronge", "Chris Grigg"]
+  s.email       = ["dnagir@gmail.com", "andreas.ronge@gmail.com", "chris@subvertallmedia.com"]
+  s.homepage    = "https://github.com/neo4jrb/neo4j-will_paginate_redux"
+  s.summary     = %q{Integration between Neo4jrb 3.0 and will_paginate.}
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency 'rspec-its'
+  s.add_runtime_dependency "activesupport", "~> 4.0"
+  s.add_runtime_dependency "will_paginate", "~> 3.0"
+  s.add_runtime_dependency "neo4j", '>= 3.0.3', '< 3.1.0'
+end

data/spec/neo4j-will_paginate_redux_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'rspec/its'
+
+describe 'pagination' do
+  class Lesson; end
+
+  class Person
+    include Neo4j::ActiveNode
+    property :name, :default => 'x'
+    has_many :both, :friends, model_class: 'Person'
+    has_many :out, :lessons
+  end
+
+  class Lesson
+    include Neo4j::ActiveNode
+    property :subject
+    has_many :in, :people, model_class: Person, origin: :lessons
+  end
+
+  describe 'will_paginate' do
+    before(:all) do
+      Person.destroy_all
+     10.times { Person.create(name: 'x') }
+   end
+
+    subject { source.paginate(:page => 2, :per_page => 3) }
+
+    def self.should_be_paginated
+      its(:size)          { is_expected.to eq 3 }
+      its(:current_page)  { is_expected.to eq 2 }
+      its(:per_page)      { is_expected.to eq 3 }
+      its(:total_entries) { is_expected.to eq 10 }
+      its(:offset)        { is_expected.to eq 3 }
+    end
+
+    describe 'called on QueryProxy chain' do
+      let(:source)  { Person.where(name: 'x') }
+      should_be_paginated
+    end
+
+    describe 'specifying return' do
+      context 'with a symbol' do
+        let(:subject) { source.paginate(page: 2, per_page: 3, return: :p) }
+        let(:source)  { Person.as(:p).where(name: 'x') }
+        should_be_paginated
+      end
+
+      context 'with an array' do
+        let(:source)  { Person.lessons(:l, :r) }
+        let(:subject) { source.paginate(page: 2, per_page: 3, return: [:l, :r]) }
+        before do
+          Lesson.create
+          Person.all.each { |p| p.lessons << Lesson.first}
+        end
+
+        it 'should contain arrays of both lessons and rels' do
+          expect(subject.first).to be_an(Array)
+          expect(subject.first[0]).to be_a(Lesson)
+          expect(subject.first[1]).to be_a(Neo4j::Server::CypherRelationship)
+        end
+      end
+    end
+
+    it 'should default to WillPaginate.per_page' do
+      pager = Person.where.paginate
+      expect(pager.per_page).to eq ::WillPaginate.per_page
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,66 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper.rb"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+
+require 'neo4j-will_paginate_redux'
+# neo4j Specs clean-up
+require 'fileutils'
+
+EMBEDDED_DB_PATH = File.join(Dir.tmpdir, "neo4j-core-java")
+
+I18n.enforce_available_locales = false
+
+def create_session
+  if RUBY_PLATFORM != 'java'
+    create_server_session
+  else
+    require "neo4j-embedded/embedded_impermanent_session"
+    create_embedded_session
+  end
+end
+
+def create_embedded_session
+  session = Neo4j::Session.open(:impermanent_db, EMBEDDED_DB_PATH, auto_commit: true)
+  session.start
+end
+
+def create_server_session
+  Neo4j::Session.open(:server_db, "http://localhost:7474")
+  delete_db
+end
+
+FileUtils.rm_rf(EMBEDDED_DB_PATH)
+
+def delete_db
+  Neo4j::Session.current._query('MATCH (n) OPTIONAL MATCH (n)-[r]-() DELETE n,r')
+end
+
+RSpec.configure do |c|
+
+  c.before(:suite) do
+    Neo4j::Session.current.close if Neo4j::Session.current
+    create_session
+  end
+
+  c.before(:each) do
+    Neo4j::Session._listeners.clear
+    curr_session = Neo4j::Session.current
+    curr_session || create_session
+  end
+
+  c.after(:each) do
+    if Neo4j::Transaction.current
+      puts "WARNING forgot to close transaction"
+      Neo4j::Transaction.current.close
+    end
+  end
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: neo4j-will_paginate_redux
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Dmytrii Nagirniak
+- Andreas Ronge
+- Chris Grigg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-03 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: neo4j
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Integration between Neo4jrb 3.0 and will_paginate.
+email:
+- dnagir@gmail.com
+- andreas.ronge@gmail.com
+- chris@subvertallmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- README.md
+- Rakefile
+- lib/neo4j-will_paginate_redux.rb
+- lib/neo4j-will_paginate_redux/version.rb
+- neo4j-will_paginate_redux.gemspec
+- spec/neo4j-will_paginate_redux_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/neo4jrb/neo4j-will_paginate_redux
+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.2
+signing_key: 
+specification_version: 4
+summary: Integration between Neo4jrb 3.0 and will_paginate.
+test_files:
+- spec/neo4j-will_paginate_redux_spec.rb
+- spec/spec_helper.rb