rails_age 0.1.0 → 0.2.0

data/lib/apache_age/types/age_type_generator.rb

@@ -0,0 +1,46 @@
+# lib/apache_age/types/age_type_generator.rb
+# Automatically generates ActiveModel::Type classes
+# Dynamically builds this (as a concrete example):
+# module ApacheAge
+#   module Types
+#     class CompanyType < ActiveModel::Type::Value
+#       def cast(value)
+#         case value
+#         when Nodes::Company
+#           value
+#         when Hash
+#           Nodes::Company.new(value)
+#         else
+#           nil
+#         end
+#       end
+#       def serialize(value)
+#         value.is_a?(Nodes::Company) ? value.attributes : nil
+#       end
+#     end
+#   end
+# end
+module ApacheAge
+  module Types
+    class AgeTypeGenerator
+      def self.create_type_for(klass)
+        Class.new(ActiveModel::Type::Value) do
+          define_method(:cast) do |value|
+            case value
+            when klass
+              value
+            when Hash
+              klass.new(value)
+            else
+              nil
+            end
+          end
+
+          define_method(:serialize) do |value|
+            value.is_a?(klass) ? value.attributes : nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apache_age/validators/unique_edge_validator.rb

@@ -0,0 +1,53 @@
+# Usage (within an Age Model)
+# validates_with UniqueEdgeValidator, attributes: [:employee_role, :start_node, :end_node]
+# validates_with UniqueEdgeValidator, attributes: [:start_id, :employee_role, :end_id]
+#
+module ApacheAge
+  module Validators
+    class UniqueEdgeValidator < ActiveModel::Validator
+      def validate(record)
+        allowed_keys = record.age_properties.keys
+        attributes = options[:attributes] || []
+
+        edge_attribs =
+          attributes
+          .map { |attr| [attr, record.send(attr)] }.to_h
+          .symbolize_keys
+          .slice(*allowed_keys)
+
+        possible_end_keys = [:end_id, 'end_id', :end_node, 'end_node']
+        end_query =
+          if possible_end_keys.any? { |key| attributes.include?(key) }
+            end_query = query_node(record.end_node)
+            edge_attribs[:end_id] = end_query&.id
+            end_query
+          end
+
+        possible_start_keys = [:start_id, 'start_id', :start_node, 'start_node']
+        start_query =
+          if possible_start_keys.any? { |key| attributes.include?(key) }
+            start_query = query_node(record.start_node)
+            edge_attribs[:start_id] = start_query&.id
+            start_query
+          end
+        return if attributes.blank? && (end_query.blank? || start_query.blank?)
+
+        query = record.class.find_edge(edge_attribs.compact)
+        return if query.blank? || (query.id == record.id)
+
+        record.errors.add(:base, 'attribute combination not unique')
+        record.errors.add(:end_node, 'attribute combination not unique')
+        record.errors.add(:start_node, 'attribute combination not unique')
+        attributes.each { record.errors.add(_1, 'attribute combination not unique') }
+      end
+
+      private
+
+      def query_node(node)
+        return nil if node.blank?
+
+        node.persisted? ? node.class.find(node.id) : node.class.find_by(node.age_properties)
+      end
+    end
+  end
+end

data/lib/apache_age/validators/unique_vertex_validator.rb

@@ -0,0 +1,28 @@
+# Usage (within an Age Model)
+# validates_with UniqueVertexValidator, attributes: [:first_name, :last_name, :gender]
+
+# lib/apache_age/validators/unique_vertex_validator.rb
+module ApacheAge
+  module Validators
+    class UniqueVertexValidator < ActiveModel::Validator
+      def validate(record)
+        allowed_keys = record.age_properties.keys
+        attributes = options[:attributes]
+        return if attributes.blank?
+
+        record_attribs =
+          attributes
+          .map { |attr| [attr, record.send(attr)] }
+          .to_h.symbolize_keys
+          .slice(*allowed_keys)
+        query = record.class.find_by(record_attribs)
+
+        # if no match is found or if it finds itself, it's valid
+        return if query.blank?  || (query.id == record.id)
+
+        record.errors.add(:base, 'attribute combination not unique')
+        attributes.each { record.errors.add(_1, 'attribute combination not unique') }
+      end
+    end
+  end
+end

