rails_age 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8228c60b43732a31b364b658e65b5d6a2e1b76018b573b1ec5b7fa25582f519c
-  data.tar.gz: 60f5211cb37aa6605523f76cde81158b6495448e90d4fbeabecd020c38520c4e
+  metadata.gz: ccc1964e751ea0670eeab5cc406f1d73d0ac4a188c3f0c97ff410cf0a12aa664
+  data.tar.gz: 9de0e59661db92464c6505c9dc3d6a2eb314f35333eeb4f97d92d2f4b628275b
 SHA512:
-  metadata.gz: eec16e9c7b4512793b4aac9a3ac1c9ee0ce6280a1033712cc6aed5466218ffa17a47c1fca4d1f4d0508ce38e4a12a9a0c392d927f72a62c5ebcf8d2ea7c343f5
-  data.tar.gz: 3ccdeba21d32bc35de9162698c5c340efce5b0557b5930a3b1e0d9caaf5697f5afcd2b39ad65d0c976b5b3bc46df5edaf18a7bb96e023a2090642b08eb002786
+  metadata.gz: 15179f421eaa5fcf6180af0fd7865b1c69884064a2030b7f03300898eeda08d7bb2f871c43ec3b5ad1ae49db98b30cf274c582e3906fd66fe24b68812fb78b9a
+  data.tar.gz: 1a83d773effad75f2e90f89ee06f8585fa5a9fe40104df7913b0e0470d3026b7cc160ecb8e3ce3e2f2fcf7c1831a902fb61b1140974cc5f792d15e43ee3de4f1

data/CHANGELOG.md

@@ -1,42 +1,59 @@
 # Change Log
 
-## VERSION 0.5.0 - 2024-xx-xx
+## VERSION 0.6.2 - 2024-xx-xx
 
-- **AGE Schema override** (instance and class methods) assumes db and migrations up-to-date
-
-- **cypher**
+- **cypher queries** (like active record queries)
   * schema override
   * query support
   * paths support
   * select attributes support
 
-- **Paths**
+## VERSION 0.6.1 - 2024-xx-xx
+
+- **Age Path**
+
+## VERSION 0.6.0 - 2024-xx-xx
+
+breaking change?: namespaces (by default) will use their own schema? (add to database.yml & schema.rb ?)
+
+- **AGE Schema override**
+
+- **multiple AGE Schema**
 
-## VERSION 0.4.4 - 2024-xx-xx
+## VERSION 0.5.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.5.2 - 2024-xx-xx
+
+- **Edge Generator**
+  * add start-/end-nodes types to edge generator (would make scaffold easier), ie:
+    `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.5.1 - 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`
 
-## VERSION 0.4.2 - 2024-xx-xx
+## VERSION 0.5.0 - 2024-06-15
+
+**breaking change**: renamed the validators to UniqueVertex and UniqueEdge
 
 - **Edge Generator**
-  * add `rails generate apache_age:edge HasPet owner_role` just a property
-  * 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)
+  * add `rails generate apache_age:edge HasPet owner_role`
+    caveate: start_node and end_node are of type `:vertex` in the generator but can be changed manually in the class file - having trouble with the generator loading the types (the generator rejects custom types - but rails still works with custom types)
 
-## 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
 
-Minor breaking change: type (:vertix) is now required in core for edges
+**breaking change**: type (:vertix) is now required in core for edges
 
 - **Installer**
   * AGE types added to installer (with tests)

data/README.md

@@ -55,8 +55,11 @@ install Apache Age (you can ignore the `unknown OID` warnings)
 bundle add rails_age
 bundle install
 bin/rails apache_age:install
+# optional: prevents `bin/rails db:migrate` from modifying the schema file,
+# alternatively you can use: `bin/rails apache_age:migrate` to run safe migrations
+bin/rails apache_age:override_db_migrate
 git add .
-git commit -m "Add Apache Age to Rails"
+git commit -m "Add & configure Apache Age within Rails"
 ```
 
 make some nodes :string is the default type
@@ -69,10 +72,10 @@ make some edges (`:vertex` is the default type) for start_node and end_node
 ```bash
 # when start node and end node are not specified they are of type `:vertex`
 # this is generally not recommended - exept when very generic relationships are needed
-rails generate apache_age:edge HasJob employee_role
+rails generate apache_age:edge HasJob employee_role begin_date:date
 
