rails_age 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03e419984be6f29b1da74d0de6e31ccb218ba966e3818537884fcff715024e02
-  data.tar.gz: cb5a30c1e17ee7bf30394691232e3185e317ef5e827ece3ab02ef7d14cb0aef5
+  metadata.gz: ccc1964e751ea0670eeab5cc406f1d73d0ac4a188c3f0c97ff410cf0a12aa664
+  data.tar.gz: 9de0e59661db92464c6505c9dc3d6a2eb314f35333eeb4f97d92d2f4b628275b
 SHA512:
-  metadata.gz: 555b80c544a8d5217d5c40ef3f24c15cd8fbf0c13bf96d1445845d9afc21d5e2ab835a60ac678ba5177fa5562ef1b87d7f293226783c94f1470d8b64e7a56fd9
-  data.tar.gz: 303f2776ebc5320711f50ec54e9a136ba7d9727fcb28c8d0038ffdcb0edb94d6715b93f40598a70d3eb3b8f1405a05610a707458f91209288414f0a4a7251374
+  metadata.gz: 15179f421eaa5fcf6180af0fd7865b1c69884064a2030b7f03300898eeda08d7bb2f871c43ec3b5ad1ae49db98b30cf274c582e3906fd66fe24b68812fb78b9a
+  data.tar.gz: 1a83d773effad75f2e90f89ee06f8585fa5a9fe40104df7913b0e0470d3026b7cc160ecb8e3ce3e2f2fcf7c1831a902fb61b1140974cc5f792d15e43ee3de4f1

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-## VERSION 0.5.1 - 2024-xx-xx
+## VERSION 0.6.2 - 2024-xx-xx
 
 - **cypher queries** (like active record queries)
   * schema override
@@ -8,32 +8,42 @@
   * paths support
   * select attributes support
 
-## VERSION 0.5.0 - 2024-xx-xx
+## VERSION 0.6.1 - 2024-xx-xx
 
 - **Age Path**
 
-## VERSION 0.4.3 - 2024-xx-xx
+## 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.3 - 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.2 - 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-06-15
 
@@ -43,7 +53,7 @@
 
 ## 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.1'
+  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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_age
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Bill Tihen
@@ -73,12 +73,13 @@ 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