guides 0.6.5 → 0.6.6

data/Rakefile

@@ -1,3 +1,7 @@
+require "bundler/setup"
+require "guides/version"
+require "erb"
+
 file "Guides/local/guides/bundle" => "Gemfile" do
   require "rbconfig"
 
@@ -43,13 +47,79 @@ file "Guides/bin/guides" => "bin/guides" do
 
   sh "mkdir -p Guides/bin"
   File.open("Guides/bin/guides", "w") { |file| file.puts guides }
+  File.chmod 0755, "Guides/bin/guides"
 end
 
 desc "Prep the release for PackageMaker"
-task :pkg => ["Guides/local/guides/bundle", "Guides/local/guides/lib", "Guides/bin/guides"]
+task :make_pkg => ["Guides/local/guides/bundle", "Guides/local/guides/lib", "Guides/bin/guides"]
 
 task :rm do
   rm_rf "Guides"
 end
 
+directory "guides-pkg/Resources"
+directory "guides-pkg/guides.pkg"
+
+pkg_dependencies = [:make_pkg, "guides-pkg/Resources", "guides-pkg/guides.pkg",
+  "guides-pkg/Distribution", "guides-pkg/guides.pkg/Bom",
+  "guides-pkg/guides.pkg/PackageInfo", "guides-pkg/guides.pkg/Payload"]
+
+def details
+  @details ||= begin
+    total_size, files = 0, 0
+
+    Dir["Guides/**/*"].each do |file|
+      files += 1
+
+      next if File.directory?(file)
+
+      total_size += File.size(file)
+    end
+
+    [total_size, files]
+  end
+end
+
+file "guides-pkg/Distribution" do
+  src = File.read File.expand_path("../build/Distribution.erb", __FILE__)
+  erb = ERB.new(src)
+
+  total_size, files = details
+
+  kbytes = total_size / 1024
+  version = Guides::VERSION
+
+  File.open("guides-pkg/Distribution", "w") do |file|
+    file.puts erb.result(binding)
+  end
+end
+
+file "guides-pkg/guides.pkg/PackageInfo" do
+  src = File.read File.expand_path("../build/PackageInfo.erb", __FILE__)
+  erb = ERB.new(src)
+
+  total_size, num_files = details
+
+  kbytes = total_size / 1024
+  version = Guides::VERSION
+
+  File.open("guides-pkg/guides.pkg/PackageInfo", "w") do |file|
+    file.puts erb.result(binding)
+  end
+end
+
+file "guides-pkg/guides.pkg/Bom" do
+  sh "mkbom -s Guides guides-pkg/guides.pkg/Bom"
+end
+
+file "guides-pkg/guides.pkg/Payload" do
+  sh "cd Guides && pax -wz -x cpio . > ../guides-pkg/guides.pkg/Payload"
+end
+
+file "Guides.pkg" => pkg_dependencies do
+  sh "pkgutil --flatten guides-pkg Guides.pkg"
+end
+
+task :pkg => "Guides.pkg"
+
 task :clean => [:rm, :pkg]

data/guides.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency "activesupport", "~> 3.0.0"
   s.add_dependency "rack", "~> 1.2.1"
   s.add_dependency "RedCloth", "~> 4.1.1"
+  s.add_dependency "maruku", "~> 0.6.0"
   s.add_dependency "thor", "~> 0.14.6"
   s.add_dependency "thin", "~> 1.2.7"
 

data/lib/guides.rb

@@ -1,7 +1,9 @@
 require "action_pack"
 require "redcloth"
+require "maruku"
 
 require "guides/textile_extensions"
+require "guides/markdown_extensions"
 require "guides/generator"
 
 module Guides

data/lib/guides/generator.rb

@@ -61,7 +61,7 @@ module Guides
   class Generator
     attr_reader :guides_dir, :source_dir, :output_dir, :edge, :warnings, :all
 
