neo4jrb_spatial 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9a8fabd817cc1db5b5d5f6f7466a1c0850f7359
-  data.tar.gz: 39f2e8a65c7a8a3f4baf988423be0916b6a9c282
+  metadata.gz: 5d7020cf724fdf56d3816dd13a1c1a6335f9cee3
+  data.tar.gz: 2326bbe73ef0c9787be9fcdac40b220a505e7e52
 SHA512:
-  metadata.gz: 3fd46e9a2b1605f8539f97c68fb9fecfd39f9a4949a20a18a811ce0ac697c015e0d181b6882c45d2b1f9bdaf7e5d895e0252a6b7c7ee4b483c07c0c962e10fca
-  data.tar.gz: 0d2eedf8a8df07564138fd9e2be26c0fad14b2f424169fbae7fbd7c4f8a8289f563e57af8ae3b2546a7e9e74889f5a1cbdd685d0c7464b266b85410869a68a9f
+  metadata.gz: 4f6874f5330f2bf7c895db54280b263c741c6b055a7ac6846d7cac3f7eb7a99e99f74177e8f4f16e49638173574bbb22c080234ee2809e3b72926e118736f4d2
+  data.tar.gz: 8e550e27b37a492ddaf7974ca22f7f962047f0bd36ae59cc1853bee5c52124cc3b01d174ae35bf7f8c7faea7cd52e36cc4f3f272570f21218b1a322818a7c419

data/CHANGELOG.md

@@ -5,6 +5,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
+## [1.1.0] - 2015-10-15
+
+### Fixed
+
+- Problems with gem config were preventing installation. Relaxed versioning requirements.
+- Rake tasks were moved out of Neo4j-core, so added the `neo4j-rake_tasks` gem to keep this ship sailing.
+
 ## [1.0.0] - 2015-06-TBD
 
 ### Added

data/Gemfile

@@ -1,6 +1,4 @@
 source 'https://rubygems.org'
-# gem 'neo4j', github: 'neo4jrb/neo4j', branch: 'master'
-gem 'neo4j-core', github: 'neo4jrb/neo4j-core', branch: 'master'
 
 # Specify your gem's dependencies in neo4jrb_spatial.gemspec
 gemspec

data/README.md

@@ -30,6 +30,11 @@ Optionally:
 
 # Usage
 
+## Add it
+
+```
+gem 'neo4jrb_spatial', '~> 1.0.0'
+```
 
 ## Require it
 
@@ -41,7 +46,7 @@ require 'neo4j/spatial'
 include Neo4j::ActiveNode::Spatial
 ```
 
-## Basics - Neo4j-core
+## Use it with Neo4j-core
 
 ```ruby
 # Create an index
@@ -58,26 +63,46 @@ Neo4j::Session.current.query.start('n = node:restaurants({location})').params(lo
 # => CypherNode 90126 (70333884677220)
 ```
 
-## Basics - Neo4j gem
+## Use it with the Neo4j gem
 
- Neo4j.rb does not support legacy indexes, so a helper method is provided to add nodes. As with normal properties, your lat and lon
- should be explicitly declared.
+ Neo4j.rb does not support legacy indexes, so adding nodes to spatial indexes needs to happen separately from node creation. This is complicated by the fact that Neo4j.rb creates all nodes in transactions, so `after_create` callbacks won't work; instead, add your node to the index once you've confirmed it has been created.
  
-### Automatic index addition
-
-At the moment, automatic index addition is not implemented.
+ Start by adding `lat` and `lon` properties to your model. You can also add a `spatial_index` to save yourself some time later.
+ 
+ ```
+ class Restaurant
+   include Neo4j::ActiveNode
+   include Neo4j::ActiveNode::Spatial
+   
+   # This is optional but might make things easier for you later
+   spatial_index 'restaurants'
+   
+   property :name
+   property :lat
+   property :lon
+ end
+ 
+ # Create it
+ pizza_hut = Restaurant.create(name: 'Pizza Hut', lat: 60.1, lon: 15.1)
+ 
+ # When called without an argument, it will use the value set through `spatial_index` in the model
+ pizza_hut.add_to_spatial_index
+ 
+ # Alternatively, to add it to a different index, just give it that name
+ pizza_hut.add_to_spatial_index('fake_pizza_places')
+ ```
 
 ### Manual index addition
 
-All of the Neo4j-core spatial methods accept ActiveNode-including nodes, so you can use them as arguments for all defined methods as you would
-Neo4j::Server::CypherNode instances.
+All of the Neo4j-core spatial methods accept ActiveNode-including nodes, so you can use them as arguments for all defined methods as you would Neo4j::Server::CypherNode instances.
 
-Additionally, you can call the `add_to_spatial_index` instance method on any node to add it to its model's defined index.
+```ruby
+Neo4j::Session.current.add_node_to_spatial_index('fake_pizza_places', pizza_hut)
+```
 
 ### Spatial queries
 
-No helpers are provided to query against the REST API -- you'll need to use the ones provided for Neo4j-core; however, a class method is provided 
-to make Cypher queries easier: `spatial_match`.
+No helpers are provided to query against the REST API -- you'll need to use the ones provided for Neo4j-core; however, a class method is provided to make Cypher queries easier: `spatial_match`.
 
 ```
 # Use the index defined on the model as demonstrated above
@@ -93,7 +118,7 @@ It then drops you back into a QueryProxy in the context of the class. If you had
  Restauarant.all.spatial_match(:r, 'withinDistance:[41.99,-87.67,10.0]').employees.where(age: 30)
  ```
  
- Alternatively, if you did no define `spatial_index` on your model, you can feed a third argument: the index to use for the query.
+If you did no define `spatial_index` on your model or what to query against something other than the model's default, you can feed a third argument: the index to use for the query.
 
 ## Additional Resources
 

data/lib/neo4jrb_spatial/version.rb

@@ -1,3 +1,3 @@
 module Neo4jrbSpatial
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/neo4jrb_spatial.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'pry'
 
-  spec.add_dependency 'neo4j', '~> 5.0.1'
-  spec.add_dependency 'neo4j-core', '~> 5.0.1'
+  spec.add_dependency 'neo4j', '>= 5.0.1'
+  spec.add_dependency 'neo4j-core', '>= 5.0.1'
+  spec.add_dependency 'neo4j-rake_tasks', '~> 0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4jrb_spatial
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Grigg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,30 +84,44 @@ dependencies:
   name: neo4j
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: neo4j-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.1
+- !ruby/object:Gem::Dependency
+  name: neo4j-rake_tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: 
 email:
 - chris@subvertallmedia.com