guide-em-up 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Bruno Michel <bruno.michel@af83.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+Guide'em up
+===========
+
+Guide'em up is a tool for writing guides in markdown. It generates an HTML
+document that you can share easily, it's just one file after all!
+
+
+How to use it?
+--------------
+
+It's really simple:
+
+1. Install it with `gem install guide-em-up`
+2. Write your guide in markdown
+3. Launch `guide-em-up` and open http://localhost:9000 in your browser
+4. Select your guide and enjoy :-)
+
+
+TODO
+----
+
+* Browse files to find the guide
+* Let us choose between several themes
+* Complete specs
+
+
+Issues or Suggestions
+---------------------
+
+Found an issue or have a suggestion? Please report it on
+[Github's issue tracker](http://github.com/nono/guide-em-up/issues).
+
+If you wants to make a pull request, please check the specs before:
+
+    ./spec/guide-em-up_spec.rb
+
+
+Credits
+-------
+
+♡2011 by Bruno Michel. Copying is an act of love. Please copy and share.
+Released under the MIT license

data/bin/guide-em-up

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "guide-em-up"
+require "goliath/runner"
+
+runner = Goliath::Runner.new(ARGV, nil)
+runner.app = GuideEmUp::Browser.new(Dir.pwd)
+runner.run

data/lib/guide-em-up/browser.rb

@@ -0,0 +1,58 @@
+require "time"
+require "rack/utils"
+require "rack/mime"
+require "goliath/api"
+
+
+module GuideEmUp
+  class Browser < Goliath::API
+    def initialize(dir)
+      @root = dir
+    end
+
+    def response(env)
+      path_info = File.join(@root, Rack::Utils.unescape(env["PATH_INFO"]))
+      if File.file?(path_info)
+        serve_guide(path_info)
+      elsif path_info.include? ".."
+        unauthorized_access
+      elsif File.directory?(path_info)
+        serve_index(path_info)
+      else
+        page_not_found(path_info)
+      end
+    end
+
+  protected
+
+    def serve_guide(filename)
+      body = Guide.new(filename).html
+      [200, {
+        "Content-Type"   => "text/html; charset=utf-8",
+        "Content-Length" => Rack::Utils.bytesize(body).to_s
+      }, [body] ]
+    end
+
+    def serve_index(path_info)
+      body = "TODO"
+      [200, {
+        "Content-Length" => Rack::Utils.bytesize(body).to_s,
+        "Content-Type"   => "text/html; charset=utf-8",
+      }, [body] ]
+    end
+
+    def page_not_found(path_info)
+      [404, {
+        "Content-Type"   => "text/plain",
+        "Content-Length" => "0"
+      }, ["File not found: #{path_info}\n"] ]
+    end
+
+    def unauthorized_access
+      [403, {
+        "Content-Type"   => "text/plain",
+        "Content-Length" => "0"
+      }, ["Forbidden\n"] ]
+    end
+  end
+end

data/lib/guide-em-up/guide.rb

@@ -0,0 +1,56 @@
+require "albino"
+require "digest/sha1"
+require "erubis"
+require "redcarpet"
+require "yajl"
+
+
+module GuideEmUp
+  class Guide < Struct.new(:filename, :title)
+    def initialize(filename)
+      self.filename = self.title = filename
+      @codemap = {}
+    end
+
+    def html
+      file = File.expand_path("../../../themes/github.erb", __FILE__)
+      tmpl = File.read(file)
+      Erubis::Eruby.new(tmpl).result(to_hash)
+    end
+
+  protected
+
+    def to_hash
+      hsh = Hash[members.zip values].merge(:content => content)
+      hsh
+    end
+
+    def content
+      raw = File.read(filename)
+      tmp = extract_code(raw)
+      red = Redcarpet.new(tmp, :autolink, :generate_toc, :smart, :strikethrough, :tables)
+      process_code red.to_html
+    end
+
+    # Code taken from gollum (http://github.com/github/gollum)
+    def extract_code(md)
+      md.gsub(/^``` ?(.+?)\r?\n(.+?)\r?\n```\r?$/m) do
+        id = Digest::SHA1.hexdigest($2)
+        @codemap[id] = { :lang => $1, :code => $2 }
+        id
+      end
+    end
+
+    def process_code(data)
+      @codemap.each do |id, spec|
+        lang, code = spec[:lang], spec[:code]
+        if code.lines.all? { |line| line =~ /\A\r?\n\Z/ || line =~ /^(    |\t)/ }
+          code.gsub!(/^(    |\t)/m, '')
+        end
+        output = Albino.new(code, lang).colorize(:P => "nowrap")
+        data.gsub!(id, "<pre><code class=\"#{lang}\">#{output}</code></pre>")
+      end
+      data
+    end
+  end
+end

data/lib/guide-em-up/version.rb

@@ -0,0 +1,3 @@
+module GuideEmUp
+  VERSION = "0.1.0"
+end

data/lib/guide-em-up.rb

@@ -0,0 +1,3 @@
+require "guide-em-up/guide"
+require "guide-em-up/browser"
+require "guide-em-up/version"

data/themes/github.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      #container { margin: 0 auto; max-width: 920px; background-color: #f8f8f8; padding: .7em; font-size: 13.34px; font-family: verdana, sans-serif; border: 1px #E0E0E0 solid; }
+      #container h2, #container h3, #content h4 { padding-top: 10px; border-top: 4px solid #E0E0E0; }
+      #container pre { padding: 5px; border-style: solid; border-width: 1px; border-color: #E0E0E0; background-color: #F8F8FF; }
+      #container pre code { padding: 5px; background-color: #F8F8FF; border: none; }
+      #container code { font-family: courier, fixed; display: inline-block; padding: 0px 2px 0px 2px; background-color: #F8F8FF; border: 1px #E0E0E0 solid; }
+      h4#title { font-family: verdana, sans-serif; display: block; margin: 0 auto; width: 920px; }
+    </style>
+    <title><%= title %></title>
+  </head>
+  <body>
+    <section id="container">
+      <%= content %>
+    </section>
+  </body>
+</html>

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: guide-em-up
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bruno Michel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: goliath
+  requirement: &75214320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75214320
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &75213920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75213920
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: &75213490 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75213490
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &75213080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75213080
+- !ruby/object:Gem::Dependency
+  name: albino
+  requirement: &75212840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *75212840
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &75212470 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: *75212470
+description: Slide'em up is a tool for writing guides in markdown
+email: bruno.michel@af83.com
+executables:
+- guide-em-up
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- MIT-LICENSE
+- README.md
+- Gemfile
+- bin/guide-em-up
+- lib/guide-em-up.rb
+- lib/guide-em-up/guide.rb
+- lib/guide-em-up/browser.rb
+- lib/guide-em-up/version.rb
+- themes/github.erb
+homepage: http://github.com/nono/guide-em-up
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Slide'em up is a tool for writing guides in markdown and generates one-page
+  HTML document from them
+test_files: []