rails_age 0.6.4 → 0.7.0

data/lib/apache_age/node.rb

@@ -12,24 +12,67 @@ module ApacheAge
       info.blank? ? "#{label} (#{id})" : "#{info} (#{label})"
     end
 
-    def self.all
-      all_nodes_sql = <<~SQL
-      SELECT *
-      FROM cypher('age_schema', $$
-          MATCH (node)
-          RETURN node
-      $$) as (node agtype);
-      SQL
-      age_results = ActiveRecord::Base.connection.execute(all_nodes_sql)
-      return [] if age_results.values.count.zero?
-
-      age_results.values.map do |result|
-        json_string = result.first.split('::').first
-        hash = JSON.parse(json_string)
-        attribs = hash.slice('id', 'label').symbolize_keys
-        attribs[:properties] = hash['properties'].symbolize_keys
-
-        new(**attribs)
+    class << self
+      def age_type = 'vertex'
+
+      def ensure_query_builder!
+        @query_builder ||= ApacheAge::Entities::QueryBuilder.new(@node_class || self)
+      end
+
+      def cypher(node_class: nil, graph_name: nil)
+        @node_class = node_class || self
+        @query_builder = ApacheAge::Entities::QueryBuilder.new(@node_class, graph_name:)
+        self
+      end
+
+      def match(match_string)
+        ensure_query_builder!
+        @query_builder.match(match_string)
+        self
+      end
+
+      def where(*args)
+        ensure_query_builder!
+        @query_builder.where(*args)
+        self
+      end
+
+      def order(ordering)
+        ensure_query_builder!
+        @query_builder.order(ordering)
+        self
+      end
+
+      def limit(limit_value)
+        ensure_query_builder!
+        @query_builder.limit(limit_value)
+        self
+      end
+
+      def return(*variables)
+        ensure_query_builder!
+        @query_builder.return(*variables)
+        self
+      end
+
+      def execute
+        ensure_query_builder!
+        @query_builder.execute
+      end
+
+      def first
+        ensure_query_builder!
+        @query_builder.first
+      end
+
+      def all
+        ensure_query_builder!
+        @query_builder.all
+      end
+
+      def to_sql
+        ensure_query_builder!
+        @query_builder.to_sql
       end
     end
   end

data/lib/apache_age/path.rb

