rails_age 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 349925c4b715d64987c69a6a20b23e67c9076d91152477a976ade763805fdbf7
-  data.tar.gz: 4c7f1e430fe94ac3cb59eac8e6cb94bc03edab9532074c0df75be233b1210973
+  metadata.gz: 272f8908dc8fb8a98adb443411e4b439eff914c8173b5eb64b53fa5362fa1572
+  data.tar.gz: bf1921611698ffc1b651787f2e1b1a5d1bc503cbe1300639b2f9dada8202cdde
 SHA512:
-  metadata.gz: af26f1a10253235703203804e508aa0d0dfbe7e44cc92097f70111587663c9af75e6cfd730fcb0986dc6093bb9bb16c847ab66ad7d3249057d3fe8adf443c78e
-  data.tar.gz: f98980a1937efeef70c1e548b2f62f5b2a7e2f383f707a92e8392a8f45b1bc9ac882a1f478fff0f24f1fcb3cb145e0f037202356ea4a2e76737ee81f4c70b459
+  metadata.gz: 51592c31e872a9b8dc6e96fe8fa42374241496e4da6a17ce70bf63f5f118ac078e81200259c048529e7e16b2147c8c5bbef00315cee8f26237295d04ffaea887
+  data.tar.gz: 0b24560f7703e4dc4f97d3d36de626906a47a2cda5f5137cc6c1840a5281bbcf2693743666fb6301b26723c9723244bd1854c9c8b21d5d657eb621d4caf0d864

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-## VERSION 0.3.0 - 2024-xx-xx
+## VERSION 0.4.0 - 2024-xx-xx
 
 - **cypher**
   * query support
@@ -9,10 +9,33 @@
 - **Paths**
   * ?
 
+## VERSION 0.3.1 - 2024-xx-xx
+
+- **Generators**
+  * add `rails generate apache_age:node` to create a node model (with its type in initializer)
+  * add `rails generate apache_age:edge` to create an edge model (with its type in initializer)
+- **Installer**
+  * refactor into multiple independent tasks with tests
+- **Documentation**
+  * updated README with additional information
+  * added `db/structure.sql` config to README
+
+## VERSION 0.3.0 - 2024-05-28
+
+- **Edges**
+  * `find_by(start_node:, :end_node:, properties:)` to find an edge with specific nodes & properties (deprecated `find_edge`)
+- **Installer** (`rails generate apache_age:install`)
+  * copy Age PG Extenstion migration to `db/migrate`
+  * run the AGE PG Migration
+  * repair `db/schema.rb` (rails mangles schema after running pg extension)
+  * update `database.yml` with schema search paths
+
+NOTE: the `rails generate apache_age:install` can be run at any time to repair the schema (or other config) file if needed.
+
 ## VERSION 0.2.0 - 2024-05-26
 
 - **Edges**
-  * add class methods to find_edge(with {properties, end_id, start_id})
+  * add class methods to `find_edge` (with {properties, end_id, start_id})
   * add missing methods to use in rails controllers
   * validate edge start- & end-nodes are valid
   * add unique edge validations
@@ -25,13 +48,13 @@
 Initial release has the following features:
 
 - **Nodes:**
-  * Create, Read, Update, Delete & .find(by id), .find_by(age_property), .all
+  * `.create`, `.read`, `.update`, `.delete`, `.all`, `.find(by id)`, `.find_by(age_properties)`
   * verified with usage in a controller and views
 - **Edges:**
-  * Create, Read, Update, Delete & .find(by id), .find_by(age_property), .all
+  *`.create`, `.read`, `.update`, `.delete`, `.all`, `.find(by id)`, `.find_by(age_properties)`
   * verified with usage in a controller and views
 - **Entities:**
-  * find (by id), find_by(age_property), all; when class/label and/or edge/node is unknown)
+  * `.all`, `.find(id)`, `.find_by(age_property)` use these when class, label, edge, node
 
 These can be used within Rails applications using a Rails APIs including within controllers and views.
 See the [README](README.md) for more information.

data/README.md

@@ -12,24 +12,30 @@ Add this line to your application's Gemfile:
 gem "rails_age"
 ```
 
-And then execute:
+### Quick Install
+
+using the installer, creates the migration to install age, runs the migration, and adjusts the schema file, and updates the `config/database.yml` file.
 
 ```bash
 $ bundle
+$ bin/rails apache_age:install
+$ git add .
+$ git commit -m "Add Apache Age to Rails"
 ```
 
-Or install it yourself as:
+NOTE: it is important to commit the `db/schema.rb` to git because `rails db:migrate` inappropriately modifies the schema file (I haven't yet tested `db/structure.sql`).  **You can run `bin/rails apache_age:install` at any time to repair the schema file as needed.**
 
-```bash
-$ gem install rails_age
-```
+For now, if you are using `db/structure.sql` you will need to manually configure Apache Age (RailsAge) as described below.
 
-finally (tempoarily you need to copy and run the migration)
-https://github.com/marpori/rails_age/blob/main/db/migrate/20240521062349_configure_apache_age.rb
+### Manual Install
 
+create a migration to add the Apache Age extension to your database
 ```bash
