tiny_wiki 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af5c72a41a3d369a441ccc793dc7b2d3c7740859bea4d5dc3807731b4ce72441
+  data.tar.gz: a9811b3e5d374cf0108561274c2ee58e333afb5e703cbbb2c75bccd629b359d4
+SHA512:
+  metadata.gz: 3c5d3f6c6d849c6790f8936c86e1a424faca750d32ec9f0dafefa29e6347b1f26b6df5b0c742c9aa51980be89496dbb2a742ea113281bc5dc592e2e5982b2c57
+  data.tar.gz: a34c9d2b61a26389a30eca5a4801f516724b311f32102df402814cae8dee85efb6479dfcb7337ccde8334c5112c34b6f7a6b67ac971d9d653c26e4574ca2c26c

data/exe/tiny_wiki_server

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+# This is the executable script that users will run to start your wiki server.
+
+require 'tiny_wiki' # Require your gem's main file
+require 'optparse'    # For command-line argument parsing
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: tiny_wiki_server [options] <wiki_directory>"
+
+  opts.on("-p", "--port PORT", Integer, "Port to listen on (default: 4567)") do |p|
+    options[:port] = p
+  end
+
+  opts.on("-b", "--bind ADDRESS", "Address to bind to (default: 0.0.0.0)") do |b|
+    options[:bind] = b
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+# The first non-option argument is expected to be the wiki directory
+wiki_directory = ARGV[0]
+
+unless wiki_directory
+  puts "Error: You must specify a wiki directory."
+  puts "Usage: tiny_wiki_server [options] <wiki_directory>"
+  exit 1
+end
+
+# Ensure the wiki directory exists
+unless File.directory?(wiki_directory)
+  puts "Wiki directory '#{wiki_directory}' does not exist. Creating it."
+  FileUtils.mkdir_p(wiki_directory)
+end
+
+# Set the wiki root path in the Sinatra application settings
+TinyWiki::App.set :wiki_root, File.expand_path(wiki_directory)
+
+# Set optional port and bind address
+TinyWiki::App.set :port, options[:port] if options[:port]
+TinyWiki::App.set :bind, options[:bind] if options[:bind]
+
+puts "Starting TinyWiki server..."
+puts "Wiki root: #{TinyWiki::App.settings.wiki_root}"
+puts "Listening on #{TinyWiki::App.settings.bind}:#{TinyWiki::App.settings.port}"
+puts "Access your wiki at: http://localhost:#{TinyWiki::App.settings.port}/"
+
+# Run the Sinatra application
+TinyWiki::App.run!

data/lib/tiny_wiki/app.rb

