rails_age 0.3.1 → 0.4.0

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

@@ -0,0 +1,56 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+module ApacheAge
+  class EdgeGenerator < Rails::Generators::NamedBase
+    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
+    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
+  end
+end

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

@@ -0,0 +1,20 @@
+<%= indented_namespace %>
+<%= '  ' * class_path.length %>class <%= class_name %>
+<%= '  ' * class_path.length %>  include ApacheAge::Entities::Edge
+
+<%- attributes_list.each do |attribute| -%>
+<%= '  ' * class_path.length %>  attribute :<%= attribute[:name] %>, :<%= attribute[:reference] || attribute[:type] %>
+<%- end -%>
+
+<%= '  ' * class_path.length %>  validates :<%= unique_attributes.first %>, presence: true
+<%= '  ' * class_path.length %>  validate :validate_unique
+
+<%= '  ' * class_path.length %>  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 %>

data/lib/generators/apache_age/node/USAGE

@@ -0,0 +1,54 @@
+Description:
+    This creates Apache AGE nodes that work seamlessly with Rails.
+    A node can be created with or without a namespace.
+    See the below examples.
+
+Example:
+    `bin/rails g apache_age:node Cat name age:integer`
+
+    This creates:
+        `app/nodes/cat.rb`
+
+    with the contents:
+        ```
+        class Cat
+          include ApacheAge::Entities::Vertex
+
+          attribute :name, :string
+          attribute :age, :integer
+
+          validates :name, presence: true
+          validates :age, presence: true
+
+          # unique node validator (remove any attributes that are not important to uniqueness)
+          validates_with(
+            ApacheAge::Validators::UniqueVertexValidator,
+            attributes: [:name, :age]
+          )
+        end
+        ```
+
+    A namespace can also be used:
+        `bin/rails g apache_age:node Animals/Cat name age:integer`
+
+    This creates:
+        `app/nodes/animals/cat.rb`
+
+    with the contents
+        ```
+        class Animals::Cat
+          include ApacheAge::Entities::Vertex
+
+          attribute :name, :string
+          attribute :age, :integer
+
+          validates :name, presence: true
+          validates :age, presence: true
+
+          # unique node validator (remove any attributes that are not important to uniqueness)
+          validates_with(
+            ApacheAge::Validators::UniqueVertexValidator,
+            attributes: [:name, :age]
+          )
+        end
+        ```

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

@@ -0,0 +1,94 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+module ApacheAge
+  class NodeGenerator < Rails::Generators::NamedBase
+    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
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+class <%= class_name %>
+  include ApacheAge::Entities::Vertex
+
+<%- attributes_list.each do |attribute| -%>
+  attribute :<%= attribute[:name] %>, :<%= attribute[:type] %>
+<%- end -%>
+
+<%- attributes_list.each do |attribute| -%>
+  validates :<%= attribute[:name] %>, presence: true
+<%- end -%>
+
+  # unique node validator (remove any attributes that are not important to uniqueness)
+  validates_with(
+    ApacheAge::Validators::UniqueVertexValidator,
+    attributes: <%= unique_attributes.inspect %>
+  )
+end

data/lib/rails_age/version.rb

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

data/lib/tasks/{database_config.rake → config_database.rake}

@@ -3,7 +3,7 @@
 #
 namespace :apache_age do
   desc "Ensure the database.yml file is properly configured for Apache Age"
-  task :database_config => :environment do
+  task :config_database => :environment do
 
     db_config_file = File.expand_path("#{Rails.root}/config/database.yml", __FILE__)
 

data/lib/tasks/config_migrate.rake

@@ -0,0 +1,35 @@
+# 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/{schema_config.rake → config_schema.rake}

@@ -3,8 +3,7 @@
 #
 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__)
+  task :config_schema => :environment do
     destination_schema = File.expand_path("#{Rails.root}/db/schema.rb", __FILE__)
 
     unless File.exist?(destination_schema)

data/lib/tasks/config_types.rake

