elder_docs 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53d1646bb49d2be38dcc43d646f38e63a257e31e3e49e7725ee5b856e88eebcc
-  data.tar.gz: 69f62037def7feea699bfbecf03b91b3769bc40321e86573f498f8bda2d41f8f
+  metadata.gz: 8f4aabd2e66c168f676bd5eb2e2f2e3266456e5800d3e88233a0897fcdae3060
+  data.tar.gz: 0e65cc39e7c4165aa4bb7eef14109ef0228b451cfc7e6b58ca93bd23eb38c894
 SHA512:
-  metadata.gz: 209001181a6d81f7eaebab82cf9a0b2df905ecc7b00b867bad810c7d20714bec87defd399a1ad58c683702359bcd2dcf46bbaaec08fa90f76c851389d76e1f9e
-  data.tar.gz: 1fd1fa84bb406777bc81cdb8121794cac0c0049cf0df3561615540f8bb3a19e8499561d32c5273d52bfa8d877132b2a18329aa62aea5df0c28914fd956c8d8b1
+  metadata.gz: 219d9898dbff6eaf5718b2d8750643fd902f875a690990d6d4d7b1d43a3106bb31a7c184e765cc88a3e67908ebd3056c17d3b4e0db1d142b36bfa34e81bda3c2
+  data.tar.gz: dd17c7cdf76a23782758eb95f72ecf1f090bfad4ee509f23cabd7612cddaf1250f0b7c38cd7ec57256e1c5503a1b9de4e73056871dc101d4622ccbc895008fa9

data/README.md

@@ -71,6 +71,7 @@ Create `articles.json`:
 bundle exec elderdocs deploy
 ```
 
+This builds the SPA into `public/elderdocs` (configurable via `output_path`) so the assets live alongside your application code.
 ### 4. Mount in routes
 
 ```ruby
@@ -123,6 +124,9 @@ ui:
 
 # Admin password for /docs/ui
 admin_password: your-secure-password
+
+# Where to write generated assets (relative paths are resolved from Rails.root)
+output_path: ./public/elderdocs
 ```
 
 ## CLI Options
@@ -131,7 +135,8 @@ admin_password: your-secure-password
 bundle exec elderdocs deploy \
   --definitions custom.json \
   --articles guides.json \
-  --api-server https://api.example.com
+  --api-server https://api.example.com \
+  --output public/custom-docs
 ```
 
 ## Requirements

data/elderdocs.yml.example

@@ -5,6 +5,9 @@
 # If /docs is already taken, ElderDocs will try: /api-docs, /documentation, /api, /docs/api
 mount_path: /docs
 
+# Output directory for generated assets (relative to your Rails root)
+output_path: ./public/elderdocs
+
 # Admin password for UI configuration page (/docs/ui)
 # Default: 'admin' (or set via ELDERDOCS_ADMIN_PASSWORD environment variable)
 # admin_password: your-secure-password-here

data/lib/elder_docs/cli.rb

@@ -8,7 +8,7 @@ module ElderDocs
     desc 'deploy', 'Generate and deploy API documentation'
     method_option :definitions, type: :string, default: 'definitions.json', aliases: '-d'
     method_option :articles, type: :string, default: 'articles.json', aliases: '-a'
-    method_option :output, type: :string, default: nil, aliases: '-o'
+    method_option :output, type: :string, default: nil, aliases: '-o', desc: 'Directory to write built assets (default: public/elderdocs)'
     method_option :api_server, type: :string, default: nil, desc: 'Default API server URL'
     method_option :skip_build, type: :boolean, default: false, desc: 'Skip frontend build if assets exist'
     method_option :force_build, type: :boolean, default: false, desc: 'Force rebuilding frontend assets'
@@ -29,10 +29,14 @@ module ElderDocs
         File.write(articles_path, [].to_json)
       end
       
