propel_api 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39e7f4915254a37e32cd3ceacaac8402a3c0f32768d0169345cf69fdb742d52d
-  data.tar.gz: 302f7022de04cd30f8c0efac85267a4e636c175169478600094a7f9c9100c465
+  metadata.gz: 2412ee53a0d7ea8f145ef0fdc491b35099ca137238c8431512b58e63e75ee715
+  data.tar.gz: 1e7d0198d37aed70300eeca7972d41faf3d75b86d9e8c704fd63cd7ef250caf5
 SHA512:
-  metadata.gz: f74c378babcf34e7077117ae21720335903589c58e4aeb68800b3abbfe8c621c323c1f0b69d12557e80e27b3c715c9aa5047a8b9c7389c834db884435e6e4cec
-  data.tar.gz: 6e93710aad4c65df5822e046239b1ea1a661dd44d7efdef050fd4fcfd734a216e4451150513df75d71f7d21748cabf83d9eb70eced4651270ff8bfa27f230e35
+  metadata.gz: 9437dfd83ecea7de889f9455e7097a4f0d4229b0475eb59e8d453695fe2cca302c6ccad2353bf78cb999c3e74bbc358d1b2264b0dcbad18db236c099f877160f
+  data.tar.gz: bdc7bd6e5a347c93700253634aaa277891d4cd4c88b2606d2c691f4dce285a304934ed4cf3ea2d46a5a536c2a71a7ccedf6294104e23c6339f225345e9e80cb3

data/CHANGELOG.md

@@ -9,10 +9,47 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Planned Features
 - GraphQL adapter support
-- API versioning migration tools
-- Advanced relationship inference patterns
-- Custom serialization adapter framework
-- Performance optimization tools
+
+## [0.1.2] - 2025-01-11
+
+### Added
+- **Automatic inverse relationship generation** - When creating resources with references, parent models are automatically updated
+  - `has_many :children, dependent: :destroy` relationships automatically added to existing parent models
+  - Smart detection of existing associations to prevent duplication
+  - Polymorphic association support with proper inverse relationship handling
+  - Clear console feedback showing which relationships were added
+  - Graceful handling of non-existent parent models
+
+- **Enhanced relationship inference system**
+  - Improved `RelationshipInferrer` class with comprehensive association detection
+  - Support for both standard (`user:references`) and polymorphic (`commentable:references`, `resource_parent:references`) patterns
+  - Intelligent model file modification with proper placement of associations
+  - Preservation of existing model structure and comments
+
+- **Optional usage comments in controllers** - `--with-comments` flag for generators
+  - Clean controllers by default (production-ready, ~7-8 lines)
+  - Detailed usage comments when `--with-comments` flag is used (~80+ lines with examples)
+  - Available for both `propel_api:controller` and `propel_api:resource` generators
+  - Works with both PropelFacets and Graphiti adapters
+
+### Fixed
+- **Association generation respects `--skip-associations` flag** - Fixed template fallback logic
+- **Polymorphic associations correctly identified** - No inverse relationships created for polymorphic references
+- **Model template conditional logic** - Improved ERB template structure for better flag handling
+
+### Improved
+- **Comprehensive test coverage** - 16 new tests for relationship inference scenarios
+- **Better error handling** - Graceful recovery when parent model modifications fail
+- **Console output** - Color-coded feedback for relationship additions and warnings
+
+## [0.1.1] - 2025-01-10
+
+### Added
+- **Optional usage comments in controllers** - `--with-comments` flag for generators
+  - Clean controllers by default (production-ready)
+  - Detailed usage comments when `--with-comments` flag is used
+  - Available for both `propel_api:controller` and `propel_api:resource` generators
+  - Works with both PropelFacets and Graphiti adapters
 
 ## [0.1.0] - 2025-01-XX
 

data/lib/generators/propel_api/controller/controller_generator.rb

@@ -43,6 +43,11 @@ module PropelApi
     desc "Generate PropelApi controller, routes and tests for existing model"
     
     argument :attributes, type: :array, default: [], banner: "field:type field:type"
+    
+    class_option :with_comments,
+                 type: :boolean,
+                 default: false,
+                 desc: "Include usage comments in generated controller"
 
     def validate_model_exists
       # Ensure attributes are parsed before validation

data/lib/generators/propel_api/core/relationship_inferrer.rb

@@ -61,7 +61,7 @@ class RelationshipInferrer
     reference_name = attribute.name.to_s
     class_name = reference_name.camelize
     
-    # Add inverse relationship
+    # Add inverse relationship for non-polymorphic references only
     add_inverse_relationship(class_name, standard_has_many)
     
     # All references except organization are optional by default (PropelAPI convention)

