activegraph 10.0.0.pre.alpha.6

data/lib/neo4j/core/driver.rb

@@ -0,0 +1,66 @@
+require 'active_support/core_ext/module/attribute_accessors'
+require 'neo4j/core/logging'
+require 'neo4j/core/has_uri'
+require 'neo4j/version'
+
+module Neo4j
+  module Core
+    class Driver
+      include HasUri
+
+      USER_AGENT_STRING = "neo4j-gem/#{::Neo4j::VERSION} (https://github.com/neo4jrb/neo4j)"
+
+      attr_accessor :wrap_level
+      attr_reader :options, :driver
+      delegate :close, to: :driver
+
+      default_url('bolt://neo4:neo4j@localhost:7687')
+
+      validate_uri do |uri|
+        uri.scheme == 'bolt'
+      end
+
+      class << self
+        def new_instance(url)
+          uri = URI(url)
+          user = uri.user
+          password = uri.password
+          auth_token = if user
+                         Neo4j::Driver::AuthTokens.basic(user, password)
+                       else
+                         Neo4j::Driver::AuthTokens.none
+                       end
+          Neo4j::Driver::GraphDatabase.driver(url, auth_token)
+        end
+      end
+
+      def initialize(url, options = {})
+        self.url = url
+        @driver = self.class.new_instance(url)
+        @options = options
+      end
+
+      def logger
+        return @logger if @logger
+
+        @logger = if @options[:logger]
+                    @options[:logger]
+                  else
+                    Logger.new(logger_location).tap do |logger|
+                      logger.level = logger_level
+                    end
+                  end
+      end
+
+      private
+
+      def logger_location
+        @options[:logger_location] || STDOUT
+      end
+
+      def logger_level
+        @options[:logger_level] || Logger::WARN
+      end
+    end
+  end
+end

data/lib/neo4j/core/has_uri.rb

@@ -0,0 +1,63 @@
+require 'active_support/concern'
+
+module Neo4j
+  module Core
+    # Containing the logic for dealing with adaptors which use URIs
+    module HasUri
+      extend ActiveSupport::Concern
+
+      included do
+        %w[scheme user password host port].each do |method|
+          define_method(method) do
+            (@uri && @uri.send(method)) || (self.class.default_uri && self.class.default_uri.send(method))
+          end
+        end
+      end
+
+      module ClassMethods
+        attr_reader :default_uri
+
+        def default_url(default_url)
+          @default_uri = uri_from_url!(default_url)
+        end
+
+        def validate_uri(&block)
+          @uri_validator = block
+        end
+
+        def uri_from_url!(url)
+          validate_url!(url)
+
+          @uri = url.nil? ? @default_uri : URI(url)
+
+          fail ArgumentError, "Invalid URL: #{url.inspect}" if uri_valid?(@uri)
+
+          @uri
+        end
+
+        private
+
+        def validate_url!(url)
+          fail ArgumentError, "Invalid URL: #{url.inspect}" if !(url.is_a?(String) || url.nil?)
+          fail ArgumentError, 'No URL or default URL specified' if url.nil? && @default_uri.nil?
+        end
+
+        def uri_valid?(uri)
+          @uri_validator && !@uri_validator.call(uri)
+        end
+      end
+
+      def url
+        @uri.to_s
+      end
+
+      def url=(url)
+        @uri = self.class.uri_from_url!(url)
+      end
+
+      def url_without_password
+        @url_without_password ||= "#{scheme}://#{user + ':...@' if user}#{host}:#{port}"
+      end
+    end
+  end
+end

data/lib/neo4j/core/instrumentable.rb

@@ -0,0 +1,36 @@
+require 'active_support/concern'
+require 'active_support/notifications'
+require 'neo4j/ansi'
+
+module Neo4j
+  module Core
+    module Instrumentable
+      extend ActiveSupport::Concern
+
+      EMPTY = ''
+      NEWLINE_W_SPACES = "\n  "
+
+      class_methods do
+        def subscribe_to_request
+          ActiveSupport::Notifications.subscribe('neo4j.core.bolt.request') do |_, start, finish, _id, _payload|
+            ms = (finish - start) * 1000
+            yield " #{ANSI::BLUE}BOLT:#{ANSI::CLEAR} #{ANSI::YELLOW}#{ms.round}ms#{ANSI::CLEAR} #{ActiveBase.current_driver.url_without_password}"
+          end
+        end
+
+        def subscribe_to_query
+          ActiveSupport::Notifications.subscribe('neo4j.core.cypher_query') do |_, _start, _finish, _id, payload|
+            query = payload[:query]
+            params_string = (query.parameters && !query.parameters.empty? ? "| #{query.parameters.inspect}" : EMPTY)
+            cypher = query.pretty_cypher ? (NEWLINE_W_SPACES if query.pretty_cypher.include?("\n")).to_s + query.pretty_cypher.gsub(/\n/, NEWLINE_W_SPACES) : query.cypher
+
+            source_line, line_number = Logging.first_external_path_and_line(caller_locations)
+
+            yield " #{ANSI::CYAN}#{query.context || 'CYPHER'}#{ANSI::CLEAR} #{cypher} #{params_string}" +
+              ("\n   ↳ #{source_line}:#{line_number}" if ActiveBase.current_driver.options[:verbose_query_logs] && source_line).to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/neo4j/core/label.rb

