patricia 0.0.1

data/lib/patricia/views/search.haml

@@ -0,0 +1,62 @@
+%div.container
+  %br
+  %a.text-muted.small{:href => '/'} < Home
+  %div.panel.panel-default.page-header
+    %div.row.panel-body
+      %div.text-center
+        %h1 Search Pages
+      %br
+      %div.container
+        %form.col.col-md-8.col-md-offset-2{:method => 'post', :action => '/patricia/search'}
+          %div.well.row
+            %div.col.col-md-10
+              %input.form-control{:type => 'text', :name => 'search_query', :placeholder => 'Search', :value => "#{@previous_search_query}"}
+            %div.col.col-md-2
+              %button.form-control.btn.btn-default{:type => 'submit'} OK
+          %div.text-right
+            %label
+              - if @previous_search_query_was_sensitive
+                %input{:type => 'checkbox', :name => 'case_sensitive', :checked => ''}
+              - else
+                %input{:type => 'checkbox', :name => 'case_sensitive'}
+              Case sensitive
+
+  - if defined?(@results)
+    %div.container
+      %div.row.col.col-md-8.col-md-offset-2
+        %div.row
+          %br
+          %div.col.col-md-10
+            - if defined?(@previous_search_query)
+              %p
+                Search results for
+                "
+                %strong= @previous_search_query
+                "
+                - if @previous_search_query_was_sensitive
+                  (case sensitive)
+                - else
+                  (case insensitive)
+          %div.col.col-md-2
+            %p.text-right.text-muted
+              = @results.length
+              results
+        - if @results.empty?
+          %hr
+          %p.text-center
+            %em No pages found
+        %div.list-group
+          - @results.each_with_index do |result, i|
+            %a.list-group-item{:href => "#{result[1]}"}
+              %div.row
+                %div.col.col-md-10
+                  %h2.no-style= result[0]
+                  %p.text-muted= result[2]
+                %div.col.col-md-2
+                  %p.text-right.text-muted
+                    %span.row.small
+                      = i + 1
+                      \.
+                    %em.row
+                      = result[3]
+                      lines

data/lib/patricia/views/wiki/page.haml

@@ -0,0 +1,31 @@
+%br
+%div.container
+  %div.row
+    %div.col.col-md-7.col-md-offset-1#content
+      %div.row
+        %div.col.col-md-8
+          %a{:href => "/"}
+            %strong= @title if defined?(@title)
+          - if defined?(@page_title)
+            - if !@page_title.empty?
+              |
+          %span.text-muted= @breadcrumb
+          = @page_title if defined?(@page_title)
+        %div.col.col-md-4
+          %p.text-right
+            %a.text-muted.small#p-page-search-link{:href => "/patricia/search"} Search pages >
+      %hr
+      = @html if defined?(@html)
+      %hr
+      - if defined?(@markup_url)
+        %p.text-center
+          %small
+            %a.text-muted{:href => "#{@markup_url}"} Markup for this page
+    %div.col.col-md-3.col-md-offset-1.well#p-sidebar
+      %input.form-control#p-sidebar-search-box{:type => 'text', :placeholder => 'Search'}
+      %p.text-right
+        %a.btn.btn-link.btn-xs#p-sidebar-width-toggle{:href => ''} Widen sidebar
+      %br
+      - if defined?(@toc)
+        %div#toc
+          = @toc

data/lib/patricia/views/wiki/welcome.md