+      output_path = File.expand_path(options[:output] || default_output_path, Dir.pwd)
+      
+      ElderDocs.config.output_path = output_path
+      
       generator = Generator.new(
         definitions_path: definitions_path,
         articles_path: articles_path,
-        output_path: options[:output] || default_output_path,
+        output_path: output_path,
         api_server: options[:api_server],
         skip_build: options[:skip_build],
         force_build: options[:force_build]
@@ -62,7 +66,7 @@ module ElderDocs
     private
     
     def default_output_path
-      File.join(File.dirname(__FILE__), '..', '..', 'lib', 'elder_docs', 'assets', 'viewer')
+      ElderDocs.config.output_path || File.join(Dir.pwd, 'public', 'elderdocs')
     end
   end
 end

data/lib/elder_docs/config.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'pathname'
 
 module ElderDocs
   class Config
-    attr_accessor :mount_path, :api_server, :auth_types, :ui_config, :admin_password
+    attr_accessor :mount_path, :api_server, :auth_types, :ui_config, :admin_password, :output_path
     
     def initialize
       @mount_path = nil
@@ -12,6 +13,8 @@ module ElderDocs
       @auth_types = ['bearer', 'api_key', 'basic', 'oauth2']
       @ui_config = {}
       @admin_password = nil
+      @api_servers = []
+      @output_path = default_output_path
       load_config_file
     end
     
@@ -29,19 +32,34 @@ module ElderDocs
       return unless config_path
       
       begin
-          config = YAML.load_file(config_path)
-          @mount_path = config['mount_path'] if config['mount_path']
-          @api_server = config['api_server'] if config['api_server']
-          @api_servers = config['api_servers'] if config['api_servers']
-          @auth_types = config['auth_types'] if config['auth_types']
-          @ui_config = config['ui'] if config['ui']  # YAML uses 'ui' key, but we store as ui_config
-          @admin_password = config['admin_password'] if config['admin_password']
-        rescue => e
-          warn "Warning: Could not load elderdocs.yml: #{e.message}"
+        config = YAML.load_file(config_path)
+        config_dir = File.dirname(config_path)
+        @mount_path = config['mount_path'] if config['mount_path']
+        @api_server = config['api_server'] if config['api_server']
+        @api_servers = config['api_servers'] if config['api_servers']
+        @auth_types = config['auth_types'] if config['auth_types']
+        @ui_config = config['ui'] if config['ui']  # YAML uses 'ui' key, but we store as ui_config
+        @admin_password = config['admin_password'] if config['admin_password']
+        if config['output_path']
+          @output_path = File.expand_path(config['output_path'], config_dir)
         end
+      rescue => e
+        warn "Warning: Could not load elderdocs.yml: #{e.message}"
       end
+    end
+    
+    def default_output_path
+      base_path =
+        if defined?(Rails) && Rails.root
+          Rails.root
+        else
+          Pathname.new(Dir.pwd)
+        end
       
-      attr_reader :api_servers
+      base_path.join('public', 'elderdocs').to_s
+    end
+    
+    attr_reader :api_servers
     
     def self.instance
       @instance ||= new

data/lib/elder_docs/engine.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 module ElderDocs
   class Engine < ::Rails::Engine
     isolate_namespace ElderDocs
@@ -47,7 +49,7 @@ module ElderDocs
       include ActionController::MimeResponds
       
       def show
-        viewer_path = Engine.root.join('lib', 'elder_docs', 'assets', 'viewer')
+        viewer_path = resolve_viewer_path
         requested_path = params[:path]
         requested_path = requested_path.present? ? requested_path : 'index'
         requested_path = [requested_path, params[:format]].compact.join('.')
@@ -69,6 +71,19 @@ module ElderDocs
       
       private
       
+      def resolve_viewer_path
+        custom_path = ElderDocs.config.output_path
+        if custom_path && Dir.exist?(custom_path)
+          Pathname.new(custom_path)
+        else
+          fallback_viewer_path
+        end
+      end
+      
+      def fallback_viewer_path
+        Engine.root.join('lib', 'elder_docs', 'assets', 'viewer')
+      end
+      
       def mime_type_for(file_path)
         ext = File.extname(file_path.to_s)
         case ext

data/lib/elder_docs/generator.rb

@@ -13,7 +13,7 @@ module ElderDocs
     def initialize(definitions_path:, articles_path:, output_path:, api_server: nil, skip_build: false, force_build: false)
       @definitions_path = definitions_path
       @articles_path = articles_path
-      @output_path = output_path
+      @output_path = File.expand_path(output_path, Dir.pwd)
       @api_server = api_server
       @skip_build = skip_build
       @force_build = force_build
@@ -240,13 +240,12 @@ module ElderDocs
       index_html_path = File.join(output_path, 'index.html')
       if File.exist?(index_html_path)
         html_content = File.read(index_html_path, encoding: 'UTF-8')
-        # Replace relative paths with paths relative to mount point
-        html_content.gsub!(/src="\.\//, 'src="/docs/')
-        html_content.gsub!(/href="\.\//, 'href="/docs/')
-        html_content.gsub!(/src="\/assets\//, 'src="/docs/assets/')
-        html_content.gsub!(/href="\/assets\//, 'href="/docs/assets/')
-        # Fix data.js path
-        html_content.gsub!(/src="\/data\.js/, 'src="/docs/data.js')
+        mount_path = normalized_mount_path
+        html_content.gsub!(/src="\.\//, %{src="#{mount_path}/})
+        html_content.gsub!(/href="\.\//, %{href="#{mount_path}/})
+        html_content.gsub!(/src="\/assets\//, %{src="#{mount_path}/assets/})
+        html_content.gsub!(/href="\/assets\//, %{href="#{mount_path}/assets/})
+        html_content.gsub!(/src="\/data\.js/, %{src="#{mount_path}/data.js})
         File.write(index_html_path, html_content)
       end
       
@@ -258,6 +257,14 @@ module ElderDocs
       
       Thor::Base.shell.new.say(message, color)
     end
+    
+    def normalized_mount_path
+      mount_path = ElderDocs.config.mount_path || '/docs'
+      mount_path = "/#{mount_path}" unless mount_path.start_with?('/')
+      mount_path = '/' if mount_path == '//'
+      mount_path = mount_path.chomp('/')
+      mount_path.empty? ? '' : mount_path
+    end
   end
 end
 

data/lib/elder_docs/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module ElderDocs
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elder_docs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - ElderDocs