@@ -0,0 +1,158 @@
+module Neo4j
+  module Core
+    class Label
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def create_index(property, options = {})
+        validate_index_options!(options)
+        properties = property.is_a?(Array) ? property.join(',') : property
+        schema_query("CREATE INDEX ON :`#{@name}`(#{properties})")
+      end
+
+      def drop_index(property, options = {})
+        validate_index_options!(options)
+        schema_query("DROP INDEX ON :`#{@name}`(#{property})")
+      end
+
+      # Creates a neo4j constraint on a property
+      # See http://docs.neo4j.org/chunked/stable/query-constraints.html
+      # @example
+      #   label = Neo4j::Label.create(:person, session)
+      #   label.create_constraint(:name, {type: :unique}, session)
+      #
+      def create_constraint(property, constraints)
+        cypher = case constraints[:type]
+                 when :unique, :uniqueness
+                   "CREATE CONSTRAINT ON (n:`#{name}`) ASSERT n.`#{property}` IS UNIQUE"
+                 else
+                   fail "Not supported constraint #{constraints.inspect} for property #{property} (expected :type => :unique)"
+                 end
+        schema_query(cypher)
+      end
+
+      def create_uniqueness_constraint(property, options = {})
+        create_constraint(property, options.merge(type: :unique))
+      end
+
+      # Drops a neo4j constraint on a property
+      # See http://docs.neo4j.org/chunked/stable/query-constraints.html
+      # @example
+      #   label = Neo4j::Label.create(:person, session)
+      #   label.create_constraint(:name, {type: :unique}, session)
+      #   label.drop_constraint(:name, {type: :unique}, session)
+      #
+      def drop_constraint(property, constraint)
+        cypher = case constraint[:type]
+                 when :unique, :uniqueness
+                   "DROP CONSTRAINT ON (n:`#{name}`) ASSERT n.`#{property}` IS UNIQUE"
+                 else
+                   fail "Not supported constraint #{constraint.inspect}"
+                 end
+        schema_query(cypher)
+      end
+
+      def drop_uniqueness_constraint(property, options = {})
+        drop_constraint(property, options.merge(type: :unique))
+      end
+
+      def indexes
+        self.class.indexes.select do |definition|
+          definition[:label] == @name.to_sym
+        end
+      end
+
+      def self.indexes
+        Neo4j::Transaction.indexes
+      end
+
+      def drop_indexes
+        self.class.drop_indexes
+      end
+
+      def self.drop_indexes
+        indexes.each do |definition|
+          begin
+            Neo4j::Transaction.query("DROP INDEX ON :`#{definition[:label]}`(#{definition[:properties][0]})")
+          rescue Neo4j::Server::CypherResponse::ResponseError
+            # This will error on each constraint. Ignore and continue.
+            next
+          end
+        end
+      end
+
+      def index?(property)
+        indexes.any? { |definition| definition[:properties] == [property.to_sym] }
+      end
+
+      def constraints(_options = {})
+        Neo4j::Transaction.constraints.select do |definition|
+          definition[:label] == @name.to_sym
+        end
+      end
+
+      def uniqueness_constraints(_options = {})
+        constraints.select do |definition|
+          definition[:type] == :uniqueness
+        end
+      end
+
+      def drop_uniqueness_constraints
+        self.class.drop_uniqueness_constraints
+      end
+
+      def self.drop_uniqueness_constraints
+        Neo4j::Transaction.constraints.each do |definition|
+          Neo4j::Transaction.query("DROP CONSTRAINT ON (n:`#{definition[:label]}`) ASSERT n.`#{definition[:properties][0]}` IS UNIQUE")
+        end
+      end
+
+      def constraint?(property)
+        constraints.any? { |definition| definition[:properties] == [property.to_sym] }
+      end
+
+      def uniqueness_constraint?(property)
+        uniqueness_constraints.include?([property])
+      end
+
+      def self.wait_for_schema_changes
+        schema_threads.map(&:join)
+        set_schema_threads(session, [])
+      end
+
+      private
+
+      # Store schema threads on the session so that we can easily wait for all
+      # threads on a session regardless of label
+      def schema_threads
+        self.class.schema_threads
+      end
+
+      def schema_threads=(array)
+        self.class.set_schema_threads(array)
+      end
+
+      class << self
+        def schema_threads
+          Neo4j::Transaction.instance_variable_get('@_schema_threads') || []
+        end
+
+        def set_schema_threads(array)
+          Neo4j::Transaction.instance_variable_set('@_schema_threads', array)
+        end
+      end
+
+      def schema_query(cypher)
+        Neo4j::Transaction.transaction { |tx| tx.query(cypher, {}) }
+      end
+
+      def validate_index_options!(options)
+        return unless options[:type] && options[:type] != :exact
+        fail "Type #{options[:type]} is not supported"
+      end
+    end
+  end
+end