-# db/migrate/20240521062349_configure_apache_age.rb
-class ConfigureApacheAge < ActiveRecord::Migration[7.1]
+$ bin/rails g migration AddApacheAge
+```
+copy the contents of https://github.com/marpori/rails_age/blob/main/db/migrate/20240521062349_add_apache_age.rb
+```ruby
+class AddApacheAge < ActiveRecord::Migration[7.1]
   def up
     # Allow age extension
     execute('CREATE EXTENSION IF NOT EXISTS age;')
@@ -65,16 +71,48 @@ class ConfigureApacheAge < ActiveRecord::Migration[7.1]
   end
 end
 ```
+into your new migration file
 
-and fix the TOP of `schema.rb` file to match the following (note: the version number should be the same as the LARGEST version number in your `db/migrations` folder)
-https://github.com/marpori/rails_age/blob/main/db/schema.rb
+then run the migration
+```bash
+$ bin/rails db:migrate
+```
 
+Rails migrate will mangle the schema `db/schema.rb` file.  You need to remove the lines that look like:
 ```ruby
-# db/schema.rb
 ActiveRecord::Schema[7.1].define(version: 2024_05_21_062349) do
+  create_schema "ag_catalog"
+  create_schema "age_schema"
+
   # These are extensions that must be enabled in order to support this database
+  enable_extension "age"
   enable_extension "plpgsql"
 
+  # Could not dump table "_ag_label_edge" because of following StandardError
+  #   Unknown type 'graphid' for column 'id'
+
+  # Could not dump table "_ag_label_vertex" because of following StandardError
+  #   Unknown type 'graphid' for column 'id'
+
+  # Could not dump table "ag_graph" because of following StandardError
+  #   Unknown type 'regnamespace' for column 'namespace'
+
+  # Could not dump table "ag_label" because of following StandardError
+  #   Unknown type 'regclass' for column 'relation'
+
+  add_foreign_key "ag_label", "ag_graph", column: "graph", primary_key: "graphid", name: "fk_graph_oid"
+
+  # other migrations
+  # ...
+end
+```
+
+and replace them with the following lines:
+```ruby
+ActiveRecord::Schema[7.1].define(version: 2024_05_21_062349) do
+  # 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;')
 
@@ -92,9 +130,35 @@ ActiveRecord::Schema[7.1].define(version: 2024_05_21_062349) do
 end
 ```
 
+NOTE: if using `db/structure.sql` use:
+```sql
+-- These are extensions that must be enabled in order to support this database
+CREATE EXTENSION IF NOT EXISTS plpgsql WITH SCHEMA public;
+
+-- Allow age extension (if not already enabled), this builds the age_catalog schema
+CREATE EXTENSION IF NOT EXISTS age;
+
+-- Load the age module
+LOAD 'age';
+
+-- Load the ag_catalog into the search path
+SET search_path = ag_catalog, "$user", public;
+
+-- Create age_schema graph if it doesn't exist
+SELECT create_graph('age_schema');
+
+# other migrations
+# ...
+
+INSERT INTO "schema_migrations" (version) VALUES
+('20110315075839'),
+--- ...
+('20240521062349');
+```
+
 ## Contributing
 
-Create an MR and tests and I will review it.
+Create an merge request (with tests) and I will review it/merge it when ready.
 
 ## License
 
@@ -102,9 +166,12 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Usage
 
+I suggest you creat a folder create a folder called `app/nodes` and `app/edges` to keep the code organized.
+I frequently use the `app/graphs` folder to keep all the graph related code together in a Module (as is done in the [rails age demo app](https://github.com/marpori/rails_age_demo_app))
+
 I suggest you creat a folder within app called `graphs` and under that create a folder called `nodes` and `edges`. This will help you keep your code organized.
 
-A full sample app can be found [here](https://github.com/marpori/rails_age_demo_app) the summary usage is described below.
+A trival, but fully functional [rails age demo app](https://github.com/marpori/rails_age_demo_app), based on the Flintstones Commic, is available for reference.
 
 ### Nodes
 
@@ -115,7 +182,12 @@ module Nodes
     include ApacheAge::Entities::Vertex
 
     attribute :company_name, :string
+
     validates :company_name, presence: true
+    validates_with(
+      ApacheAge::Validators::UniqueVertexValidator,
+      attributes: [:company_name]
+    )
   end
 end
 ```
@@ -148,15 +220,30 @@ end
 ### Edges
 
 ```ruby
-# app/graphs/edges/works_at.rb
+# app/graphs/edges/has_job.rb
 module Edges
   class HasJob
     include ApacheAge::Entities::Edge
 
     attribute :employee_role, :string
-    attribute :start_node, :person # if using optional age types
-    # attribute :end_node, :person # if using optional age types
+    attribute :start_node, :person
+    attribute :end_node, :company
+
     validates :employee_role, presence: true
+    validate :validate_unique
+    # or with a one-liner
+    # validates_with(
+    #   ApacheAge::Validators::UniqueEdgeValidator,
+    #   attributes: %i[employee_role start_node end_node]
+    # )
+
+    private
+
+    def validate_unique
+      ApacheAge::Validators::UniqueEdgeValidator
+        .new(attributes: %i[employee_role start_node end_node])
+        .validate(self)
+    end
   end
 end
 ```