@@ -0,0 +1,85 @@
+# lib/tasks/install.rake
+# Usage: `rake apache_age:config_types`
+#
+namespace :apache_age do
+  desc "Install AGE types from rails_age into the rails initializers"
+  task :config_types => :environment do
+    types_file_path = File.expand_path("#{Rails.root}/config/initializers/types.rb", __FILE__)
+    required_file_path = "require 'apache_age/types/age_type_generator'"
+    required_file_content =
+      <<~RUBY
+      require 'apache_age/types/age_type_generator'
+      # AGE Type Definition Usage (edges/nodes):
+      # require_dependency 'nodes/company'
+      # ActiveModel::Type.register(
+      #   :company, ApacheAge::Types::AgeTypeGenerator.create_type_for(Nodes::Company)
+      # )
+      RUBY
+    node_type_content =
+<<-RUBY
+  require_dependency 'apache_age/entities/vertex'
+  ActiveModel::Type.register(
+    :vertex, ApacheAge::Types::AgeTypeGenerator.create_type_for(ApacheAge::Entities::Vertex)
+  )
+RUBY
+    edge_type_content =
+<<-RUBY
+  require_dependency 'apache_age/entities/edge'
+  ActiveModel::Type.register(
+    :edge, ApacheAge::Types::AgeTypeGenerator.create_type_for(ApacheAge::Entities::Edge)
+  )
+RUBY
+
+    unless File.exist?(types_file_path)
+      source_content =
+        <<~RUBY
+        # config/initializers/types.rb
+
+        #{required_file_content}
+        Rails.application.config.to_prepare do
+          # Register AGE types
+        #{node_type_content}
+        #{edge_type_content}
+        end
+        RUBY
+      File.open(types_file_path, 'w') { |file| file.write(source_content) }
+      puts "config/initializers/types.rb file created with AGE base types"
+    else
+      destination_content = File.read(types_file_path)
+      original_content = destination_content.dup
+
+      unless destination_content.include?(required_file_path)
+        destination_content.sub!(
+          /^(\s*Rails\.application\.config\.to_prepare do\n)/,
+          "#{required_file_content}\n\\1"
+        )
+      end
+
+      unless destination_content.include?('# Register AGE types')
+        destination_content.sub!(
+          /^(\s*Rails\.application\.config\.to_prepare do\n)/,
+          "\\1  # Register AGE types\n"
+        )
+      end
+
+      unless destination_content.include?(edge_type_content)
+        destination_content.sub!(
+          /^(\s*Rails\.application\.config\.to_prepare do\n  # Register AGE types\n)/,
+          "\\1#{edge_type_content}"
+        )
+      end
+
+      unless destination_content.include?(node_type_content)
+        destination_content.sub!(
+          /^(\s*Rails\.application\.config\.to_prepare do\n  # Register AGE types\n)/,
+          "\\1#{node_type_content}"
+        )
+      end
+
+      if destination_content != original_content
+        File.open(types_file_path, 'w') { |file| file.write(destination_content) }
+        puts "modified: config/initializers/types.rb"
+      end
+    end
+  end
+end

data/lib/tasks/install.rake

@@ -10,10 +10,17 @@ namespace :apache_age do
     # run any new migrations
     Rake::Task["db:migrate"].invoke
 
+    # ensure the config/database.yml file has the proper configurations
+    Rake::Task["apache_age:config_database"].invoke
+
     # adjust the schema file (unfortunately rails mangles the schema file)
-    Rake::Task["apache_age:schema_config"].invoke
+    Rake::Task["apache_age:config_schema"].invoke
 
-    # ensure the config/database.yml file has the proper configurations
-    Rake::Task["apache_age:database_config"].invoke
+    # 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/migrate.rake

@@ -0,0 +1,7 @@
+namespace :apache_age do
+  desc "Ensure 'db:migrate' is followed by 'apache_age:config_schema' to repair 'schema.rb' after migrations"
+  task :migrate do
+    Rake::Task['db:migrate'].invoke
+    Rake::Task["apache_age:config_schema"].invoke
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_age
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Bill Tihen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-02 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -76,14 +76,22 @@ files:
 - 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/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/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/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/database_config.rake
-- lib/tasks/install.original.rake
 - lib/tasks/install.rake
-- lib/tasks/schema_config.rake
+- lib/tasks/migrate.rake
 homepage: https://github.com/marpori/rails_age
 licenses:
 - MIT