rubymonolith 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a47f3d7e88749e8ef4a3121ebf295745308596ceeacc43adca80ab847eb38fc6
-  data.tar.gz: 753a4d5312cf016c706047b6405bf63b170c8c3e16fe5f446edcd7c58943dfe1
+  metadata.gz: 99a4d823bd217e148a5bdc6499edccf29f945189d1953e9a6315f63f8fba1230
+  data.tar.gz: 380581ef6ce997e7136caa3bd26277bd98108db2f02617ebd446c86a7afd14d3
 SHA512:
-  metadata.gz: 90da3406e2644fc578074d6ab106c8ce7bbf158b62fcf0902c5b68069794fdee8b70e53bde82ab15542978e93b8161312bb3dc8185dbd809a6168210e016cdae
-  data.tar.gz: 030e4f0c69b6164a9cdc01d94dbf0b62c5e3e89ca55873a39790b292aef62c203552542f84b79a715cfc2296fbb84f8e9d3e79e0fa3803afb33201bb8fcee764
+  metadata.gz: 86ff18a6821057a36b6d6748300c5b3b84cafca7dd31f1e756b408bd4d8898d9df912602ed2f3e43c3412a1aa96ee1db7c0a1bff95c6863de60ee98e47fc6ed5
+  data.tar.gz: a27bce71a7e623800667e41d936e21ddf3e088af7b07f748e51294e78c1437b875bb529ea513c4beac863070e74ef074f77bccf5d96fe9f3b737c9147777355a

data/README.md

