neo4j 5.1.5 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee39f89dbeb6c4cbb84e138646bd14387a58a3e1
-  data.tar.gz: d3db82c3713b3be64ed389f9e249c95064d68491
+  metadata.gz: cdc33103cf05e1ec6a124c615303f0fcb7ff0760
+  data.tar.gz: 679ae2889ebbe49d6083fe9d471508996a2e6750
 SHA512:
-  metadata.gz: 7761cd3c739a85440143ebf2c0063b797e874a83002639a6fecebc35b24f04013cfda55a798b344fbb5bbccfc85a287340773ca238f3373400cf2488e601ade4
-  data.tar.gz: 779db34b9d23809daec8ba37bee90ba6207869016f29928b52b7e1f1a5a6b687ff644d70c15ed14a86fcc747047d9b7062a87e57ea33fb0ef0589b7fd2bb0fac
+  metadata.gz: 1b770454c98281fded4132b80fd9c3b7e6fc42b9450fa6dbc97d5b6eefd77b98a9c909183cfe05637ce2e7cef3d368d72d5abd06d2dbe690d8b203f527ee0885
+  data.tar.gz: 4b46fbd5003efb1421a0fdc5f99fe0511c0c89ed6ff7a9c8d08822d7cb03bd156cb82e526ea44c1608476f4ad4c5c9fc5ed1b1d918a2f8a4988e8b741c874b19

data/CHANGELOG.md

@@ -5,17 +5,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased][unreleased]
 
-## [5.1.5] = 08-26-2015
+## [5.2.0] - 08-30-2015
 
