guides 0.6.7 → 0.6.8

data/Rakefile

@@ -1,3 +1,7 @@
+require "bundler/setup"
+require "guides/version"
+require "erb"
+
 file "Guides/local/guides/bundle" => "Gemfile" do
   require "rbconfig"
 
@@ -14,14 +18,16 @@ file "Guides/local/guides/bundle" => "Gemfile" do
   puts "Regenerating the bundle."
 
   sh "rm -rf bundle"
-  sh "bundle --standalone --local --without development"
+  Bundler.with_clean_env do
+    sh "bundle --standalone --local --without development"
+  end
   sh "mkdir -p Guides/local/guides"
   sh "cp -R bundle Guides/local/guides/"
 
   verbose(false) do
     Dir.chdir("Guides/local/guides/bundle/ruby/1.9.1") do
       Dir["{bin,cache,doc,specifications}"].each { |f| rm_rf f }
-      Dir["**/{ext,docs,test,spec}"].each { |f| rm_rf(f) if File.directory?(f) }
+      Dir["**/{ext,docs,test,spec}"].each { |f| rm_rf(f) if File.directory?(f) && f !~ /maruku/i }
       Dir["**/erubis-*/doc-api"].each {|f| rm_rf(f) }
     end
   end
@@ -43,13 +49,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/build/Distribution.erb

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<installer-script minSpecVersion="1.000000" authoringTool="org.ruby-lang.rake" authoringToolVersion="0.8.7">
+  <title>Guides</title>
+  <options customize="never" allow-external-scripts="no"/>
+  <domains enable_localSystem="true"/>
+  <script>
+    function ruby19p136_installed() {
+      return !(system.files.fileExistsAtPath('/usr/local/ruby1.9') == true);
+    }
+  </script>
+  <choices-outline>
+    <line choice="ruby19p136"/>
+    <line choice="guides"/>
+  </choices-outline>
+  <choice id="ruby19p136" title="ruby" start_selected="false" start_enabled="false" selected="ruby19p136_installed()" enabled="ruby19p136_installed()">
+    <pkg-ref id="com.strobecorp.ruby19"/>
+  </choice>
+  <choice id="guides" title="Guides">
+    <pkg-ref id="com.strobecorp.guides"/>
+  </choice>
+  <pkg-ref id="com.strobecorp.ruby19" installKBytes="26156" archiveKBytes="7353" hash-sha256="7b9507f7a9178c0eaafd3ffcfd2e246400e82899e6f29df2f7c4fcec6ec04ac5" version="1.9.2p136" auth="Root">http://ruby-pkg.strobeapp.com/Ruby-1.9.2p136.pkg</pkg-ref>
+  <pkg-ref id="com.strobecorp.guides" installKBytes="<%= kbytes %>" version="<%= version %>" auth="Root">#guides.pkg</pkg-ref>
+</installer-script>

data/build/PackageInfo.erb

@@ -0,0 +1,4 @@
+<pkg-info format-version="2" identifier="com.strobecorp.guides" version="<%= version %>" install-location="/usr" auth="root">
+  <payload installKBytes="<%= kbytes %>" numberOfFiles="<%= num_files %>"/>
+</pkg-info>
+

data/guides.gemspec

@@ -28,7 +28,6 @@ Gem::Specification.new do |s|
   s.files              = `git ls-files`.split("\n")
   s.test_files         = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables        = %w(guides)
-  s.default_executable = "guides"
   s.require_paths      = ["lib"]
 end
 

data/lib/guides.rb

@@ -2,7 +2,7 @@ require "action_pack"
 require "redcloth"
 require "maruku"
 
-require "guides/textile_extensions"
+require "guides/textile_transformer"
 require "guides/markdown_extensions"
 require "guides/generator"
 

data/lib/guides/cli.rb

@@ -21,8 +21,12 @@ module Guides
     desc "build", "build the guides output"
     method_option "only", :type => :array
     method_option "clean", :type => :boolean
+    method_option "production", :type => :boolean, :default => true, :banner => "use production mode", :aliases => "-p"
     def build
-      FileUtils.rm_rf("#{Guides.root}/output") if options[:clean]
+      if options[:clean]
+        FileUtils.rm_rf(File.join(Guides.root, options[:production] ? 'output' : 'staging'))
+      end
+
       require "guides/generator"
 
       opts = options.dup
@@ -42,8 +46,9 @@ module Guides
     end
 
     desc "preview", "preview the guides as you work"
+    method_option "production", :type => :boolean, :banner => "use production mode", :aliases => "-p"
     def preview
-      Preview.start
+      Preview.start(options)
     end
 
     #desc "update", "when running from the pkg, updates the gem"

data/lib/guides/generator.rb

@@ -70,13 +70,14 @@ module Guides
 
       @guides_dir = File.expand_path(Dir.pwd)
       @source_dir = File.join(@guides_dir, "source")
-      @output_dir = File.join(@guides_dir, "output")
+      @output_dir = File.join(@guides_dir, options[:production] ? "output" : "staging")
 
       FileUtils.mkdir_p(@output_dir)
 
       @edge     = options[:edge]
       @warnings = options[:warnings]
       @all      = options[:all]
+      @production = options[:production]
 
       @meta = Guides.meta
     end
@@ -86,6 +87,13 @@ module Guides
       copy_assets
     end
 
+    def construction?(source_file)
+      # TODO: Clean this up a bit, it is messy
+      url = source_file.sub(/\.(#{EXTENSIONS.map{|e| Regexp.escape(e) }.join('|')})$/, '')
+      guide = @meta['index'].values.flatten.select{|g| g['url'] == url }.first rescue nil
+      guide && guide['construction']
+    end
+
   private
     def generate_guides
       guides_to_generate.each do |guide|
@@ -116,6 +124,8 @@ module Guides
       fin  = File.join(source_dir, source_file)
       fout = File.join(output_dir, output_file)
 
+      return false if @production && construction?(source_file)
+
       if File.exists?(fout) && File.mtime(fout) < File.mtime(File.join(Guides.root, "guides.yml"))
         Guides.meta(true)
         return true
@@ -129,7 +139,7 @@ module Guides
 
       puts "Generating #{output_file}"
       File.open(File.join(output_dir, output_file), 'w') do |f|
-        view = ActionView::Base.new(source_dir, :edge => edge)
+        view = ActionView::Base.new(source_dir, :edge => edge, :production => @production)
         view.extend(Helpers)
 
         if guide =~ /\.html\.erb$/
@@ -222,56 +232,13 @@ module Guides
     end
 
     def textile(body, lite_mode=false)
-      # If the issue with notextile is fixed just remove the wrapper.
-      with_workaround_for_notextile(body) do |new_body|
-        t = RedCloth.new(new_body)
-        t.hard_breaks = false
-        t.lite_mode = lite_mode
-        t.to_html(:notestuff, :plusplus)
-      end
+      TextileTransformer.new(@production).transform(body)
     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.
-    def with_workaround_for_notextile(body)
-      code_blocks = []
-
-      body.gsub!(%r{<(yaml|shell|ruby|erb|html|sql|plain|javascript|css)>(.*?)</\1>}m) do |m|
-        brush = case $1
-          when 'ruby', 'sql', 'javascript', 'css', 'plain'
-            $1
-          when 'erb'
-            'ruby; html-script: true'
-          when 'html'
-            'xml' # html is understood, but there are .xml rules in the CSS
-          else
-            'plain'
-        end
-
-        code_blocks.push(<<HTML)
-<notextile>
-<div class="code_container">
-<pre class="brush: #{brush}; gutter: false; toolbar: false">
-#{ERB::Util.h($2).strip}
-</pre>
-</div>
-</notextile>
-HTML
-        "\ndirty_workaround_for_notextile_#{code_blocks.size - 1}\n"
-      end
-
-      body = yield body
-
-      body.gsub(%r{<p>dirty_workaround_for_notextile_(\d+)</p>}) do |_|
-        code_blocks[$1.to_i]
-      end
-    end
-
     def warn_about_broken_links(html)
       anchors = extract_anchors(html)
       check_fragment_identifiers(html, anchors)

data/lib/guides/helpers.rb

@@ -1,8 +1,6 @@
 module Guides
   module Helpers
     def clickable_index
-      all_guides = Guides.meta["index"]
-
       total_guides = all_guides.inject(0) do |sum, (name, guides)|
         sum + guides.size
       end
@@ -22,6 +20,18 @@ module Guides
       render "clickable_index", :lgroup => lgroup, :rgroup => rgroup
     end
 
+    def is_production?
+      assigns[:production]
+    end
+
+    def all_guides
+      Guides.meta["index"].inject({}) do |ret, (section, items)|
+        items = items.reject{|item| item['construction'] } if is_production?
+        ret[section] = items unless items.empty?
+        ret
+      end
+    end
+
     def guide(name, url, options = {}, &block)
       link = content_tag(:a, :href => url) { name }
       result = content_tag(:dt, link)

data/lib/guides/preview.rb

@@ -2,10 +2,11 @@ require "rack"
 
 module Guides
   class App
-    def initialize
+    def initialize(options = {})
+      @production = !!options[:production]
       @local  = Rack::File.new(local_assets)
       @source = Rack::File.new(source_assets)
-      @output = Rack::File.new(File.join(Guides.root, "output"))
+      @output = Rack::File.new(File.join(Guides.root, @production ? "output" : "staging"))
     end
 
     def local_assets
@@ -29,14 +30,21 @@ module Guides
         return call(env)
       when /\/(.*)\.html$/
         name = $1
-        generator = Guides::Generator.new({})
-        source_file = Dir["#{source_templates}/#{name}.{html.erb,textile}"].first
+        generator = Guides::Generator.new({ :production => @production })
+
+        source_file = Dir["#{source_templates}/#{name}.{#{Guides::Generator::EXTENSIONS.join(",")}}"].first
 
         unless source_file
           return [404, {"Content-Type" => "text/html"}, ["#{name} not found in #{source_templates}: #{Guides.root}"]]
         end
 
-        generator.send(:generate_guide, File.basename(source_file), "#{name}.html")
+        source_base = File.basename(source_file)
+
+        if generator.construction?(source_base) && @production
+          return [404, {"Content-Type" => "text/html"}, ["#{name} is under construction and not available in production"]]
+        end
+
+        generator.send(:generate_guide, source_base, "#{name}.html")
         return @output.call(env)
       else
         source = @source.call(env)
@@ -47,12 +55,17 @@ module Guides
   end
 
   class Preview < Rack::Server
-    def self.start(*)
-      super :host => '0.0.0.0', :Port => 9292, :server => "thin"
+    def self.start(options = {})
+      super options.merge(:host => '0.0.0.0', :Port => 9292, :server => "thin")
+    end
+
+    def initialize(options = {})
+      @production = !!options[:production]
+      super(options)
     end
 
     def app
-      @app ||= App.new
+      @app ||= App.new(:production => @production)
     end
   end
 end

data/lib/guides/templates/assets/stylesheets/main.css

@@ -370,6 +370,17 @@ div.code_container {
 	padding: 0.25em 1em 0.5em 48px;
 }
 
+div.code_container div.filename {
+	font-family: monospace;
+	color: #666;
+	border-bottom: 1px solid #ccc;
+	border-top: 1px solid #ccc;
+	margin: 4px -14px 0 -13px;
+	padding-bottom: 4px;
+	background-color: #ddd;
+	padding-left: 10px;
+}
+
 .note {
 	background: #fff9d8 url(../images/tab_note.gif) no-repeat left top;
 	border: none;

data/lib/guides/templates/source/index.html.erb

@@ -1 +1 @@
-<%= render "full_index", :guides => Guides.meta["index"] %>
+<%= render "full_index", :guides => all_guides %>

data/lib/guides/textile_transformer.rb

@@ -0,0 +1,84 @@
+require "strscan"
+require "cgi"
+
+module Guides
+  class TextileTransformer
+    LANGUAGES = { "ruby" => "ruby", "sql" => "sql", "javascript" => "javascript",
+                  "css" => "css", "plain" => "plain", "erb" => "ruby; html-script: true",
+                  "html" => "xml", "xml" => "xml", "shell" => "plain", "yaml" => "yaml" }
+
+    NOTES =     { "CAUTION" => "warning", "IMPORTANT" => "warning", "WARNING" => "warning",
+                  "INFO" => "info", "TIP" => "info", "NOTE" => "note" }
+
+    def initialize(production=false)
+      @production = production
+    end
+
+    def transform(string)
+      @string = string.dup
+
+      @output  = ""
+      @pending_textile = ""
+
+      until @string.empty?
+        notes     = NOTES.keys.map {|note| "#{note}" }.join("|")
+        languages = LANGUAGES.keys.join("|")
+
+        match = scan_until /(\+(\S.*?\S?)\+|<(#{languages})(?: filename=["']([^"']*)["'])?>|(#{notes}): |<(construction)>|\z)/m
+
+        @pending_textile << match.pre_match
+
+        if match[2]    # +foo+
+          @pending_textile << "<notextile><tt>#{CGI.escapeHTML(match[2])}</tt></notextile>" if match[2]
+        elsif match[3] # <language>
+          flush_textile
+          generate_brushes match[3], LANGUAGES[match[3]], match[4]
+        elsif match[5] # NOTE:
+          flush_textile
+          consume_note NOTES[match[5]]
+        elsif match[6] # <construction>
+          consume_construction
+        end
+      end
+
+      flush_textile
+
+      @output
+    end
+
+    def generate_brushes(tag, replace, filename)
+      match = scan_until %r{</#{tag}>}
+      @output << %{<div class="code_container">\n}
+      @output << %{<div class="filename">#{filename}</div>\n} if filename
+      @output << %{<pre class="brush: #{replace}; gutter: false; toolbar: false">\n} <<
+                 CGI.escapeHTML(match.pre_match) << %{</pre></div>}
+    end
+
+    def scan_until(regex)
+      match = @string.match(regex)
+      @string = match.post_match
+      match
+    end
+
+    def consume_note(css_class)
+      match = scan_until /(\r?\n){2}/
+      note = match.pre_match.gsub(/\n\s*/, " ")
+      note = RedCloth.new(note, [:lite_mode]).to_html
+      @output << %{<div class="#{css_class}"><p>#{note}</p></div>\n}
+    end
+
+    def consume_construction
+      if @production
+        @string.sub!(%r{^.*</construction>}, '')
+      else
+        @string.sub!(%r{</construction>}, '')
+      end
+    end
+
+    def flush_textile
+      @pending_textile.gsub!(/(?<!\n)\n(?!\n)/, ' ') # Don't convert single \n to line-breaks
+      @output << RedCloth.new(@pending_textile).to_html << "\n"
+      @pending_textile = ""
+    end
+  end
+end

data/lib/guides/version.rb

@@ -1,3 +1,3 @@
 module Guides
-  VERSION = "0.6.7"
+  VERSION = "0.6.8"
 end

data/spec/build_spec.rb

@@ -1,45 +1,98 @@
 require "spec_helper"
 
 describe "guides build" do
-  before(:all) do
-    reset_tmp
-    guides "new", "sample" and wait
-    Dir.chdir tmp.join("sample")
-    guides "build" and wait
-  end
 
-  it "generates the app" do
-    out.should =~ /Generating contribute.html.*Generating credits.html.*Generating index.html/m
-  end
+  describe "production" do
 
-  it "generates assets" do
-    files = Dir["output/*"]
+    before(:all) do
+      reset_tmp
+      guides "new", "sample" and wait
+      copy_fixtures
+      Dir.chdir tmp.join("sample")
+      guides "build" and wait
+    end
 
-    File.directory?("output/images").should be_true
-    File.directory?("output/javascripts").should be_true
-    File.directory?("output/stylesheets").should be_true
-    File.file?("output/javascripts/guides.js").should be_true
-    File.file?("output/stylesheets/main.css").should be_true
-    File.file?("output/stylesheets/overrides.style.css").should be_true
-  end
+    it "generates the app" do
+      out.should == "Generating article_one.html\nGenerating article_three.html\n" +
+        "Generating article_two.html\nGenerating contribute.html\nGenerating credits.html\nGenerating index.html\n"
+    end
 
-  it "does nothing if run twice in a row" do
-    guides "build"
-    out.should be_blank
-  end
+    it "generates assets" do
+      files = Dir["output/*"]
 
-  it "re-runs if run with --clean" do
-    guides "build", "--clean"
-    out.should =~ /Generating contribute.html.*Generating credits.html.*Generating index.html/m
-  end
+      File.directory?("output/images").should be_true
+      File.directory?("output/javascripts").should be_true
+      File.directory?("output/stylesheets").should be_true
+      File.file?("output/javascripts/guides.js").should be_true
+      File.file?("output/stylesheets/main.css").should be_true
+      File.file?("output/stylesheets/overrides.style.css").should be_true
+    end
+
+    it "does nothing if run twice in a row" do
+      guides "build"
+      out.should be_blank
+    end
+
+    it "re-runs if run with --clean" do
+      guides "build", "--clean"
+      out.should == "Generating article_one.html\nGenerating article_three.html\n" +
+        "Generating article_two.html\nGenerating contribute.html\nGenerating credits.html\nGenerating index.html\n"
+    end
+
+    it "creates index.html" do
+      File.read("output/index.html").should =~ /<a href="article_one.html">/
+    end
+
+    it "should not show under-construction articles in index" do
+      File.read("output/index.html").should_not =~ /<a href="article_four.html">/
+    end
+
+    it "creates contribute.html" do
+      contribute = File.read("output/contribute.html")
+      contribute.should =~ /<h2>Contribute<\/h2>/
+    end
+
+    it "creates normal article" do
+      article_one = File.read("output/article_one.html")
+      article_one.should =~ /<h2>Article One<\/h2>/
+    end
+
+    it "creates markdown article" do
+      article_two = File.read("output/article_two.html")
+      article_two.should =~ /<h2[^>]*>Article Two<\/h2>/
+    end
+
+    it "does not create under-construction article" do
+      File.exist?("output/article_four.html").should be_false
+    end
 
-  it "creates index.html" do
-    File.read("output/index.html").should =~ /<a href="contribute.html">/
   end
 
-  it "creates contribute.html" do
-    contribute = File.read("output/contribute.html")
-    contribute.should =~ /<h2>Contribute<\/h2>/
+  describe "development" do
+
+    before(:all) do
+      reset_tmp
+      guides "new", "sample" and wait
+      copy_fixtures
+      Dir.chdir tmp.join("sample")
+      guides "build", "--production=false" and wait
+    end
+
+    it "generates the app" do
+      out.should == "Generating article_four.html\nGenerating article_one.html\nGenerating article_three.html\n" +
+        "Generating article_two.html\nGenerating contribute.html\nGenerating credits.html\nGenerating index.html\n"
+    end
+
+    it "should show under-construction articles in index" do
+      File.read("staging/index.html").should =~ /<a href="article_four.html">/
+    end
+
+    it "creates under construction article" do
+      article_four = File.read("staging/article_four.html")
+      article_four.should =~ /<h2>Article Four<\/h2>/
+    end
+
   end
+
 end
 

data/spec/fixtures/guides.yml

@@ -0,0 +1,33 @@
+title: Guides Test
+description: Enter your description here.
+  It can take up several lines. This description
+  will appear immediately below the main title in
+  the outputted guides.
+
+authors:
+  Documentation Team:
+    - name: Yehuda Katz
+      nick: wycats
+      description: Yehuda wrote the Rails guides gem.
+  Designers:
+    - name: Jason Zimdars
+      nick: jz
+      description: Jason Zimdars is an experienced creative director and web designer who has lead UI and UX design for numerous websites and web applications. You can see more of his design and writing at <a href="http://www.thinkcage.com/">Thinkcage.com</a> or follow him on <a href="http://twitter.com/JZ">Twitter</a>
+
+index:
+  Section One:
+    - title: Article One
+      url: article_one
+      text: This is the first article
+    - title: Article Two
+      url: article_two
+      text: This is the second article
+  Section Two:
+    - title: Article Three
+      url: article_three
+      text: This is the third article
+    - title: Article Four
+      url: article_four
+      text: This is the fourth article
+      construction: true
+

data/spec/fixtures/source/article_four.textile

@@ -0,0 +1,10 @@
+h2. Article Four
+
+This is where we have the stuff for the fourth article.
+
+endprologue.
+
+
+h3. What is Article Four?
+
+Article Four is the fourth article.

data/spec/fixtures/source/article_one.textile

@@ -0,0 +1,10 @@
+h2. Article One
+
+This is where we have the stuff for the first article.
+
+endprologue.
+
+
+h3. What is Article One?
+
+Article One is the first article.

data/spec/fixtures/source/article_three.textile

@@ -0,0 +1,10 @@
+h2. Article Three
+
+This is where we have the stuff for the third article.
+
+endprologue.
+
+
+h3. What is Article Three?
+
+Article Three is the third article.

data/spec/fixtures/source/article_two.md

@@ -0,0 +1,10 @@
+## Article Two
+
+This is where we have the stuff for the second article.
+
+endprologue.
+
+
+### What is Article Two?
+
+Article Two is the second article.

data/spec/preview_spec.rb

@@ -4,35 +4,78 @@ describe "guides preview" do
   before(:all) do
     reset_tmp
     guides "new", "sample" and wait
+    copy_fixtures
     Dir.chdir tmp.join("sample")
-    guides "build" and wait
   end
 
   after(:all) do
     Dir.chdir(tmp)
   end
 
-  before(:each) do
-    host! :preview
-    guides "preview"
-  end
+  describe "without arguments" do
 
-  after(:each) do
-    kill!
-  end
+    before(:each) do
+      host! :preview
+      guides "preview"
+    end
 
-  it "downloads the index at /" do
-    get "/"
-    should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h3>Start Here<\/h3>/m
-  end
+    after(:each) do
+      kill!
+    end
+
+    it "downloads the index at /" do
+      get "/"
+      should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h3>Section One<\/h3>/m
+    end
+
+    it "downloads the index at /index.html" do
+      get "/"
+      should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h3>Section One<\/h3>/m
+    end
+
+    it "downloads contribute at /contribute.html" do
+      get "/contribute.html"
+      should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h2>Contribute<\/h2>/m
+    end
+
+    it "downloads a normal page" do
+      get "/article_one.html"
+      should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h2>Article One<\/h2>/m
+    end
+
+    it "downloads a markdown page" do
+      get "/article_two.html"
+      should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h2[^>]*>Article Two<\/h2>/m
+    end
+
+    it "downloads an under-construction page" do
+      get "/article_four.html"
+      should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h2>Article Four<\/h2>/m
+    end
 
-  it "downloads the index at /index.html" do
-    get "/"
-    should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h3>Start Here<\/h3>/m
   end
 
-  it "downloads contribute at /contribute.html" do
-    get "/contribute.html"
-    should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h2>Contribute<\/h2>/m
+  describe "production" do
+
+    before(:each) do
+      host! :preview
+      guides "preview", "--production"
+    end
+
+    after(:each) do
+      kill!
+    end
+
+    it "downloads a normal page" do
+      get "/article_one.html"
+      should_respond_with 200, /<!DOCTYPE html PUBLIC.*>.*<h2>Article One<\/h2>/m
+    end
+
+    it "does not download an under-construction page" do
+      get "/article_four.html"
+      should_respond_with 404, "article_four is under construction and not available in production"
+    end
+
   end
+
 end

data/spec/spec_helper.rb

@@ -16,6 +16,10 @@ RSpec.configure do |config|
     Dir.chdir(tmp)
   end
 
+  def fixtures
+    @fixtures ||= Pathname.new(File.expand_path("../fixtures", __FILE__))
+  end
+
   config.before(:suite) do
     reset_tmp
   end

data/spec/support/cli.rb

@@ -47,10 +47,16 @@ module SpecHelpers
     @pid
   end
 
+  def copy_fixtures
+    FileUtils.cp fixtures.join("guides.yml"), tmp.join("sample")
+    FileUtils.cp_r fixtures.join("source"), tmp.join("sample")
+  end
+
   def wait_for_preview_server
     s = TCPSocket.new('0.0.0.0', 9292)
   rescue Errno::ECONNREFUSED, Errno::ECONNRESET
     sleep 0.2
+    raise "server not found" if (tries = (tries || 0) + 1) > 5
     retry
   rescue Exception => e
     puts [e.class, e.message]

data/spec/support/rack.rb

@@ -78,7 +78,13 @@ module SpecHelpers
     path = uri.path
     path = "#{path}?#{uri.query}" if uri.query
 
-    @response = conn.run_request(method, path, args.first, {})
+    begin
+      @response = conn.run_request(method, path, args.first, {})
+    rescue StandardError => e
+      sleep 0.5
+      raise e if (tries = (tries || 0) + 1) > 5
+      retry
+    end
   end
 
   def should_respond_with(status, body = nil, hdrs = {})

data/spec/textile_transformer_spec.rb

@@ -0,0 +1,86 @@
+require "spec_helper"
+
+describe "Transformer" do
+  before do
+    @transformer = Guides::TextileTransformer.new(true)
+    @dev_transformer = Guides::TextileTransformer.new
+  end
+
+  it "handles regular textile" do
+    @transformer.transform("h1. foo\n\nbar").should == "<h1>foo</h1>\n<p>bar</p>\n"
+  end
+
+  it "handles <code>" do
+    result = @transformer.transform("h1. foo\n\n+foo*bar*baz is <bat>+")
+    result.should == "<h1>foo</h1>\n<tt>foo*bar*baz is &lt;bat&gt;</tt>\n"
+  end
+
+  it "handles <javascript>" do
+    result = @transformer.transform("h1. foo\n\nHi there.\n\n<javascript>SC.Object.extend({\n  foo: function() {\n    return foo < bar && baz\n  }\n})</javascript>")
+    result.should == %{<h1>foo</h1>\n<p>Hi there.</p>\n<div class="code_container">\n<pre class="brush: javascript; gutter: false; toolbar: false">\n} +
+                     %{SC.Object.extend({\n  foo: function() {\n    return foo &lt; bar &amp;&amp; baz\n  }\n})</pre></div>\n}
+  end
+
+  it "handles <javascript> with a filename" do
+    result = @transformer.transform("h1. foo\n\nHi there.\n\n<javascript filename='fake.js'>SC.Object.extend({\n  foo: function() {\n    return foo < bar && baz\n  }\n})</javascript>")
+    result.should == %{<h1>foo</h1>\n<p>Hi there.</p>\n<div class="code_container">\n<div class="filename">fake.js</div>\n} +
+                     %{<pre class="brush: javascript; gutter: false; toolbar: false">\n} +
+                     %{SC.Object.extend({\n  foo: function() {\n    return foo &lt; bar &amp;&amp; baz\n  }\n})</pre></div>\n}
+  end
+
+  it "handles <ruby>" do
+    result = @transformer.transform("h1. foo\n\nHi there.\n\n<ruby>class Foo < Bar\n  def foo\n    bar && baz\n  end\nend</ruby>")
+    result.should == %{<h1>foo</h1>\n<p>Hi there.</p>\n<div class="code_container">\n<pre class="brush: ruby; gutter: false; toolbar: false">\n} +
+      %{class Foo &lt; Bar\n  def foo\n    bar &amp;&amp; baz\n  end\nend</pre></div>\n}
+  end
+
+  it "handles <erb>" do
+    result = @transformer.transform("h1. foo\n\nHi there.\n\n<erb><div><%= ohai %></div></erb>")
+    result.should == %{<h1>foo</h1>\n<p>Hi there.</p>\n<div class="code_container">\n<pre class="brush: ruby; html-script: true; gutter: false; toolbar: false">\n} +
+      %{&lt;div&gt;&lt;%= ohai %&gt;&lt;/div&gt;</pre></div>\n}
+  end
+
+  it "handles <shell>" do
+    result = @transformer.transform("h1. foo\n\nHi there.\n\n<shell>$ foo && bar</shell>")
+    result.should == %{<h1>foo</h1>\n<p>Hi there.</p>\n<div class="code_container">\n<pre class="brush: plain; gutter: false; toolbar: false">\n} +
+      %{$ foo &amp;&amp; bar</pre></div>\n}
+  end
+
+  it "handles <css>" do
+    result = @transformer.transform("h1. foo\n\nHi there.\n\n<css>body { color: red; };\na { color: blue; }</css>")
+    result.should == %{<h1>foo</h1>\n<p>Hi there.</p>\n<div class="code_container">\n} +
+                      %{<pre class="brush: css; gutter: false; toolbar: false">\n} +
+                      %{body { color: red; };\na { color: blue; }</pre></div>\n}
+  end
+
+  it "handles NOTE:" do
+    result = @transformer.transform("h1. foo\n\nHi there.\n\nNOTE: Some note\nmore of *the same* note\n\nAnother paragraph")
+    result.should == %{<h1>foo</h1>\n<p>Hi there.</p>\n<div class="note"><p>Some note more of <strong>the same</strong> note</p></div>\n} +
+      %{<p>Another paragraph</p>\n}
+  end
+
+  it "does not convert single line breaks to <br>" do
+    @transformer.transform("This\nhas\nbreaks.").should == "<p>This has breaks.</p>\n"
+    @transformer.transform("This\nhas\nbreaks.\n\nAnd\nparagraphs.").should == "<p>This has breaks.</p>\n<p>And paragraphs.</p>\n"
+  end
+
+  it "handles <construction>" do
+    str = "Testing this out. <construction>Write more here later.</construction> This is awesome.\n"
+    @transformer.transform(str).should == "<p>Testing this out.  This is awesome.</p>\n"
+    @dev_transformer.transform(str).should == "<p>Testing this out. Write more here later. This is awesome.</p>\n"
+
+    str = "Before\n\n<construction>Blah</construction>\n\nAfter"
+    @transformer.transform(str).should == "<p>Before</p>\n<p>After</p>\n"
+    @dev_transformer.transform(str).should == "<p>Before</p>\n<p>Blah</p>\n<p>After</p>\n"
+
+    @dev_transformer.transform("<construction>+Test+</construction>").should == "<tt>Test</tt>\n"
+  end
+
+  it "handles +" do
+    @transformer.transform("This +is a+ test.").should == "<p>This <tt>is a</tt> test.</p>\n"
+    @transformer.transform("This +is+ a +test+.").should == "<p>This <tt>is</tt> a <tt>test</tt>.</p>\n"
+    @transformer.transform("This +is a test.").should == "<p>This +is a test.</p>\n"
+    @transformer.transform("This + is + a + test.").should == "<p>This + is + a + test.</p>\n"
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: guides
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.6.7
+  version: 0.6.8
 platform: ruby
 authors: 
 - Yehuda Katz
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-25 00:00:00 -08:00
-default_executable: guides
+date: 2011-04-27 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionpack
@@ -104,6 +103,8 @@ files:
 - Gemfile
 - Rakefile
 - bin/guides
+- build/Distribution.erb
+- build/PackageInfo.erb
 - guides.gemspec
 - lib/guides.rb
 - lib/guides/cli.rb
@@ -217,16 +218,21 @@ files:
 - lib/guides/templates/source/credits.html.erb
 - lib/guides/templates/source/index.html.erb
 - lib/guides/templates/source/layout.html.erb
-- lib/guides/textile_extensions.rb
+- lib/guides/textile_transformer.rb
 - lib/guides/version.rb
 - lib/guides/w3c_validator.rb
 - spec/build_spec.rb
+- spec/fixtures/guides.yml
+- spec/fixtures/source/article_four.textile
+- spec/fixtures/source/article_one.textile
+- spec/fixtures/source/article_three.textile
+- spec/fixtures/source/article_two.md
 - spec/new_spec.rb
 - spec/preview_spec.rb
 - spec/spec_helper.rb
 - spec/support/cli.rb
 - spec/support/rack.rb
-has_rdoc: true
+- spec/textile_transformer_spec.rb
 homepage: http://yehudakatz.com
 licenses: []
 
@@ -250,14 +256,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: guides
-rubygems_version: 1.5.2
+rubygems_version: 1.7.1
 signing_key: 
 specification_version: 3
 summary: Extracting the Rails Guides framework for the rest of us
 test_files: 
 - spec/build_spec.rb
+- spec/fixtures/guides.yml
+- spec/fixtures/source/article_four.textile
+- spec/fixtures/source/article_one.textile
+- spec/fixtures/source/article_three.textile
+- spec/fixtures/source/article_two.md
 - spec/new_spec.rb
 - spec/preview_spec.rb
 - spec/spec_helper.rb
 - spec/support/cli.rb
 - spec/support/rack.rb
+- spec/textile_transformer_spec.rb

data/lib/guides/textile_extensions.rb

@@ -1,23 +0,0 @@
-class RedCloth::TextileDoc
-  def notestuff(body)
-    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
-      result << '</p></div>'
-      result
-    end
-  end
-
-  def plusplus(body)
-    body.gsub!(/\+(.*?)\+/) do |m|
-      "<notextile><tt>#{$1}</tt></notextile>"
-    end
-
-    # The real plus sign
-    body.gsub!('<plus>', '+')
-  end
-end