data/lib/neo4j/core/logging.rb

@@ -0,0 +1,44 @@
+# Copied largely from activerecord/lib/active_record/log_subscriber.rb
+module Neo4j
+  module Core
+    module Logging
+      class << self
+        def first_external_path_and_line(callstack)
+          line = callstack.find do |frame|
+            frame.absolute_path && !ignored_callstack(frame.absolute_path)
+          end
+
+          offending_line = line || callstack.first
+
+          [offending_line.path,
+           offending_line.lineno]
+        end
+
+        NEO4J_CORE_GEM_ROOT = File.expand_path('../../..', __dir__) + '/'
+
+        def ignored_callstack(path)
+          paths_to_ignore.any?(&path.method(:start_with?))
+        end
+
+        def paths_to_ignore
+          @paths_to_ignore ||= [NEO4J_CORE_GEM_ROOT,
+                                RbConfig::CONFIG['rubylibdir'],
+                                neo4j_gem_path,
+                                active_support_gem_path].compact
+        end
+
+        def neo4j_gem_path
+          return if !defined?(::Rails.root)
+
+          @neo4j_gem_path ||= File.expand_path('../../..', Neo4j::ActiveBase.method(:current_driver).source_location[0])
+        end
+
+        def active_support_gem_path
+          return if !defined?(::ActiveSupport::Notifications)
+
+          @active_support_gem_path ||= File.expand_path('../../..', ActiveSupport::Notifications.method(:subscribe).source_location[0])
+        end
+      end
+    end
+  end
+end

data/lib/neo4j/core/node.rb

@@ -0,0 +1,23 @@
+require 'neo4j/core/wrappable'
+
+module Neo4j
+  module Core
+    module Node
+      def props; properties; end
+      # Perhaps we should deprecate this?
+      def neo_id; id; end
+
+      def ==(other)
+        other.is_a?(Node) && neo_id == other.neo_id
+      end
+
+      def labels
+        @labels ||= super
+      end
+
+      def properties
+        @properties ||= super
+      end
+    end
+  end
+end

data/lib/neo4j/core/querable.rb

@@ -0,0 +1,88 @@
+require 'neo4j/core/instrumentable'
+require 'neo4j/transaction'
+require 'neo4j/core/query_builder'
+require 'neo4j/core/responses'
+
+module Neo4j
+  module Core
+    module Querable
+      extend ActiveSupport::Concern
+      include Instrumentable
+      include Responses
+
+      class_methods do
+        def query(*args)
+          options = case args.size
+                    when 3
+                      args.pop
+                    when 2
+                      args.pop if args[0].is_a?(::Neo4j::Core::Query)
+                    end || {}
+
+          queries(options) { append(*args) }[0]
+        end
+
+        def queries(options = {}, &block)
+          query_builder = QueryBuilder.new
+
+          query_builder.instance_eval(&block)
+
+          new_or_current_transaction(options[:transaction]) do |tx|
+            query_set(tx, query_builder.queries, { commit: !options[:transaction] }.merge(options))
+          end
+        end
+
+# If called without a block, returns a Transaction object
+# which can be used to call query/queries/mark_failed/commit
+# If called with a block, the Transaction object is yielded
+# to the block and `commit` is ensured.  Any uncaught exceptions
+# will mark the transaction as failed first
+        def transaction
+          return Transaction.new unless block_given?
+
+          begin
+            tx = transaction
+
+            yield tx
+          rescue => e
+            tx.mark_failed if tx
+
+            raise e
+          ensure
+            tx.close if tx
+          end
+        end
+
+        def setup_queries!(queries, options = {})
+          return if options[:skip_instrumentation]
+          queries.each do |query|
+            ActiveSupport::Notifications.instrument('neo4j.core.cypher_query', query: query)
+          end
+        end
+
+        def query_set(transaction, queries, options = {})
+          setup_queries!(queries, skip_instrumentation: options[:skip_instrumentation])
+
+          ActiveSupport::Notifications.instrument('neo4j.core.bolt.request') do
+            self.wrap_level = options[:wrap_level]
+            queries.map do |query|
+              result_from_data(transaction.root_tx.run(query.cypher, query.parameters))
+            end
+          rescue Neo4j::Driver::Exceptions::Neo4jException => e
+            raise Neo4j::Core::CypherError.new_from(e.code, e.message) # , e.stack_track.to_a
+          end
+        end
+
+        private
+
+        def new_or_current_transaction(tx, &block)
+          if tx
+            yield(tx)
+          else
+            transaction(&block)
+          end
+        end
+      end
+    end
+  end
+end