data/lib/apache_age/validators/vertex_type_validator.rb

@@ -0,0 +1,14 @@
+module ApacheAge
+  module VertexTypeValidator
+    def vertex_attribute(attribute_name, type_symbol, klass)
+      attribute attribute_name, type_symbol
+
+      validate do
+        value = send(attribute_name)
+        unless value.is_a?(klass)
+          errors.add(attribute_name, "must be a #{klass.name}")
+        end
+      end
+    end
+  end
+end

data/lib/rails_age/version.rb

@@ -1,3 +1,3 @@
 module RailsAge
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rails_age.rb

@@ -1,14 +1,17 @@
-require "rails_age/version"
-require "rails_age/engine"
+require 'rails_age/version'
+require 'rails_age/engine'
 
 module RailsAge
   # Your code goes here...
 end
 
 module ApacheAge
-  require "apache_age/class_methods"
-  require "apache_age/common_methods"
-  require "apache_age/edge"
-  require "apache_age/entity"
-  require "apache_age/vertex"
+  require 'apache_age/entities/class_methods'
+  require 'apache_age/entities/common_methods'
+  require 'apache_age/entities/edge'
+  require 'apache_age/entities/entity'
+  require 'apache_age/entities/vertex'
+  require 'apache_age/types/age_type_generator'
+  require 'apache_age/validators/unique_edge_validator'
+  require 'apache_age/validators/unique_vertex_validator'
 end

data/lib/tasks/install.rake