data/db/migrate/{20240521062349_configure_apache_age.rb → 20240521062349_add_apache_age.rb}

@@ -1,4 +1,4 @@
-class ConfigureApacheAge < ActiveRecord::Migration[7.1]
+class AddApacheAge < ActiveRecord::Migration[7.1]
   def up
     # Allow age extension
     execute('CREATE EXTENSION IF NOT EXISTS age;')

data/db/schema.rb

@@ -1,6 +1,6 @@
 ActiveRecord::Schema[7.1].define(version: 2024_05_21_062349) do
   # These are extensions that must be enabled in order to support this database
-  enable_extension "plpgsql"
+  enable_extension 'plpgsql'
 
   # Allow age extension
   execute('CREATE EXTENSION IF NOT EXISTS age;')

data/lib/apache_age/entities/class_methods.rb

@@ -8,29 +8,15 @@ module ApacheAge
         instance
       end
 
-      def find_edge(attributes)
-        where_attribs =
-          attributes
-          .compact
-          .except(:end_id, :start_id, :end_node, :start_node)
-          .map { |k, v| "find.#{k} = '#{v}'" }.join(' AND ')
-        where_attribs = where_attribs.empty? ? nil : where_attribs
-
-        end_id = attributes[:end_id] || attributes[:end_node]&.id
-        start_id = attributes[:start_id] || attributes[:start_node]&.id
-        where_end_id = end_id ? "id(end_node) = #{end_id}" : nil
-        where_start_id = start_id ? "id(start_node) = #{start_id}" : nil
-
-        where_clause = [where_attribs, where_start_id, where_end_id].compact.join(' AND ')
-        return nil if where_clause.empty?
+      def find_by(attributes)
+        return nil if attributes.reject{ |k,v| v.blank? }.empty?
 
-        cypher_sql = find_edge_sql(where_clause)
-        execute_find(cypher_sql)
-      end
+        edge_keys = [:start_id, :start_node, :end_id, :end_node]
+        return find_edge(attributes) if edge_keys.any? { |key| attributes.include?(key) }
 
-      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
 
@@ -55,6 +41,27 @@ module ApacheAge
 
       # Private stuff
 
+      def find_edge(attributes)
+        where_attribs =
+          attributes
+          .compact
+          .except(:end_id, :start_id, :end_node, :start_node)
+          .map { |k, v| "find.#{k} = '#{v}'" }.join(' AND ')
+        where_attribs = where_attribs.empty? ? nil : where_attribs
+
+        end_id = attributes[:end_id] || attributes[:end_node]&.id
+        start_id = attributes[:start_id] || attributes[:start_node]&.id
+        where_end_id = end_id ? "id(end_node) = #{end_id}" : nil
+        where_start_id = start_id ? "id(start_node) = #{start_id}" : nil
+
+        where_clause = [where_attribs, where_start_id, where_end_id].compact.join(' AND ')
+        return nil if where_clause.empty?
+
+        cypher_sql = find_edge_sql(where_clause)
+
+        execute_find(cypher_sql)
+      end
+
       def age_graph = 'age_schema'
       def age_label = name.gsub('::', '__')
       def age_type = name.constantize.new.age_type

data/lib/apache_age/validators/unique_edge_validator.rb

@@ -32,7 +32,7 @@ module ApacheAge
           end
         return if attributes.blank? && (end_query.blank? || start_query.blank?)
 
-        query = record.class.find_edge(edge_attribs.compact)
+        query = record.class.find_by(edge_attribs.compact)
         return if query.blank? || (query.id == record.id)
 
         record.errors.add(:base, 'attribute combination not unique')

data/lib/rails_age/version.rb

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

data/lib/tasks/copy_migrations.rake

@@ -0,0 +1,33 @@
+# lib/tasks/install.rake
+# Usage:
+# * `bin/rails apache_age:copy_migrations`
+# * `bundle exec rails apache_age:copy_migrations[destination_path.to_s]`
+# * `bundle exec rails apache_age:copy_migrations.invoke(destination_path.to_s)`
+namespace :apache_age do
+  desc "Copy migrations from rails_age to application and update schema"
+  task :copy_migrations, [:destination_path] => :environment do |t, args|
+    source = File.expand_path('../../../db/migrate', __FILE__)
+    destination_path =
+      File.expand_path(args[:destination_path].presence || "#{Rails.root}/db/migrate", __FILE__)
+
+    FileUtils.mkdir_p(destination_path) unless File.exist?(destination_path)
+    existing_migrations =
+      Dir.glob("#{destination_path}/*.rb").map { |file| File.basename(file).sub(/^\d+/, '') }
+
+    Dir.glob("#{source}/*.rb").each do |file|
+      filename = File.basename(file)
+      test_name = filename.sub(/^\d+/, '')
+
+      if existing_migrations.include?(test_name)
+        puts "Skipping migration: '#{filename}', it already exists"
+      else
+        migration_version = Time.now.utc.strftime("%Y_%m_%d_%H%M%S")
+        file_version = migration_version.delete('_')
+        new_filename = filename.sub(/^\d+/, file_version)
+        destination_file = File.join(destination_path, new_filename)
+        FileUtils.cp(file, destination_file)
+        puts "Created migration: '#{new_filename}'"
+      end
+    end
+  end
+end