data/lib/generators/propel_api/resource/resource_generator.rb

@@ -38,6 +38,11 @@ module PropelApi
   class_option :skip_tenancy,
                type: :boolean,
                desc: "Skip multi-tenancy foundation (organization and agency)"
+               
+  class_option :with_comments,
+               type: :boolean,
+               default: false,
+               desc: "Include usage comments in generated controller"
 
   def create_migration
     initialize_propel_api_settings
@@ -112,6 +117,9 @@ module PropelApi
     else
       raise "Unknown adapter: #{@adapter}. Run 'rails generate propel_api:install' first."
     end
+
+    # Apply inverse relationships to existing parent models
+    apply_inverse_relationships
   end
 
   def create_controller
@@ -248,6 +256,99 @@ module PropelApi
     @relationship_inferrer
   end
 
+  def apply_inverse_relationships
+    return unless @relationship_inferrer.should_generate_associations?
+    return if behavior == :revoke
+
+    # Get the inverse relationships from the inferrer
+    inverse_relationships = @relationship_inferrer.inverse_relationships
+
+    inverse_relationships.each do |parent_class_name, relationships|
+      parent_model_file = "app/models/#{parent_class_name.underscore}.rb"
+      full_path = File.join(destination_root, parent_model_file)
+      
+      # Skip if parent model doesn't exist
+      next unless File.exist?(full_path)
+      
+      # Skip polymorphic relationships (they don't get inverse relationships)
+      # Only standard belongs_to relationships get has_many inverses
+      next if relationships.any? { |rel| rel.include?('polymorphic') }
+      
+      begin
+        update_parent_model(full_path, relationships, parent_class_name)
+      rescue => e
+        say "Warning: Could not update #{parent_model_file}: #{e.message}", :yellow
+      end
+    end
+  end
+
+  def update_parent_model(model_file_path, relationships, parent_class_name)
+    content = File.read(model_file_path)
+    original_content = content.dup
+    
+    relationships.each do |relationship|
+      # Check if relationship already exists to avoid duplication
+      if content.match?(/^\s*#{Regexp.escape(relationship)}\s*$/)
+        say "  #{parent_class_name} already has: #{relationship}", :blue
+        next
+      end
+      
+      # Find the associations section and add the new relationship
+      content = add_relationship_to_model(content, relationship, parent_class_name)
+    end
+    
+    # Only write if content changed
+    if content != original_content
+      File.write(model_file_path, content)
+      relationships.each do |relationship|
+        say "  ✅ Added to #{parent_class_name}: #{relationship}", :green
+      end
+    end
+  end
+
+  def add_relationship_to_model(content, relationship, parent_class_name)
+    # Look for existing associations section patterns
+    association_patterns = [
+      /^(\s*# Associations\s*\n)/,
+      /^(\s*belongs_to\s+.*\n)/,
+      /^(\s*has_many\s+.*\n)/,
+      /^(\s*has_one\s+.*\n)/
+    ]
+    
+    # Try to find existing associations section
+    association_match = nil
+    association_patterns.each do |pattern|
+      match = content.match(pattern)
+      if match
+        association_match = match
+        break
+      end
+    end
+    
+    if association_match
+      # Insert after the associations section
+      insertion_point = association_match.end(0)
+      content.insert(insertion_point, "  #{relationship}\n")
+    else
+      # Look for the class declaration and add associations section
+      class_match = content.match(/^class\s+#{Regexp.escape(parent_class_name)}\s*<.*\n/)
+      if class_match
+        insertion_point = class_match.end(0)
+        associations_section = "\n  # Associations\n  #{relationship}\n"
+        content.insert(insertion_point, associations_section)
+      else
+        # Fallback: add before the end of the class
+        end_match = content.match(/^end\s*$/)
+        if end_match
+          insertion_point = end_match.begin(0)
+          content.insert(insertion_point, "  # Associations\n  #{relationship}\n\n")
+        end
+      end
+    end
+    
+    content
+  end
+
   # Override Base class method to enable Graphiti resource generation for main generator
   def should_generate_graphiti_resource?
     true

data/lib/generators/propel_api/templates/controllers/api_controller_graphiti.rb

@@ -5,6 +5,7 @@ class <%= api_controller_class_name %> < ApplicationController
 
   before_action :authenticate_user
 
+<% if options[:with_comments] -%>
   # Graphiti handles CRUD operations through resources automatically
   # Individual controllers should define their resource class like:
   #   class UsersController < <%= api_controller_class_name %>
@@ -14,6 +15,7 @@ class <%= api_controller_class_name %> < ApplicationController
   # Resources should be created using:
   #   rails generate graphiti:resource User
   
+<% end -%>
   def index
     resources = resource.all(params)
     respond_with(resources)
@@ -53,17 +55,21 @@ class <%= api_controller_class_name %> < ApplicationController
 
   private
 
+<% if options[:with_comments] -%>
   # Override in subclasses to specify the Graphiti resource class
   # Example:
   #   def resource
   #     UserResource
   #   end
+<% end -%>
   def resource
     @resource ||= infer_resource_class.new
   end
 
+<% if options[:with_comments] -%>
   # Auto-infer resource class from controller name
   # e.g., UsersController -> UserResource
+<% end -%>
   def infer_resource_class
     resource_class_name = "#{controller_name.classify}Resource"
     resource_class_name.constantize
@@ -71,9 +77,11 @@ class <%= api_controller_class_name %> < ApplicationController
     raise "#{resource_class_name} not found. Please create it using: rails generate graphiti:resource #{controller_name.classify}"
   end
 
+<% if options[:with_comments] -%>
   # Graphiti handles parameter filtering through resources automatically
   # No need for manual strong parameters - resources define allowed attributes
   # Define attributes in your resource files:
   #   attribute :name, :string
   #   attribute :email, :string
+<% end -%>
 end 

data/lib/generators/propel_api/templates/controllers/api_controller_propel_facets.rb

@@ -8,7 +8,9 @@ class <%= api_controller_class_name %> < ApplicationController
   before_action :authenticate_user
   before_action :set_resource, only: [:show, :update, :destroy]
 
+<% if options[:with_comments] -%>
   # Connect default facets to actions - can be overridden in subclasses
+<% end -%>
   connect_facet :short, actions: [:index]
   connect_facet :details, actions: [:show, :update, :create]
 
@@ -56,6 +58,7 @@ class <%= api_controller_class_name %> < ApplicationController
     @resource = resource_class.find(params[:id])
   end
 
+<% if options[:with_comments] -%>
   # resource_params method is provided by StrongParamsHelper concern
   # Define permitted parameters in your individual controllers using:
   #   permitted_params :field1, :field2, :field3
@@ -63,6 +66,7 @@ class <%= api_controller_class_name %> < ApplicationController
   # Example for a UsersController:
   #   permitted_params :username, :email_address, :first_name, :last_name
 
+<% end -%>
   def pagy_metadata(pagy)
     {
       current_page: pagy.page,

data/lib/generators/propel_api/templates/scaffold/facet_controller_template.rb.tt

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 class <%= controller_class_name_with_namespace %>Controller < <%= api_controller_class_name %>
+<% if options[:with_comments] -%>
   # Define which parameters are allowed for <%= class_name %> creation/updates
   # This uses the StrongParamsHelper concern from the base controller
+<% end -%>
   permitted_params <%= permitted_param_names.map { |attribute| ":#{attribute}" }.join(', ') %>
 
+<% if options[:with_comments] -%>
   # Connect facets to actions - customize as needed for your <%= class_name.downcase %> model
   # Default facets (:short for index, :details for show/create/update) are inherited from parent
   # Uncomment and customize these lines if you want different facet connections:
@@ -77,4 +80,6 @@ class <%= controller_class_name_with_namespace %>Controller < <%= api_controller
   #   authorize! :read, @resource # Example: authorization check
   #   render json: { data: resource_json(@resource) }
   # end
+
+<% end -%>
 end

data/lib/generators/propel_api/templates/scaffold/facet_model_template.rb.tt

@@ -58,7 +58,7 @@ class <%= class_name %> < ApplicationRecord
   <%= relationship %>
 <% end -%>
 <% end -%>
-<% else -%>
+<% elsif !options[:skip_associations] -%>
 <% attributes.select { |attr| attr.type == :references }.each do |attribute| -%>
 <% # Skip organization and agency if tenancy is included (they're already added above) -%>
 <% unless !options[:skip_tenancy] && (attribute.name == 'organization' || attribute.name == 'agency') -%>

data/lib/generators/propel_api/templates/scaffold/graphiti_controller_template.rb.tt

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 class <%= controller_class_name_with_namespace %>Controller < <%= api_controller_class_name %>
+<% if options[:with_comments] -%>
   # Specify the Graphiti resource class for this controller
+<% end -%>
   self.resource = <%= class_name %>Resource
 
+<% if options[:with_comments] -%>
   # All CRUD methods (index, show, create, update, destroy) are inherited from <%= api_controller_class_name %>
   # The inherited methods provide:
   # - JSON:API compliant responses
@@ -63,8 +66,10 @@ class <%= controller_class_name_with_namespace %>Controller < <%= api_controller
   #   respond_with(resource_instance)
   # end
 
+<% end -%>
   private
 
+<% if options[:with_comments] -%>
   # Alternative: Override the resource method instead of using self.resource
   # def resource
   #   <%= class_name %>Resource
@@ -79,4 +84,5 @@ class <%= controller_class_name_with_namespace %>Controller < <%= api_controller
   # def additional_<%= singular_table_name %>_setup
   #   # Custom setup logic
   # end
+<% end -%>
 end 

data/lib/generators/propel_api/templates/scaffold/graphiti_resource_template.rb.tt

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+<% unless options[:skip_tenancy] -%>
+require_relative '../concerns/tenancy'
+<% end -%>
+
+##
+# Graphiti Resource for <%= class_name %>
+#
+# Provides API serialization, filtering, and pagination for <%= class_name %> models.
+# Generated by PropelApi with Graphiti adapter.
+#
+# @example Usage
+#   # In your controller:
+#   def index
+#     <%= plural_name %> = <%= class_name %>Resource.all(params)
+#     render jsonapi: <%= plural_name %>
+#   end
+#
+# @see https://www.graphiti.dev/guides/concepts/resources
+#
+class <%= class_name %>Resource < ApplicationResource
+<% unless options[:skip_tenancy] -%>
+  include Tenancy
+<% end -%>
+  
+  # Define the associated model
+  self.model = <%= class_name %>
+  
+  # Define available attributes for serialization
+<% attributes.each do |attribute| -%>
+<% next if attribute.name == 'id' -%>
+<% if attribute.type == :references -%>
+  attribute :<%= attribute.name %>_id, :integer
+<% else -%>
+  attribute :<%= attribute.name %>, :<%= attribute.type %>
+<% end -%>
+<% end -%>
+  
+  # Define filterable attributes
+  filter :id, :integer
+<% attributes.each do |attribute| -%>
+<% next if attribute.name == 'id' -%>
+<% if attribute.type == :references -%>
+  filter :<%= attribute.name %>_id, :integer
+<% else -%>
+  filter :<%= attribute.name %>, :<%= attribute.type %>
+<% end -%>
+<% end -%>
+  
+  # Define sortable attributes
+  sort_all
+  
+  # Define default sort
+  default_sort :id
+  
+  # Define pagination
+  page_size 25
+  max_page_size 100
+  
+<% if defined?(relationship_inferrer) && relationship_inferrer.should_generate_associations? -%>
+  # Relationships
+<% relationship_inferrer.belongs_to_relationships.each do |relationship| -%>
+<% # Extract the association name from the relationship string -%>
+<% association_name = relationship.match(/belongs_to :(\w+)/)[1] -%>
+  belongs_to :<%= association_name %>, resource: <%= association_name.camelize %>Resource
+<% end -%>
+<% end -%>
+  
+  # Define scopes for filtering
+  scope :all, :all
+  
+  # Custom scopes can be added here
+  # scope :active, -> { where(active: true) }
+  
+  private
+  
+  # Override to add custom query logic
+  def base_scope
+    super
+  end
+  
+  # Override to add custom authorization logic
+  def resolve(scope)
+    super
+  end
+end 

data/lib/propel_api.rb

@@ -1,3 +1,3 @@
 module PropelApi
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propel_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Ryan Martin, Rafael Pivato, Chi Putera
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-11 00:00:00.000000000 Z
+date: 2025-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,8 +31,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '9.0'
 description: A comprehensive Rails generator that creates complete API resources with
-  models, controllers, tests, and realistic seed data using Faker. Supports both JSON
-  Facet and Graphiti serialization engines.
+  models, controllers, tests, and realistic seed data. Supports both JSON Facet and
+  Graphiti serialization engines.
 email:
 - admin@propelhq.dev
 executables: []
@@ -60,6 +60,7 @@ files:
 - lib/generators/propel_api/templates/scaffold/facet_model_template.rb.tt
 - lib/generators/propel_api/templates/scaffold/graphiti_controller_template.rb.tt
 - lib/generators/propel_api/templates/scaffold/graphiti_model_template.rb.tt
+- lib/generators/propel_api/templates/scaffold/graphiti_resource_template.rb.tt
 - lib/generators/propel_api/templates/seeds/seeds_template.rb.tt
 - lib/generators/propel_api/templates/tests/controller_test_template.rb.tt
 - lib/generators/propel_api/templates/tests/fixtures_template.yml.tt
@@ -71,8 +72,9 @@ homepage: https://github.com/propel-hq/propel_rails.git
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/propel-hq/propel_rails.git
-  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/propel-hq/propel_rails.git
 post_install_message:
 rdoc_options: []
 require_paths: