scriptorium 0.0.3 → 0.7.2

data/ui/README.md

@@ -0,0 +1,67 @@
+# Scriptorium UI Directory
+
+This directory contains all user interface implementations for Scriptorium.
+
+## Structure
+
+```
+ui/
+├── tui/                    # Terminal User Interface
+│   ├── bin/scriptorium     # TUI executable
+│   ├── lib/                # TUI-specific code
+│   └── test/               # TUI-specific tests
+├── web/                    # Web User Interface (future)
+│   ├── app/                # Web app code
+│   ├── public/             # Static assets
+│   └── test/               # Web-specific tests
+└── common/                 # Shared UI utilities
+    ├── lib/                # Common UI libraries
+    └── test/               # Common UI tests
+```
+
+## TUI (Terminal User Interface)
+
+The current TUI implementation provides a command-line interface for Scriptorium.
+
+- **Location**: `ui/tui/bin/scriptorium`
+- **Features**: Interactive commands, view management, post creation, deployment
+- **Dependencies**: Readline (optional), core Scriptorium library
+
+## Web UI (Future)
+
+Planned web interface for Scriptorium.
+
+- **Status**: Not yet implemented
+- **Planned Features**: Web-based post editing, view management, real-time preview
+- **Technology**: To be determined (Sinatra, Rails, or other framework)
+
+## Common Utilities
+
+Shared code that can be used by multiple UI implementations.
+
+- **Location**: `ui/common/lib/`
+- **Purpose**: API wrappers, validation, common UI patterns
+- **Usage**: Imported by TUI, Web UI, and future interfaces
+
+## Development
+
+### Adding a new UI
+
+1. Create a new directory under `ui/`
+2. Follow the established structure (bin/, lib/, test/)
+3. Import common utilities from `ui/common/lib/`
+4. Update the gemspec to include the new UI files
+
+### Testing
+
+Each UI has its own test directory for UI-specific tests. Common functionality is tested in `ui/common/test/`.
+
+### Dependencies
+
+- **TUI**: Minimal dependencies, uses core Scriptorium library
+- **Web UI**: Will have additional web framework dependencies
+- **Common**: No additional dependencies beyond core Scriptorium
+
+## Migration Notes
+
+The TUI was moved from `bin/scriptorium` to `ui/tui/bin/scriptorium` to better organize the codebase and prepare for multiple UI implementations. 

data/ui/common/lib/ui_common.rb

@@ -0,0 +1,8 @@
+# Common UI utilities that can be shared between different interfaces
+module Scriptorium
+  module UI
+    module Common
+      # Shared utilities for all UI implementations
+    end
+  end
+end 

data/ui/rubytext/README.md