data/lib/tasks/database_config.rake

@@ -0,0 +1,99 @@
+# lib/tasks/install.rake
+# Usage: `rake apache_age:copy_migrations`
+#
+namespace :apache_age do
+  desc "Ensure the database.yml file is properly configured for Apache Age"
+  task :database_config => :environment do
+
+    db_config_file = File.expand_path("#{Rails.root}/config/database.yml", __FILE__)
+
+    # Read the file
+    lines = File.readlines(db_config_file)
+
+    # any uncommented "schema_search_path:" lines?
+    path_index = lines.find_index { |line| !line.include?('#') && line.include?('schema_search_path:') }
+    default_start_index = lines.index { |line| line.strip.start_with?('default:') }
+
+    # when it finds an existing schema_search_path, it updates it
+    if path_index && lines[path_index].include?('ag_catalog,age_schema')
+      puts "the schema_search_path in config/database.yml is already properly set, nothing to do."
+    else
+      if path_index
+        key, val = lines[path_index].split(': ')
+        # remove any unwanted characters
+        val = val.gsub(/[ "\s\"\"'\n]/, '')
+        lines[path_index] = "#{key}: ag_catalog,age_schema,#{val}\n"
+        puts "added ag_catalog,age_schema to schema_search_path in config/database.yml"
+      elsif default_start_index
+        puts "the schema_search_path in config/database.yml is now properly set."
+        sections_index = lines.map.with_index { |line, index| index if !line.start_with?(' ') }.compact.sort
+
+        # find the start of the default section
+        next_section_in_list = sections_index.index(default_start_index) + 1
+
+        # find the end of the default section (before the next section starts)
+        path_insert_index = sections_index[next_section_in_list]
+
+        lines.insert(path_insert_index, "  schema_search_path: ag_catalog,age_schema,public\n")
+      else
+        puts "didn't find a default section in database.yml, please add the following line:"
+        puts "  schema_search_path: ag_catalog,age_schema,public"
+        puts "to the apprpriate section of your database.yml"
+      end
+
+      # Write the modified lines back to the file
+      File.open(db_config_file, 'w') { |file| file.write(lines.join) }
+    end
+  end
+end
+
+# # lib/tasks/install.rake
+# # Usage: `rake apache_age:copy_migrations`
+# #
+# namespace :apache_age do
+#   desc "Ensure the database.yml file is properly configured for Apache Age"
+#   task :database_config, [:destination_path] => :environment do |t, args|
+#     destination_path =
+#       File.expand_path(args[:destination_path].presence || "#{Rails.root}/config", __FILE__)
+
+#     db_config_file = File.expand_path("#{destination_path.to_s}/database.yml", __FILE__)
+
+#     # Read the file
+#     lines = File.readlines(db_config_file)
+
+#     # any uncommented "schema_search_path:" lines?
+#     path_index = lines.find_index { |line| !line.include?('#') && line.include?('schema_search_path:') }
+#     default_start_index = lines.index { |line| line.strip.start_with?('default:') }
+
+#     # when it finds an existing schema_search_path, it updates it
+#     if path_index && lines[path_index].include?('ag_catalog,age_schema')
+#       puts "the schema_search_path in config/database.yml is already properly set, nothing to do."
+#     else
+#       if path_index
+#         key, val = lines[path_index].split(': ')
+#         # remove any unwanted characters
+#         val = val.gsub(/[ "\s\"\"'\n]/, '')
+#         lines[path_index] = "#{key}: ag_catalog,age_schema,#{val}\n"
+#         puts "added ag_catalog,age_schema to schema_search_path in config/database.yml"
+#       elsif default_start_index
+#         puts "the schema_search_path in config/database.yml is now properly set."
+#         sections_index = lines.map.with_index { |line, index| index if !line.start_with?(' ') }.compact.sort
+
+#         # find the start of the default section
+#         next_section_in_list = sections_index.index(default_start_index) + 1
+
+#         # find the end of the default section (before the next section starts)
+#         path_insert_index = sections_index[next_section_in_list]
+
+#         lines.insert(path_insert_index, "  schema_search_path: ag_catalog,age_schema,public\n")
+#       else
+#         puts "didn't find a default section in database.yml, please add the following line:"
+#         puts "  schema_search_path: ag_catalog,age_schema,public"
+#         puts "to the apprpriate section of your database.yml"
+#       end
+
+#       # Write the modified lines back to the file
+#       File.open(db_config_file, 'w') { |file| file.write(lines.join) }
+#     end
+#   end
+# end

data/lib/tasks/install.original.rake

@@ -0,0 +1,257 @@
+# lib/tasks/install.rake
+# Usage: `rake apache_age:install`
+#
+namespace :apache_age do
+  desc "Install & configure Apache Age within Rails (updates migrations, schema & database.yml)"
+  task :install_old => :environment do
+    source_schema = File.expand_path('../../../db/schema.rb', __FILE__)
+    destination_schema = File.expand_path("#{Rails.root}/db/schema.rb", __FILE__)
+    source_migrations = File.expand_path('../../../db/migrate', __FILE__)
+    destination_migrations = File.expand_path("#{Rails.root}/db/migrate", __FILE__)
+    # create the migrations folder if needed
+    FileUtils.mkdir_p(destination_migrations) unless File.exist?(destination_migrations)
+    original_migrations =
+      Dir.glob("#{destination_migrations}/*.rb").map { |file| File.basename(file).sub(/^\d+/, '') }
+
+    # # check if the schema is non-existent or blank (NEW) we need to know how to handle schema
+    # is_schema_blank = !File.exist?(destination_schema) || blank_schema?(destination_schema)
+    # puts "Schema is blank: #{is_schema_blank}"
+
+    # ensure we have a schema file
+    unless File.exist?(destination_schema)
+      run_db_create
+      run_db_migrate
+    end
+
+    # copy our migrations to the application (last_migration_version is nil if no migration necessary)
+    # last_migration_version = copy_migrations
+    Rake::Task["apache_age:copy_migrations"].invoke
+
+    updated_migrations =
+      Dir.glob("#{destination_migrations}/*.rb").map { |file| File.basename(file).sub(/^\d+/, '') }
+
+    # # run our new migrations (unless we have not added any new migrations)
+    # if original_migrations == updated_migrations
+    #   puts "no new migrations were copied, skipping migrations"
+    # else
+    #   puts "added Apache Age migrations, running migrations"
+    #   run_db_migrate
+    # end
+    run_db_migrate
+
+    # adjust the schema file (unfortunately rails mangles the schema file)
+    # if is_schema_blank
+    #   puts "creating new schema..."
+    #   create_new_schema(last_migration_version, destination_schema, source_schema)
+    # else
+    #   puts "updating existing schema..."
+    #   update_existing_schema(last_migration_version, destination_schema, source_schema)
+    # end
+    Rake::Task["apache_age:schema_config"].invoke
+
+    # ensure the config/database.yml file has the proper configurations
+    # update_database_yml
+    Rake::Task["apache_age:database_config"].invoke
+  end
+
+  def run_db_create
+    puts "Running db:create..."
+    Rake::Task["db:create"].invoke
+  end
+
+  def run_db_migrate
+    puts "Running db:migrate..."
+    Rake::Task["db:migrate"].invoke
+  end
+
+  def copy_migrations
+    migration_version = nil
+
+    source = File.expand_path('../../../db/migrate', __FILE__)
+    destination = File.expand_path("#{Rails.root}/db/migrate", __FILE__)
+
+    FileUtils.mkdir_p(destination) unless File.exist?(destination)
+    existing_migrations =
+      Dir.glob("#{destination}/*.rb").map { |file| File.basename(file).sub(/^\d+/, '') }
+
+    Dir.glob("#{source}/*.rb").each do |file|
+      filename = File.basename(file)
+      test_name = filename.sub(/^\d+/, '')
+
+      if existing_migrations.include?(test_name)
+        puts "Skipping #{filename}, it already exists"
+      else
+        migration_version = Time.now.utc.strftime("%Y_%m_%d_%H%M%S")
+        file_version = migration_version.delete('_')
+        new_filename = filename.sub(/^\d+/, file_version)
+        destination_file = File.join(destination, new_filename)
+        FileUtils.cp(file, destination_file)
+        puts "Copied #{filename} to #{destination} as #{new_filename}"
+      end
+    end
+    migration_version
+  end
+
+  def blank_schema?(destination_schema)
+    return false unless File.exist?(destination_schema)
+
+    content = File.read(destination_schema)
+    content.include?('define(version: 0)') &&
+      (content.include?("enable_extension 'plpgsql'") || content.include?('enable_extension "plpgsql"')) &&
+      content.scan(/enable_extension/).size == 1
+  end
+
+  def schema_rails_version(destination_schema)
+    if File.exist?(destination_schema)
+      content = File.read(destination_schema)
+      version_match = content.match(/ActiveRecord::Schema\[(.*?)\]/)
+      return version_match[1] if version_match
+    else
+      full_version = Rails.version
+      primary_secondary_version = full_version.split('.')[0..1].join('.')
+      primary_secondary_version
+    end
+  end
+
+  def create_new_schema(last_migration_version, destination_schema, source_schema)
+    if File.exist?(source_schema) && File.exist?(destination_schema)
+      rails_version = schema_rails_version(destination_schema)
+      source_content = File.read(source_schema)
+
+      # ensure we use the Rails version from the destination schema
+      source_content.gsub!(
+        /ActiveRecord::Schema\[\d+\.\d+\]/,
+        "ActiveRecord::Schema[#{rails_version}]"
+      )
+      # ensure we use the last migration version (not the source schema version)
+      source_content.gsub!(
+        /define\(version: \d{4}(?:_\d{2}){2}(?:_\d{6})?\) do/,
+        "define(version: #{last_migration_version}) do"
+      )
+
+      File.write(destination_schema, source_content)
+      puts "Created new schema in #{destination_schema} with necessary extensions and configurations."
+    else
+      puts "local db/schema.rb file not found."
+    end
+  end
+
+  def update_existing_schema(last_migration_version, destination_schema, source_schema)
+    if File.exist?(source_schema) && File.exist?(destination_schema)
+      rails_version = schema_rails_version(destination_schema)
+      source_content = File.read(source_schema)
+      new_content =
+        source_content.gsub(
+          /.*ActiveRecord::Schema\[\d+\.\d+\]\.define\(version: \d{4}(?:_\d{2}){2}(?:_\d{6})?\) do\n|\nend$/,
+          ''
+        )
+
+      destination_content = File.read(destination_schema)
+
+      # Remove unwanted schema statements
+      destination_content.gsub!(%r{^.*?create_schema "ag_catalog".*?\n}, '')
+      destination_content.gsub!(%r{^.*?create_schema "age_schema".*?\n}, '')
+      destination_content.gsub!(%r{^.*?enable_extension "age".*?\n}, '')
+      destination_content.gsub!(%r{^.*?enable_extension "plpgsql".*?\n}, '')
+      destination_content.gsub!(%r{^.*?# Could not dump table "ag_graph" because of following StandardError.*?\n}, '')
+      destination_content.gsub!(%r{^.*?#   Unknown type 'regnamespace' for column 'namespace'.*?\n}, '')
+      destination_content.gsub!(%r{^.*?# Could not dump table "ag_label" because of following StandardError.*?\n}, '')
+      destination_content.gsub!(%r{^.*?#   Unknown type 'regclass' for column 'relation'.*?\n}, '')
+      destination_content.gsub!(%r{^.*?#   Unknown type 'graphid' for column 'id'.*?\n}, '')
+      destination_content.gsub!(
+        %r{^.*?# Could not dump table "_ag_label_edge" because of following StandardError.*?\n}, ''
+      )
+      destination_content.gsub!(
+        %r{^.*?# Could not dump table "_ag_label_vertex" because of following StandardError.*?\n}, ''
+      )
+      destination_content.gsub!(%r{^.*?# Could not dump table "ag_graph" because of following StandardError.*?\n}, '')
+      destination_content.gsub!(%r{^.*?# Could not dump table "ag_label" because of following StandardError.*?\n}, '')
+      destination_content.gsub!(%r{^.*?add_foreign_key "ag_label", "ag_graph".*?\n}, '')
+
+      # add new wanted schema statements (at the top of the schema)
+      unless destination_content.include?(%{execute("LOAD 'age';")}) &&
+             destination_content.include?(%{enable_extension 'plpgsql'}) &&
+             destination_content.include?(%{execute("SELECT create_graph('age_schema');")}) &&
+             destination_content.include?(%{execute('CREATE EXTENSION IF NOT EXISTS age;')}) &&
+             destination_content.include?(%{execute('SET search_path = ag_catalog, "$user", public;')})
+        # if not all are found then remove any found
+        destination_content.gsub!(%r{^.*?execute("LOAD 'age';")*?\n}, '')
+        destination_content.gsub!(%r{^.*?enable_extension 'plpgsql'*?\n}, '')
+        destination_content.gsub!(%r{^.*?execute("SELECT create_graph('age_schema');")*?\n}, '')
+        destination_content.gsub!(%r{^.*?execute('CREATE EXTENSION IF NOT EXISTS age;')*?\n}, '')
+        destination_content.gsub!(%r{^.*?execute('SET search_path = ag_catalog, "$user", public;')*?\n}, '')
+        destination_content.gsub!(%r{^.*?# Allow age extension*?\n}, '')
+        destination_content.gsub!(%r{^.*?# Load the ag_catalog into the search path*?\n}, '')
+        destination_content.gsub!(%r{^.*?# Create age_schema graph if it doesn't exist*?\n}, '')
+        destination_content.gsub!(%r{^.*?# These are extensions that must be enabled in order to support this database*?\n}, '')
+
+        # add all of the correct settings back in
+        destination_content.sub!(
+          %r{(ActiveRecord::Schema\[\d+\.\d+\]\.define\(version: \d{4}(?:_\d{2}){2}(?:_\d{6})?\) do\n)},
+          "\\1#{new_content}\n"
+        )
+          puts 'db/schema.rb has been updated with the necessary configuration.'
+      else
+        puts 'db/schema.rb has the necessary configuration, no adjustments necessary'
+      end
+
+      existing_version = destination_content.match(/define\(version: (\d{4}(?:_\d{2}){2}(?:_\d{6})?)\)/)[1].gsub('_', '')
+      current_version = last_migration_version ? last_migration_version.gsub('_', '') : existing_version
+
+      # ensure we use the last migration version (not the source schema version)
+      if current_version.to_i > existing_version.to_i
+        destination_content.gsub!(
+          /define\(version: \d{4}(?:_\d{2}){2}(?:_\d{6})?\) do/,
+          "define(version: #{last_migration_version}) do"
+        )
+        puts "Updated schema version to the migration version #{last_migration_version}"
+      end
+
+      File.write(destination_schema, destination_content)
+      puts "Updated #{destination_schema} with necessary extensions and configurations."
+    else
+      puts "local db/schema.rb file not found."
+    end
+  end
+
+  def update_database_yml
+    db_config_file = File.expand_path("#{Rails.root}/config/database.yml", __FILE__)
+
+    # Read the file
+    lines = File.readlines(db_config_file)
+
+    # any uncommented "schema_search_path:" lines?
+    path_index = lines.find_index { |line| !line.include?('#') && line.include?('schema_search_path:') }
+    default_start_index = lines.index { |line| line.strip.start_with?('default:') }
+
+    # when it finds an existing schema_search_path, it updates it
+    if path_index && lines[path_index].include?('ag_catalog,age_schema')
+      puts "schema_search_path already set to ag_catalog,age_schema nothing to do."
+      return
+    elsif path_index
+      key, val = lines[path_index].split(': ')
+      # remove any unwanted characters
+      val = val.gsub(/[ "\s\"\"'\n]/, '')
+      lines[path_index] = "#{key}: ag_catalog,age_schema,#{val}\n"
+      puts "add ag_catalog,age_schema to schema_search_path"
+    elsif default_start_index
+      puts "add ag_catalog,age_schema,public to schema_search_path in the default section of database.yml"
+      sections_index = lines.map.with_index { |line, index| index if !line.start_with?(' ') }.compact.sort
+
+      # find the start of the default section
+      next_section_in_list = sections_index.index(default_start_index) + 1
+
+      # find the end of the default section (before the next section starts)
+      path_insert_index = sections_index[next_section_in_list]
+
+      lines.insert(path_insert_index, "  schema_search_path: ag_catalog,age_schema,public\n")
+    else
+      puts "didn't find a default section in database.yml, please add the following line:"
+      puts "  schema_search_path: ag_catalog,age_schema,public"
+      puts "to the apprpriate section of your database.yml"
+    end
+
+    # Write the modified lines back to the file
+    File.open(db_config_file, 'w') { |file| file.write(lines.join) }
+  end
+end

data/lib/tasks/install.rake

@@ -1,91 +1,19 @@
 # lib/tasks/install.rake
-# Usage: `rake rails_age:install`
+# Usage: `rake apache_age:install`
 #
-namespace :rails_age do
-  desc "Copy migrations from rails_age to application and update schema"
+namespace :apache_age do
+  desc "Install & configure Apache Age within Rails (updates migrations, schema & database.yml)"
   task :install => :environment do
-    source = File.expand_path('../../../db/migrate', __FILE__)
-    destination = File.expand_path('../../../../db/migrate', __FILE__)
+    # copy our migrations to the application (if needed)
+    Rake::Task["apache_age:copy_migrations"].invoke
 
-    FileUtils.mkdir_p(destination) unless File.exists?(destination)
+    # run any new migrations
+    Rake::Task["db:migrate"].invoke
 
-    Dir.glob("#{source}/*.rb").each do |file|
-      filename = File.basename(file)
-      destination_file = File.join(destination, filename)
+    # adjust the schema file (unfortunately rails mangles the schema file)
+    Rake::Task["apache_age:schema_config"].invoke
 
-      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
+    # ensure the config/database.yml file has the proper configurations
+    Rake::Task["apache_age:database_config"].invoke
   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

data/lib/tasks/schema_config.rake

@@ -0,0 +1,95 @@
+# lib/tasks/install.rake
+# Usage: `rake apache_age:schema_config`
+#
+namespace :apache_age do
+  desc "Copy migrations from rails_age to application and update schema"
+  task :schema_config => :environment do
+    # source_schema = File.expand_path('../../../db/schema.rb', __FILE__)
+    destination_schema = File.expand_path("#{Rails.root}/db/schema.rb", __FILE__)
+
+    unless File.exist?(destination_schema)
+      puts "local db/schema.rb file not found. please run db:create and db:migrate first"
+    else
+      destination_content = File.read(destination_schema)
+
+      # Remove unwanted schema statements
+      destination_content.gsub!(%r{^.*?create_schema "ag_catalog".*?\n}, '')
+      destination_content.gsub!(%r{^.*?create_schema "age_schema".*?\n}, '')
+      destination_content.gsub!(%r{^.*?enable_extension "age".*?\n}, '')
+      destination_content.gsub!(%r{^.*?enable_extension "plpgsql".*?\n}, '')
+      destination_content.gsub!(%r{^.*?# Could not dump table "ag_graph" because of following StandardError.*?\n}, '')
+      destination_content.gsub!(%r{^.*?#   Unknown type 'regnamespace' for column 'namespace'.*?\n}, '')
+      destination_content.gsub!(%r{^.*?# Could not dump table "ag_label" because of following StandardError.*?\n}, '')
+      destination_content.gsub!(%r{^.*?#   Unknown type 'regclass' for column 'relation'.*?\n}, '')
+      destination_content.gsub!(%r{^.*?#   Unknown type 'graphid' for column 'id'.*?\n}, '')
+      destination_content.gsub!(
+        %r{^.*?# Could not dump table "_ag_label_edge" because of following StandardError.*?\n}, ''
+      )
+      destination_content.gsub!(
+        %r{^.*?# Could not dump table "_ag_label_vertex" because of following StandardError.*?\n}, ''
+      )
+      destination_content.gsub!(%r{^.*?# Could not dump table "ag_graph" because of following StandardError.*?\n}, '')
+      destination_content.gsub!(%r{^.*?# Could not dump table "ag_label" because of following StandardError.*?\n}, '')
+      destination_content.gsub!(%r{^.*?add_foreign_key "ag_label", "ag_graph".*?\n}, '')
+
+      # add necessary contents (as needed)
+      if destination_content.include?(%{execute("LOAD 'age';")}) &&
+              destination_content.include?(%{enable_extension 'plpgsql'}) &&
+              destination_content.include?(%{execute("SELECT create_graph('age_schema');")}) &&
+              destination_content.include?(%{execute('CREATE EXTENSION IF NOT EXISTS age;')}) &&
+              destination_content.include?(%{execute('SET search_path = ag_catalog, "$user", public;')})
+        puts "schema.rb is properly configured, nothing to do"
+      else
+        # if not all are found then remove any found
+        destination_content.gsub!(%r{^.*?execute("LOAD 'age';")*?\n}, '')
+        destination_content.gsub!(%r{^.*?enable_extension 'plpgsql'*?\n}, '')
+        destination_content.gsub!(%r{^.*?execute("SELECT create_graph('age_schema');")*?\n}, '')
+        destination_content.gsub!(%r{^.*?execute('CREATE EXTENSION IF NOT EXISTS age;')*?\n}, '')
+        destination_content.gsub!(%r{^.*?execute('SET search_path = ag_catalog, "$user", public;')*?\n}, '')
+        destination_content.gsub!(%r{^.*?# Allow age extension*?\n}, '')
+        destination_content.gsub!(%r{^.*?# Load the ag_catalog into the search path*?\n}, '')
+        destination_content.gsub!(%r{^.*?# Create age_schema graph if it doesn't exist*?\n}, '')
+        destination_content.gsub!(%r{^.*?# These are extensions that must be enabled in order to support this database*?\n}, '')
+
+        # add all of the correct settings back in
+        # source_content = File.read(source_schema)
+        source_content =
+          <<~RUBY
+          ActiveRecord::Schema[7.1].define(version: 2024_05_21_062349) do
+            # 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');")
+          end
+          RUBY
+
+        age_config_contents =
+          source_content.gsub(
+            /.*ActiveRecord::Schema\[\d+\.\d+\]\.define\(version: \d{4}(?:_\d{2}){2}(?:_\d{6})?\) do\n|\nend$/,
+            ''
+          )
+
+        destination_content.sub!(
+          %r{(ActiveRecord::Schema\[\d+\.\d+\]\.define\(version: \d{4}(?:_\d{2}){2}(?:_\d{6})?\) do\n)},
+          "\\1#{age_config_contents}\n"
+        )
+      end
+
+      # Remove multiple consecutive empty lines
+      destination_content.gsub!(/\n{2,}/, "\n\n")
+
+      File.write(destination_schema, destination_content)
+      puts "The schema '#{destination_schema}' is ready to work with Apache Age."
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_age
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Bill Tihen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-26 00:00:00.000000000 Z
+date: 2024-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,8 +44,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         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.
+description: This plugin integrates Apache AGE for PostgreSQL with Rails 7.x, providing
+  tools and helpers for working with graph databases within a Rails application.
 email:
 - btihen@gmail.com
 executables: []
@@ -65,7 +65,7 @@ files:
 - app/models/rails_age/application_record.rb
 - app/views/layouts/rails_age/application.html.erb
 - config/routes.rb
-- db/migrate/20240521062349_configure_apache_age.rb
+- db/migrate/20240521062349_add_apache_age.rb
 - db/schema.rb
 - lib/apache_age/entities/class_methods.rb
 - lib/apache_age/entities/common_methods.rb
@@ -79,8 +79,11 @@ files:
 - lib/rails_age.rb
 - lib/rails_age/engine.rb
 - lib/rails_age/version.rb
+- lib/tasks/copy_migrations.rake
+- lib/tasks/database_config.rake
+- lib/tasks/install.original.rake
 - lib/tasks/install.rake
-- lib/tasks/rails_age_tasks.rake
+- lib/tasks/schema_config.rake
 homepage: https://github.com/marpori/rails_age
 licenses:
 - MIT

data/lib/tasks/rails_age_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :rails_age do
-#   # Task goes here
-# end