-# this is recommended - use explicit start_node and end_node types
-rails generate apache_age:node HasPet start_node:person end_node:pet caretaker_role
+# # this is recommended - (but not yet working) add explicit start_node and end_node types manually
+# rails generate apache_age:node HasPet start_node:person end_node:pet caretaker_role
 ```
 
 **NOTE:** the default `rails db:migrate` inappropriately modifies the schema file. This installer patches the migration to prevent this (however this might break on rails updates, etc). **You can run `bin/rails apache_age:install` at any time to repair the schema file as needed.**

data/lib/apache_age/validators/{unique_edge_validator.rb → unique_edge.rb}

@@ -1,10 +1,14 @@
+# lib/apache_age/validators/unique_edge.rb
+
 # 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]
-#
+# validates_with(
+#   ApacheAge::Validators::UniqueEdge,
+#   attributes: [:start_id, :employee_role, :end_id]
+# )
+
 module ApacheAge
   module Validators
-    class UniqueEdgeValidator < ActiveModel::Validator
+    class UniqueEdge < ActiveModel::Validator
       def validate(record)
         allowed_keys = record.age_properties.keys
         attributes = options[:attributes] || []

data/lib/apache_age/validators/{unique_vertex_validator.rb → unique_vertex.rb}

@@ -1,10 +1,14 @@
+# lib/apache_age/validators/unique_vertex.rb
+
 # Usage (within an Age Model)
-# validates_with UniqueVertexValidator, attributes: [:first_name, :last_name, :gender]
+# validates_with(
+#   ApacheAge::Validators::UniqueVertex,
+#   attributes: [:first_name, :last_name, :gender]
+# )
 
-# lib/apache_age/validators/unique_vertex_validator.rb
 module ApacheAge
   module Validators
-    class UniqueVertexValidator < ActiveModel::Validator
+    class UniqueVertex < ActiveModel::Validator
       def validate(record)
         allowed_keys = record.age_properties.keys
         attributes = options[:attributes]

data/lib/generators/apache_age/edge/USAGE

@@ -1,35 +1,38 @@
 Description:
-    This creates Apache AGE nodes that work seamlessly with Rails.
-    A node can be created with or without a namespace.
+    This creates Apache AGE edges that work seamlessly with Rails.
+    An edge can be created with or without a namespace.
     See the below examples.
 
 Example:
-    `bin/rails g apache_age:node Cat name age:integer`
+    `bin/rails g apache_age:edge HasJob employee_role start_date:date`
+
+    (hopefully comming soon - but not yet ready is the ability to add start_node and end_node types)
+    `bin/rails g apache_age:edge HasJob employee_role start_date:date start_node:person end_node:company`
 
     This creates:
-        `app/nodes/cat.rb`
+        `app/edges/has_job.rb`
 
     with the contents:
         ```
-        class Cat
-          include ApacheAge::Entities::Vertex
+        class HasJob
+          include ApacheAge::Entities::Edge
 
-          attribute :name, :string
-          attribute :age, :integer
+          attribute :employee_role, :string
+          attribute :start_date, :date
 
-          validates :name, presence: true
-          validates :age, presence: true
+          validates :employee_role, presence: true
+          validates :begin_date, presence: true
 
           # unique node validator (remove any attributes that are not important to uniqueness)
           validates_with(
-            ApacheAge::Validators::UniqueVertexValidator,
-            attributes: [:name, :age]
+            ApacheAge::Validators::UniqueVertex,
+            attributes: [:employee_role, :begin_date :start_node, :end_node]
           )
         end
         ```
 
     A namespace can also be used:
-        `bin/rails g apache_age:node Animals/Cat name age:integer`
+        `bin/rails g apache_age:edge Animals/Cat name age:integer`
 
     This creates:
         `app/nodes/animals/cat.rb`
@@ -47,8 +50,8 @@ Example:
 
           # unique node validator (remove any attributes that are not important to uniqueness)
           validates_with(
-            ApacheAge::Validators::UniqueVertexValidator,
-            attributes: [:name, :age]
+            ApacheAge::Validators::UniqueVertex,
+            attributes: [:name, :age, :start_node, :end_node]
           )
         end
         ```

data/lib/generators/apache_age/edge/edge_generator.rb

@@ -1,56 +1,27 @@
+# lib/generators/apache_age/edge/edge_generator.rb
 require 'rails/generators'
 require 'rails/generators/named_base'
 