@@ -2,6 +2,16 @@
 
 A quick way to spin up a [Monlithic Rails](https://rubymonolith.org) application. [Rocketship](https://rocketship.io/) uses Monolith when building new SaaS applications.
 
+Monolith includes a Rails engine with development tools for inspecting your application:
+- Email previews
+- Database table browser
+- Installed gems viewer
+- Route inspector
+- Model inspector
+- Rails generators interface
+
+The engine automatically mounts at `http://localhost:3000/monolith` in development mode.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -18,18 +28,34 @@ Monolith creates a new Rails project with the dependencies needed to be producti
 
 ## Existing Rails applications
 
-The gem may also be installed for existing Rails applications by executing:
+Add to your Gemfile:
 
-    $ bundle add rubymonolith
+```ruby
+gem 'rubymonolith'
+```
 
-Then run the following to see the available tasks:
+Run `bundle install` and the engine automatically mounts at `http://localhost:3000/monolith` in development.
 
-    $ rails generate --help
+To see available generators, run `rails generate --help`.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+### Tailwind CSS Development
+
+The engine includes a pre-compiled Tailwind CSS file with daisyUI committed to the repo. When developing the gem:
+
+```bash
+npm install                     # Install daisyUI
+bin/build                       # Build CSS once
+rake monolith:tailwind:watch    # Watch and rebuild on changes
+```
+
+The engine uses Tailwind v4 with CSS-based configuration and daisyUI for components and dark mode support. The compiled CSS is committed so users don't need Tailwind or npm installed.
+
+### Releasing
+
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing

data/Rakefile

@@ -6,3 +6,5 @@ load "rails/tasks/engine.rake"
 load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"
+
+task default: "app:monolith:tailwind:watch"

data/app/assets/images/monolith/logo.svg

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Generated by Pixelmator Pro 3.1.1 -->
+<svg width="632" height="1206" viewBox="0 0 632 1206" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <path id="Rounded-Rectangle" fill="#000000" fill-rule="evenodd" stroke="none" d="M 12 1021 L 620 1021 L 620 0 L 12 0 Z"/>
+    <text id="MONOLITH" xml:space="preserve" x="2" y="1164" font-family="Helvetica Neue" font-size="147" font-stretch="condensed" font-weight="700" fill="#000000">MONOLITH</text>
+</svg>

data/app/assets/stylesheets/monolith/application.tailwind.css

@@ -0,0 +1,14 @@
+@import "tailwindcss";
+
+@plugin "@tailwindcss/forms";
+@plugin "daisyui" {
+  themes: light --default, dark --prefersdark;
+}
+
+@theme {
+  --font-family-sans: ui-sans-serif, system-ui, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";
+}
+
+@source "../../views";
+@source "../../helpers";
+@source "../../controllers";

data/app/components/monolith/base.rb

@@ -0,0 +1,6 @@
+class Monolith::Components::Base < Phlex::HTML
+  include Phlex::Rails::Helpers::URLFor
+  include Phlex::Rails::Helpers::FormAuthenticityToken
+  include Phlex::Rails::Helpers::AssetPath
+  include Phlex::Rails::Helpers::TurboFrameTag
+end

data/app/components/monolith/table.rb

@@ -0,0 +1,37 @@
+class Monolith::Components::Table < Monolith::Components::Base
+  def initialize(collection)
+    @collection = collection
+    @columns = []
+  end
+
+  def row(header, &row)
+    @columns << [ header, row ]
+  end
+
+  def view_template(&)
+    vanish(&)
+
+    headers, rows = @columns.transpose
+
+    div(class: "overflow-x-auto") do
+      table class: "table" do
+        thead do
+          tr do
+            headers.each do |header|
+              th { header }
+            end
+          end
+        end
+        tbody do
+          @collection.each do |item|
+            tr do
+              rows.each do |cell|
+                td { cell.call item }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/monolith/application_controller.rb

@@ -1,4 +1,70 @@
-module Monolith
-  class ApplicationController < ActionController::Base
+require 'superview'
+
+class Monolith::ApplicationController < ActionController::Base
+  layout false
+
+  include Superview::Actions
+  # # include Superform::Rails::StrongParameters
+  # include ExceptionHandler
+
+  private
+
+  def unprocessable(view)
+    render component(view), status: :unprocessable_entity
+  end
+
+  def processed(model, form: self.class::Form)
+    save form.new model
+  end
+
+  # =======================
+  # View with Navigation
+  # =======================
+  class View < Monolith::Views::Layouts::Base
+    def around_template
+      super do
+        div(class: "flex min-h-screen") do
+          render_sidebar
+          div(class: "flex-1 p-6 overflow-hidden") do
+            yield self if block_given?
+          end
+        end
+      end
+    end
+
+    def render_sidebar
+      aside(class: "w-64 shrink-0 bg-base-200 p-4") do
+        div(class: "mb-6") do
+          a(href: url_for(controller: "/monolith/home", action: :show)) do
+            img(src: asset_path("monolith/logo.svg"), alt: "Monolith", class: "dark:invert h-24 w-auto")
+          end
+        end
+
+        ul(class: "menu bg-base-200 rounded-box w-full") do
+          # li { nav_link "Emails", controller: "/monolith/emails", action: :index }
+          li { nav_link "Gems", controller: "/monolith/gems", action: :index }
+          li { nav_link "Routes", controller: "/monolith/routes", action: :index }
+          li { nav_link "Generators", controller: "/monolith/generators", action: :index }
+          li do
+            details(open: true) do
+              summary { "Data" }
+              ul do
+                li { nav_link "Models", controller: "/monolith/models", action: :index }
+                li { nav_link "Tables", controller: "/monolith/tables", action: :index }
+              end
+            end
+          end
+        end
+      end
+    end
+
+    def nav_link(text, **to)
+      a(href: url_for(to)) { text }
+    end
+
+    def ext_link(href, text = nil)
+      return em { "—" } if href.nil?
+      a(href:, target: "_blank", rel: "noopener", class: "link") { text || href }
+    end
   end
 end

data/app/controllers/monolith/emails_controller.rb

@@ -0,0 +1,61 @@
+module Monolith
+  class EmailsController < ApplicationController
+    before_action do
+      Rails.application.eager_load!
+      # @emails = ApplicationEmail.descendants
+
+      if params.key? :id
+        @email = @emails.find { it.to_s == params.fetch(:id) }
+      end
+    end
+
+    class Index < View
+      attr_writer :emails
+
+      def view_template
+        div(class: "p-6 space-y-4") do
+          h1(class: "text-2xl font-bold") { "Emails" }
+          ul(class: "list-disc pl-6 space-y-1") {
+            @emails.each do |email|
+              li {
+                if email.respond_to? :preview
+                  nav_link email.to_s, action: :show, id: email.to_s
+                else
+                  plain email.to_s
+                end
+              }
+            end
+          }
+        end
+      end
+    end
+
+    class Show < View
+      attr_writer :email
+
+      def view_template
+        div(class: "p-6 space-y-4") do
+          h1(class: "text-2xl font-bold") { @email.to_s }
+          dl(class: "grid grid-cols-1 gap-y-2") {
+            dt(class: "font-semibold") { "To:" }
+            dd(class: "mb-3") { preview.to }
+
+            dt(class: "font-semibold") { "From:" }
+            dd(class: "mb-3") { preview.from }
+
+            dt(class: "font-semibold") { "Subject:" }
+            dd(class: "mb-3") { preview.subject }
+
+            dt(class: "font-semibold") { "Body:" }
+            dd(class: "whitespace-pre-wrap") { preview.body }
+          }
+          div(class: "pt-4") { nav_link "← All emails", controller: "/monolith/emails", action: :index }
+        end
+      end
+
+      def preview
+        @email.preview
+      end
+    end
+  end
+end

data/app/controllers/monolith/exceptions_controller.rb

@@ -0,0 +1,370 @@
+# app/controllers/monolith/exceptions_controller.rb
+module Monolith
+  class ExceptionsController < Monolith::ApplicationController
+    skip_before_action :verify_authenticity_token, raise: false
+
+    def show
+      exception = request.env['action_dispatch.exception']
+
+      if exception.nil?
+        return render plain: "No exception found", status: :not_found
+      end
+
+      render Show.new.tap { |v| v.exception = ExceptionInfo.new(exception) }
+    end
+
+    def source
+      file = params[:file]
+      line = params[:line].to_i
+
+      if file.blank? || line <= 0
+        Rails.logger.error "Invalid parameters for source: file=#{file}, line=#{line}"
+        return render plain: "Invalid parameters", status: :bad_request
+      end
+
+      # Security: ensure file exists and is a real file (not a directory traversal)
+      unless File.exist?(file) && File.file?(file)
+        Rails.logger.error "File not found: #{file}"
+        return render plain: "File not found", status: :not_found
+      end
+
+      # Security: resolve path and ensure it's not trying to escape via symlinks
+      real_path = File.realpath(file)
+
+      # Allow files in Rails.root or gem directories
+      allowed = real_path.start_with?(Rails.root.to_s) ||
+                real_path.include?('/gems/') ||
+                real_path.include?('/.rbenv/') ||
+                real_path.include?('/.rvm/') ||
+                real_path.include?('/ruby/')
+
+      unless allowed
+        Rails.logger.error "Access denied for file: #{real_path}"
+        return render plain: "Access denied", status: :forbidden
+      end
+
+      extract = ExceptionInfo.new(nil).send(:extract_source, file, line)
+
+      if extract
+        render SourceExtract.new.tap { |v| v.extract = extract }, layout: false
+      else
+        Rails.logger.error "Source not available for file: #{file}, line: #{line}"
+        render plain: "Source not available", status: :not_found
+      end
+    rescue => e
+      Rails.logger.error "Exception in source action: #{e.class.name}: #{e.message}\n#{e.backtrace.join("\n")}"
+      render plain: "Error: #{e.message}", status: :internal_server_error
+    end
+
+    # =======================
+    # Inline ActiveModel-like object
+    # =======================
+    class ExceptionInfo
+      attr_reader :exception
+
+      def initialize(exception)
+        @exception = exception
+      end
+
+      def class_name
+        exception.class.name
+      end
+
+      def message
+        exception.message
+      end
+
+      def backtrace
+        exception.backtrace || []
+      end
+
+      def grouped_trace
+        @grouped_trace ||= backtrace.map do |frame|
+          file, line, method = parse_frame(frame)
+          group = categorize_frame(frame)
+          {
+            frame: frame,
+            file: file,
+            line: line,
+            method: method,
+            group: group
+          }
+        end
+      end
+
+      def first_application_frame
+        # Try Application first, then any other group
+        grouped_trace.find { |f| f[:group] == 'Application' } || grouped_trace.first
+      end
+
+      def source_extract
+        frame = first_application_frame
+        return nil unless frame
+
+        file = frame[:file]
+        line = frame[:line]
+        return nil unless file && line
+        return nil unless File.exist?(file)
+
+        extract_source(file, line)
+      end
+
+      private
+
+      def categorize_frame(frame)
+        if frame.start_with?(Rails.root.to_s)
+          if frame.include?('/app/')
+            'Application'
+          elsif frame.include?('/lib/')
+            'Library'
+          elsif frame.include?('/config/')
+            'Configuration'
+          else
+            'Application'
+          end
+        elsif frame.include?('/.gem/') || frame.include?('/gems/')
+          'Gems'
+        elsif frame.include?('/ruby/')
+          'Ruby'
+        else
+          'Framework'
+        end
+      end
+
+      def parse_frame(frame)
+        # Parse "path/to/file.rb:123:in `method_name'" format
+        # Also handle "path/to/file.rb:123" format without method
+        if match = frame.match(/^(.+?):(\d+)(?::in [`'](.+?)['"])?/)
+          file = match[1]
+          line = match[2].to_i
+          method_name = match[3]
+          [file, line, method_name]
+        else
+          [nil, nil, nil]
+        end
+      end
+
+      def extract_source(file, line_number, context = nil)
+        return nil unless file
+        return nil unless File.exist?(file)
+
+        source_code = File.read(file)
+        lines = source_code.split("\n")
+        return nil if lines.empty?
+
+        # Load entire file
+        {
+          file: file.gsub(Rails.root.to_s + '/', ''),
+          line_number: line_number,
+          start_line: 1,
+          end_line: lines.size,
+          total_lines: lines.size,
+          lines: lines.map.with_index do |content, idx|
+            {
+              number: idx + 1,
+              content: content,
+              highlighted: (idx + 1) == line_number
+            }
+          end
+        }
+      rescue => e
+        # Debug: log the error
+        Rails.logger.error("Error extracting source from #{file}: #{e.message}")
+        nil
+      end
+    end
+
+    # =======================
+    # Phlex views
+    # =======================
+    class Show < View
+      attr_writer :exception
+
+      def view_template
+        e = @exception
+
+        # Full-screen dark background with code editor aesthetic
+        div(class: "relative h-screen overflow-hidden bg-gray-900") do
+          # Main scrollable code area (fills entire screen) - wrapped in turbo frame
+          turbo_frame_tag "source-view", class: "h-full overflow-y-auto block" do
+            extract = e.source_extract
+            if extract
+              render_source_extract(extract)
+            else
+              div(class: "flex items-center justify-center h-full text-gray-500 font-mono text-sm") do
+                plain "Click a stack frame to view source"
+              end
+            end
+          end
+
+          # Floating HUD on the right side
+          div(class: "fixed top-20 right-8 w-96 max-h-[calc(100vh-6rem)] flex flex-col bg-gray-800/80 backdrop-blur-md rounded-xl shadow-2xl border border-gray-700 overflow-hidden") do
+            # Exception header (fixed at top of HUD)
+            div(class: "bg-gray-700 text-white p-4 border-b border-gray-600") do
+              h1(class: "text-lg font-bold mb-1 text-red-400") { e.class_name }
+              p(class: "text-sm text-gray-300 leading-snug") { e.message }
+            end
+
+            # Scrollable stack trace
+            div(class: "overflow-y-auto flex-1") do
+              render_grouped_trace(e.grouped_trace)
+            end
+          end
+        end
+      end
+
+      def render_source_extract(extract)
+        return unless extract
+
+        div(class: "min-h-full bg-gray-900") do
+          # File header (sticky at top)
+          div(class: "sticky top-0 bg-gray-800 text-gray-300 px-6 py-3 font-mono text-xs border-b border-gray-700 z-10") do
+            span(class: "text-gray-500") { "📄 " }
+            span(class: "text-green-400") { extract[:file] }
+          end
+
+          # Code lines - text editor style
+          div(class: "p-6") do
+            div(class: "font-mono text-sm") do
+              extract[:lines].each do |line_data|
+                div(
+                  id: "L#{line_data[:number]}",
+                  class: line_data[:highlighted] ? "bg-red-900/30 border-l-4 border-red-500" : ""
+                ) do
+                  div(class: "flex") do
+                    # Line number (left side, text editor style)
+                    div(class: "px-4 py-1 text-right select-none text-gray-600 min-w-[4rem]") do
+                      if line_data[:highlighted]
+                        span(class: "text-red-400 font-bold") { line_data[:number].to_s }
+                      else
+                        plain line_data[:number].to_s
+                      end
+                    end
+                    # Code content
+                    div(class: "px-4 py-1 flex-1 whitespace-pre") do
+                      code(class: line_data[:highlighted] ? "text-red-300" : "text-gray-300") do
+                        plain line_data[:content]
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          # Auto-scroll to highlighted line on load
+          if extract[:line_number]
+            script do
+              raw safe("setTimeout(() => { const frame = document.getElementById('source-view'); const el = document.getElementById('L#{extract[:line_number]}'); if (frame && el) { el.scrollIntoView({ block: 'center', behavior: 'instant' }); } }, 10);")
+            end
+          end
+        end
+      end
+
+      def render_grouped_trace(grouped_trace)
+        # Group frames by category
+        current_group = nil
+
+        grouped_trace.each_with_index do |frame_data, idx|
+          # If we're starting a new group, render the group header
+          if current_group != frame_data[:group]
+            current_group = frame_data[:group]
+
+            # Group header with subtle color coding
+            group_color = case current_group
+            when 'Application' then 'bg-blue-900/50'
+            when 'Gems' then 'bg-purple-900/50'
+            when 'Framework' then 'bg-green-900/50'
+            when 'Ruby' then 'bg-red-900/50'
+            else 'bg-gray-700'
+            end
+
+            div(class: "#{group_color} text-gray-300 px-4 py-2 text-xs font-bold uppercase tracking-wide") do
+              plain current_group
+            end
+          end
+
+          # Render the frame (clickable link with Turbo Frame target)
+          if frame_data[:file] && frame_data[:line]
+            a(
+              href: url_for(controller: 'monolith/exceptions', action: 'source', file: frame_data[:file], line: frame_data[:line]),
+              class: "block border-b border-gray-700 px-4 py-3 font-mono text-xs hover:bg-gray-700/50 transition-colors no-underline",
+              data_turbo_frame: "source-view"
+            ) do
+              div(class: "truncate text-gray-200 mb-1 font-medium") {
+                plain frame_data[:file]
+              }
+              div(class: "text-gray-400 text-xs") do
+                span(class: "text-cyan-400") { "Line #{frame_data[:line]}" }
+                if frame_data[:method]
+                  plain " • "
+                  code(class: "text-yellow-300") { frame_data[:method] }
+                end
+              end
+            end
+          else
+            div(class: "border-b border-gray-700 px-4 py-3 font-mono text-xs") do
+              code(class: "text-xs text-gray-400") { frame_data[:frame] }
+            end
+          end
+        end
+      end
+    end
+
+    class SourceExtract < View
+      attr_writer :extract
+
+      def view_template
+        return unless @extract
+
+        turbo_frame_tag "source-view", class: "h-full overflow-y-auto block" do
+          div(class: "min-h-full bg-gray-900") do
+            # File header (sticky at top)
+            div(class: "sticky top-0 bg-gray-800 text-gray-300 px-6 py-3 font-mono text-xs border-b border-gray-700 z-10") do
+              span(class: "text-gray-500") { "📄 " }
+              span(class: "text-green-400") { @extract[:file] }
+            end
+
+            # Code lines - text editor style
+            div(class: "p-6") do
+              div(class: "font-mono text-sm") do
+                @extract[:lines].each do |line_data|
+                  div(
+                    id: "L#{line_data[:number]}",
+                    class: line_data[:highlighted] ? "bg-red-900/30 border-l-4 border-red-500" : ""
+                  ) do
+                    div(class: "flex") do
+                      # Line number (left side, text editor style)
+                      div(class: "px-4 py-1 text-right select-none text-gray-600 min-w-[4rem]") do
+                        if line_data[:highlighted]
+                          span(class: "text-red-400 font-bold") { line_data[:number].to_s }
+                        else
+                          plain line_data[:number].to_s
+                        end
+                      end
+                      # Code content
+                      div(class: "px-4 py-1 flex-1 whitespace-pre") do
+                        code(class: line_data[:highlighted] ? "text-red-300" : "text-gray-300") do
+                          plain line_data[:content]
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+
+            # Auto-scroll to highlighted line on load
+            if @extract[:line_number]
+              script do
+                raw safe("document.addEventListener('turbo:frame-load', function(e) { if (e.target.id === 'source-view') { setTimeout(() => { const el = document.getElementById('L#{@extract[:line_number]}'); if (el) { el.scrollIntoView({ block: 'center', behavior: 'smooth' }); } }, 50); } });")
+              end
+            end
+          end
+        end
+      end
+    end
+
+
+  end
+end