@@ -0,0 +1,191 @@
+# Scriptorium RubyText UI
+
+## Overview
+
+The RubyText UI brings back the sophisticated interactive interface from Runeblog, providing a middle ground between the simple TUI and the web app. It offers:
+
+- **Rich interactive menus** - File selection, configuration, widget management
+- **Context-aware interface** - Shows current view, status, and available actions
+- **Direct file editing** - Integrated editor support with syntax highlighting
+- **Visual feedback** - Colors, bold text, clear screens, progress indicators
+- **Widget management** - Manage pages, links, navbar, and other widgets
+- **Real-time preview** - Live preview of changes as you make them
+
+## Architecture
+
+### Core Components
+
+1. **Main Interface** (`ui/rubytext/bin/scriptorium-rubytext`)
+   - Entry point with auto-discovery and setup
+   - Context display and command processing
+   - Error handling and recovery
+
+2. **Menu System** (`ui/rubytext/lib/menus.rb`)
+   - Interactive menus for file selection
+   - Configuration management
+   - Widget management interfaces
+
+3. **REPL System** (`ui/rubytext/lib/repl.rb`)
+   - Command processing and execution
+   - Context management
+   - Help system and documentation
+
+4. **Editor Integration** (`ui/rubytext/lib/editor.rb`)
+   - Direct file editing with syntax highlighting
+   - Editor selection and configuration
+   - File validation and error handling
+
+5. **Widget Management** (`ui/rubytext/lib/widgets.rb`)
+   - Page management
+   - Link management
+   - Navbar configuration
+   - Asset management
+
+## Key Features
+
+### Interactive Menus
+
+```ruby
+# File selection menu
+files = Dir.glob("*.rb")
+num, selected = STDSCR.menu(title: "Select file:", items: files)
+edit_file(selected) if selected
+
+# Configuration menu
+config_items = {
+  "General Settings" => "config/general.txt",
+  "View Settings" => "config/view.txt",
+  "Theme Settings" => "config/theme.txt"
+}
+num, target = STDSCR.menu(title: "Edit configuration:", items: config_items)
+edit_file(target) if target
+```
+
+### Context-Aware Interface
+
+```ruby
+# Shows current context in prompt
+def display_context
+  view_name = @repo.current_view&.name || "No view"
+  print fx("[#{view_name}] ", Red, :bold)
+end
+```
+
+### Direct File Editing
+
+```ruby
+# Integrated editor with syntax highlighting
+def edit_file(file, editor: nil)
+  editor ||= @repo.config.editor || "vim"
+  system("#{editor} #{file}")
+  refresh_screen
+end
+```
+
+### Widget Management
+
+```ruby
+# Manage pages widget
+def manage_pages
+  pages_dir = @view.dir/"pages"
+  files = Dir.glob("#{pages_dir}/*.html")
+  
+  menu_items = files.map { |f| File.basename(f) } + ["[New Page]"]
+  num, selected = STDSCR.menu(title: "Manage Pages:", items: menu_items)
+  
+  case selected
+  when "[New Page]"
+    create_new_page
+  else
+    edit_page(selected)
+  end
+end
+```
+
+## Implementation Plan
+
+### Phase 1: Core Interface
+- [ ] Basic RubyText integration
+- [ ] Context display and command processing
+- [ ] Simple menu system
+- [ ] File editing integration
+
+### Phase 2: Rich Menus
+- [ ] Interactive file selection
+- [ ] Configuration management
+- [ ] Widget management interfaces
+- [ ] Help system
+
+### Phase 3: Advanced Features
+- [ ] Real-time preview
+- [ ] Asset management
+- [ ] Deployment integration
+- [ ] Performance optimization
+
+## Usage Examples
+
+### Basic Usage
+
+```bash
+# Start RubyText UI
+scriptorium-rubytext
+
+# Context-aware prompt
+[sample] help                    # Show help
+[sample] new post               # Create new post
+[sample] list posts             # List posts in current view
+[sample] config                 # Edit configuration
+[sample] manage pages           # Manage pages widget
+```
+
+### Interactive Menus
+
+```
+Select file:
+  1. config/general.txt
+  2. config/view.txt
+  3. config/theme.txt
+  4. [Cancel]
+
+Enter choice (1-4): 2
+```
+
+### Widget Management
+
+```
+Manage Pages:
+  1. about.html
+  2. contact.html
+  3. [New Page]
+  4. [Cancel]
+
+Enter choice (1-4): 3
+```
+
+## Benefits Over Current TUI
+
+1. **More Interactive** - Rich menus vs. command-line only
+2. **Better Visual Feedback** - Colors, bold text, clear screens
+3. **Direct File Editing** - Integrated editor support
+4. **Widget Management** - Visual management of pages, links, etc.
+5. **Context Awareness** - Always shows current view and status
+6. **Error Recovery** - Better error handling and recovery
+
+## Benefits Over Web App
+
+1. **Lighter Weight** - No web server, no browser needed
+2. **Faster** - Direct file system access
+3. **SSH Friendly** - Works over SSH connections
+4. **Offline** - No internet connection required
+5. **Familiar** - Terminal-based interface for command-line users
+
+## Dependencies
+
+- `rubytext` gem - Curses-based UI framework
+- `scriptorium` core - Core Scriptorium functionality
+- `livetext` - Content processing and generation
+
+## Testing
+
+See `test/rubytext/` for comprehensive testing strategy and implementation.
+

data/ui/rubytext/bin/scriptorium-rubytext

