scriptorium 0.0.2 → 0.6.1

data/lib/scriptorium/widgets/featured_posts.rb

@@ -0,0 +1,149 @@
+class Scriptorium::Widget::FeaturedPosts < Scriptorium::Widget::ListWidget
+  include Scriptorium::Contract
+
+  Title = "Featured Posts"
+
+  # Invariants
+  def define_invariants
+    invariant { @lines.is_a?(Array) }
+    invariant { Title.is_a?(String) && !Title.empty? }
+  end
+
+  def initialize(repo, view)
+    assume { repo.is_a?(Scriptorium::Repo) }
+    assume { view.is_a?(Scriptorium::View) }
+    
+    super(repo, view)
+    @lines = @data
+    
+    define_invariants
+    verify { @lines == @data }
+    check_invariants
+  end
+
+  def load_config
+    check_invariants
+    # No configuration needed for this widget
+    check_invariants
+  end
+
+  def generate
+    check_invariants
+    assume { @view.is_a?(Scriptorium::View) }
+    
+    write_main
+    write_card
+    result = true
+    
+    verify { result == true }
+    check_invariants
+    result
+  end
+
+  def widget_title
+    check_invariants
+    result = Title
+    verify { result.is_a?(String) && !result.empty? }
+    check_invariants
+    result
+  end
+
+  def card
+    check_invariants
+    assume { @view.is_a?(Scriptorium::View) }
+    assume { @name.is_a?(String) && !@name.empty? }
+    
+    file = "#{@view.dir}/widgets/#@name/#@name-card.html"
+    result = read_file(file)
+    
+    verify { result.is_a?(String) }
+    check_invariants
+    result
+  end
+
+  def write_main
+    check_invariants
+    # Nothing in this case
+    check_invariants
+  end
+
+  def parse_featured_line(line)
+    check_invariants
+    assume { line.is_a?(String) }
+    
+    # Parse line in format: <id> <title>
+    # Title is optional, so we need to handle both cases
+    parts = line.strip.split(/\s+/, 2)
+    if parts.length >= 2
+      result = [parts[0], parts[1]]
+    else
+      result = [parts[0], nil]
+    end
+    
+    verify { result.is_a?(Array) && result.length == 2 }
+    check_invariants
+    result
+  end
+
+  def get_post_title(post_id)
+    check_invariants
+    assume { post_id.is_a?(String) && !post_id.empty? }
+    assume { @repo.is_a?(Scriptorium::Repo) }
+    
+    # Get the actual post title from metadata
+    post = Scriptorium::Post.new(@repo, post_id)
+    
+    # Check if the post actually exists by looking for the meta file
+    if File.exist?(post.meta_file)
+      result = post.title || "Untitled Post"
+    else
+      result = "Error: Post #{post_id} not found"
+    end
+  rescue => e
+    # If post can't be created (invalid ID, etc.), return error message
+    result = "Error: Post #{post_id} not found"
+  ensure
+    verify { result.is_a?(String) && !result.empty? }
+    check_invariants
+    result
+  end
+
+  def featured_post_item(post_id, list_title = nil)
+    check_invariants
+    assume { post_id.is_a?(String) && !post_id.empty? }
+    assume { list_title.nil? || list_title.is_a?(String) }
+    
+    # Use actual post title from metadata, show error if post doesn't exist
+    display_title = get_post_title(post_id)
+    
+    # Create link to the post (or error message)
+    anchor = %[<a href="javascript:void(0)" onclick="load_main('posts/#{post_id}.html')" style="text-decoration: none;">#{display_title}</a>]
+    result = %[<li class="list-group-item">#{anchor}</li>]
+    
+    verify { result.is_a?(String) && result.include?("list-group-item") }
+    check_invariants
+    result
+  end
+
+  def write_card
+    check_invariants
+    assume { @view.is_a?(Scriptorium::View) }
+    assume { @name.is_a?(String) && !@name.empty? }
+    assume { @data.is_a?(Array) }
+    
+    tag = @name
+    cardout = "#{@view.dir}/widgets/#@name/#@name-card.html"
+    card_title = Title
+    content = ""
+    
+    @data.each do |line|
+      next if line.strip.empty?
+      
+      post_id, list_title = parse_featured_line(line)
+      content << featured_post_item(post_id, list_title)
+    end
+    
+    write_file(cardout, html_card(card_title, tag, content))
+    check_invariants
+  end
+end 

data/lib/scriptorium/widgets/links.rb

@@ -0,0 +1,112 @@
+class Scriptorium::Widget::Links < Scriptorium::Widget::ListWidget
+  include Scriptorium::Contract
+
+  Title = "External links"
+
+  # Invariants
+  def define_invariants
+    invariant { @lines.is_a?(Array) }
+    invariant { Title.is_a?(String) && !Title.empty? }
+  end
+
+  def initialize(repo, view)
+    assume { repo.is_a?(Scriptorium::Repo) }
+    assume { view.is_a?(Scriptorium::View) }
+    
+    super(repo, view)
+    @lines = @data
+    
+    define_invariants
+    verify { @lines == @data }
+    check_invariants
+  end
+
+  def get_list
+    check_invariants
+    assume { @lines.is_a?(Array) }
+    
+    result = @lines.map { |line| line.chomp.split(/, */, 2) }
+    
+    verify { result.is_a?(Array) }
+    check_invariants
+    result
+  end
+
+  def load_config
+    check_invariants
+    # No configuration needed for this widget
+    check_invariants
+  end
+
+  def generate
+    check_invariants
+    assume { @view.is_a?(Scriptorium::View) }
+    
+    write_main
+    write_card
+    result = true
+    
+    verify { result == true }
+    check_invariants
+    result
+  end
+
+  def widget_title
+    check_invariants
+    result = Title
+    verify { result.is_a?(String) && !result.empty? }
+    check_invariants
+    result
+  end
+
+  def card
+    check_invariants
+    assume { @view.is_a?(Scriptorium::View) }
+    assume { @name.is_a?(String) && !@name.empty? }
+    
+    file = "#{@view.dir}/widgets/#@name/#@name-card.html"
+    result = read_file(file)
+    
+    verify { result.is_a?(String) }
+    check_invariants
+    result
+  end
+
+  def write_main
+    check_invariants
+    # Nothing in this case
+    check_invariants
+  end
+
+  def link_item(url, title)
+    check_invariants
+    assume { url.is_a?(String) && !url.empty? }
+    assume { title.is_a?(String) && !title.empty? }
+    
+    anchor = %[<a href="#{url}" target="_blank" style="text-decoration: none;">#{title}</a>]
+    result = %[<li class="list-group-item">#{anchor}</li>]
+    
+    verify { result.is_a?(String) && result.include?("list-group-item") }
+    check_invariants
+    result
+  end
+
+  def write_card
+    check_invariants
+    assume { @view.is_a?(Scriptorium::View) }
+    assume { @name.is_a?(String) && !@name.empty? }
+    assume { @data.is_a?(Array) }
+    
+    tag = @name
+    cardout = "#{@view.dir}/widgets/#@name/#@name-card.html"
+    # url = "../widgets/#@name/#@name-card.html"
+    card_title = Title
+    content = ""
+    @data.each do |line|
+      url2, title = line.chomp.split(",")
+      content << link_item(url2, title)
+    end
+    write_file(cardout, html_card(card_title, tag, content))
+    check_invariants
+  end
+end

data/lib/scriptorium/widgets/pages.rb

@@ -0,0 +1,133 @@
+class Scriptorium::Widget::Pages < Scriptorium::Widget::ListWidget
+  include Scriptorium::Contract
+
+  Title = "Pages"
+  attr_reader :data
+
+  # Invariants
+  def define_invariants
+    invariant { @pages_dir.is_a?(String) && !@pages_dir.empty? }
+    invariant { @data.is_a?(Array) }
+    invariant { Title.is_a?(String) && !Title.empty? }
+  end
+
+  def initialize(repo, view)
+    assume { repo.is_a?(Scriptorium::Repo) }
+    assume { view.is_a?(Scriptorium::View) }
+    
+    super(repo, view)
+    @pages_dir = "#{@view.dir}/pages"
+    
+    define_invariants
+    verify { @pages_dir.include?("pages") }
+    check_invariants
+  end
+
+  def load_config
+    check_invariants
+    # No configuration needed for this widget
+    check_invariants
+  end
+
+  def generate
+    check_invariants
+    assume { @view.is_a?(Scriptorium::View) }
+    
+    write_main
+    write_card
+    result = true
+    
+    verify { result == true }
+    check_invariants
+    result
+  end
+
+  def widget_title
+    check_invariants
+    result = Title
+    verify { result.is_a?(String) && !result.empty? }
+    check_invariants
+    result
+  end
+
+  def card
+    check_invariants
+    assume { @view.is_a?(Scriptorium::View) }
+    assume { @name.is_a?(String) && !@name.empty? }
+    
+    file = "#{@view.dir}/widgets/#@name/#@name-card.html"
+    result = read_file(file)
+    
+    verify { result.is_a?(String) }
+    check_invariants
+    result
+  end
+
+  def write_main
+    check_invariants
+    # Nothing in this case
+    check_invariants
+  end
+
+  def extract_title_from_html(html_content)
+    check_invariants
+    assume { html_content.is_a?(String) }
+    
+    # Try to extract title from <title> tag first
+    if match = html_content.match(/<title[^>]*>(.*?)<\/title>/i)
+      result = match[1].strip
+    elsif match = html_content.match(/<h1[^>]*>(.*?)<\/h1>/i)
+      # Fall back to first <h1> tag
+      result = match[1].strip
+    else
+      # Last resort: use filename
+      result = "Untitled"
+    end
+    
+    verify { result.is_a?(String) && !result.empty? }
+    check_invariants
+    result
+  end
+
+  def page_item(filename, title)
+    check_invariants
+    assume { filename.is_a?(String) && !filename.empty? }
+    assume { title.is_a?(String) && !title.empty? }
+    
+    anchor = %[<a href="javascript:void(0)" onclick="load_main('pages/#{filename}.html')" style="text-decoration: none;">#{title}</a>]
+    result = %[<li class="list-group-item">#{anchor}</li>]
+    
+    verify { result.is_a?(String) && result.include?("list-group-item") }
+    check_invariants
+    result
+  end
+
+  def write_card
+    check_invariants
+    assume { @view.is_a?(Scriptorium::View) }
+    assume { @name.is_a?(String) && !@name.empty? }
+    assume { @data.is_a?(Array) }
+    assume { @pages_dir.is_a?(String) && !@pages_dir.empty? }
+    
+    tag = @name
+    cardout = "#{@view.dir}/widgets/#@name/#@name-card.html"
+    card_title = Title
+    content = ""
+    
+    @data.each do |filename|
+      html_file = "#{@pages_dir}/#{filename}.html"
+      
+      if File.exist?(html_file)
+        html_content = read_file(html_file)
+        title = extract_title_from_html(html_content)
+        content << page_item(filename, title)
+      else
+        # Page doesn't exist, skip it
+        next
+      end
+    end
+    
+    write_file(cardout, html_card(card_title, tag, content))
+    check_invariants
+  end
+end 

data/lib/scriptorium/widgets/widget.rb

@@ -0,0 +1,133 @@
+class Scriptorium::Widget
+  include Scriptorium::Helpers
+  include Scriptorium::Contract
+  attr_reader :repo, :view, :config, :name, :path
+
+  # Invariants
+  def define_invariants
+    invariant { @repo.is_a?(Scriptorium::Repo) }
+    invariant { @view.is_a?(Scriptorium::View) }
+    invariant { @name.is_a?(String) && !@name.empty? }
+    invariant { @path.is_a?(String) && !@path.empty? }
+  end
+
+  def initialize(repo, view)
+    assume { repo.is_a?(Scriptorium::Repo) }
+    assume { view.is_a?(Scriptorium::View) }
+    
+    @repo = repo
+    @view = view
+    @config = load_config
+    @name = self.class.to_s.split("::").last.downcase
+    @path = "#{@view.dir}/widgets/#@name"
+    
+    define_invariants
+    verify { @repo == repo }
+    verify { @view == view }
+    check_invariants
+  end
+
+  def generate
+    raise NotImplementedError, "Subclasses must implement the 'generate' method"
+  end
+
+  def load_config
+    raise NotImplementedError, "Subclasses must implement 'load_config'"
+  end
+
+  # Common HTML body wrapper for widgets
+  def html_body(css = nil)
+    check_invariants
+    assume { css.nil? || css.is_a?(String) }
+    
+    result = "<html>" +
+      (css ? "<head><style>#{css}</style></head>" : "") +
+      "<body>" + yield + "</body></html>"
+    
+    verify { result.is_a?(String) && result.include?("<html>") }
+    check_invariants
+    result
+  end
+
+  # Common HTML card structure for widgets like Links
+  def html_card(card_title = "Widget Card", tag = "widget", content)
+    check_invariants
+    assume { card_title.is_a?(String) }
+    assume { tag.is_a?(String) }
+    assume { content.is_a?(String) }
+    
+    result = <<~EOS
+      <div class="card mb-3">
+        <div class="card-body">
+          <h5 class="card-title">
+            <button type="button" class="btn btn-primary" data-bs-toggle="collapse" data-bs-target="##{tag}">+</button>
+            <a href="javascript:void(0)" onclick="javascript:load_main('#{tag}-main.html')" style="text-decoration: none; color: black">#{card_title}</a>
+          </h5>
+          <div class="collapse" id="#{tag}">
+            #{content}
+          </div>
+        </div>
+      </div>
+    EOS
+    
+    verify { result.is_a?(String) && result.include?("card") }
+    check_invariants
+    result
+  end
+  
+  # A generic container for widget content (for those that don't use cards)
+  def html_container(content)
+    check_invariants
+    assume { content.is_a?(String) }
+    
+    result = <<~HTML
+      <div class="widget-container">
+        #{content}
+      </div>
+    HTML
+    
+    verify { result.is_a?(String) && result.include?("widget-container") }
+    check_invariants
+    result
+  end
+  end
+
+  
+  ####
+  
+  
+class Scriptorium::Widget::ListWidget < Scriptorium::Widget
+  include Scriptorium::Contract
+
+  # Invariants
+  def define_invariants
+    invariant { @list.is_a?(String) && !@list.empty? }
+    invariant { @data.is_a?(Array) }
+  end
+
+  def initialize(repo, view)
+    assume { repo.is_a?(Scriptorium::Repo) }
+    assume { view.is_a?(Scriptorium::View) }
+    
+    super(repo, view)
+    @list = "#{@path}/list.txt"
+    @data = load_data
+    
+    define_invariants
+    verify { @list.include?("list.txt") }
+    verify { @data.is_a?(Array) }
+    check_invariants
+  end
+
+  # Method to load the list data from the list.txt file
+  def load_data
+    check_invariants
+    assume { @list.is_a?(String) && !@list.empty? }
+    
+    result = read_file(@list, lines: true, chomp: true).map(&:strip)
+    
+    verify { result.is_a?(Array) }
+    check_invariants
+    result
+  end
+end

data/lib/scriptorium.rb

@@ -1,10 +1,23 @@
-require_relative "skeleton"
-
-class Scriptorium
+require 'livetext'
+require 'find'
+require 'htmlbeautifier'
+require 'pp'
 
-  def initialize
-    puts "Initializing... no code yet."
-    puts
-  end
-
-end
+require_relative "skeleton"
+require_relative "scriptorium/version"
+require_relative "scriptorium/contract"
+require_relative "scriptorium/repo"
+require_relative "scriptorium/post"
+require_relative "scriptorium/theme"
+require_relative "scriptorium/view"
+require_relative "scriptorium/exceptions"
+require_relative "scriptorium/helpers"
+require_relative "scriptorium/standard_files"
+require_relative "scriptorium/banner_svg"
+require_relative "scriptorium/reddit"
+require_relative "scriptorium/widgets/widget"
+require_relative "scriptorium/widgets/links"
+require_relative "scriptorium/widgets/pages"
+require_relative "scriptorium/widgets/featured_posts"
+require_relative "scriptorium/api"
+require_relative "scriptorium/syntax_highlighter"

data/lib/skeleton.rb

@@ -1,6 +1,15 @@
-class Scriptorium
+module Scriptorium
 
-  class Engine
+  module Exceptions
+  end
+
+  class Repo
+  end
+
+  class View
+  end
+
+  module Helpers
   end
 
   class UI

data/scriptorium.gemspec

@@ -21,23 +21,34 @@ spec = Gem::Specification.new do |s|
   s.authors     = ["Hal Fulton"]
   s.email       = 'rubyhacker@gmail.com'
   s.executables << "sblog"
+  s.executables << "scriptorium"
 
   s.add_runtime_dependency 'livetext', '~> 0.9',  '>= 0.9.41'
   s.add_runtime_dependency 'rubytext', '~> 0.1',  '>= 0.1.26'
   s.add_runtime_dependency 'rouge',    '~> 3.25', '>= 3.25.0'
+  s.add_runtime_dependency 'sinatra',  '~> 3.0',  '>= 3.0.0'
+  s.add_runtime_dependency 'redd',     '~> 0.8.8'
+  s.add_runtime_dependency 'htmlbeautifier', '~> 1.4', '>= 1.4.0'
+  s.add_runtime_dependency 'clipboard', '~> 1.3', '>= 1.3.6'
 
   s.add_development_dependency 'minitest', '~> 5.10', '>= 5.10.0'
 
   # Files...
 
-  main = Find.find("bin").to_a + 
-         Find.find("lib").to_a + 
-         Find.find("doc").to_a 
+  # Core library files
+  main = Find.find("lib").to_a + 
+         Find.find("doc").to_a +
+         Find.find("assets").to_a
+  
+  # UI-specific files
+  ui_files = Find.find("ui").to_a
+  
+  # Test files
   test = Find.find("test").to_a
 
   misc = %w[./README.lt3 ./README.md ./scriptorium.gemspec]
 
-  s.files       =  main + misc + test
+  s.files       =  main + ui_files + misc + test
   s.homepage    = 'https://github.com/Hal9000/scriptorium'
   s.license     = "Ruby"
   s.post_install_message = 

data/test/README.md

@@ -0,0 +1,69 @@
+# Scriptorium Test Suite
+
+## Quick Start
+
+### Run All Tests (Unit + Automated Manual Tests)
+```bash
+ruby test/run_automated_tests.rb
+```
+
+### Run Unit Tests Only
+```bash
+ruby test/all
+```
+
+### Run Individual Manual Tests
+```bash
+# Interactive mode (opens browser)
+ruby test/manual/test1.rb
+
+# Automated mode (no browser, just validation)
+ruby test/manual/test1.rb --automated
+```
+
+## Test Types
+
+### Unit Tests (`test/unit/`)
+- **Core functionality tests** - Basic helper methods, file operations
+- **Repo tests** - Repository creation, management, post handling
+- **Post tests** - Individual post functionality
+- **View tests** - View generation and management
+- **Banner SVG tests** - SVG banner generation and validation
+
+### Manual Tests (`test/manual/`)
+- **Integration tests** - End-to-end workflows
+- **Banner feature tests** - Visual verification of SVG banners
+- **Widget tests** - Sidebar widgets and functionality
+- **Layout tests** - Page layout and styling
+
+## Automated Testing
+
+All manual tests support `--automated` mode for CI/CD:
+- No browser interaction required
+- Validates file generation
+- Returns exit codes for automation
+- Use `--automated` as the **last** parameter
+
+## Environment Setup
+
+The test environment is automatically configured:
+- PATH is set to include rbenv shims
+- Test repositories are created in `test/scriptorium-TEST/`
+- Webrick server starts on port 8000 for manual tests
+- Cleanup happens automatically
+
+## Examples
+
+```bash
+# Run all tests
+ruby test/run_automated_tests.rb
+
+# Run specific manual test interactively
+ruby test/manual/test_banner_combinations.rb
+
+# Run specific manual test in automated mode
+ruby test/manual/test_banner_combinations.rb --automated
+
+# Run test3 with specific view
+ruby test/manual/test3.rb blog1 --automated
+```