@@ -1,4 +1,262 @@
+# Query Paths
+# DSL - When all edges are of the same type
+# - Path.cypher(path_edge: HasChild, path_length: "1..5")
+#     .where(start_node: {first_name: 'Zeke'})
+#     .where('end_node.last_name CONTAINS ?', 'Flintstone')
+#     .limit(3)
+# with full control of the matching paths
+# JUST FATHER LINEAGE (where can't handle edge path properties - not one element and get error:
+# `ERROR:  array index must resolve to an integer value`
+# so instead match as an edge property instead as shown below
+# - Path.cypher(path_edge: HasChild, path_length: "1..5", path_properties: {guardian_role: 'father'})
+#     .where(start_node: {first_name: 'Zeke'})
+#     .where('end_node.last_name =~ ?', 'Flintstone')
+#     .limit(3)
+# - Path
+#     .match('(start_node)-[HasChild*1..5 {guardian_role: 'father'}]->(end_node)')
+#     .where(start_node: {first_name: 'Zeke'})
+#     .where('end_node.last_name =~ ?', 'Flintstone')
+#     .limit(3)
+#
+# # DSL RESULTS:
+# [
+#   [
+#     Person.find(844424930131969), # Zeke Flintstone
+#     Edge.find(1407374883553281),  # HasChild(mother)
+#     Person.find(844424930131971)  # Rockbottom Flintstone
+#   ],
+#   [
+#     Person.find(844424930131969), # Zeke Flintstone
+#     Edge.find(1407374883553281),  # HasChild(mother)
+#     Person.find(844424930131971), # Rockbottom Flintstone
+#     Edge.find(1407374883553284),  # HasChild(falther)
+#     Person.find(844424930131975)  # Giggles Flintstone
+#   ],
+#   [
+#     Person.find(844424930131969), # Zeke Flintstone
+#     Edge.find(1407374883553281),  # HasChild(mother)
+#     Person.find(844424930131971), # Rockbottom Flintstone
+#     Edge.find(1407374883553283),  # HasChild(father)
+#     Person.find(844424930131974)  # Ed Flintstone
+#   ]
+# ]
+# SQL:
+# - SELECT *
+#   FROM cypher('age_schema', $$
+#   MATCH path = (start_node)-[HasChild*1..5]->(end_node)
+#   WHERE start_node.first_name = 'Zeke' AND end_node.last_name CONTAINS 'Flintstone'
+#   RETURN path
+#   LIMIT 3
+#   $$) AS (path agtype);
+#
+# SQL:
+# SELECT *
+#   FROM cypher('age_schema', $$
+#   MATCH path = (start_node)-[HasChild*1..5 {guardian_role: 'father'}]->(end_node)
+#   WHERE start_node.first_name = "Jed" AND end_node.last_name =~ 'Flintstone'
+#   RETURN path
+#   LIMIT 3
+#   $$) AS (path agtype);
+#
+# SQL RESULTS:
+# [
+#   {"id": 844424930131969, "label": "Person", "properties": {"gender": "female", "last_name": "Flintstone", "first_name": "Zeke"}}::vertex,
+#   {"id": 1407374883553281, "label": "HasChild", "end_id": 844424930131971, "start_id": 844424930131969, "properties": {"guardian_role": "mother"}}::edge,
+#   {"id": 844424930131971, "label": "Person", "properties": {"gender": "male", "last_name": "Flintstone", "first_name": "Rockbottom"}}::vertex
+# ]::path
+# [
+#   {"id": 844424930131969, "label": "Person", "properties": {"gender": "female", "last_name": "Flintstone", "first_name": "Zeke"}}::vertex,
+#   {"id": 1407374883553281, "label": "HasChild", "end_id": 844424930131971, "start_id": 844424930131969, "properties": {"guardian_role": "mother"}}::edge,
+#   {"id": 844424930131971, "label": "Person", "properties": {"gender": "male", "last_name": "Flintstone", "first_name": "Rockbottom"}}::vertex,
+#   {"id": 1407374883553284, "label": "HasChild", "end_id": 844424930131975, "start_id": 844424930131971, "properties": {"guardian_role": "father"}}::edge,
+#   {"id": 844424930131975, "label": "Person", "properties": {"gender": "male", "last_name": "Flintstone", "first_name": "Giggles"}}::vertex
+# ]::path
+# [
+#   {"id": 844424930131969, "label": "Person", "properties": {"gender": "female", "last_name": "Flintstone", "first_name": "Zeke"}}::vertex,
+#   {"id": 1407374883553281, "label": "HasChild", "end_id": 844424930131971, "start_id": 844424930131969, "properties": {"guardian_role": "mother"}}::edge,
+#   {"id": 844424930131971, "label": "Person", "properties": {"gender": "male", "last_name": "Flintstone", "first_name": "Rockbottom"}}::vertex, {"id": 1407374883553283, "label": "HasChild", "end_id": 844424930131974, "start_id": 844424930131971, "properties": {"guardian_role": "father"}}::edge,
+#   {"id": 844424930131974, "label": "Person", "properties": {"gender": "male", "last_name": "Flintstone", "first_name": "Ed"}}::vertex
+# ]::path
+# (3 rows)
+
 module ApacheAge
   class Path