-    EXTENSIONS = %w(textile html.erb)
+    EXTENSIONS = %w(textile md html.erb)
     GUIDES_RE = /\.(?:#{EXTENSIONS.map{|e| Regexp.escape(e)}.join('|')})$/
     LOCAL_ASSETS = File.expand_path("../templates/assets", __FILE__)
 
@@ -86,33 +86,6 @@ module Guides
       copy_assets
     end
 
-    def generate_guide(guide, output_file)
-      return unless generate?(guide, output_file)
-
-      puts "Generating #{output_file}"
-      File.open(File.join(output_dir, output_file), 'w') do |f|
-        view = ActionView::Base.new(source_dir, :edge => edge)
-        view.extend(Helpers)
-
-        if guide =~ /\.html\.erb$/
-          # Generate the special pages like the home.
-          view.render("sections")
-          type = @edge ? "edge" : "normal"
-          result = view.render(:layout => 'layout', :file => guide, :locals => {:guide_type => type})
-        else
-          body = File.read(File.join(source_dir, guide))
-          body = set_header_section(body, view)
-          body = set_index(body, view)
-
-          result = view.render(:layout => 'layout', :text => textile(body))
-
-          warn_about_broken_links(result) if @warnings
-        end
-
-        f.write result
-      end
-    end
-
   private
     def generate_guides
       guides_to_generate.each do |guide|
@@ -165,11 +138,15 @@ module Guides
           type = @edge ? "edge" : "normal"
           result = view.render(:layout => 'layout', :file => guide, :locals => {:guide_type => type})
         else
+          processor = (guide =~ /\.md$/) ? :markdown : :textile
+
           body = File.read(File.join(source_dir, guide))
-          body = set_header_section(body, view)
-          body = set_index(body, view)
+          body = set_header_section(body, view, processor)
+          body = set_index(body, view, processor)
 
-          result = view.render(:layout => 'layout', :text => textile(body))
+          text = (processor == :markdown) ? markdown(body) : textile(body)
+
+          result = view.render(:layout => 'layout', :text => text)
 
           warn_about_broken_links(result) if @warnings
         end
@@ -178,7 +155,7 @@ module Guides
       end
     end
 
-    def set_header_section(body, view)
+    def set_header_section(body, view, processor)
       new_body = body.sub(/(.*?)endprologue\./m, '').strip
       header = $1
 
@@ -186,20 +163,28 @@ module Guides
         raise FormatError, "A prologue is required. Use 'endprologue.' to separate the prologue from the main body."
       end
 
-      if header =~ /h2\.(.*)/
-        page_title = "#{@meta["title"]}: #{$1.strip}"
+      if processor == :markdown
+        if header =~ /^(.+)\r?\n-+$/ || header =~ /^## (.+)$/
+          page_title = "#{@meta["title"]}: #{$1.strip}"
+        else
+          raise FormatError, "A title is required. Underline the title with '------' or prefix it with '##'"
+        end
       else
-        raise FormatError, "A title is required. Use the 'h2.' declaration to denote the title."
+        if header =~ /h2\.(.*)/
+          page_title = "#{@meta["title"]}: #{$1.strip}"
+        else
+          raise FormatError, "A title is required. Use the 'h2.' declaration to denote the title."
+        end
       end
 
-      header = textile(header)
+      header = (processor == :markdown) ? markdown(header) : textile(header)
 
       view.content_for(:page_title) { page_title.html_safe }
       view.content_for(:header_section) { header.html_safe }
       new_body
     end
 
-    def set_index(body, view)
+    def set_index(body, view, processor)
       index = <<-INDEX
       <div id="subCol">
         <h3 class="chapter"><img src="images/chapters_icon.gif" alt="" />Chapters</h3>
@@ -211,11 +196,16 @@ module Guides
 
       # Set index for 2 levels
       i.level_hash.each do |key, value|
-        link = view.content_tag(:a, :href => key[:id]) { textile(key[:title], true).html_safe }
+        link = view.content_tag(:a, :href => key[:id]) do
+          (processor == :markdown ? markdown(key[:title]) : textile(key[:title], true)).html_safe
+        end
 
         children = value.keys.map do |k|
-          view.content_tag(:li,
-            view.content_tag(:a, :href => k[:id]) { textile(k[:title], true).html_safe })
+          view.content_tag :li do
+            view.content_tag(:a, :href => k[:id]) do
+              (processor == :markdown ? markdown(k[:title]) : textile(k[:title], true)).html_safe
+            end
+          end
         end
 
         children_ul = children.empty? ? "" : view.content_tag(:ul, children.join(" ").html_safe)
@@ -237,10 +227,14 @@ module Guides
         t = RedCloth.new(new_body)
         t.hard_breaks = false
         t.lite_mode = lite_mode
-        t.to_html(:notestuff, :plusplus, :code, :tip)
+        t.to_html(:notestuff, :plusplus)
       end
     end
 
+    def markdown(body)
+      Maruku.new(body).to_html
+    end
+
     # For some reason the notextile tag does not always turn off textile. See
     # LH ticket of the security guide (#7). As a temporary workaround we deal
     # with code blocks by hand.

data/lib/guides/markdown_extensions.rb

@@ -0,0 +1,77 @@
+# Hack for buggy method that thinks NOTE is an email header
+class MaRuKu::MDDocument
+  def parse_email_headers(s)
+    { :data => s}
+  end
+end
+
+
+OpenCodeRegexp = /<(yaml|shell|ruby|erb|html|sql|plain|javascript|css)>/
+CloseCodeRegexp = lambda{|type| /<\/#{type}>/ }
+
+NoteRegexp = /^(IMPORTANT|CAUTION|WARNING|NOTE|INFO|TIP)[.:](.*)/
+
+Maruku::In::Markdown.register_block_extension(
+  :regexp => OpenCodeRegexp,
+  :handler => lambda{|doc, src, context|
+    # Double check first line to get type
+    type = src.shift_line.match(OpenCodeRegexp)[1]
+
+    # Get all intermediate lines
+    body = ""
+    while src.cur_line && src.cur_line !~ CloseCodeRegexp.call(type)
+      body << src.shift_line + "\n"
+    end
+
+    # Throw away last line
+    src.shift_line
+
+
+    brush = case type
+      when 'ruby', 'sql', 'javascript', 'css', 'plain'
+        type
+      when 'erb'
+        'ruby; html-script: true'
+      when 'html'
+        'xml' # html is understood, but there are .xml rules in the CSS
+      else
+        'plain'
+    end
+
+    context.push doc.md_html(<<HTML
+<div class="code_container">
+<pre class="brush: #{brush}; gutter: false; toolbar: false">
+#{ERB::Util.h(body.strip)}
+</pre>
+</div>
+HTML
+    )
+    true
+  }
+)
+
+
+Maruku::In::Markdown.register_block_extension(
+  :regexp => NoteRegexp,
+  :handler => lambda{|doc, src, context|
+    # Double check first line to get type and starting text
+    type, body = src.shift_line.match(NoteRegexp).captures
+
+    # Get all intermediate lines
+    while src.cur_line && src.cur_line.strip.length > 0
+      body << " #{src.shift_line}"
+    end
+
+    css_class = type.downcase
+    css_class = 'warning' if ['caution', 'important'].include?(css_class)
+    css_class = 'info' if css_class == 'tip'
+
+    result = "<div class='#{css_class}'><p>"
+    result << body.strip
+    result << '</p></div>'
+
+    context.push doc.md_html(result)
+    true
+  }
+)
+

data/lib/guides/textile_extensions.rb

@@ -1,8 +1,9 @@
 class RedCloth::TextileDoc
   def notestuff(body)
-    body.gsub!(/^(IMPORTANT|CAUTION|WARNING|NOTE|INFO)[.:](.*)$/) do |m|
+    body.gsub!(/^(IMPORTANT|CAUTION|WARNING|NOTE|INFO|TIP)[.:](.*?)(?=((\r?\n){2}|\z))/m) do |m|
       css_class = $1.downcase
       css_class = 'warning' if ['caution', 'important'].include?(css_class)
+      css_class = 'info' if css_class == 'tip'
 
       result = "<div class='#{css_class}'><p>"
       result << $2.strip
@@ -11,15 +12,6 @@ class RedCloth::TextileDoc
     end
   end
 
-  def tip(body)
-    body.gsub!(/^TIP[.:](.*)$/) do |m|
-      result = "<div class='info'><p>"
-      result << $1.strip
-      result << '</p></div>'
-      result
-    end
-  end
-
   def plusplus(body)
     body.gsub!(/\+(.*?)\+/) do |m|
       "<notextile><tt>#{$1}</tt></notextile>"
@@ -28,12 +20,4 @@ class RedCloth::TextileDoc
     # The real plus sign
     body.gsub!('<plus>', '+')
   end
-
-  def code(body)
-    body.gsub!(%r{<(yaml|shell|ruby|erb|html|sql|plain)>(.*?)</\1>}m) do |m|
-      es = ERB::Util.h($2)
-      css_class = ['erb', 'shell'].include?($1) ? 'html' : $1
-      %{<notextile><div class="code_container"><code class="#{css_class}">#{es}</code></div></notextile>}
-    end
-  end
 end

data/lib/guides/version.rb

@@ -1,3 +1,3 @@
 module Guides
-  VERSION = "0.6.5"
+  VERSION = "0.6.6"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 6
-  - 5
-  version: 0.6.5
+  - 6
+  version: 0.6.6
 platform: ruby
 authors: 
 - Yehuda Katz
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-20 00:00:00 -08:00
+date: 2011-02-02 00:00:00 -08:00
 default_executable: guides
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,9 +78,24 @@ dependencies:
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: thor
+  name: maruku
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -91,11 +106,11 @@ dependencies:
         - 6
         version: 0.14.6
   type: :runtime
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: thin
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -106,7 +121,7 @@ dependencies:
         - 7
         version: 1.2.7
   type: :runtime
-  version_requirements: *id006
+  version_requirements: *id007
 description: A tool for creating version controlled guides for open source projects, based on the Rails Guides framework
 email: 
 - wycats@gmail.com
@@ -128,6 +143,7 @@ files:
 - lib/guides/helpers.rb
 - lib/guides/indexer.rb
 - lib/guides/levenshtein.rb
+- lib/guides/markdown_extensions.rb
 - lib/guides/new.rb
 - lib/guides/preview.rb
 - lib/guides/templates/assets/images/book_icon.gif