@@ -0,0 +1,153 @@
+# This file contains the Sinatra web application logic.
+
+require 'sinatra/base'
+require 'redcarpet'
+require 'fileutils'
+require 'uri' # For URI encoding/decoding
+
+module TinyWiki
+  class App < Sinatra::Base
+    # Configuration for the Sinatra app
+    # Set the binding address to listen on all interfaces (0.0.0.0)
+    set :bind, '0.0.0.0'
+    # Set the default port
+    set :port, 4567
+    # Set the root directory for the Sinatra app (where templates are)
+    set :root, File.expand_path('../..', __FILE__)
+    # Set the views directory for ERB templates
+    set :views, File.join(settings.root, 'tiny_wiki', 'templates')
+    # Enable sessions for flash messages (optional, but good for feedback)
+    enable :sessions
+
+    # Custom Redcarpet renderer to handle wiki links (e.g., [[Page Name]])
+    class WikiLinkRenderer < Redcarpet::Render::HTML
+      # The postprocess method is called after all other rendering is complete.
+      # We use it to find and replace our custom wiki link syntax.
+      def postprocess(full_document)
+        full_document.gsub(/\[\[(.*?)\]\]/) do
+          page_name = $1.strip # Get the text inside the brackets
+          # Sanitize page name for URL: replace spaces with underscores, then URI encode
+          url_safe_page_name = URI.encode_www_form_component(page_name.gsub(' ', '_'))
+          "<a href=\"/#{url_safe_page_name}\">#{page_name}</a>"
+        end
+      end
+    end
+
+    # Markdown renderer setup
+    # Create a Redcarpet renderer that uses HTML with code highlighting and auto-links.
+    # The `fenced_code_blocks` and `autolink` extensions are common and useful.
+    markdown_renderer = WikiLinkRenderer.new(
+      filter_html: true,
+      hard_wrap: true,
+      link_attributes: { rel: "nofollow", target: "_blank" },
+      prettify: true,
+      with_toc_data: true
+    )
+    # Create the Redcarpet Markdown object with desired extensions
+    @@markdown = Redcarpet::Markdown.new(
+      markdown_renderer,
+      autolink: true,
+      tables: true,
+      fenced_code_blocks: true,
+      strikethrough: true,
+      superscript: true,
+      highlight: true,
+      quote: true,
+      footnotes: true
+    )
+
+    # Helper method to get the full path to a markdown file
+    # `page_name` is expected to be URL-decoded and safe for filenames.
+    def wiki_file_path(page_name)
+      # Ensure the page name doesn't contain directory traversal attempts
+      # This is a basic sanitization. For production, more robust checks are needed.
+      sanitized_page_name = page_name.gsub(/[^a-zA-Z0-9_\-]/, '') # Allow only alphanumeric, underscore, hyphen
+      File.join(settings.wiki_root, "#{sanitized_page_name}.md")
+    end
+
+    # Helper method to read the content of a wiki page
+    def read_page(page_name)
+      path = wiki_file_path(page_name)
+      File.exist?(path) ? File.read(path) : nil
+    end
+
+    # Helper method to write content to a wiki page
+    def write_page(page_name, content)
+      path = wiki_file_path(page_name)
+      # Ensure the directory exists
+      FileUtils.mkdir_p(File.dirname(path)) unless File.directory?(File.dirname(path))
+      File.write(path, content)
+    end
+
+    # Helper method to convert Markdown to HTML
+    def markdown_to_html(markdown_content)
+      @@markdown.render(markdown_content)
+    end
+
+    # Helper to get all wiki pages (filenames without extension)
+    def all_wiki_pages
+      Dir.glob(File.join(settings.wiki_root, '*.md')).map do |file|
+        File.basename(file, '.md')
+      end.sort
+    rescue Errno::ENOENT
+      # If the wiki_root directory doesn't exist yet, return an empty array
+      []
+    end
+
+    # --- Routes ---
+
+    # Redirect root to a default page (e.g., 'Home')
+    get '/' do
+      redirect to('/Home')
+    end
+
+    # List all wiki pages
+    get '/_list' do
+      @pages = all_wiki_pages
+      erb :list # Render a 'list.erb' template (you'll need to create this)
+    end
+
+    # Display a wiki page
+    get '/:page_name' do
+      @page_name = URI.decode_www_form_component(params[:page_name])
+      @markdown_content = read_page(@page_name)
+
+      if @markdown_content
+        @html_content = markdown_to_html(@markdown_content)
+        erb :show # Render 'show.erb'
+      else
+        # Page not found, redirect to edit page
+        session[:message] = "Page '#{@page_name}' does not exist. Create it!"
+        redirect to("/#{@page_name}/edit")
+      end
+    end
+
+    # Show the edit form for a wiki page
+    get '/:page_name/edit' do
+      @page_name = URI.decode_www_form_component(params[:page_name])
+      @markdown_content = read_page(@page_name) || "" # Empty string if new page
+      erb :edit # Render 'edit.erb'
+    end
+
+    # Save the content of a wiki page
+    post '/:page_name' do
+      @page_name = URI.decode_www_form_component(params[:page_name])
+      new_content = params[:content]
+
+      if new_content && !new_content.strip.empty?
+        write_page(@page_name, new_content)
+        session[:message] = "Page '#{@page_name}' saved successfully!"
+        redirect to("/#{@page_name}")
+      else
+        session[:message] = "Page content cannot be empty!"
+        redirect to("/#{@page_name}/edit") # Redirect back to edit with error
+      end
+    end
+
+    # Handle 404 errors (page not found)
+    not_found do
+      status 404
+      "<h1>404 - Page Not Found</h1><p>The page you requested does not exist.</p><p><a href='/'>Go Home</a></p>"
+    end
+  end
+end

data/lib/tiny_wiki/templates/edit.erb

@@ -0,0 +1,6 @@
+<h1>Editing <%= @page_name.empty? ? 'New Page' : @page_name %></h1>
+
+<form action="/<%= URI.encode_www_form_component(@page_name) %>" method="post">
+    <textarea name="content"><%= @markdown_content %></textarea><br>
+    <input type="submit" value="Save Page">
+</form>

data/lib/tiny_wiki/templates/layout.erb

