rails_age 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8228c60b43732a31b364b658e65b5d6a2e1b76018b573b1ec5b7fa25582f519c
-  data.tar.gz: 60f5211cb37aa6605523f76cde81158b6495448e90d4fbeabecd020c38520c4e
+  metadata.gz: 03e419984be6f29b1da74d0de6e31ccb218ba966e3818537884fcff715024e02
+  data.tar.gz: cb5a30c1e17ee7bf30394691232e3185e317ef5e827ece3ab02ef7d14cb0aef5
 SHA512:
-  metadata.gz: eec16e9c7b4512793b4aac9a3ac1c9ee0ce6280a1033712cc6aed5466218ffa17a47c1fca4d1f4d0508ce38e4a12a9a0c392d927f72a62c5ebcf8d2ea7c343f5
-  data.tar.gz: 3ccdeba21d32bc35de9162698c5c340efce5b0557b5930a3b1e0d9caaf5697f5afcd2b39ad65d0c976b5b3bc46df5edaf18a7bb96e023a2090642b08eb002786
+  metadata.gz: 555b80c544a8d5217d5c40ef3f24c15cd8fbf0c13bf96d1445845d9afc21d5e2ab835a60ac678ba5177fa5562ef1b87d7f293226783c94f1470d8b64e7a56fd9
+  data.tar.gz: 303f2776ebc5320711f50ec54e9a136ba7d9727fcb28c8d0038ffdcb0edb94d6715b93f40598a70d3eb3b8f1405a05610a707458f91209288414f0a4a7251374

data/CHANGELOG.md

@@ -1,23 +1,29 @@
 # Change Log
 
-## VERSION 0.5.0 - 2024-xx-xx
-
-- **AGE Schema override** (instance and class methods) assumes db and migrations up-to-date
+## VERSION 0.5.1 - 2024-xx-xx
 
-- **cypher**
+- **cypher queries** (like active record queries)
   * schema override
   * query support
   * paths support
   * select attributes support
 
-- **Paths**
+## VERSION 0.5.0 - 2024-xx-xx
+
+- **Age Path**
+
+## VERSION 0.4.3 - 2024-xx-xx
+
+- **AGE Schema override**
+
+- **multiple AGE Schema**
 
-## VERSION 0.4.4 - 2024-xx-xx
+## VERSION 0.4.3 - 2024-xx-xx
 
 - **Edge Scaffold** (generates edge, type, view and controller)
   * add `rails generate apache_age:edge_scaffold HasJob employee_role start_node:person end_node:company`
 
-## VERSION 0.4.3 - 2024-xx-xx
+## VERSION 0.4.2 - 2024-xx-xx
 
 - **Node Scaffold** (generates node, type, view and controller)
   * add `rails generate apache_age:node_scaffold Person first_name last_name age:integer`
@@ -29,10 +35,11 @@
   * add `rails generate apache_age:edge HasPet owner_role start_node:person end_node:pet`
         with property and specified start-/end-nodes (person and pet nodes must have already been created)
 
-## VERSION 0.4.1 - 2024-xx-xx
+## VERSION 0.4.1 - 2024-06-15
 
-- **OPTIONAL Installer**
-  * add `config_migrate` to `rails generate apache_age:install` auto fix the schema after `rails db:migrate`
+- **Installer**
+  * add optional: safe migrations with `bin/rails db:migrate` instead of using `bin/rails apache_age:migrate`
+    (install using `bin/rails apache_age:override_db_migrate`)
 
 ## VERSION 0.4.0 - 2024-06-14
 

data/lib/rails_age/version.rb

@@ -1,3 +1,3 @@
 module RailsAge
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/lib/tasks/add_age_migration.rake

@@ -0,0 +1,69 @@
+# lib/tasks/install.rake
+# Usage:
+# * `bin/rails apache_age:add_age_migration`
+# * `bin/rails  apache_age:add_age_migration[destination_path.to_s]`
+# * `bundle exec rails apache_age:add_age_migration.invoke(destination_path.to_s)`
+namespace :apache_age do
+  desc "Copy migrations from rails_age to application and update schema"
+  task :add_age_migration, [:destination_path] => :environment do |t, args|
+
+    base_name = 'add_apache_age'
+    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+/, '') }
+
+    if existing_migrations.any? { |migration| migration.include?(base_name) }
+      puts "Skipping migration AddApacheAge, it already exists"
+    else
+      age_migration_contents =
+        <<~RUBY
+        class AddApacheAge < ActiveRecord::Migration[7.1]
+          def up
+            # 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
+
+          def down
+            execute <<-SQL
+              DO $$
+              BEGIN
+                IF EXISTS (
+                  SELECT 1
+                  FROM pg_constraint
+                  WHERE conname = 'fk_graph_oid'
+                ) THEN
+                  ALTER TABLE ag_catalog.ag_label
+                  DROP CONSTRAINT fk_graph_oid;
+                END IF;
+              END $$;
+            SQL
+
+            execute("SELECT drop_graph('age_schema', true);")
+            execute('DROP SCHEMA IF EXISTS ag_catalog CASCADE;')
+            execute('DROP EXTENSION IF EXISTS age;')
+          end
+        end
+        RUBY
+
+      migration_version = Time.now.utc.strftime("%Y%m%d%H%M%S")
+      file_version = migration_version.delete('_')
+      new_filename = "#{file_version}_#{base_name}.rb"
+      destination_file = File.join(destination_path, new_filename)
+
+      File.write(destination_file, age_migration_contents)
+      puts "Created migration AddApacheAge"
+    end
+  end
+end