+require_relative '../generate_entity_methods'
+# TODO: get generators to work with custom types!
+# require_relative "#{Rails.root}/config/initializers/types"
+
 module ApacheAge
   class EdgeGenerator < Rails::Generators::NamedBase
+    include ApacheAge::GenerateEntityMethods
+
     source_root File.expand_path('templates', __dir__)
     argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
     def perform_task
-      behavior == :invoke ? create_edge_file : destroy_edge_file
+      age_type = 'edge'
+      Rails.application.eager_load! # Ensure all initializers and dependencies are loaded
+      behavior == :invoke ? generate_age_entity(age_type) : destroy_age_entity(age_type)
     end
 
     private
 
-    def create_edge_file
-      template "edge.rb.tt", File.join("app/edge", class_path, "#{file_name}.rb")
-    end
-
-    def destroy_edge_file
-      file_path = File.join("app/edge", class_path, "#{file_name}.rb")
-      File.delete(file_path) if File.exist?(file_path)
-    end
-
-    def attributes_list
-      attributes.map { |attr| { name: attr.name, type: attr.type } }
-    end
-
-    def unique_attributes
-      attributes_list.map { |attr| attr[:name].to_sym }
-    end
-
-    def parent_module
-      class_path.map(&:camelize).join('::')
-    end
-
-    def full_class_name
-      parent_module.empty? ? class_name : "#{parent_module}::#{class_name}"
-    end
-
-    def indented_namespace
-      return '' if parent_module.empty?
-
-      parent_module.split('::').map.with_index do |namespace, index|
-        "#{'  ' * index}module #{namespace}"
-      end.join("\n") + "\n"
-    end
-
-    def indented_end_namespace
-      return '' if parent_module.empty?
-
-      parent_module.split('::').map.with_index do |_, index|
-        "#{'  ' * (parent_module.split('::').length - 1 - index)}end"
-      end.join("\n") + "\n"
-    end
+    # different than node_generator.rb
+    def unique_edge_attributes = unique_attributes + [:start_node, :end_node]
   end
 end

data/lib/generators/apache_age/edge/templates/edge.rb.tt

@@ -1,20 +1,28 @@
-<%= indented_namespace %>
-<%= '  ' * class_path.length %>class <%= class_name %>
-<%= '  ' * class_path.length %>  include ApacheAge::Entities::Edge
+class <%= class_name %>
+  include ApacheAge::Entities::Edge
 
 <%- attributes_list.each do |attribute| -%>
-<%= '  ' * class_path.length %>  attribute :<%= attribute[:name] %>, :<%= attribute[:reference] || attribute[:type] %>
+  attribute :<%= attribute[:name] %>, :<%= attribute[:reference] || attribute[:type] %>
 <%- end -%>
+  # recommendation for (start_node and end_node): change `:vertex` with the 'node' type
+  # see `config/initializers/apache_age.rb` for the list of available node types
+  attribute :start_node, :vertex
+  attribute :end_node, :vertex
 
-<%= '  ' * class_path.length %>  validates :<%= unique_attributes.first %>, presence: true
-<%= '  ' * class_path.length %>  validate :validate_unique
+<%- attributes_list.each do |attribute| -%>
+  validates :<%= attribute[:name] %>, presence: true
+<%- end -%>
+  validates :start_node, presence: true
+  validates :end_node, presence: true
+
+  validate :validate_unique_edge
 
-<%= '  ' * class_path.length %>  private
+  private
 
-<%= '  ' * class_path.length %>  def validate_unique
-<%= '  ' * class_path.length %>    ApacheAge::Validators::UniqueEdgeValidator
-<%= '  ' * class_path.length %>      .new(attributes: <%= unique_attributes.inspect %>)
-<%= '  ' * class_path.length %>      .validate(self)
-<%= '  ' * class_path.length %>  end
-<%= '  ' * class_path.length %>end
-<%= indented_end_namespace %>
+  # custom unique edge validator (remove any attributes that are NOT important to uniqueness)
+  def validate_unique_edge
+    ApacheAge::Validators::UniqueEdge
+      .new(attributes: <%= unique_edge_attributes.inspect %>)
+      .validate(self)
+  end
+end

data/lib/generators/apache_age/generate_entity_methods.rb