@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Tiny Wiki - <%= @page_name || 'Home' %></title>
+    <style>
+        body { font-family: sans-serif; margin: 20px; background-color: #f4f4f4; color: #333; }
+        .container { max-width: 800px; margin: 0 auto; background-color: #fff; padding: 20px; border-radius: 8px; box-shadow: 0 2px 4px rgba(0,0,0,0.1); }
+        h1, h2, h3 { color: #333; }
+        a { color: #007bff; text-decoration: none; }
+        a:hover { text-decoration: underline; }
+        nav { margin-bottom: 20px; }
+        nav a { margin-right: 15px; }
+        textarea { width: 100%; height: 400px; padding: 10px; border: 1px solid #ccc; border-radius: 4px; box-sizing: border-box; font-family: monospace; }
+        input[type="submit"] { background-color: #28a745; color: white; padding: 10px 20px; border: none; border-radius: 4px; cursor: pointer; font-size: 16px; }
+        input[type="submit"]:hover { background-color: #218838; }
+        .message { background-color: #d4edda; color: #155724; border: 1px solid #c3e6cb; padding: 10px; margin-bottom: 15px; border-radius: 4px; }
+        .error-message { background-color: #f8d7da; color: #721c24; border: 1px solid #f5c6cb; padding: 10px; margin-bottom: 15px; border-radius: 4px; }
+        pre { background-color: #eee; padding: 10px; border-radius: 4px; overflow-x: auto; }
+        code { font-family: monospace; background-color: #e9e9e9; padding: 2px 4px; border-radius: 3px; }
+        footer {
+            margin-top: 30px;
+            padding-top: 20px;
+            border-top: 1px solid #e0e0e0;
+            text-align: center;
+            font-size: 0.9em;
+            color: #777;
+        }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <nav>
+            <a href="/">Home</a>
+            <a href="/_list">All Pages</a>
+            <% if @page_name %>
+                | <a href="/<%= URI.encode_www_form_component(@page_name) %>/edit">Edit this Page</a>
+            <% end %>
+        </nav>
+
+        <% if session[:message] %>
+            <div class="message"><%= session.delete(:message) %></div>
+        <% end %>
+
+        <%= yield %>
+
+        <footer>
+            <p>&copy; <%= Time.now.year %> <a href="https://github.com/erikyuzwa/tiny-wiki-gem" target="_blank">Tiny Wiki</a>. All rights reserved.</p>
+            <p>Powered by <a href="https://rubyonrails.org/" target="_blank">Ruby</a>, <a href="https://sinatrarb.com/" target="_blank">Sinatra</a>, and <a href="https://github.com/vmg/redcarpet" target="_blank">Redcarpet</a>.</p>
+        </footer>
+    </div>
+</body>
+</html>

data/lib/tiny_wiki/templates/list.erb

@@ -0,0 +1,11 @@
+<h1>All Wiki Pages</h1>
+
+<% if @pages.empty? %>
+    <p>No pages found. <a href="/Home/edit">Create your first page!</a></p>
+<% else %>
+    <ul>
+        <% @pages.each do |page| %>
+            <li><a href="/<%= URI.encode_www_form_component(page) %>"><%= page %></a></li>
+        <% end %>
+    </ul>
+<% end %>

data/lib/tiny_wiki/templates/show.erb

@@ -0,0 +1,5 @@
+<h1><%= @page_name %></h1>
+
+<div class="wiki-content">
+    <%= @html_content %>
+</div>

data/lib/tiny_wiki/version.rb

@@ -0,0 +1,5 @@
+# Defines the version of the gem.
+
+module TinyWiki
+  VERSION = "0.2.0"
+end

data/lib/tiny_wiki.rb

@@ -0,0 +1,11 @@
+# This is the main entry point for your gem.
+# It requires other parts of your gem.
+
+require "tiny_wiki/version"
+require "tiny_wiki/app" # This will load your Sinatra application
+require "fileutils" # Ensure FileUtils is available for directory operations
+
+module TinyWiki
+  # Main module for the gem.
+  # No direct code here, it's primarily for namespacing.
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: tiny_wiki
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Erik Yuzwa
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A Ruby gem that serves a wiki from Markdown files in a local directory.
+email:
+- erikyuzwa@gmail.com
+executables:
+- tiny_wiki_server
+extensions: []
+extra_rdoc_files: []
+files:
+- exe/tiny_wiki_server
+- lib/tiny_wiki.rb
+- lib/tiny_wiki/app.rb
+- lib/tiny_wiki/templates/edit.erb
+- lib/tiny_wiki/templates/layout.erb
+- lib/tiny_wiki/templates/list.erb
+- lib/tiny_wiki/templates/show.erb
+- lib/tiny_wiki/version.rb
+homepage: https://github.com/erikyuzwa/tiny-wiki-gem
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A simple Markdown-based wiki server gem.
+test_files: []