@@ -0,0 +1,402 @@
+#!/usr/bin/env ruby
+
+# Scriptorium RubyText UI
+# Brings back the sophisticated interactive interface from Runeblog
+
+require 'rubytext'
+require_relative '../../lib/scriptorium'
+require_relative '../lib/rubytext_ui'
+
+# Set up environment
+ENV['DBC_DISABLED'] = 'true' if ENV['RACK_ENV'] == 'test'
+
+class ScriptoriumRubyTextUI
+  include Scriptorium::Exceptions
+  include Scriptorium::Helpers
+
+  def initialize
+    @repo = nil
+    @current_view = nil
+    @editor = ENV['EDITOR'] || 'vim'
+  end
+
+  def start
+    setup_rubytext
+    check_repository
+    main_loop
+  rescue => e
+    handle_error(e)
+  ensure
+    cleanup
+  end
+
+  private
+
+  def setup_rubytext
+    RubyText.start(:_echo, :keypad, scroll: true, fg: :blue, bg: :white)
+    puts fx("Scriptorium RubyText UI", :bold)
+    puts fx("v #{Scriptorium::VERSION}", :red)
+    puts
+  end
+
+  def check_repository
+    if Scriptorium::Repo.exist?
+      @repo = Scriptorium::Repo.new
+      @current_view = @repo.current_view
+      puts fx("Repository found: #{@repo.root}", :green)
+      puts fx("Current view: #{@current_view&.name || 'None'}", :green)
+    else
+      puts fx("No repository found.", :yellow)
+      if yesno("Create new repository?")
+        create_repository
+      else
+        puts "Exiting..."
+        exit 0
+      end
+    end
+  end
+
+  def create_repository
+    puts fx("Creating new repository...", :bold)
+    @repo = Scriptorium::Repo.create
+    puts fx("Repository created successfully!", :green)
+    
+    if yesno("Create your first view?")
+      create_first_view
+    end
+  end
+
+  def create_first_view
+    print "View name: "
+    view_name = gets.chomp.strip
+    return if view_name.empty?
+
+    print "View title: "
+    view_title = gets.chomp.strip
+    return if view_title.empty?
+
+    print "View subtitle (optional): "
+    view_subtitle = gets.chomp.strip
+
+    @current_view = @repo.create_view(view_name, view_title, view_subtitle)
+    puts fx("View '#{view_name}' created successfully!", :green)
+  end
+
+  def main_loop
+    loop do
+      display_context
+      command = gets.chomp.strip
+      
+      case command.downcase
+      when 'q', 'quit', 'exit'
+        break
+      when 'h', 'help'
+        show_help
+      when 'v', 'version'
+        show_version
+      when 'new post'
+        create_post
+      when 'list posts'
+        list_posts
+      when 'list views'
+        list_views
+      when 'change view'
+        change_view
+      when 'config'
+        edit_config
+      when 'manage pages'
+        manage_pages
+      when 'manage links'
+        manage_links
+      when 'rebuild'
+        rebuild_view
+      when 'preview'
+        preview_view
+      when 'publish'
+        publish_view
+      when ''
+        # Empty command, continue
+      else
+        puts fx("Unknown command: #{command}", :red)
+        puts "Type 'help' for available commands"
+      end
+    end
+  end
+
+  def display_context
+    view_name = @current_view&.name || "No view"
+    print fx("[#{view_name}] ", :red, :bold)
+  end
+
+  def show_help
+    help_text = <<~HELP
+      Available Commands:
+      
+      Basics:
+        h, help           Show this help
+        q, quit, exit     Exit the program
+        v, version        Show version information
+      
+      Posts:
+        new post          Create a new post
+        list posts        List posts in current view
+        edit <id>         Edit a specific post
+      
+      Views:
+        list views        List all views
+        change view       Change current view
+        new view          Create a new view
+      
+      Configuration:
+        config            Edit configuration files
+        manage pages      Manage pages widget
+        manage links      Manage links widget
+      
+      Generation:
+        rebuild           Rebuild current view
+        preview           Preview current view
+        publish           Publish current view
+    HELP
+    
+    puts help_text
+  end
+
+  def show_version
+    puts fx("Scriptorium", :bold), fx(" v #{Scriptorium::VERSION}", :red)
+  end
+
+  def create_post
+    return unless check_view
+    
+    print "Post title: "
+    title = gets.chomp.strip
+    return if title.empty?
+
+    print "Post body (optional): "
+    body = gets.chomp.strip
+
+    draft_name = @repo.create_draft(title: title, body: body)
+    post_num = @repo.finish_draft(draft_name)
+    
+    puts fx("Post ##{post_num} created successfully!", :green)
+  end
+
+  def list_posts
+    return unless check_view
+    
+    posts = @repo.all_posts(@current_view)
+    if posts.empty?
+      puts "No posts in current view."
+    else
+      puts fx("Posts in #{@current_view.name}:", :bold)
+      posts.each do |post|
+        puts "  #{post.id}: #{post.title}"
+      end
+    end
+  end
+
+  def list_views
+    views = @repo.views
+    if views.empty?
+      puts "No views found."
+    else
+      puts fx("Available views:", :bold)
+      views.each do |view|
+        current = view == @current_view ? " (current)" : ""
+        puts "  #{view.name}#{current}"
+      end
+    end
+  end
+
+  def change_view
+    views = @repo.views
+    return puts("No views available.") if views.empty?
+
+    puts fx("Available views:", :bold)
+    views.each_with_index do |view, i|
+      current = view == @current_view ? " (current)" : ""
+      puts "  #{i + 1}. #{view.name}#{current}"
+    end
+
+    print "Select view (1-#{views.length}): "
+    choice = gets.chomp.strip.to_i
+    
+    if choice >= 1 && choice <= views.length
+      @current_view = views[choice - 1]
+      @repo.current_view = @current_view
+      puts fx("Switched to view: #{@current_view.name}", :green)
+    else
+      puts fx("Invalid choice.", :red)
+    end
+  end
+
+  def edit_config
+    config_items = {
+      "General Settings" => "config/general.txt",
+      "View Settings" => "config/view.txt",
+      "Theme Settings" => "config/theme.txt"
+    }
+    
+    puts fx("Configuration files:", :bold)
+    config_items.each_with_index do |(name, path), i|
+      puts "  #{i + 1}. #{name}"
+    end
+
+    print "Select file (1-#{config_items.length}): "
+    choice = gets.chomp.strip.to_i
+    
+    if choice >= 1 && choice <= config_items.length
+      file_path = config_items.values[choice - 1]
+      edit_file(file_path)
+    else
+      puts fx("Invalid choice.", :red)
+    end
+  end
+
+  def manage_pages
+    return unless check_view
+    
+    pages_dir = @current_view.dir/"pages"
+    files = Dir.glob("#{pages_dir}/*.html") if Dir.exist?(pages_dir)
+    files ||= []
+    
+    menu_items = files.map { |f| File.basename(f) } + ["[New Page]", "[Cancel]"]
+    
+    puts fx("Manage Pages:", :bold)
+    menu_items.each_with_index do |item, i|
+      puts "  #{i + 1}. #{item}"
+    end
+
+    print "Select option (1-#{menu_items.length}): "
+    choice = gets.chomp.strip.to_i
+    
+    if choice >= 1 && choice <= menu_items.length
+      selected = menu_items[choice - 1]
+      case selected
+      when "[New Page]"
+        create_new_page
+      when "[Cancel]"
+        return
+      else
+        edit_page(selected)
+      end
+    else
+      puts fx("Invalid choice.", :red)
+    end
+  end
+
+  def manage_links
+    return unless check_view
+    
+    links_dir = @current_view.dir/"widgets"/"links"
+    list_file = links_dir/"list.txt" if Dir.exist?(links_dir)
+    
+    if list_file && File.exist?(list_file)
+      edit_file(list_file)
+    else
+      puts "No links widget found. Create one first."
+    end
+  end
+
+  def rebuild_view
+    return unless check_view
+    
+    puts fx("Rebuilding view...", :bold)
+    @repo.generate_view(@current_view)
+    puts fx("View rebuilt successfully!", :green)
+  end
+
+  def preview_view
+    return unless check_view
+    
+    puts fx("Starting preview server...", :bold)
+    # Implementation would start a local server
+    puts "Preview available at: http://localhost:8000"
+  end
+
+  def publish_view
+    return unless check_view
+    
+    puts fx("Publishing view...", :bold)
+    # Implementation would handle deployment
+    puts fx("View published successfully!", :green)
+  end
+
+  def create_new_page
+    print "Page title: "
+    title = gets.chomp.strip
+    return if title.empty?
+
+    print "Page filename (without .html): "
+    filename = gets.chomp.strip
+    return if filename.empty?
+
+    filename += ".html" unless filename.end_with?(".html")
+    page_path = @current_view.dir/"pages"/filename
+    
+    content = <<~HTML
+      <!DOCTYPE html>
+      <html>
+      <head>
+        <title>#{title}</title>
+      </head>
+      <body>
+        <h1>#{title}</h1>
+        <p>Page content goes here.</p>
+      </body>
+      </html>
+    HTML
+
+    File.write(page_path, content)
+    puts fx("Page '#{filename}' created successfully!", :green)
+  end
+
+  def edit_page(filename)
+    page_path = @current_view.dir/"pages"/filename
+    if File.exist?(page_path)
+      edit_file(page_path)
+    else
+      puts fx("Page '#{filename}' not found.", :red)
+    end
+  end
+
+  def edit_file(file_path)
+    full_path = File.expand_path(file_path, @repo.root)
+    if File.exist?(full_path)
+      system("#{@editor} #{full_path}")
+    else
+      puts fx("File '#{file_path}' not found.", :red)
+    end
+  end
+
+  def check_view
+    unless @current_view
+      puts fx("No view selected. Use 'change view' first.", :red)
+      return false
+    end
+    true
+  end
+
+  def yesno(question)
+    print fx("#{question} (y/n): ", :bold)
+    response = gets.chomp.strip.downcase
+    response == 'y' || response == 'yes'
+  end
+
+  def handle_error(error)
+    puts fx("Error: #{error.message}", :red)
+    puts error.backtrace if ENV['DEBUG']
+  end
+
+  def cleanup
+    RubyText.stop
+    puts "\nGoodbye!"
+  end
+end
+
+# Main execution
+if __FILE__ == $0
+  ui = ScriptoriumRubyTextUI.new
+  ui.start
+end
+