propel_api 0.1.1

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# Infers ActiveRecord relationships based on PropelAPI conventions
+# 
+# Conventions:
+# - All references default to belongs_to with has_many inverse
+# - All relationships use dependent: :destroy by default
+# - Class names match reference names (no STI support)
+# - Polymorphic relationships use _parent suffix (resource_parent or resourceable_parent)
+# - Through relationships create join tables
+#
+class RelationshipInferrer
+  attr_reader :model_name, :attributes, :options
+  
+  def initialize(model_name, attributes, options = {})
+    @model_name = model_name
+    @attributes = attributes
+    @options = options
+    @inverse_relationships = {}
+  end
+  
+  # Generate relationships for this model
+  def belongs_to_relationships
+    relationships = []
+    
+    reference_attributes.each do |attribute|
+      if polymorphic_reference?(attribute)
+        relationships << polymorphic_belongs_to(attribute)
+      else
+        relationships << standard_belongs_to(attribute)
+      end
+    end
+    
+    relationships.compact
+  end
+  
+  # Generate inverse relationships that need to be added to other models
+  def inverse_relationships
+    @inverse_relationships
+  end
+  
+  # Check if we should generate associations (can be disabled)
+  def should_generate_associations?
+    !options[:skip_associations]
+  end
+  
+  private
+  
+  def reference_attributes
+    attributes.select { |attr| attr.type == :references }
+  end
+  
+  def polymorphic_reference?(attribute)
+    attribute.name.to_s.end_with?('_parent') || 
+    attribute.name.to_s.end_with?('able')
+  end
+  
+
+  
+  def standard_belongs_to(attribute)
+    reference_name = attribute.name.to_s
+    class_name = reference_name.camelize
+    
+    # Add inverse relationship
+    add_inverse_relationship(class_name, standard_has_many)
+    
+    # All references except organization are optional by default (PropelAPI convention)
+    if reference_name == 'organization'
+      "belongs_to :#{reference_name}"
+    else
+      "belongs_to :#{reference_name}, optional: true"
+    end
+  end
+  
+  def polymorphic_belongs_to(attribute)
+    # Extract the base name for polymorphic association
+    if attribute.name.to_s.end_with?('_parent')
+      # resource_parent -> resource
+      base_name = attribute.name.to_s.gsub(/_parent$/, '')
+    elsif attribute.name.to_s.end_with?('able')
+      # commentable -> commentable
+      base_name = attribute.name.to_s
+    else
+      base_name = attribute.name.to_s
+    end
+    
+    # Polymorphic associations are optional by default (PropelAPI convention)
+    "belongs_to :#{base_name}, polymorphic: true, optional: true"
+  end
+  
+
+  
+  def standard_has_many
+    "has_many :#{table_name}, dependent: :destroy"
+  end
+  
+
+  
+
+  
+  def add_inverse_relationship(class_name, relationship)
+    @inverse_relationships[class_name] ||= []
+    @inverse_relationships[class_name] << relationship
+  end
+  
+  def table_name
+    model_name.tableize
+  end
+  
+  def singular_table_name
+    model_name.underscore
+  end
+  
+  def class_name
+    model_name.camelize
+  end
+end 

data/lib/generators/propel_api/install/install_generator.rb