-### Fixed
-- Fixed errors when trying to call `#{association}_ids=` on an unpersisted node with UUIDs or an array thereof.
-- Removed extra Cypher query to replace relationships when working with unpersisted nodes and `association=`.
-- Bug related to Rails reloading an app and returning nodes without first reinitializing models, resulting in CypherNodes.
-
-## [5.1.4] - 08-24-2015
+### Added
+- `props_for_persistence`, `props_for_create`, `props_for_update` instance methods for all nodes and rels. Each returns a hash with properties appropriate for sending to the database in a Cypher query to create or update an object.
+- Added `record_timestamps` configuration do default all `ActiveNode` and `ActiveRel` models to have `created_at` and `updated_at` timestamps (from #939, thanks @rebecca-eakins)
+- Added `timestamp_type` configuration to specify how timestamps should be stored (from #939, thanks @rebecca-eakins)
 
-### Fixed
-- `AssociationProxy` now responds to `serializable_hash` so that `include` can be used in `render json` in Rails controllers
+### Changed
+- Methods related to basic node and rel persistence (`save`, `create_model`, `_create_node`, others) were refactored to make the processes simpler, clearer, and slightly faster.
+- Unit test directory structure was rearranged to mirror the `lib` directory.
 
 ## [5.1.3] - 08-23-2015
 
@@ -23,6 +22,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - `has_one` associations are now properly cached (like `has_many` associations)
 - `QueryProxy` now responds to `#to_ary`.  Fixes integration with ActiveModelSerializer gem
 
+
 ## [5.1.2] - 08-20-2015
 
 ### Fixed

data/lib/neo4j/active_node/has_n.rb

@@ -79,10 +79,6 @@ module Neo4j::ActiveNode
         target.public_send(method_name, *args, &block)
       end
 
-      def serializable_hash(options = {})
-        to_a.map { |record| record.serializable_hash(options) }
-      end
-
       private
 
       def target_for_missing_method(method_name)

data/lib/neo4j/active_node/labels.rb

@@ -3,7 +3,6 @@ module Neo4j
     # Provides a mapping between neo4j labels and Ruby classes
     module Labels
       extend ActiveSupport::Concern
-      include Neo4j::ActiveNode::Labels::Reloading
 
       WRAPPED_CLASSES = []
       MODELS_FOR_LABELS_CACHE = {}
@@ -76,9 +75,17 @@ module Neo4j
         WRAPPED_CLASSES.clear
       end
 
+      protected
+
       module ClassMethods
         include Neo4j::ActiveNode::QueryMethods
 
+        def before_remove_const
+          associations.each_value(&:queue_model_refresh!)
+          MODELS_FOR_LABELS_CACHE.clear
+          WRAPPED_CLASSES.clear
+        end
+
         # Returns the object with the specified neo4j id.
         # @param [String,Integer] id of node to find
         def find(id)

data/lib/neo4j/active_node/persistence.rb

@@ -23,7 +23,6 @@ module Neo4j::ActiveNode
     # There's a series of callbacks associated with save.
     # If any of the before_* callbacks return false the action is cancelled and save returns false.
     def save(*)
-      update_magic_properties
       cascade_save do
         association_proxy_cache.clear
         create_or_update
@@ -47,25 +46,32 @@ module Neo4j::ActiveNode
     # Creates a model with values matching those of the instance attributes and returns its id.
     # @private
     # @return true
-    def create_model(*)
-      create_magic_properties
-      set_timestamps
-      create_magic_properties
-      properties = self.class.declared_property_manager.convert_properties_to(self, :db, props)
-      node = _create_node(properties)
+    def create_model
+      node = _create_node(props_for_create)
       init_on_load(node, node.props)
       send_props(@relationship_props) if @relationship_props
       @relationship_props = @deferred_nodes = nil
       true
     end
 
-    def _create_node(*args)
-      session = self.class.neo4j_session
-      props = self.class.default_property_values(self)
-      props.merge!(args[0]) if args[0].is_a?(Hash)
-      set_classname(props)
-      labels = self.class.mapped_label_names
-      session.create_node(props, labels)
+    # TODO: This does not seem like it should be the responsibility of the node.
+    # Creates an unwrapped node in the database.
+    # @param [Hash] node_props The type-converted properties to be added to the new node.
+    # @param [Array] labels The labels to use for creating the new node.
+    # @return [Neo4j::Node] A CypherNode or EmbeddedNode
+    def _create_node(node_props, labels = labels_for_create)
+      self.class.neo4j_session.create_node(node_props, labels)
+    end
+
+    def inject_primary_key!(converted_props)
+      self.class.default_property_values(self).tap do |destination_props|
+        destination_props.merge!(converted_props) if converted_props.is_a?(Hash)
+      end
+    end
+
+    # @return [Array] Labels to be set on the node during a create event
+    def labels_for_create
+      self.class.mapped_label_names
     end
 
     private

data/lib/neo4j/active_node/query/query_proxy_methods.rb

@@ -164,7 +164,6 @@ module Neo4j
 
         # Deletes the relationships between all nodes for the last step in the QueryProxy chain.  Executed in the database, callbacks will not be run.
         def delete_all_rels
-          return unless start_object && start_object._persisted_obj
           self.query.delete(rel_var).exec
         end
 

data/lib/neo4j/active_node/unpersisted.rb

@@ -40,10 +40,8 @@ module Neo4j
       end
 
       def save_and_associate_node(association_name, node, operator)
-        if node.respond_to?(:changed?)
-          node.save if node.changed? || !node.persisted?
-          fail "Unable to defer node persistence, could not save #{node.inspect}" unless node.persisted?
-        end
+        node.save if node.changed? || !node.persisted?
+        fail "Unable to defer node persistence, could not save #{node.inspect}" unless node.persisted?
         operator == :<< ? send(association_name).send(operator, node) : send(:"#{association_name}=", node)
       end
     end

data/lib/neo4j/active_node.rb

@@ -55,6 +55,8 @@ module Neo4j
     end
 
     included do
+      include Neo4j::Timestamps if Neo4j::Config.record_timestamps
+
       def self.inherited(other)
         inherit_id_property(other)
         inherited_indexes(other) if self.respond_to?(:indexed_properties)

data/lib/neo4j/active_rel/persistence.rb

@@ -7,13 +7,7 @@ module Neo4j::ActiveRel
     class ModelClassInvalidError < RuntimeError; end
     class RelCreateFailedError < RuntimeError; end
 
-    # Should probably find a way to not need this
-    def association_proxy_cache
-      {}
-    end
-
     def save(*)
-      update_magic_properties
       create_or_update
     end
 
@@ -21,12 +15,9 @@ module Neo4j::ActiveRel
       fail RelInvalidError, self unless save(*args)
     end
 
-    def create_model(*)
+    def create_model
       validate_node_classes!
-      create_magic_properties
-      set_timestamps
-      properties = self.class.declared_property_manager.convert_properties_to(self, :db, props)
-      rel = _create_rel(from_node, to_node, properties)
+      rel = _create_rel(from_node, to_node, props_for_create)
       return self unless rel.respond_to?(:_persisted_obj)
       init_on_load(rel._persisted_obj, from_node, to_node, @rel_type)
       true
@@ -82,8 +73,6 @@ module Neo4j::ActiveRel
     end
 
     def _create_rel(from_node, to_node, props = {})
-      set_classname(props, true)
-
       if from_node.id.nil? || to_node.id.nil?
         fail RelCreateFailedError, "Unable to create relationship (id is nil). from_node: #{from_node}, to_node: #{to_node}"
       end

data/lib/neo4j/active_rel.rb

@@ -44,6 +44,8 @@ module Neo4j
     end
 
     included do
+      include Neo4j::Timestamps if Neo4j::Config.record_timestamps
+
       def self.inherited(other)
         super
       end

data/lib/neo4j/config.rb

@@ -2,19 +2,22 @@ module Neo4j
   # == Keeps configuration for neo4j
   #
   # == Configurations keys
-  #
   class Config
     DEFAULT_FILE = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'config', 'neo4j', 'config.yml'))
     CLASS_NAME_PROPERTY_KEY = 'class_name_property'
 
     class << self