+    include ApacheAge::Entities::Path
+
+    attr_reader :query_builder, :path_edge, :path_length, :path_properties, :start_node_filter, :end_node_filter
+
+    class << self
+      def age_type = 'path'
+
+      # Convert a path result or collection of path results to hashes
+      # This handles both a single path (array of nodes/edges) and multiple paths
+      def path_to_h(path_result)
+        if path_result.first.is_a?(Array)
+          # It's a collection of paths
+          path_result.map { |path| path.map(&:to_h) }
+        else
+          # It's a single path
+          path_result.map(&:to_h)
+        end
+      end
+
+      # Convert a path result to rich hashes with additional context information
+      # This handles both a single path (array of nodes/edges) and multiple paths
+      def path_to_rich_h(path_result)
+        if path_result.first.is_a?(Array)
+          # It's a collection of paths
+          path_result.map { |path| path.map(&:to_rich_h) }
+        else
+          # It's a single path
+          path_result.map(&:to_rich_h)
+        end
+      end
+
+      def ensure_query_builder!
+        @query_builder ||= ApacheAge::Entities::QueryBuilder.new(self)
+      end
+
+      def cypher(path_edge: nil, path_length: nil, path_properties: {}, start_node_filter: nil, end_node_filter: nil, graph_name: nil)
+        unless path_edge.nil? || path_edge.ancestors.include?(ApacheAge::Entities::Edge)
+          raise ArgumentError, 'Path edge must be a valid edge class'
+        end
+
+        @path_edge = path_edge ? path_edge.name.gsub('::', '__') : nil
+        @path_length = path_length ? "*#{path_length}" : "*"
+        @path_properties = path_properties.blank? ? nil : " {#{path_properties.map { |k, v| "#{k}: '#{v}'" }.join(', ')}}"
+
+        # Format node filters for the match clause if provided
+        start_filter = format_node_filter(start_node_filter)
+        end_filter = format_node_filter(end_node_filter)
+
+        @has_edge_ordering = false
+        @match_clause = "path = (start_node#{start_filter})-[#{@path_edge}#{@path_length}#{@path_properties}]->(end_node#{end_filter})"
+        @query_builder =
+          ApacheAge::Entities::QueryBuilder.new(
+            self,
+            graph_name:,
+            return_clause: 'path',
+            match_clause: @match_clause
+          )
+        self
+      end
+
+      def match_clause
+        # Use the edge variable if we're ordering by edge properties
+        if @has_edge_ordering
+          "path = (start_node)-[edge:#{@path_edge}#{@path_length}#{@path_properties}]->(end_node)"
+        else
+          "path = (start_node)-[#{@path_edge}#{@path_length}#{@path_properties}]->(end_node)"
+        end
+      end
+
+      def match(match_string)
+        ensure_query_builder!
+        @query_builder.match(match_string)
+        self
+      end
+
+      # Delegate additional methods like `where`, `limit`, etc., to `QueryBuilder`
+      def where(*args)
+        ensure_query_builder!
+        @query_builder.where(*args)
+        self
+      end
+
+      # order is important to put last (but before limit)
+      # Path.cypher(...).where(...).order("start_node.first_name ASC").limit(5)
+      def order(ordering)
+        ensure_query_builder!
+
+        # Check if we're ordering by edge properties
+        if ordering.is_a?(Hash) && ordering.key?(:edge)
+          # Update match clause to include edge variable
+          @match_clause = "path = (start_node)-[edge:#{@path_edge}#{@path_length}#{@path_properties}]->(end_node)"
+          @query_builder.match_clause = @match_clause
+        end
+
+        @query_builder.order(ordering)
+        self
+      end
+
+      def limit(limit_value)
+        ensure_query_builder!
+        @query_builder.limit(limit_value)
+        self
+      end
+
+      def return(*variables)
+        ensure_query_builder!
+        @query_builder.return(*variables)
+        self
+      end
+
+      # Executes the query and returns results
+      def execute
+        ensure_query_builder!
+        @query_builder.execute
+      end
+
+      def first
+        ensure_query_builder!
+        @query_builder.first
+      end
+
+      def all
+        ensure_query_builder!
+        @query_builder.all
+      end
+
+      # Build the final SQL query
+      def to_sql
+        ensure_query_builder!
+        @query_builder.to_sql
+      end
+
+      private
+
+      # Format node filter hash into Cypher node property syntax {key: 'value', ...}
+      # Returns a properly formatted string for insertion into a MATCH clause
+      def format_node_filter(filter)
+        return '' if filter.nil? || !filter.is_a?(Hash) || filter.empty?
+
+        properties = filter.map do |key, value|
+          formatted_value = value.is_a?(String) ? "'#{value}'" : value
+          "#{key}: #{formatted_value}"
+        end.join(', ')
+
+        " {#{properties}}"
+      end
+
+      # PathResult is a custom Array subclass that adds to_rich_h convenience method
+      class PathResult < Array
+        def to_rich_h
+          map(&:to_rich_h)
+        end
+      end
+
+      # private
+
+      def execute_where(cypher_sql)
+        age_results = ActiveRecord::Base.connection.execute(cypher_sql)
+        return [] if age_results.values.count.zero?
+
+        age_results.values.map do |row|
+          path_data = row.first.split('::path').first
+          # [1..-2] - removes leading and trailing brackets
+          elements = path_data[1..-2].split(/(?<=\}::vertex,)|(?<=\}::edge,)/)
+          # elements.map do |element|
+          path_elements = elements.map do |element|
+            path_hash = JSON.parse(element.sub("::vertex,", "").sub("::vertex", "").sub("::edge,", "").sub("::edge", "").strip)
+            path_klass = path_hash['label'].gsub('__', '::').constantize
+            path_attribs = path_hash.except('label', 'properties').merge(path_hash['properties']).symbolize_keys
+            path_klass.new(**path_attribs)
+          end
+          
+          # Wrap the result in our custom PathResult class
+          PathResult.new(path_elements)
+        end
+      end
+    end
   end
 end

data/lib/rails_age/version.rb

@@ -1,3 +1,3 @@
 module RailsAge
-  VERSION = '0.6.4'
+  VERSION = '0.7.0'
 end

data/lib/rails_age.rb

@@ -13,10 +13,10 @@ module ApacheAge
   require 'apache_age/entities/entity'
   require 'apache_age/entities/node'
   require 'apache_age/entities/edge'
-  # require 'apache_age/entities/path'
+  require 'apache_age/entities/path'
   require 'apache_age/node'
   require 'apache_age/edge'
-  # require 'apache_age/path'
+  require 'apache_age/path'
   require 'apache_age/validators/expected_node_type'
   require 'apache_age/validators/unique_node'
   require 'apache_age/validators/unique_edge'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_age
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - Bill Tihen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -171,7 +170,6 @@ metadata:
   homepage_uri: https://github.com/marpori/rails_age
   source_code_uri: https://github.com/marpori/rails_age/blob/main
   changelog_uri: https://github.com/marpori/rails_age/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,8 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Apache AGE plugin for Rails 7.x
 test_files: []