gitdoc 3.10.0 → 3.13.0

data/Rakefile

@@ -1,21 +1,13 @@
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gs|
-    gs.name     = "gitdoc"
-    gs.homepage = "http://github.com/quackingduck/gitdoc"
-    gs.summary  = "A light-weight web app for serving up a folder of markdown files"
-    gs.email    = "myles@myles.id.au"
-    gs.authors  = ["Myles Byrne"]
-    gs.require_path = '.'
-    gs.add_dependency('rdiscount', '~>1.5.8')
-    gs.add_dependency('haml', '~>3.0.25')
-    gs.add_dependency('sinatra', '~>1.0')
-    gs.add_dependency('unicorn','~>3.1.0')
-    gs.add_dependency('coffee-script', '~>2.1.1')
-    gs.add_dependency('json','~>1.4.6') # dependency of coffee-script
-    gs.add_dependency('livereload', '~>1.5')
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Install jeweler to build gem"
-end
+def gemfile
+  Dir['pkg/*'].sort.last
+end
+
+task :install do
+  sh 'gem build gitdoc.gemspec'
+  sh 'mv *.gem pkg/'
+  sh "gem install -l #{gemfile}"
+end
+
+task :tag do
+  sh "git tag -a v`cat VERSION` `git rev-parse HEAD` -m ''"
+end

data/TODO.md

@@ -0,0 +1,73 @@
+# config.ru for build
+
+custom 404
+
+# .htaccess for build
+
+custom 404
+
+# Set verison via set 
+
+right now there's a file_read in not_found
+
+# Remove livereload support
+
+Because Chris whines about it. Add instructions for adding to documentation
+
+# Embedded HAML support
+
+Would allow dynamic indexes and rss generation (by implementors). Example:
+
+    ///haml
+      - generate_rss
+      = article_list
+    ///
+
+# Remove unicorn dependency
+
+webrick is probably fine
+
+# horizontal scrollbars to code elements
+
+Can get this style from centro blog
+
+# Rename to Goat
+
+The program has very little to do with git
+
+# Factor out ExtendedHTMLCompiler
+
+Supports inline coffeescript and inline stylus
+
+# Factor out DocumentCompiler
+
+Supports embedded style/script and embedded syntax-highlighted code.
+
+# New Interface
+
+    Goat.set :default_styles, false
+    Goat! "Default Title"
+
+# Features load on boot
+
+A log message appears when Goat can't load CoffeeScript, Stylus or Pygments
+
+Something like
+
+    Couldn't find `coffee` in path, CoffeeScript to JavaScript compiler not loaded
+    Couldn't find `stylus` node package, Stylus to CSS compiler not loaded
+    Couldn't find `pygments` in path, Pgyments syntax highlighter not loaded
+
+# Reasonable Errors for features that are not loaded
+
+# Custom Error pages
+
+The sinatra one is just ugly
+
+# Bundle non-ruby dependencies
+
+The priority is stylus (0.6), then coffeescript.
+
+Might be a little tricky but it would be nice to ship vendored CoffeeScript, Stylus and Pygments so that these things don't unexpectedly break.
+
+There's arguments for and against this one

data/VERSION

@@ -1 +1 @@
-3.10.0
+3.13.0

data/doc.haml

@@ -4,4 +4,8 @@
   %meta{:charset => "utf-8"}
   %link{:rel => :stylesheet, :href => '/.css'}
   = settings.header
-#doc!= @doc
+
+- if custom_body?
+  = custom_body
+- else
+  #doc!= @doc

data/gitdoc.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |gs|
+  gs.name     = "gitdoc"
+  gs.version  = File.read(File.dirname(__FILE__)+'/VERSION')
+  gs.homepage = "http://github.com/quackingduck/gitdoc"
+  gs.summary  = "A light-weight web app for serving up a folder of markdown files"
+  gs.email    = "myles@myles.id.au"
+  gs.author   = "Myles Byrne"
+  gs.require_path = '.'
+
+  gs.extra_rdoc_files = ["README.md"]
+
+  gs.files = Dir['**/**/*']
+
+  gs.add_dependency 'rdiscount', '~>1.5.8'
+  gs.add_dependency 'haml', '~>3.0.25'
+  gs.add_dependency 'sinatra', '~>1.0'
+  gs.add_dependency 'unicorn','~>3.1.0'
+  gs.add_dependency 'coffee-script', '~>2.1.1'
+  gs.add_dependency 'json','~>1.4.6' # dependency of coffee-script
+  gs.add_dependency 'livereload', '~>1.5'
+end