+      # In keeping with the Rails convention, this class writer lets you globally configure
+      # the incluse of timestamps on your nodes and rels. It defaults to false, requiring manual
+      # timestamp inclusion.
+      # @return [Boolean] the true/false value specified.
+      attr_writer :record_timestamps
       # @return [Fixnum] The location of the default configuration file.
       def default_file
         @default_file ||= DEFAULT_FILE
       end
 
       # Sets the location of the configuration YAML file and old deletes configurations.
-      #
       # @param [String] file_path represent the path to the file.
       def default_file=(file_path)
         delete_all
@@ -93,6 +96,12 @@ module Neo4j
         configuration.to_yaml
       end
 
+      # @return [Boolean] The value of the config variable for including
+      # timestamps on all models.
+      def record_timestamps
+        @record_timestamps ||= false
+      end
+
       def class_name_property
         @_class_name_property = Neo4j::Config[CLASS_NAME_PROPERTY_KEY] || :_classname
       end
@@ -106,6 +115,11 @@ module Neo4j
         Neo4j::Config[:module_handling] || :none
       end
 
+      # @return [Class] The configured timestamps type (e.g. Integer) or the default DateTime.
+      def timestamp_type
+        Neo4j::Config[:timestamp_type] || DateTime
+      end
+
       def association_model_namespace
         Neo4j::Config[:association_model_namespace] || nil
       end

data/lib/neo4j/railtie.rb

@@ -5,12 +5,6 @@ module Neo4j
   class Railtie < ::Rails::Railtie
     config.neo4j = ActiveSupport::OrderedOptions.new
 
-    if const_defined?(:ActionDispatch)
-      ActionDispatch::Reloader.to_prepare do
-        Neo4j::ActiveNode::Labels::Reloading.reload_models!
-      end
-    end
-
     # Add ActiveModel translations to the I18n load_path
     initializer 'i18n' do
       config.i18n.load_path += Dir[File.join(File.dirname(__FILE__), '..', '..', '..', 'config', 'locales', '*.{rb,yml}')]

data/lib/neo4j/shared/declared_property.rb

@@ -33,12 +33,16 @@ module Neo4j::Shared
 
     # Tweaks properties
     def register_magic_properties
-      options[:type] ||= DateTime if name.to_sym == :created_at || name.to_sym == :updated_at
+      options[:type] ||= Neo4j::Config.timestamp_type if timestamp_prop?
 
       register_magic_typecaster
       register_type_converter
     end
 
+    def timestamp_prop?
+      name.to_sym == :created_at || name.to_sym == :updated_at
+    end
+
     def register_magic_typecaster
       found_typecaster = Neo4j::Shared::TypeConverters.typecaster_for(options[:type])
       return unless found_typecaster && found_typecaster.respond_to?(:primitive_type)

data/lib/neo4j/shared/persistence.rb

@@ -4,13 +4,38 @@ module Neo4j::Shared
 
     USES_CLASSNAME = []
 
+    # @return [Hash] Given a node's state, will call the appropriate `props_for_{action}` method.
+    def props_for_persistence
+      _persisted_obj ? props_for_update : props_for_create
+    end
+
     def update_model
       return if !changed_attributes || changed_attributes.empty?
+      _persisted_obj.update_props(props_for_update)
+      changed_attributes.clear
+    end
 
+    # Returns a hash containing:
+    # * All properties and values for insertion in the database
+    # * A `uuid` (or equivalent) key and value
+    # * A `_classname` property, if one is to be set
+    # * Timestamps, if the class is set to include them.
+    # Note that the UUID is added to the hash but is not set on the node.
+    # The timestamps, by comparison, are set on the node prior to addition in this hash.
+    # @return [Hash]
+    def props_for_create
+      inject_timestamps!
+      converted_props = props_for_db(props)
+      inject_classname!(converted_props)
+      return converted_props unless self.class.respond_to?(:default_property_values)
+      inject_primary_key!(converted_props)
+    end
+
+    # @return [Hash] Properties and values, type-converted and timestamped for the database.
+    def props_for_update
+      update_magic_properties
       changed_props = attributes.select { |k, _| changed_attributes.include?(k) }
-      changed_props = self.class.declared_property_manager.convert_properties_to(self, :db, changed_props)
-      _persisted_obj.update_props(changed_props)
-      changed_attributes.clear
+      props_for_db(changed_props)
     end
 
     # Convenience method to set attribute and #save at the same time
