rails_age 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 272f8908dc8fb8a98adb443411e4b439eff914c8173b5eb64b53fa5362fa1572
-  data.tar.gz: bf1921611698ffc1b651787f2e1b1a5d1bc503cbe1300639b2f9dada8202cdde
+  metadata.gz: dc953f22e786b1ce4280d8ced0bcb6ca768f89773c49a4ad0d7ddd3e3505e91e
+  data.tar.gz: fff1d2809ce6f439196bfbc8a50b7990453d17def541829ef332ee2711a7fd3a
 SHA512:
-  metadata.gz: 51592c31e872a9b8dc6e96fe8fa42374241496e4da6a17ce70bf63f5f118ac078e81200259c048529e7e16b2147c8c5bbef00315cee8f26237295d04ffaea887
-  data.tar.gz: 0b24560f7703e4dc4f97d3d36de626906a47a2cda5f5137cc6c1840a5281bbcf2693743666fb6301b26723c9723244bd1854c9c8b21d5d657eb621d4caf0d864
+  metadata.gz: e03cb391c29274953ab63badc3da19a9a965d53b23844086775d5668e61f32feba68605078b506c2a1ef8bde9d6627c67c087b7b1752acd2ccff681a55d4eec2
+  data.tar.gz: 6373605ea72f6d85babde6ba167135f3098bb6b04c60a56015a04670e48f40e452a2473ce974de2e5577d2930d267aff72e253fc0a1fe10f740def2b28c0cf1b

data/CHANGELOG.md

@@ -9,11 +9,28 @@
 - **Paths**
   * ?
 
-## VERSION 0.3.1 - 2024-xx-xx
+## VERSION 0.3.4 - 2024-xx-xx
+
+- **Type Generators**
+  * add `rails generate apache_age:type`
+  * add `rails generate apache_age:node_type`
+  * add `rails generate apache_age:edge_type`
+
+## VERSION 0.3.3 - 2024-xx-xx
+
+- **Edge Generator**
+  * add `rails generate apache_age:edge` to create an edge model
+
+
+## VERSION 0.3.2 - 2024-06-08
+
+- **Node Generator**
+  * add `rails generate apache_age:node Pets/Cat name age:integer` creates a node with a namespace and attributes at: `app/nodes/pets/cat.rb`
+  * add `rails generate apache_age:node Cat name age:integer` creates a node with attributes at:  `app/nodes/cat.rb`
+  * add `rails destroy apache_age:node Cat` deletes an existing node at: `app/nodes/cat.rb`
+
+## VERSION 0.3.1 - 2024-06-02
 
-- **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**

data/README.md

@@ -21,9 +21,13 @@ $ bundle
 $ bin/rails apache_age:install
 $ git add .
 $ git commit -m "Add Apache Age to Rails"
+$ rails generate apache_age:node Company company_name
+$ rails generate apache_age:node Person first_name last_name age:integer
 ```
 
-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.**
+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.**
 
 For now, if you are using `db/structure.sql` you will need to manually configure Apache Age (RailsAge) as described below.
 
@@ -202,9 +206,8 @@ module Nodes
     attribute :last_name, :string, default: nil
     attribute :given_name, :string, default: nil
     attribute :nick_name, :string, default: nil
-    attribute :gender, :string, default: nil
 
-    validates :gender, :first_name, :last_name, :given_name, :nick_name,
+    validates :first_name, :last_name, :given_name, :nick_name,
               presence: true
 
     def initialize(**attributes)

data/lib/generators/apache_age/edge/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/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,56 @@
+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")
+    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)
+    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/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.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_age
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Bill Tihen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-02 00:00:00.000000000 Z
+date: 2024-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -76,6 +76,12 @@ 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