@@ -0,0 +1,343 @@
+require_relative '../core/base'
+require_relative '../unpack/unpack_generator'
+
+##
+# PropelApi installer that provides API generators for Rails applications
+#
+# This creates a COMPLETELY STANDALONE API generation system with no gem dependencies.
+# Usage:
+#   rails generate propel_api:install    # Full standalone system (runtime + generators)
+#
+# This generator:
+# 1. Installs API controller configuration and examples
+# 2. Automatically extracts generator logic to lib/generators/propel_api/
+# 3. Creates a system that requires NO gem dependencies for generation
+#
+# After installation, you can remove 'propel_api' from your Gemfile completely.
+# All code is in your application and fully customizable.
+#
+module PropelApi
+  class InstallGenerator < PropelApi::Base
+    source_root File.expand_path("../templates", __dir__)
+    
+    desc "Install API controllers with configurable serialization backend"
+
+    def copy_api_controller
+      initialize_propel_api_settings
+      
+      if behavior == :revoke
+        say "Removing API controller with #{@adapter} adapter", :red
+        say "Using namespace: #{namespace_display} version: #{version_display}", :blue
+      else
+        say "Installing API controller with #{@adapter} adapter", :green
+        say "Using namespace: #{namespace_display} version: #{version_display}", :blue
+      end
+      
+      case @adapter
+      when 'graphiti'
+        copy_graphiti_controller
+        generate_graphiti_resources if respond_to?(:generate_graphiti_resources, true)
+      when 'propel_facets'
+        copy_propel_facets_controller
+      else
+        raise "Unknown adapter: #{@adapter}. Supported: 'propel_facets', 'graphiti'"
+      end
+    end
+
+    def create_configuration
+      if behavior == :revoke
+        remove_file "config/initializers/propel_api.rb"
+        # Rails automatically handles file removal, just show appropriate message
+        say "Removed PropelApi configuration", :red
+      else
+        # Create the PropelApi configuration initializer
+        template "config/propel_api.rb.tt", "config/initializers/propel_api.rb"
+        say "Created PropelApi configuration with your selected options", :green
+      end
+    end
+
+    def create_api_routes
+      if behavior == :revoke
+        # Remove API namespace structure
+        remove_api_namespace
+      else
+        # Add basic API namespace structure (defaults to api/v1)
+        add_api_namespace
+      end
+    end
+
+    def add_required_gems
+      if behavior == :revoke
+        say "💎 Note: Gems added during installation are still in your Gemfile", :yellow
+        say "   Remove manually if no longer needed: faker, pagy, has_scope, ransack#{', graphiti, graphiti-rails, vandal_ui' if @adapter == 'graphiti'}", :yellow
+      else
+        case @adapter
+        when 'graphiti'
+          add_graphiti_gems
+        when 'propel_facets'
+          add_propel_facets_gems
+        end
+      end
+    end
+
+    def show_setup_instructions
+      say_setup_instructions
+    end
+
+    def extract_generator_for_customization
+      generator_path = "lib/generators/propel_api"
+      
+      if File.exist?(generator_path)
+        say ""
+        say "📦 Generator logic already extracted at #{generator_path}/", :blue
+        say "💡 Skipping extraction to preserve your customizations", :cyan
+      else
+        say ""
+        say "📦 Extracting generator logic for full customization...", :blue
+        
+        # Automatically run the unpack generator to extract generator logic
+        invoke PropelApi::UnpackGenerator, [], { force: false }
+        
+        say ""
+        say "✅ Generator logic extracted to lib/generators/propel_api/", :green
+        say "💡 Your application is now completely standalone - no gem dependency needed for generators!", :cyan
+        say "🗑️  You can now remove 'propel_api' from your Gemfile", :yellow
+      end
+    end
+
+    private
+
+    def copy_propel_facets_controller
+      template "controllers/api_controller_propel_facets.rb", api_controller_path
+      copy_example_controller
+      
+      # Copy propel_facets specific dependencies
+      copy_propel_facets_concerns if respond_to?(:copy_propel_facets_concerns, true)
+    end
+
+    def copy_graphiti_controller
+      template "controllers/api_controller_graphiti.rb", api_controller_path
+      copy_example_controller
+      
+      # Graphiti doesn't need additional concerns - it's self-contained
+      say "Remember to create Graphiti resources for your models:", :cyan
+      say "  rails generate graphiti:resource YourModel", :yellow
+    end
+
+    def copy_example_controller
+      if behavior == :revoke
+        # Rails automatically handles file removal, just show appropriate message
+        say "📝 Removed example controller at doc/api_controller_example.rb", :red
+      else
+        # Create example controller showing usage patterns
+        @engine = @adapter
+        @resource_name = "Post"  # Use a generic example name
+        
+        template "controllers/example_controller.rb.tt", "doc/api_controller_example.rb"
+        say "📝 Created example controller at doc/api_controller_example.rb", :blue
+      end
+    end
+
+    def add_propel_facets_gems
+      add_gem_if_missing 'faker', '~> 3.5', 'Realistic seed data generation'
+      add_gem_if_missing 'pagy', '~> 9.0', 'Pagination for Propel Facets API'
+      add_gem_if_missing 'has_scope', '~> 0.8.0', 'Scope filtering for Propel Facets API'
+      add_gem_if_missing 'ransack', '~> 4.0', 'Advanced search for Propel Facets API'
+      
+      say "Don't forget to run: bundle install", :yellow
+    end
+
+    def add_graphiti_gems
+      add_gem_if_missing 'faker', '~> 3.5', 'Realistic seed data generation'
+      add_gem_if_missing 'graphiti', '~> 1.4', 'JSON:API resource framework'
+      add_gem_if_missing 'graphiti-rails', '~> 0.2', 'Rails integration for Graphiti'
+      add_gem_if_missing 'vandal_ui', '~> 0.4', 'Interactive API documentation for Graphiti'
+      
+      say "Don't forget to run: bundle install", :yellow
+    end
+
+    def add_gem_if_missing(gem_name, version, comment)
+      gemfile_content = File.read(File.join(destination_root, 'Gemfile'))
+      
+      # Check if gem is already present
+      if gemfile_content.match(/gem\s+['"]#{gem_name}['"]/)
+        say "#{gem_name} is already in Gemfile, skipping...", :blue
+      else
+        gem gem_name, version, comment: comment
+        say "Added #{gem_name} #{version} to Gemfile", :green
+      end
+    end
+
+    def say_setup_instructions
+      if behavior == :revoke
+        say "\n" + "="*60, :red
+        say "API Controller Removed Successfully!", :red
+        say "="*60, :red
+        say "\n🔧 PropelApi configuration removed from config/initializers/propel_api.rb", :cyan
+        say "📋 Removed: --adapter=#{@adapter} --namespace=#{@api_namespace || 'none'} --version=#{@api_version || 'none'}", :cyan
+        say "\n💡 To reinstall: rails generate propel_api:install", :blue
+        say "="*60, :red
+      else
+        say "\n" + "="*60, :green
+        say "API Controller Installed Successfully!", :green
+        say "="*60, :green
+        
+        say "\n📦 System Status: Completely standalone - no gem dependency!", :green
+        say "💡 Optional: Remove 'propel_api' from Gemfile (system is fully extracted)", :cyan
+        
+        say "\n🔧 Configuration saved to config/initializers/propel_api.rb", :cyan
+        say "📋 Your defaults: --adapter=#{@adapter} --namespace=#{@api_namespace || 'none'} --version=#{@api_version || 'none'}", :cyan
+        
+        case @adapter
+        when 'propel_facets'
+          say_propel_facets_instructions
+        when 'graphiti'
+          say_graphiti_instructions
+        end
+        
+        say "\n🎨 Customization:", :bold
+        say "• Generator logic: lib/generators/propel_api/propel_api_generator.rb", :blue
+        say "• Templates: lib/generators/propel_api/templates/", :blue
+        say "• Modify any part of the system - it's all yours now!", :cyan
+        
+        say "="*60, :green
+      end
+    end
+
+    def say_propel_facets_instructions
+      say "\n📋 Propel Facets Setup Instructions:", :cyan
+      say "\n1. Install the propel_facets generator if not already done:"
+      say "   rails generate propel_facets", :yellow
+      say "\n2. Your API controller uses the propel_facets serialization system"
+      say "3. Add facets to your models using:"
+      say "   json_facet :summary, fields: [:title, :excerpt]", :yellow
+      say "\n4. Create controllers that inherit from #{api_controller_class_name}:"
+      say "   class #{api_controller_class_name.gsub('ApiController', 'UsersController')} < #{api_controller_class_name}", :yellow
+      say "     permitted_params :name, :email", :yellow
+      say "     connect_facet :short, actions: [:index]", :yellow
+      say "     connect_facet :details, actions: [:show]", :yellow
+      say "   end", :yellow
+      say "\n5. See doc/api_controller_example.rb for complete usage examples"
+      say "6. Your API endpoints will be available at: #{api_route_prefix}/..."
+      say "7. Pagination and filtering are built-in via Pagy and HasScope"
+      say "\n8. Generate resources using:"
+      say "   rails generate propel_api Resource field1:type field2:type", :yellow
+    end
+
+    def say_graphiti_instructions
+      say "\n🎯 Graphiti Setup Instructions:", :cyan
+      say "\n1. Create resource classes for your models:"
+      say "   rails generate graphiti:resource User", :yellow
+      say "\n2. Create controllers that inherit from #{api_controller_class_name}:"
+      say "   class #{api_controller_class_name.gsub('ApiController', 'UsersController')} < #{api_controller_class_name}", :yellow
+      say "     self.resource = UserResource", :yellow
+      say "   end", :yellow
+      say "\n3. Add to your application.rb or initializer:"
+      say "   Graphiti.configure { |c| c.base_url = Rails.application.routes.url_helpers.root_url }", :yellow
+      say "\n4. See doc/api_controller_example.rb for complete usage examples"
+      say "5. Visit /vandal for interactive API documentation"
+      say "6. Your API follows JSON:API specification automatically"
+      say "7. Use the Spraypaint.js client for frontend integration"
+      say "8. API endpoints: #{api_route_prefix}/... with JSON:API format"
+      say "\n9. Generate resources using:"
+      say "   rails generate propel_api Resource field1:type field2:type", :yellow
+    end
+
+    # Propel orchestration methods - only active when called by Propel installer
+    def propel_orchestrated_adapter
+      return nil unless called_by_propel_installer?
+      
+      begin
+        if defined?(Propel) && Propel.configuration.respond_to?(:api_adapter)
+          return Propel.configuration.api_adapter
+        end
+      rescue => e
+        # Propel configuration not available
+      end
+      
+      nil
+    end
+
+    def propel_orchestrated_namespace
+      return nil unless called_by_propel_installer?
+      
+      begin
+        if defined?(Propel) && Propel.configuration.respond_to?(:api_namespace)
+          return Propel.configuration.api_namespace
+        end
+      rescue => e
+        # Propel configuration not available
+      end
+      
+      nil
+    end
+
+    def propel_orchestrated_version
+      return nil unless called_by_propel_installer?
+      
+      begin
+        if defined?(Propel) && Propel.configuration.respond_to?(:api_version)
+          return Propel.configuration.api_version
+        end
+      rescue => e
+        # Propel configuration not available
+      end
+      
+      nil
+    end
+
+    def called_by_propel_installer?
+      # Check if we're being called by Propel installer by examining the call stack
+      caller.any? { |line| line.include?('propel/install_generator') }
+    end
+
+    def add_api_namespace
+      initialize_propel_api_settings
+      
+      # Use defaults: api/v1 (these come from the PropelApi configuration)
+      namespace = @api_namespace || 'api'
+      version = @api_version || 'v1'
+      
+      # Create the namespace structure (always use nested structure for consistency)
+      route_content = "namespace :#{namespace} do\n    namespace :#{version} do\n      # Add your API routes here\n      # Example: resources :users\n    end\n  end"
+      
+      # Check if namespace already exists
+      routes_file = File.join(destination_root, "config/routes.rb")
+      if File.exist?(routes_file)
+        routes_content = File.read(routes_file)
+        
+        # Check if API namespace already exists
+        if routes_content.match?(/namespace\s+:#{namespace}/)
+          say "API namespace already exists in routes", :blue
+          return
+        end
+      end
+      
+      route route_content
+      say "Added API namespace to routes (#{namespace}/#{version})", :green
+    end
+
+    def remove_api_namespace
+      initialize_propel_api_settings
+      
+      namespace = @api_namespace || 'api'
+      version = @api_version || 'v1'
+      
+      routes_file = File.join(destination_root, "config/routes.rb")
+      return unless File.exist?(routes_file)
+      
+      routes_content = File.read(routes_file)
+      
+      # Remove the nested namespace block (api/v1 structure)
+      pattern = /namespace\s+:#{namespace}\s+do.*?namespace\s+:#{version}\s+do.*?end.*?end/m
+      
+      if routes_content.match?(pattern)
+        updated_content = routes_content.gsub(pattern, '')
+        # Clean up extra newlines
+        updated_content = updated_content.gsub(/\n\n+/, "\n\n")
+        File.write(routes_file, updated_content)
+        say "Removed API namespace from routes (#{namespace}/#{version})", :red
+      end
+    end
+  end
+end