@@ -115,7 +140,7 @@ module Neo4j::Shared
 
     def reload
       return self if new_record?
-      association_proxy_cache.clear
+      association_proxy_cache.clear if respond_to?(:association_proxy_cache)
       changed_attributes && changed_attributes.clear
       unless reload_from_database
         @_deleted = true
@@ -159,11 +184,12 @@ module Neo4j::Shared
 
     private
 
-    def model_cache_key
-      self.class.model_name.cache_key
+    def props_for_db(props_hash)
+      self.class.declared_property_manager.convert_properties_to(self, :db, props_hash)
     end
 
-    def create_magic_properties
+    def model_cache_key
+      self.class.model_name.cache_key
     end
 
     def update_magic_properties
@@ -171,16 +197,28 @@ module Neo4j::Shared
     end
 
     # Inserts the _classname property into an object's properties during object creation.
-    def set_classname(props, check_version = true)
+    def inject_classname!(props, check_version = true)
       props[:_classname] = self.class.name if self.class.cached_class?(check_version)
     end
 
-    def set_timestamps
+    def set_classname(props, check_version = true)
+      warning = 'This method has been replaced with `inject_classname!` and will be removed in a future version'.freeze
+      ActiveSupport::Deprecation.warn warning, caller
+      inject_classname!(props, check_version)
+    end
+
+    def inject_timestamps!
       now = DateTime.now
       self.created_at ||= now if respond_to?(:created_at=)
       self.updated_at ||= now if respond_to?(:updated_at=)
     end
 
+    def set_timestamps
+      warning = 'This method has been replaced with `inject_timestamps!` and will be removed in a future version'.freeze
+      ActiveSupport::Deprecation.warn warning, caller
+      inject_timestamps!
+    end
+
     module ClassMethods
       # Determines whether a model should insert a _classname property. This can be used to override the automatic matching of returned
       # objects to models.

data/lib/neo4j/timestamps/created.rb

@@ -3,9 +3,7 @@ module Neo4j
     # This mixin includes a created_at timestamp property
     module Created
       extend ActiveSupport::Concern
-      included do
-        property :created_at, type: DateTime
-      end
+      included { property :created_at }
     end
   end
 end

data/lib/neo4j/timestamps/updated.rb

@@ -3,9 +3,7 @@ module Neo4j
     # This mixin includes a updated_at timestamp property
     module Updated
       extend ActiveSupport::Concern
-      included do
-        property :updated_at, type: DateTime
-      end
+      included { property :updated_at }
     end
   end
 end

data/lib/neo4j/version.rb

@@ -1,3 +1,3 @@
 module Neo4j
-  VERSION = '5.1.5'
+  VERSION = '5.2.0'
 end

data/lib/neo4j.rb

@@ -60,7 +60,6 @@ require 'neo4j/active_node/query/query_proxy_enumerable'
 require 'neo4j/active_node/query/query_proxy_find_in_batches'
 require 'neo4j/active_node/query/query_proxy_eager_loading'
 require 'neo4j/active_node/query/query_proxy_link'
-require 'neo4j/active_node/labels/reloading'
 require 'neo4j/active_node/labels'
 require 'neo4j/active_node/id_property/accessor'
 require 'neo4j/active_node/id_property'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: neo4j
 version: !ruby/object:Gem::Version
-  version: 5.1.5
+  version: 5.2.0
 platform: ruby
 authors:
 - Andreas Ronge, Brian Underwood, Chris Grigg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orm_adapter
@@ -236,7 +236,6 @@ files:
 - lib/neo4j/active_node/id_property/accessor.rb
 - lib/neo4j/active_node/initialize.rb
 - lib/neo4j/active_node/labels.rb
-- lib/neo4j/active_node/labels/reloading.rb
 - lib/neo4j/active_node/node_wrapper.rb
 - lib/neo4j/active_node/orm_adapter.rb
 - lib/neo4j/active_node/persistence.rb
@@ -323,7 +322,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: neo4j
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A graph database for Ruby

data/lib/neo4j/active_node/labels/reloading.rb

@@ -1,21 +0,0 @@
-module Neo4j::ActiveNode::Labels
-  module Reloading
-    extend ActiveSupport::Concern
-
-    MODELS_TO_RELOAD = []
-
-    def self.reload_models!
-      MODELS_TO_RELOAD.each(&:constantize)
-      MODELS_TO_RELOAD.clear
-    end
-
-    module ClassMethods
-      def before_remove_const
-        associations.each_value(&:queue_model_refresh!)
-        MODELS_FOR_LABELS_CACHE.clear
-        WRAPPED_CLASSES.each { |c| MODELS_TO_RELOAD << c.name }
-        WRAPPED_CLASSES.clear
-      end
-    end
-  end
-end