@@ -0,0 +1,84 @@
+# lib/generators/apache_age/generate_entity_methods.rb
+
+module ApacheAge
+  module GenerateEntityMethods
+    def generate_age_entity(age_type)
+      template "#{age_type}.rb.tt", File.join(destination_root, "app/#{age_type}s", class_path, "#{file_name}.rb")
+      add_type_config
+    end
+
+    def destroy_age_entity(age_type)
+      file_path = File.join(destination_root, "app/#{age_type}s", class_path, "#{file_name}.rb")
+      File.delete(file_path) if File.exist?(file_path)
+      remove_type_config
+    end
+
+    def attributes_list
+      attributes.map { |attr| { name: attr.name, type: attr.type } }
+    end
+
+    def parent_module
+      class_path.map(&:camelize).join('::')
+    end
+
+    def unique_attributes
+      attributes_list.map { |attr| attr[:name].to_sym }
+    end
+
+    def full_class_name
+      parent_module.empty? ? class_name : "#{parent_module}::#{class_name}"
+    end
+
+    def indented_namespace
+      return '' if parent_module.empty?
+
+      parent_module.split('::').map.with_index do |namespace, index|
+        "#{'  ' * index}module #{namespace}"
+      end.join("\n") + "\n"
+    end
+
+    # def indented_end_namespace
+    #   return '' if parent_module.empty?
+
+    #   parent_module.split('::').map.with_index do |_, index|
+    #     "#{'  ' * (parent_module.split('::').length - 1 - index)}end"
+    #   end.join("\n") + "\n"
+    # end
+
+    def add_type_config
+      return unless File.exist?(types_config_file)
+
+      types_content = File.read(types_config_file)
+      types_content.sub!(/^end\s*$/, "#{new_type_content}end")
+      File.open(types_config_file, 'w') { |file| file.write(types_content) }
+      puts "      modified: config/initializers/types.rb"
+    end
+
+    def remove_type_config
+      return unless File.exist?(types_config_file)
+
+      type_to_remove = new_type_content
+
+      types_content = File.read(types_config_file)
+      types_content.gsub!(type_to_remove, '')
+      File.open(types_config_file, 'w') { |file| file.write(types_content) }
+    end
+
+    def types_config_file = File.join(Rails.root, 'config/initializers/types.rb')
+
+    def new_type_content
+      file_path = [class_path, file_name].reject(&:blank?).join('/').downcase
+      entity_namespace = class_path.map(&:capitalize).join('::')
+      entity_class_name = file_name.split('_').map(&:capitalize).join
+      entity_namespaced_class = [entity_namespace, entity_class_name].reject(&:blank?).join('::')
+      type_name = [class_path.join('_'), file_name].reject(&:blank?).join('_')
+      content =
+<<-RUBY
+  require_dependency '#{file_path}'
+  ActiveModel::Type.register(
+    :#{type_name}, ApacheAge::Types::AgeTypeGenerator.create_type_for(#{entity_namespaced_class})
+  )
+RUBY
+    end
+  end
+end

data/lib/generators/apache_age/node/USAGE

@@ -14,16 +14,16 @@ Example:
         class Cat
           include ApacheAge::Entities::Vertex
 
-          attribute :name, :string
-          attribute :age, :integer
+          attribute :full_name, :string
+          attribute :birthdate, :date
 