@@ -0,0 +1,101 @@
+# Welcome
+
+This is *Patricia*, a simple markup-based Wiki. You feed it a directory
+full of markup files and it can do two things for you.
+
+1. Serve the files for you dynamically; refreshing the page will always
+   fetch the current state of the markup file.
+2. Generate an output directory full of static HTML files that you can
+   serve yourself.
+
+## Usage
+
+To start serving your files dynamically, run
+
+        patricia /path/to/markup/dir -p 4321
+
+`-p` will use a port of your choice. If you supply `-t`, hovering over
+items in the sidebar will show a tooltip with the path to the associated
+markup file or directory.
+
+The `--css` and `--js` options allow you to use your own stylesheets and
+JavaScipt files.
+
+To see all available options, run `patricia --help`.
+
+---------------------------------------------------------------------------
+
+If you want to generate an output directory full of static HTML files, run
+
+        patricia /path/to/markup/dir /path/to/output/dir
+
+Of course, you can also use `--css` and `--js` here, too. Don't forget to
+serve those CSS and JavaScript asset files with the correct path, though
+when actually serving the Wiki from your server/CDN.
+
+## Links
+
+Links are relative to the root of your markup directory, but the root
+directory name itself can be left out.
+
+Suppose you have a markup directory structure that looks like this:
+
+
+        .
+        my-flower-wiki
+        |-- small-flowers
+        |   |-- bright-colors
+        |   |   |-- orange.md
+        |   |   |-- red.markdown
+        |   |   `-- yellow.rst
+        |   |-- dark-colors
+        |   |   |-- blue.md
+        |   |   `-- violet.org
+        |   `-- overview.pdf
+        `-- tall-flowers
+            |-- bright-colors
+            |   |-- orange.md
+            |   |-- red.markdown
+            |   `-- yellow.rst
+            `-- dark-colors
+                |-- blue.md
+                `-- violet.org
+
+To link from `my-flower-wiki/small-flowers/brigh-colors/red.md` to
+`my-flower-wiki/tall-flowers/dark-colors/blue.md`, you would specify a link
+with the **full path**, but **without the markup file extension**:
+
+        [Tall dark blue flower](/tall-flowers/dark-colors/blue)
+
+## Images
+
+Images, like links, use the **full path**, but, unlike links,
+**do include the file extension**:
+
+        ![Rose image](tall-flowers/bright-colors/rose.png)
+
+## PDFs/videos/text files/...
+
+Static files work just like images, specifiy the **full path** and
+**do include the file extension**:
+
+        [Overview PDF](tall-flowers/overview.pdf)
+
+## Installation
+
+You already have Patricia, but if you want to make a friend a Patricia
+user, run:
+
+        gem install patricia
+
+---------------------------------------------------------------------------
+
+## Sidebar
+
+- The search box is case-insensitive, but otherwise RegEx-aware.
+
+- The sidebar can be widened. Click `Widen sidebar` or hit the `w` key.
+
+- Press `?` to get a list of all keyboard shortcuts.
+
+---------------------------------------------------------------------------

data/lib/patricia.rb

@@ -0,0 +1,3 @@
+require_relative "patricia/version"
+require_relative "patricia/patricia"
+require_relative "patricia/cli"

data/patricia/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/patricia.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'patricia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "patricia"
+  spec.version       = Patricia::VERSION
+  spec.authors       = ["nounch"]
+  spec.email         = [""]
+  spec.summary       = "Minimal markup-based Wiki"
+  spec.description   = "Renders markup Wiki pages in the browser or \
+generates static files. Hierarchical tree navigation for all pages is \
+provided."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/spec/app_spec.rb

@@ -0,0 +1,195 @@
+require 'rspec'
+require 'rack/test'
+require 'yaml'
+require_relative '../lib/patricia/patricia'
+require_relative '../lib/patricia/app'
+require_relative 'test_helpers'
+
+
+RSpec.configure do |c|
+  c.include TestHelpers
+end
+
+
+describe "PatriciaApp::App" do
+  include Rack::Test::Methods
+
+  def app
+    PatriciaApp::App
+  end
+
+  describe "Use default CSS and JavaScript" do
+
+    before(:each) do
+      config = {
+        :css_dir => nil,
+        :js_dir => nil,
+        :tooltips => false,
+      }
+      load_config(config)
+    end
+
+
+    describe "Rendering markup language Wiki files as HTML page" do
+
+      after(:each) do
+        # Check  for the existence of the sidebar
+        expect(last_response.body).to include('toc')
+        expect(last_response.body).to include('p-sidebar')
+      end
+
+
+      describe "Markup language: Markdown" do
+        it "reads a Markdown file and renders it as HTML upon a GET \
+request" do
+          get '/colors/blue'
+          expect(last_response).to be_ok
+          expect(last_response.body)
+            .to include('c40445cd-f06a-461c-9008-9ca890d893d1')
+        end
+      end
+
+      describe "Markup language: Org" do
+        it "reads an Org file and renders it as HTML upon a GET request" do
+          get '/colors/bright-orange'
+          expect(last_response).to be_ok
+          expect(last_response.body)
+            .to include('37ed608c-7c67-4a48-99ae-d351b576269d')
+        end
+      end
+
+      describe "Markup language: Textile" do
+        it "reads a Textile file and renders it as HTML upon a GET \
+request" do
+          get '/colors/dark-yellow'
+          expect(last_response).to be_ok
+          expect(last_response.body)
+            .to include('46dbe50e-be4a-42b9-8796-50ddf302ead0')
+        end
+      end
+
+      describe "Markup language: reStructuredText" do
+        it "reads a reStructuredText file and renders it as HTML upon a GET \
+request" do
+          get '/colors/light-pink'
+          expect(last_response).to be_ok
+          expect(last_response.body)
+            .to include('8c180fdb-6db8-404d-ba7c-0fe8487234a3')
+        end
+      end
+    end
+
+
+    describe "Return static files" do
+      describe "Static file: PNG image" do
+        it "returns a PNG image uppon a GET request" do
+          get '/colors/red.md'
+          expect(last_response).to be_ok
+        end
+      end
+
+      describe "Static file: markup file" do
+        it "returns a Markdown file uppon a GET request" do
+          get '/colors/red.md'
+          expect(last_response).to be_ok
+        end
+
+        it "returns an Org file uppon a GET request" do
+          get '/colors/bright-orange.org'
+          expect(last_response).to be_ok
+        end
+
+        it "returns a Textile file uppon a GET request" do
+          get '/colors/dark-yellow.textile'
+          expect(last_response).to be_ok
+        end
+
+        it "returns a reStructuredText file uppon a GET request" do
+          get '/colors/light-pink.rst'
+          expect(last_response).to be_ok
+        end
+      end
+
+      describe "Static file: CSS file" do
+        it "returns a CSS file uppon a GET request" do
+          get '/patricia.css'
+          expect(last_response).to be_ok
+        end
+      end
+
+      describe "Static file: JavaScript file" do
+        it "returns a JavaScript file uppon a GET request" do
+          get '/patricia.js'
+          expect(last_response).to be_ok
+        end
+      end
+    end
+
+    # Diverse
+
+    describe "Page search" do
+      it "returns a list of pages with the search query provided by a \
+POST request" do
+        post '/patricia/search', {:search_query =>
+          'color', :case_sensitive => false}
+        expect(last_response).to be_ok
+      end
+
+      it "displays links to all the pages found for the last search query \
+upon a GET request" do
+        get '/patricia/search'
+        expect(last_response).to be_ok
+      end
+    end
+
+  end
+
+  describe "Use custom CSS and JavaScript" do
+    before(:each) do
+      config = {
+        :css_dir => File.join(File.dirname(__FILE__),
+                              'assets/stylesheets/'),
+        :js_dir => File.join(File.dirname(__FILE__),
+                             'assets/javascripts/'),
+        :tooltips => false,
+      }
+      load_config(config)
+    end
+
+    describe "Static file: Custom CSS file" do
+      it "returns a CSS file uppon a GET request" do
+        get '/red.css'
+        expect(last_response).to be_ok
+        expect(last_response.body).to include('background-color')
+        expect(last_response.body).to include('red')
+      end
+    end
+
+    describe "Static file: Custom CSS file" do
+      it "returns a CSS file uppon a GET request" do
+        get '/green.css'
+        expect(last_response).to be_ok
+        expect(last_response.body).to include('background-color')
+        expect(last_response.body).to include('green')
+      end
+    end
+
+    describe "Static file: Custom JavaScript file" do
+      it "returns a JavaScript file uppon a GET request" do
+        get '/one.js'
+        expect(last_response).to be_ok
+        expect(last_response.body).to include('console.log')
+        expect(last_response.body).to include('one')
+      end
+    end
+
+    describe "Static file: Custom JavaScript file" do
+      it "returns a JavaScript file uppon a GET request" do
+        get '/two.js'
+        expect(last_response).to be_ok
+        expect(last_response.body).to include('console.log')
+        expect(last_response.body).to include('two')
+      end
+    end
+  end
+end

data/spec/assets/javascripts/one.js

@@ -0,0 +1 @@
+console.log('one');

data/spec/assets/javascripts/two.js

@@ -0,0 +1 @@
+console.log('two');

data/spec/assets/stylesheets/green.css

@@ -0,0 +1,3 @@
+div {
+  background-color: "green";
+}

data/spec/assets/stylesheets/red.css

@@ -0,0 +1,3 @@
+body {
+  background-color: "red";
+}

data/spec/patricia_wiki_spec.rb

@@ -0,0 +1,123 @@
+require 'sinatra'
+require_relative '../lib/patricia/patricia'
+
+
+describe "Patricia::Wiki" do
+  before(:all) do
+    pwd = File.dirname(__FILE__)
+    css_dir = File.join(pwd, 'assets/stylesheets/')
+    js_dir = File.join(pwd, 'assets/javascripts/')
+    css = Dir[css_dir + '/**/*.css']
+      .collect { |x| x.sub(/#{css_dir}/, '') }
+    js = Dir[js_dir + '/**/*.js'].collect { |x| x.sub(/#{js_dir}/, '') }
+    markup_dir = File.join(pwd, 'random-test-wiki')
+    @output_dir = File.join(pwd, 'output')
+
+    @patricia = Patricia::Wiki.new(markup_dir, :@output_dir =>
+                                   @output_dir, :css => css, :js => js)
+    @patricia.render
+  end
+
+  describe "Rendering a markup dir to HTMl and writes it to an output \
+directory containing  static HTML files" do
+    it "contains the correct output for a Markdown input file" do
+      output = File.read(File.join(@output_dir, 'colors/blue/index.html'))
+      expect(output).to include('c40445cd-f06a-461c-9008-9ca890d893d1')
+      expect(output).to include('blue')
+      expect(output).to include('id="toc"')
+      expect(output).to include('id="content"')
+    end
+
+    it "contains the correct output for an Org input file" do
+      output =
+        File.read(File.join(@output_dir, 'colors/bright-orange/index.html'))
+      expect(output).to include('37ed608c-7c67-4a48-99ae-d351b576269d')
+      expect(output).to include('bright')
+      expect(output).to include('orange')
+      expect(output).to include('id="toc"')
+      expect(output).to include('id="content"')
+    end
+
+    it "contains the correct output for an Textile input file" do
+      output =
+        File.read(File.join(@output_dir, 'colors/dark-yellow/index.html'))
+      expect(output).to include('46dbe50e-be4a-42b9-8796-50ddf302ead0')
+      expect(output).to include('yellow')
+      expect(output).to include('id="toc"')
+      expect(output).to include('id="content"')
+    end
+
+    it "contains the correct output for an reStructuredText input file" do
+      output =
+        File.read(File.join(@output_dir, 'colors/light-pink/index.html'))
+      expect(output).to include('8c180fdb-6db8-404d-ba7c-0fe8487234a3')
+      expect(output).to include('pink')
+      expect(output).to include('id="toc"')
+      expect(output).to include('id="content"')
+    end
+
+    it "confirms that there is a static file copied over to the output \
+directory" do
+      exists = File.exists?(File.join(@output_dir, 'colors/image.png'))
+      expect(exists).to be(true)
+    end
+  end
+
+
+  describe "Helpers" do
+    describe "Patricia::Wiki#_css_tags" do
+      it "link tag markup for a list of resource paths" do
+        paths =
+          [
+           'javascripts/one.css',
+           'javascripts/two.css',
+           'javascripts/three.css',
+          ]
+        css_tags = @patricia._css_tags(paths)
+        output = <<-CSSTAGS
+
+<link rel="stylesheet" href="javascripts/one.css" type="text/css">
+<link rel="stylesheet" href="javascripts/two.css" type="text/css">
+<link rel="stylesheet" href="javascripts/three.css" type="text/css">
+CSSTAGS
+        expect(css_tags).to eq(output.gsub(/\n$/, ''))
+      end
+    end
+
+    describe "Patricia::Wiki#_js_tags" do
+      it "script tag markup for a list of resource paths" do
+        paths =
+          [
+           'stylesheets/one.js',
+           'stylesheets/two.js',
+           'stylesheets/three.js',
+          ]
+        js_tags = @patricia._css_tags(paths)
+        output = <<-JSTAGS
+
+<link rel="stylesheet" href="stylesheets/one.js" type="text/css">
+<link rel="stylesheet" href="stylesheets/two.js" type="text/css">
+<link rel="stylesheet" href="stylesheets/three.js" type="text/css">
+JSTAGS
+        expect(js_tags).to eq(output.gsub(/\n$/, ''))
+      end
+    end
+
+    describe "Patricia::Wiki#_without_extension" do
+      it "returns a file path without its extension" do
+        output = @patricia._without_extension('/path/to/file.txt')
+        expected_output = '/path/to/file'
+        expect(output).to eq(expected_output)
+      end
+    end
+
+    describe "Patricia::Wiki#_without_input_dir" do
+      it "returns a path without the input markup directory" do
+        subpath = '/subpath/to/file'
+        path = File.join(@patricia.input_dir, subpath)
+        output = @patricia._without_input_dir(path)
+        expect(output).to eq(subpath)
+      end
+    end
+  end
+end

data/spec/random-test-wiki/amazing-animals/index.md

@@ -0,0 +1,3 @@
+# Animals Index
+
+This is an *index* file.

data/spec/random-test-wiki/amazing-animals/small/hamster.md

@@ -0,0 +1,7 @@
+# Hamster
+
+## Description
+This is a small animal.
+
+## Info
+A hamster is a really small animal.

data/spec/random-test-wiki/amazing-animals/small/mouse.md

@@ -0,0 +1,13 @@
+# Mouse
+
+## Description
+This is a small animal.
+
+## Info
+A mouse is a really small animal.
+
+## PDF
+
+Here is a
+[PDF](/amazing-animals/small/pdf.pdf)
+for you.

data/spec/random-test-wiki/amazing-animals/small/rat.md

@@ -0,0 +1,7 @@
+# Rat
+
+## Description
+This is a small animal.
+
+## Info
+A rat is a really small animal.

data/spec/random-test-wiki/amazing-animals/tall/elephant.md

@@ -0,0 +1,13 @@
+# Elephhant
+
+## Description
+This is an example of a tall animal.
+
+## Info
+A elephhant is really tall.
+
+## Link
+
+- [/colors/blue.html](/colors/blue.html)
+- [/colors/blue](/colors/blue)
+- [../../small/rat](../../small/rat)

data/spec/random-test-wiki/amazing-animals/tall/giraffe.md

@@ -0,0 +1,7 @@
+# Giraffe
+
+## Description
+This is an example of a tall animal.
+
+## Info
+A giraffe is really tall.

data/spec/random-test-wiki/colors/blue.md

@@ -0,0 +1,9 @@
+# Blue
+
+c40445cd-f06a-461c-9008-9ca890d893d1
+
+This is *blue*.
+
+# Link
+
+[Blue color](/colors/blue)

data/spec/random-test-wiki/colors/bright-orange.org

@@ -0,0 +1,19 @@
+* TODO Orange
+
+37ed608c-7c67-4a48-99ae-d351b576269d
+
+This is *orange*.
+
+** Info						     :info:knowledge:diverse:
+
+Orange is a bright color.
+
+** Code						    :code:source:programming:
+
+#+begin_src ruby
+class Cloud
+  def rain(intensity)
+    puts "Raining with intensity #{speed}"
+  end
+end
+#+end_src