data/lib/tasks/install.rake

@@ -4,8 +4,8 @@
 namespace :apache_age do
   desc "Install & configure Apache Age within Rails (updates migrations, schema & database.yml)"
   task :install => :environment do
-    # copy our migrations to the application (if needed)
-    Rake::Task["apache_age:copy_migrations"].invoke
+    # Ensure the AGE migration is in place
+    Rake::Task["apache_age:add_age_migration"].invoke
 
     # run any new migrations
     Rake::Task["db:migrate"].invoke
@@ -18,9 +18,5 @@ namespace :apache_age do
 
     # ensure the config/initializers/types.rb file has the base AGE Types
     Rake::Task["apache_age:config_types"].invoke
-
-    # # ensure bin/rails db:migrate is always followed with
-    # # `Rake::Task["apache_age:config_schema"].invoke` to ensure the schema isn't mangled
-    # Rake::Task["apache_age:config_migrate"].invoke
   end
 end

data/lib/tasks/override_db_migrate.rake

@@ -0,0 +1,50 @@
+namespace :apache_age do
+  desc "Ensure 'db:migrate' is followed by 'apache_age:config_schema' to repair the schema.rb file after migration mangles it."
+  task :override_db_migrate, [:destination_path] => :environment do |t, args|
+    destination_path = (args[:destination_path].presence || "#{Rails.root}") + "/bin"
+    FileUtils.mkdir_p(destination_path) unless File.exist?(destination_path)
+    bin_rails_path = File.expand_path("#{destination_path}/rails", __FILE__)
+
+    original_content = File.read(bin_rails_path)
+    destination_content = original_content.dup
+
+    unless destination_content.include?("#!/usr/bin/env ruby\nrails_cmd = ARGV.first")
+      capture_rails_cmd =
+        <<~RUBY
+        rails_cmd = ARGV.first # must be first (otherwise consumed by rails:commands)
+        RUBY
+
+      # add to the top of the file (with gsub)
+      destination_content.sub!(
+        %r{#!/usr/bin/env ruby\n},
+        "#!/usr/bin/env ruby\n#{capture_rails_cmd}\n"
+      )
+    end
+
+    # Check if the migration hook is already present
+    unless destination_content.include?('Rake::Task["apache_age:config_schema"].invoke')
+      override_migrate =
+        <<~RUBY
+
+        # ensure db:migrate is followed with: `Rake::Task["apache_age:config_schema"].invoke`
+        # to the schema.rb file after the migration mangles it
+        if rails_cmd == 'db:migrate'
+          require 'rake'
+          Rails.application.load_tasks
+          Rake::Task['db:migrate'].invoke
+          Rake::Task["apache_age:config_schema"].invoke
+        end
+        RUBY
+
+      # append to the end of the file
+      destination_content << override_migrate
+    end
+
+    if destination_content == original_content
+      puts "AGE Safe Migration is already present in bin/rails. (If its not working inspect the bin/rails file)"
+    else
+      File.write(bin_rails_path, destination_content)
+      puts "AGE Safe Migration added to bin/rails. Now run `bin/rails db:migrate`, then run your tests (or inspect the schema.rb file)."
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_age
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Bill Tihen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -85,13 +85,13 @@ files:
 - lib/rails_age.rb
 - lib/rails_age/engine.rb
 - lib/rails_age/version.rb
+- lib/tasks/add_age_migration.rake
 - lib/tasks/config_database.rake
-- lib/tasks/config_migrate.rake
 - lib/tasks/config_schema.rake
 - lib/tasks/config_types.rake
-- lib/tasks/copy_migrations.rake
 - lib/tasks/install.rake
 - lib/tasks/migrate.rake
+- lib/tasks/override_db_migrate.rake
 homepage: https://github.com/marpori/rails_age
 licenses:
 - MIT

data/lib/tasks/config_migrate.rake

@@ -1,35 +0,0 @@
-# namespace :apache_age do
-#   desc "Ensure db:migrate is followed by apache_age:config_schema"
-#   task :config_migrate do
-#     bin_rails_path = File.expand_path('../../../bin/rails', __FILE__)
-#     migration_hook =
-# <<-RUBY
-# # ensure db:migrate is followed with: `Rake::Task["apache_age:config_schema"].invoke`
-# # which repairs the schema.rb file after the migration mangles it
-# require_relative '../config/boot'
-# require 'rails/commands'
-
-# if ARGV.first == 'db:migrate'
-#   require 'rake'
-#   Rails.application.load_tasks
-#   Rake::Task['db:migrate'].invoke
-#   Rake::Task["apache_age:config_schema"].invoke
-# else
-#   Rake::Task['rails:commands'].invoke(*ARGV)
-# end
-# RUBY
-
-#    # Read the current content of the bin/rails file
-#    bin_rails_content = File.read(bin_rails_path)
-
-#    # Check if the migration hook is already present
-#    unless bin_rails_content.include?('Rake::Task["apache_age:config_schema"].invoke')
-#      # Append the migration hook to the end of the bin/rails file
-#      File.open(bin_rails_path, 'a') do |file|
-#        file.write(migration_hook)
-#      end
-#      puts "Migration hook added to bin/rails."
-#    else
-#      puts "Migration hook already present in bin/rails."
-#    end
-#  end

data/lib/tasks/copy_migrations.rake

@@ -1,33 +0,0 @@
-# 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