@@ -0,0 +1,91 @@
+# lib/tasks/install.rake
+# Usage: `rake rails_age:install`
+#
+namespace :rails_age do
+  desc "Copy migrations from rails_age to application and update schema"
+  task :install => :environment do
+    source = File.expand_path('../../../db/migrate', __FILE__)
+    destination = File.expand_path('../../../../db/migrate', __FILE__)
+
+    FileUtils.mkdir_p(destination) unless File.exists?(destination)
+
+    Dir.glob("#{source}/*.rb").each do |file|
+      filename = File.basename(file)
+      destination_file = File.join(destination, filename)
+
+      if File.exists?(destination_file)
+        puts "Skipping #{filename}, it already exists"
+      else
+        FileUtils.cp(file, destination_file)
+        puts "Copied #{filename} to #{destination}"
+      end
+    end
+
+    # Update the schema.rb file
+    schema_file = File.expand_path('../../../../db/schema.rb', __FILE__)
+    if File.exists?(schema_file)
+      content = File.read(schema_file)
+
+      # Add the necessary extensions and configurations at the top of the schema
+      insert_statements = <<-RUBY
+
+  # These are extensions that must be enabled in order to support this database
+  enable_extension "plpgsql"
+
+  # Allow age extension
+  execute('CREATE EXTENSION IF NOT EXISTS age;')
+
+  # Load the age code
+  execute("LOAD 'age';")
+
+  # Load the ag_catalog into the search path
+  execute('SET search_path = ag_catalog, "$user", public;')
+
+  # Create age_schema graph if it doesn't exist
+  execute("SELECT create_graph('age_schema');")
+
+      RUBY
+
+      unless content.include?(insert_statements.strip)
+        content.sub!(/^# These are extensions that must be enabled in order to support this database.*?\n\n/m, insert_statements)
+      end
+
+      # Remove unwanted schema statements
+      content.gsub!(/^.*?create_schema "ag_catalog".*?\n\n/m, '')
+      content.gsub!(/^.*?create_schema "age_schema".*?\n\n/m, '')
+      content.gsub!(/^.*?enable_extension "age".*?\n\n/m, '')
+      content.gsub!(/^.*?# Could not dump table "_ag_label_edge" because of following StandardError.*?\n\n/m, '')
+      content.gsub!(/^.*?# Could not dump table "_ag_label_vertex" because of following StandardError.*?\n\n/m, '')
+      content.gsub!(/^.*?# Could not dump table "ag_graph" because of following StandardError.*?\n\n/m, '')
+      content.gsub!(/^.*?# Could not dump table "ag_label" because of following StandardError.*?\n\n/m, '')
+      content.gsub!(/^.*?add_foreign_key "ag_label", "ag_graph".*?\n\n/m, '')
+
+      File.write(schema_file, content)
+      puts "Updated #{schema_file} with necessary extensions and configurations."
+    else
+      puts "schema.rb file not found. Please ensure migrations have been run."
+    end
+  end
+end
+
+# namespace :rails_age do
+#   desc "Copy migrations from rails_age to application"
+#   task :install => :environment do
+#     source = File.expand_path('../../../db/migrate', __FILE__)
+#     destination = File.expand_path('../../../../db/migrate', __FILE__)
+
+#     FileUtils.mkdir_p(destination) unless File.exists?(destination)
+
+#     Dir.glob("#{source}/*.rb").each do |file|
+#       filename = File.basename(file)
+#       destination_file = File.join(destination, filename)
+
+#       if File.exists?(destination_file)
+#         puts "Skipping #{filename}, it already exists"
+#       else
+#         FileUtils.cp(file, destination_file)
+#         puts "Copied #{filename} to #{destination}"
+#       end
+#     end
+#   end
+# end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_age
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bill Tihen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-21 00:00:00.000000000 Z
+date: 2024-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,29 +16,36 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.3.2
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.3.2
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Apache AGE plugin for Rails 7.1
+        version: '6.0'
+description: This plugin integrates Apache AGE with Rails 7.x, providing tools and
+  helpers for working with graph databases within a Rails application.
 email:
 - btihen@gmail.com
 executables: []
@@ -60,21 +67,26 @@ files:
 - config/routes.rb
 - db/migrate/20240521062349_configure_apache_age.rb
 - db/schema.rb
-- lib/apache_age/class_methods.rb
-- lib/apache_age/common_methods.rb
-- lib/apache_age/edge.rb
-- lib/apache_age/entity.rb
-- lib/apache_age/vertex.rb
+- lib/apache_age/entities/class_methods.rb
+- lib/apache_age/entities/common_methods.rb
+- lib/apache_age/entities/edge.rb
+- lib/apache_age/entities/entity.rb
+- lib/apache_age/entities/vertex.rb
+- lib/apache_age/types/age_type_generator.rb
+- lib/apache_age/validators/unique_edge_validator.rb
+- lib/apache_age/validators/unique_vertex_validator.rb
+- lib/apache_age/validators/vertex_type_validator.rb
 - lib/rails_age.rb
 - lib/rails_age/engine.rb
 - lib/rails_age/version.rb
+- lib/tasks/install.rake
 - lib/tasks/rails_age_tasks.rake
 homepage: https://github.com/marpori/rails_age
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/marpori/rails_age
-  source_code_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: []
@@ -84,15 +96,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
-summary: Apache AGE plugin for Rails 7.1
+summary: Apache AGE plugin for Rails 7.x
 test_files: []

data/lib/apache_age/class_methods.rb

@@ -1,75 +0,0 @@
-module ApacheAge
-  module ClassMethods
-    # for now we only allow one predertimed graph
-    def create(attributes) = new(**attributes).save
-
-    def find_by(attributes)
-      where_clause = attributes.map { |k, v| "find.#{k} = '#{v}'" }.join(' AND ')
-      cypher_sql = find_sql(where_clause)
-      execute_find(cypher_sql)
-    end
-
-    def find(id)
-      where_clause = "id(find) = #{id}"
-      cypher_sql = find_sql(where_clause)
-      execute_find(cypher_sql)
-    end
-
-    def all
-      age_results = ActiveRecord::Base.connection.execute(all_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.except('label', 'properties').merge(hash['properties']).symbolize_keys
-
-        new(**attribs)
-      end
-    end
-
-    # Private stuff
-
-    def age_graph = 'age_schema'
-    def age_label = name.gsub('::', '__')
-    def age_type = name.constantize.new.age_type
-
-    def match_clause
-      age_type == 'vertex' ? "(find:#{age_label})" : "()-[find:#{age_label}]->()"
-    end
-
-    def execute_find(cypher_sql)
-      age_result = ActiveRecord::Base.connection.execute(cypher_sql)
-      return nil if age_result.values.count.zero?
-
-      age_type = age_result.values.first.first.split('::').last
-      json_data = age_result.values.first.first.split('::').first
-
-      hash = JSON.parse(json_data)
-      attribs = hash.except('label', 'properties').merge(hash['properties']).symbolize_keys
-
-      new(**attribs)
-    end
-
-    def all_sql
-      <<-SQL
-      SELECT *
-      FROM cypher('#{age_graph}', $$
-          MATCH #{match_clause}
-          RETURN find
-      $$) as (#{age_label} agtype);
-      SQL
-    end
-
-    def find_sql(where_clause)
-      <<-SQL
-        SELECT *
-        FROM cypher('#{age_graph}', $$
-            MATCH #{match_clause}
-            WHERE #{where_clause}
-            RETURN find
-        $$) as (#{age_label} agtype);
-      SQL
-    end
-  end
-end

data/lib/apache_age/common_methods.rb

@@ -1,126 +0,0 @@
-module ApacheAge
-  module CommonMethods
-    def initialize(**attributes)
-      super
-      return self unless age_type == 'edge'
-
-      self.end_id ||= end_node.id if end_node
-      self.start_id ||= start_node.id if start_node
-      self.end_node ||= Entity.find(end_id) if end_id
-      self.start_node ||= Entity.find(start_id) if start_id
-    end
-
-    # for now we just can just use one schema
-    def age_graph = 'age_schema'
-    def age_label = self.class.name.gsub('::', '__')
-    def persisted? = id.present?
-    def to_s = ":#{age_label} #{properties_to_s}"
-
-    def to_h
-      base_h = attributes.to_hash
-      if age_type == 'edge'
-        # remove the nodes (in attribute form and re-add in hash form)
-        base_h = base_h.except('start_node', 'end_node')
-        base_h[:end_node] = end_node.to_h if end_node
-        base_h[:start_node] = start_node.to_h if start_node
-      end
-      base_h.symbolize_keys
-    end
-
-    def update_attributes(attribs)
-      attribs.except(id:).each do |key, value|
-        send("#{key}=", value) if respond_to?("#{key}=")
-      end
-    end
-
-    def update(attribs)
-      update_attributes(attribs)
-      save
-    end
-
-    def save
-      return false unless valid?
-
-      cypher_sql = (persisted? ? update_sql : create_sql)
-      response_hash = execute_sql(cypher_sql)
-
-      self.id = response_hash['id']
-
-      if age_type == 'edge'
-        self.end_id = response_hash['end_id']
-        self.start_id = response_hash['start_id']
-        # reload the nodes? (can we change the nodes?)
-        # self.end_node = ApacheAge::Entity.find(end_id)
-        # self.start_node = ApacheAge::Entity.find(start_id)
-      end
-
-      self
-    end
-
-    def destroy
-      match_clause = (age_type == 'vertex' ? "(done:#{age_label})" : "()-[done:#{age_label}]->()")
-      delete_clause = (age_type == 'vertex' ? 'DETACH DELETE done' : 'DELETE done')
-      cypher_sql =
-        <<-SQL
-        SELECT *
-        FROM cypher('#{age_graph}', $$
-            MATCH #{match_clause}
-            WHERE id(done) = #{id}
- 	          #{delete_clause}
-            return done
-        $$) as (deleted agtype);
-        SQL
-
-      hash = execute_sql(cypher_sql)
-      return nil if hash.blank?
-
-      self.id = nil
-      self
-    end
-    alias destroy! destroy
-    alias delete destroy
-
-    # private
-
-    def age_properties
-      attrs = attributes.except('id')
-      attrs = attrs.except('end_node', 'start_node', 'end_id', 'start_id') if age_type == 'edge'
-      attrs.symbolize_keys
-    end
-
-    def age_hash
-      hash =
-        {
-          id:,
-          label: age_label,
-          properties: age_properties
-        }
-      hash.merge!(end_id:, start_id:) if age_type == 'edge'
-      hash.transform_keys(&:to_s)
-    end
-
-    def properties_to_s
-      string_values =
-        age_properties.each_with_object([]) do |(key, val), array|
-          array << "#{key}: '#{val}'"
-        end
-      "{#{string_values.join(', ')}}"
-    end
-
-    def age_alias
-      return nil if id.blank?
-
-      # we start the alias with a since we can't start with a number
-      'a' + Digest::SHA256.hexdigest(id.to_s).to_i(16).to_s(36)[0..9]
-    end
-
-    def execute_sql(cypher_sql)
-      age_result = ActiveRecord::Base.connection.execute(cypher_sql)
-      age_type = age_result.values.first.first.split('::').last
-      json_data = age_result.values.first.first.split('::').first
-      # json_data = age_result.to_a.first.values.first.split("::#{age_type}").first
-
-      JSON.parse(json_data)
-    end
-  end
-end

data/lib/apache_age/edge.rb

@@ -1,64 +0,0 @@
-module ApacheAge
-  module Edge
-    extend ActiveSupport::Concern
-
-    included do
-      include ActiveModel::Model
-      include ActiveModel::Dirty
-      include ActiveModel::Attributes
-
-      attribute :id, :integer
-      attribute :end_id, :integer
-      attribute :start_id, :integer
-      attribute :end_node # :vertex
-      attribute :start_node # :vertex
-
-      validates :end_node, :start_node, presence: true
-
-      extend ApacheAge::ClassMethods
-      include ApacheAge::CommonMethods
-    end
-
-    def age_type = 'edge'
-
-    # AgeSchema::Edges::WorksAt.create(
-    #   start_node: fred, end_node: quarry, employee_role: 'Crane Operator'
-    # )
-    # SELECT *
-    # FROM cypher('age_schema', $$
-    #     MATCH (start_vertex:Person), (end_vertex:Company)
-    #     WHERE id(start_vertex) = 1125899906842634 and id(end_vertex) = 844424930131976
-    #     CREATE (start_vertex)-[edge:WorksAt {employee_role: 'Crane Operator'}]->(end_vertex)
-    #     RETURN edge
-    # $$) as (edge agtype);
-    def create_sql
-      self.start_node = start_node.save unless start_node.persisted?
-      self.end_node = end_node.save unless end_node.persisted?
-      <<-SQL
-        SELECT *
-        FROM cypher('#{age_graph}', $$
-            MATCH (from_node:#{start_node.age_label}), (to_node:#{end_node.age_label})
-            WHERE id(from_node) = #{start_node.id} and id(to_node) = #{end_node.id}
-            CREATE (from_node)-[edge#{self}]->(to_node)
-            RETURN edge
-        $$) as (edge agtype);
-      SQL
-    end
-
-    # So far just properties of string type with '' around them
-    def update_sql
-      alias_name = age_alias || age_label.downcase
-      set_caluse =
-        age_properties.map { |k, v| v ? "#{alias_name}.#{k} = '#{v}'" : "#{alias_name}.#{k} = NULL" }.join(', ')
-      <<-SQL
-        SELECT *
-        FROM cypher('#{age_graph}', $$
-            MATCH ()-[#{alias_name}:#{age_label}]->()
-            WHERE id(#{alias_name}) = #{id}
-            SET #{set_caluse}
-            RETURN #{alias_name}
-        $$) as (#{age_label} agtype);
-      SQL
-    end
-  end
-end