data/gitdoc.rb

@@ -30,7 +30,9 @@ end
 
 ## The Implementation
 
-set :haml, {:format => :html5}
+GitDoc = Sinatra::Application
+
+set :haml, :format => :html5
 set :views, lambda { root }
 disable :logging # the server always writes its own log anyway
 
@@ -43,12 +45,28 @@ helpers do
   # 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 = extract_code source
+    html = process_haml html
+    html = extract_styles html
+    html = RDiscount.new(html).to_html
     html = highlight_code html
     newline_entities_for_tag :pre, html
   end
 
+  def process_haml source
+    # only supports single lines atm
+    source.gsub %r{///\s*haml\s*(.+)?$} do
+      haml $1
+    end
+  end
+
+  def extract_styles source
+    # only suppors css atm, also a dirty hack
+    source.gsub(/^<style\s?(?:type=['"]?text\/css['"])?>\r?\n(.+?)<\/style>?$/m) do |match|
+      "<div><style type='text/css'>\n#{scss $1}</style></div>"
+    end
+  end
+
   # `extract_code` and `highlight_code` based on:
   # https://github.com/github/gollum/blob/0b8bc597a7e9495b272e5dbb743827f56ccd2fe6/lib/gollum/markup.rb#L367
 
@@ -138,6 +156,16 @@ stylus.render str, {paths: ['#{File.dirname file}']}, (err,css) -> sys.puts css
     `coffee --eval #{Shellwords.escape stylus_compiler}`.chomp
   end
 
+  # Custom templates
+
+  def custom_body?
+    File.exists? settings.dir + '/body.haml'
+  end
+
+  def custom_body
+    haml File.read(settings.dir + '/body.haml')
+  end
+
 end
 
 # If the path doesn't have a file extension and a matching GitDoc document
@@ -176,6 +204,7 @@ get '*.html' do |name|
   html file
 end
 
+# Deprecated
 get '*._plain' do |name|
   file = settings.dir + '/' + name
   pass unless File.exist? file
@@ -183,6 +212,13 @@ get '*._plain' do |name|
   File.read(file)
 end
 
+get '*.txt' do |name|
+  file = settings.dir + '/' + name
+  pass unless File.exist? file
+  content_type :text
+  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)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gitdoc
 version: !ruby/object:Gem::Version 
-  hash: 47
+  hash: 51
   prerelease: false
   segments: 
   - 3
-  - 10
+  - 13
   - 0
-  version: 3.10.0
+  version: 3.13.0
 platform: ruby
 authors: 
 - Myles Byrne
@@ -15,8 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-28 00:00:00 +11:00
-default_executable: gitdoc
+date: 2011-04-07 00:00:00 +10:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rdiscount
@@ -130,34 +130,37 @@ dependencies:
   version_requirements: *id007
 description: 
 email: myles@myles.id.au
-executables: 
-- gitdoc
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
 - README.md
-- TODO
 files: 
-- .gitignore
-- README.md
-- Rakefile
-- TODO
-- VERSION
 - bin/gitdoc
 - default.sass
 - doc.haml
 - favicon.ico
-- gitdoc.rb
 - gitdoc/tasks.rb
+- gitdoc.gemspec
+- gitdoc.rb
 - highlight.css
+- pkg/gitdoc-3.10.1.gem
+- pkg/gitdoc-3.11.0.gem
+- pkg/gitdoc-3.11.1.gem
+- pkg/gitdoc-3.12.0.gem
+- Rakefile
+- README.md
 - reset.sass
+- TODO.md
+- VERSION
 has_rdoc: true
 homepage: http://github.com/quackingduck/gitdoc
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - .
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1,2 +0,0 @@
-*.gemspec
-pkg

data/TODO

@@ -1,9 +0,0 @@
-* Push the current path level into the load path for sass
-* Add nice horizontal scrollbars to code elements
-* Support inline coffee compilation in html
-* Open web browser after server launches
-* Less http logging
-* 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