-          validates :name, presence: true
-          validates :age, presence: true
+          validates :full_name, presence: true
+          validates :birthdate, presence: true
 
           # unique node validator (remove any attributes that are not important to uniqueness)
           validates_with(
-            ApacheAge::Validators::UniqueVertexValidator,
-            attributes: [:name, :age]
+            ApacheAge::Validators::UniqueVertex,
+            attributes: [:full_name, :birthdate]
           )
         end
         ```
@@ -47,7 +47,7 @@ Example:
 
           # unique node validator (remove any attributes that are not important to uniqueness)
           validates_with(
-            ApacheAge::Validators::UniqueVertexValidator,
+            ApacheAge::Validators::UniqueVertex,
             attributes: [:name, :age]
           )
         end

data/lib/generators/apache_age/node/node_generator.rb

@@ -1,94 +1,19 @@
+# lib/generators/apache_age/node/entity_generator.rb
 require 'rails/generators'
 require 'rails/generators/named_base'
 
+require_relative '../generate_entity_methods'
+
 module ApacheAge
   class NodeGenerator < Rails::Generators::NamedBase
+    include ApacheAge::GenerateEntityMethods
+
     source_root File.expand_path('templates', __dir__)
     argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
     def perform_task
-      behavior == :invoke ? create_node_file : destroy_node_file
-    end
-
-    private
-
-    def create_node_file
-      template "node.rb.tt", File.join(destination_root, "app/nodes", class_path, "#{file_name}.rb")
-      add_type_config
-    end
-
-    def destroy_node_file
-      file_path = File.join(destination_root, "app/nodes", class_path, "#{file_name}.rb")
-      File.delete(file_path) if File.exist?(file_path)
-      remove_type_config
-    end
-
-    def attributes_list
-      attributes.map { |attr| { name: attr.name, type: attr.type } }
-    end
-
-    def unique_attributes
-      attributes_list.map { |attr| attr[:name].to_sym }
-    end
-
-    def parent_module
-      class_path.map(&:camelize).join('::')
-    end
-
-    def full_class_name
-      parent_module.empty? ? class_name : "#{parent_module}::#{class_name}"
-    end
-
-    def indented_namespace
-      return '' if parent_module.empty?
-
-      parent_module.split('::').map.with_index do |namespace, index|
-        "#{'  ' * index}module #{namespace}"
-      end.join("\n") + "\n"
-    end
-
-    def indented_end_namespace
-      return '' if parent_module.empty?
-
-      parent_module.split('::').map.with_index do |_, index|
-        "#{'  ' * (parent_module.split('::').length - 1 - index)}end"
-      end.join("\n") + "\n"
-    end
-
-    def add_type_config
-      return unless File.exist?(types_config_file)
-
-      types_content = File.read(types_config_file)
-      types_content.sub!(/^end\s*$/, "#{new_type_content}end")
-      File.open(types_config_file, 'w') { |file| file.write(types_content) }
-      puts "      modified: config/initializers/types.rb"
-    end
-
-    def remove_type_config
-      return unless File.exist?(types_config_file)
-
-      type_to_remove = new_type_content
-
-      types_content = File.read(types_config_file)
-      types_content.gsub!(type_to_remove, '')
-      File.open(types_config_file, 'w') { |file| file.write(types_content) }
-    end
-
-    def types_config_file = File.join(Rails.root, 'config/initializers/types.rb')
-
-    def new_type_content
-      file_path = [class_path, file_name].reject(&:blank?).join('/').downcase
-      node_namespace = class_path.map(&:capitalize).join('::')
-      node_class_name = file_name.split('_').map(&:capitalize).join
-      node_namespaced_class = [node_namespace, node_class_name].reject(&:blank?).join('::')
-      type_name = [class_path.join('_'), file_name].reject(&:blank?).join('_')
-      content =
-<<-RUBY
-  require_dependency '#{file_path}'
-  ActiveModel::Type.register(
-    :#{type_name}, ApacheAge::Types::AgeTypeGenerator.create_type_for(#{node_namespaced_class})
-  )
-RUBY
+      age_type = 'node'
+      behavior == :invoke ? generate_age_entity(age_type) : destroy_age_entity(age_type)
     end
   end
 end

data/lib/generators/apache_age/node/templates/node.rb.tt

@@ -9,9 +9,9 @@ class <%= class_name %>
   validates :<%= attribute[:name] %>, presence: true
 <%- end -%>
 
-  # unique node validator (remove any attributes that are not important to uniqueness)
+  # custom unique node validator (remove any attributes that are NOT important to uniqueness)
   validates_with(
-    ApacheAge::Validators::UniqueVertexValidator,
+    ApacheAge::Validators::UniqueVertex,
     attributes: <%= unique_attributes.inspect %>
   )
 end

data/lib/rails_age/version.rb

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

data/lib/rails_age.rb

@@ -11,7 +11,7 @@ module ApacheAge
   require 'apache_age/entities/edge'
   require 'apache_age/entities/entity'
   require 'apache_age/entities/vertex'
+  require 'apache_age/validators/unique_edge'
+  require 'apache_age/validators/unique_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/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.5.0
 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
@@ -73,25 +73,26 @@ files:
 - 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/unique_edge.rb
+- lib/apache_age/validators/unique_vertex.rb
 - lib/apache_age/validators/vertex_type_validator.rb
 - lib/generators/apache_age/edge/USAGE
 - lib/generators/apache_age/edge/edge_generator.rb
 - lib/generators/apache_age/edge/templates/edge.rb.tt
+- lib/generators/apache_age/generate_entity_methods.rb
 - lib/generators/apache_age/node/USAGE
 - lib/generators/apache_age/node/node_generator.rb
 - lib/generators/apache_age/node/templates/node.rb.tt
 - 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