gitdoc 3.1.0 → 3.2.0

data/Rakefile

@@ -7,10 +7,13 @@ begin
     gs.email    = "myles@myles.id.au"
     gs.authors  = ["Myles Byrne"]
     gs.require_path = '.'
-    gs.add_dependency('rdiscount', '>=1.5.8')
-    gs.add_dependency('haml', '>=2.2.22')
-    gs.add_dependency('sinatra', '>=1.0')
-    gs.add_dependency('unicorn','>=3.1.0')
+    gs.add_dependency('rdiscount', '~>1.5.8')
+    gs.add_dependency('haml', '~>2.2.22')
+    gs.add_dependency('sinatra', '~>1.0')
+    gs.add_dependency('unicorn','~>3.1.0')
+    gs.add_dependency('coffee-script', '~>2.1.1')
+    gs.add_dependency('therubyracer', '~>0.8.0') # v8 implementation
+    gs.add_dependency('json','~>1.4.6') # dependency of coffee-script
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/TODO

@@ -1,5 +1,6 @@
 * Open web browser after server launches
 * Less http logging
-* TomDoc the public API
 * A :scriptable option that supports script embedding and an /index.json call
 * Don't run the server on a port that's in use
+* Support ///cs syntax
+* running `gitdoc` launches gitdoc in current directory

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.2.0

data/bin/gitdoc

@@ -19,7 +19,7 @@ GitDoc!
 END
 
 rakefile = <<-END
-require 'bundler/setup' unless $LOAD_PATH.detect { |p| p =~ /gitdoc$/ }
+require 'bundler/setup' unless $LOAD_PATH.last =~ /gitdoc$/
 require 'gitdoc/tasks'
 END
 

data/gitdoc.rb

@@ -2,32 +2,54 @@ require 'sinatra'
 require 'rdiscount'
 require 'haml'
 require 'sass'
-require 'digest/sha1'
+
+## The Public Interface
+#
+# To run gitdoc in a directory create a rackup file like this:
+#
+#     require 'gitdoc'
+#     GitDoc!
+#
+# Boom. There are also some optional arguments:
+#
+#     require 'gitdoc'
+#     GitDoc! "Title to use",
+#       :header => '<!-- this will appear before the </head> tag -->'
+#       # This turns off GitDoc's default css, you still get reset and code
+#       # highligting styles
+#       :default_styles => false
 
 def GitDoc! title = nil, opts = {}
   dir = File.dirname(File.expand_path(caller.first.split(':').first))
   set :dir, dir
-  set :styles, dir + '/styles.sass'
   set :title, title
   set :header, opts[:header]
   set :default_styles, opts[:default_styles] != false
   run Sinatra::Application
 end
 
+## The Implementation
+
 set :haml, {:format => :html5}
 set :views, lambda { root }
 disable :logging # the server always writes its own log anyway
 
 helpers do
 
-  def md source
+  ### Document Compiler
+
+  require 'digest/sha1'
+
+  # Compiles a GitDoc document (basically markdown with code highlighting)
+  # into html
+  def gd source
     source_without_code = extract_code source
     html = RDiscount.new(source_without_code).to_html
     html = highlight_code html
     newline_entities_for_tag :pre, html
   end
 
-  # extract_code and highlight_code cribbed from:
+  # `extract_code` and `highlight_code` based on:
   # https://github.com/github/gollum/blob/0b8bc597a7e9495b272e5dbb743827f56ccd2fe6/lib/gollum/markup.rb#L367
 
   # Replaces all code fragments with a SHA1 hash. Stores the original fragment
@@ -70,29 +92,58 @@ helpers do
     end
   end
 
+  ### Coffee Compiler
+
+  require 'v8'
+  require 'coffee-script'
+
+  def coffee source
+    CoffeeScript.compile source
+  end
+
 end
 
+# If the path doesn't have a file extension and a matching GitDoc document
+# exists then it is compiled and rendered
 get '/*' do |name|
   name = 'index' if name.empty?
   file = File.join(settings.dir + '/' + name + '.md')
   pass unless File.exist? file
-  @doc = md File.read(file)
+  @doc = gd File.read(file)
   haml :doc
 end
 
-get '/*.*' do |name,ext|
-  file = File.join(settings.dir + '/' + name + '.' + ext)
-  pass unless File.exist? file
-  send_file file
-end
-
+# GitDoc document styles
 get '/.css' do
   content_type :css
   styles = sass(:reset)
   styles += File.read(settings.root + '/highlight.css')
   styles += sass(:default) if settings.default_styles?
-  styles += sass(File.read(settings.styles)) if File.exist? settings.styles
+  custom_styles = settings.dir + '/styles.sass'
+  styles += sass(File.read(custom_styles)) if File.exist? custom_styles
   styles
 end
 
-not_found { "404. Oh Noes!" }
+# If the corresponding .coffee file exists it is compiled and rendered
+get '*.coffee.js' do |name|
+  file = settings.dir + '/' + name + '.coffee'
+  pass unless File.exist? file
+  coffee File.read file
+end
+
+# If the path matches any file in the directory then send that down
+get '/*.*' do |name,ext|
+  file = File.join(settings.dir + '/' + name + '.' + ext)
+  pass unless File.exist? file
+  send_file file
+end
+
+not_found do
+  version = File.read(File.dirname(__FILE__)+'/VERSION')
+  @doc = gd(
+    "# Not Found"+
+    "\n\n"+
+    "GitDoc version #{version}"
+  )
+  haml :doc
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gitdoc
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 15
   prerelease: false
   segments: 
   - 3
-  - 1
+  - 2
   - 0
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors: 
 - Myles Byrne
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-20 00:00:00 +11:00
+date: 2011-01-23 00:00:00 +11:00
 default_executable: gitdoc
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,7 +24,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 19
         segments: 
@@ -40,7 +40,7 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 43
         segments: 
@@ -56,7 +56,7 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 15
         segments: 
@@ -71,7 +71,7 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
@@ -81,6 +81,54 @@ dependencies:
         version: 3.1.0
   type: :runtime
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: coffee-script
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: therubyracer
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 8
+        - 0
+        version: 0.8.0
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id007
 description: 
 email: myles@myles.id.au
 executables: