RubyGems - guides - Versions diffs - 0.5.0 - Mend

guides 0.5.0

Files changed (118) hide show

data/lib/guides/templates/source/credits.html.erb ADDED

@@ -0,0 +1,21 @@
+<% content_for :page_title do %>
+<%= Guides.meta["title"] %>: Credits
+<% end %>
+<% content_for :header_section do %>
+<h2>Credits</h2>
+<p>We'd like to thank the following people for their tireless contributions to this project.</p>
+<% end %>
+<h3 class="section"><%= Guides.meta["team_name"] %></h3>
+<% Guides.meta["authors"].each do |group, authors| %>
+  <h3 class="section"><%= group %></h3>
+  <% authors.each do |author| %>
+    <%= author(author["name"], author["nick"]) do %>
+      <%= author["description"].html_safe %>
+    <% end %>
+  <% end %>
+<% end %>

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

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

data/lib/guides/templates/source/layout.html.erb ADDED

@@ -0,0 +1,82 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+<title><%= yield(:page_title) %></title>
+<link rel="stylesheet" type="text/css" href="stylesheets/style.css" />
+<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
+<link rel="stylesheet" type="text/css" href="stylesheets/overrides.style.css" />
+<link rel="stylesheet" type="text/css" href="stylesheets/overrides.print.css" media="print" />
+<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shCore.css" />
+<link rel="stylesheet" type="text/css" href="stylesheets/syntaxhighlighter/shThemeRailsGuides.css" />
+</head>
+<body class="guide">
+  <% if @edge %>
+  <div>
+    <img src="images/edge_badge.png" alt="edge-badge" id="edge-badge" />
+  </div>
+  <% end %>
+  <div id="topNav">
+    <div class="wrapper">
+      <%= yield :top_nav %>
+    </div>
+  </div>
+  <div id="header">
+    <div class="wrapper clearfix">
+      <h1><a href="index.html" title="Return to home page"><%= Guides.meta["title"] %></a></h1>
+      <p class="hide"><a href="#mainCol">Skip navigation</a>.</p>
+      <ul class="nav">
+        <li><a href="index.html">Home</a></li>
+        <li class="index"><a href="index.html" onclick="guideMenu(); return false;" id="guidesMenu">Guides Index <span id="guidesArrow">&#9656;</span></a>
+          <div id="guides" class="clearfix" style="display: none;">
+            <hr />
+            <%= clickable_index %>
+          </div>
+        </li>
+        <li><a href="contribute.html">Contribute</a></li>
+        <li><a href="credits.html">Credits</a></li>
+      </ul>
+    </div>
+  </div>
+  <hr class="hide" />
+  <div id="feature">
+    <div class="wrapper">
+      <h2><%= Guides.meta["title"] %></h2>
+      <p><%= Guides.meta["description"] %></p>
+    </div>
+  </div>
+  <div id="container">
+    <div class="wrapper">
+      <div id="mainCol">
+        <%= yield %>
+      </div>
+    </div>
+  </div>
+  <hr class="hide" />
+  <div id="footer">
+    <div class="wrapper">
+      <%= yield :license %>
+    </div>
+  </div>
+  <script type="text/javascript" src="javascripts/guides.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shCore.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushRuby.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushJScript.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushXml.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushSql.js"></script>
+  <script type="text/javascript" src="javascripts/syntaxhighlighter/shBrushPlain.js"></script>
+  <script type="text/javascript">
+    SyntaxHighlighter.all()
+  </script>
+</body>
+</html>

data/lib/guides/textile_extensions.rb ADDED

@@ -0,0 +1,39 @@
+module RedCloth
+  def notestuff(body)
+    body.gsub!(/^(IMPORTANT|CAUTION|WARNING|NOTE|INFO)[.:](.*)$/) do |m|
+      css_class = $1.downcase
+      css_class = 'warning' if ['caution', 'important'].include?(css_class)
+      result = "<div class='#{css_class}'><p>"
+      result << $2.strip
+      result << '</p></div>'
+      result
+    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>"
+    end
+    # 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 ADDED

@@ -0,0 +1,3 @@
+module Guides
+  VERSION = "0.5.0"
+end

data/lib/guides/w3c_validator.rb ADDED

@@ -0,0 +1,89 @@
+# ---------------------------------------------------------------------------
+#
+# This script validates the generated guides against the W3C Validator.
+#
+# Guides are taken from the output directory, from where all .html files are
+# submitted to the validator.
+#
+# This script is prepared to be launched from the railties directory as a rake task:
+#
+# rake validate_guides
+#
+# If nothing is specified, all files will be validated, but you can check just
+# some of them using this environment variable:
+#
+#   ONLY
+#     Use ONLY if you want to validate only one or a set of guides. Prefixes are
+#     enough:
+#
+#       # validates only association_basics.html
+#       ONLY=assoc rake validate_guides
+#
+#     Separate many using commas:
+#
+#       # validates only association_basics.html and migrations.html
+#       ONLY=assoc,migrations rake validate_guides
+#
+# ---------------------------------------------------------------------------
+# TODO: Libraryify
+include W3CValidators
+module Guides
+  class Validator
+    def validate
+      validator = MarkupValidator.new
+      STDOUT.sync = true
+      errors_on_guides = {}
+      guides_to_validate.each do |f|
+        results = validator.validate_file(f)
+        if results.validity
+          print "."
+        else
+          print "E"
+          errors_on_guides[f] = results.errors
+        end
+      end
+      show_results(errors_on_guides)
+    end
+    private
+    def guides_to_validate
+      guides = Dir["./guides/output/*.html"]
+      guides.delete("./guides/output/layout.html")
+      ENV.key?('ONLY') ? select_only(guides) : guides
+    end
+    def select_only(guides)
+      prefixes = ENV['ONLY'].split(",").map(&:strip)
+      guides.select do |guide|
+        prefixes.any? {|p| guide.start_with?("./guides/output/#{p}")}
+      end
+    end
+    def show_results(error_list)
+      if error_list.size == 0
+        puts "\n\nAll checked guides validate OK!"
+      else
+        error_summary = error_detail = ""
+        error_list.each_pair do |name, errors|
+          error_summary += "\n  #{name}"
+          error_detail += "\n\n  #{name} has #{errors.size} validation error(s):\n"
+          errors.each do |error|
+            error_detail += "\n    "+error.to_s.gsub("\n", "")
+          end
+        end
+        puts "\n\nThere are #{error_list.size} guides with validation errors:\n" + error_summary
+        puts "\nHere are the detailed errors for each guide:" + error_detail
+      end
+    end
+  end
+end

metadata ADDED

@@ -0,0 +1,257 @@
+--- !ruby/object:Gem::Specification
+name: guides
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors:
+- Yehuda Katz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-01-04 00:00:00 -08:00
+default_executable: guides
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: rack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 4
+        - 1
+        - 1
+        version: 4.1.1
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency
+  name: thor
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        - 14
+        - 6
+        version: 0.14.6
+  type: :runtime
+  version_requirements: *id005
+description: A tool for creating version controlled guides for open source projects, based on the Rails Guides framework
+email:
+- wycats@gmail.com
+executables:
+- guides
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- bin/guides
+- guides.gemspec
+- lib/guides.rb
+- lib/guides/cli.rb
+- lib/guides/generator.rb
+- lib/guides/helpers.rb
+- lib/guides/indexer.rb
+- lib/guides/levenshtein.rb
+- lib/guides/new.rb
+- lib/guides/templates/assets/images/book_icon.gif
+- lib/guides/templates/assets/images/bullet.gif
+- lib/guides/templates/assets/images/chapters_icon.gif
+- lib/guides/templates/assets/images/check_bullet.gif
+- lib/guides/templates/assets/images/construction.png
+- lib/guides/templates/assets/images/construction.svg
+- lib/guides/templates/assets/images/credits_pic_blank.gif
+- lib/guides/templates/assets/images/edge_badge.png
+- lib/guides/templates/assets/images/feature_tile.gif
+- lib/guides/templates/assets/images/footer_tile.gif
+- lib/guides/templates/assets/images/grey_bullet.gif
+- lib/guides/templates/assets/images/header_backdrop.png
+- lib/guides/templates/assets/images/header_tile.gif
+- lib/guides/templates/assets/images/icons/README
+- lib/guides/templates/assets/images/icons/callouts/1.png
+- lib/guides/templates/assets/images/icons/callouts/10.png
+- lib/guides/templates/assets/images/icons/callouts/11.png
+- lib/guides/templates/assets/images/icons/callouts/12.png
+- lib/guides/templates/assets/images/icons/callouts/13.png
+- lib/guides/templates/assets/images/icons/callouts/14.png
+- lib/guides/templates/assets/images/icons/callouts/15.png
+- lib/guides/templates/assets/images/icons/callouts/2.png
+- lib/guides/templates/assets/images/icons/callouts/3.png
+- lib/guides/templates/assets/images/icons/callouts/4.png
+- lib/guides/templates/assets/images/icons/callouts/5.png
+- lib/guides/templates/assets/images/icons/callouts/6.png
+- lib/guides/templates/assets/images/icons/callouts/7.png
+- lib/guides/templates/assets/images/icons/callouts/8.png
+- lib/guides/templates/assets/images/icons/callouts/9.png
+- lib/guides/templates/assets/images/icons/caution.png
+- lib/guides/templates/assets/images/icons/example.png
+- lib/guides/templates/assets/images/icons/home.png
+- lib/guides/templates/assets/images/icons/important.png
+- lib/guides/templates/assets/images/icons/next.png
+- lib/guides/templates/assets/images/icons/note.png
+- lib/guides/templates/assets/images/icons/prev.png
+- lib/guides/templates/assets/images/icons/tip.png
+- lib/guides/templates/assets/images/icons/up.png
+- lib/guides/templates/assets/images/icons/warning.png
+- lib/guides/templates/assets/images/nav_arrow.gif
+- lib/guides/templates/assets/images/tab_grey.gif
+- lib/guides/templates/assets/images/tab_info.gif
+- lib/guides/templates/assets/images/tab_note.gif
+- lib/guides/templates/assets/images/tab_red.gif
+- lib/guides/templates/assets/images/tab_yellow.gif
+- lib/guides/templates/assets/images/tab_yellow.png
+- lib/guides/templates/assets/javascripts/guides.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushAS3.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushAppleScript.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushBash.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushCSharp.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushColdFusion.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushCpp.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushCss.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushDelphi.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushDiff.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushErlang.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushGroovy.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushJScript.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushJava.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushJavaFX.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushPerl.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushPhp.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushPlain.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushPowerShell.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushPython.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushRuby.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushSass.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushScala.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushSql.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushVb.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shBrushXml.js
+- lib/guides/templates/assets/javascripts/syntaxhighlighter/shCore.js
+- lib/guides/templates/assets/stylesheets/main.css
+- lib/guides/templates/assets/stylesheets/print.css
+- lib/guides/templates/assets/stylesheets/reset.css
+- lib/guides/templates/assets/stylesheets/style.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shCore.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shCoreDefault.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shCoreDjango.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shCoreEclipse.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shCoreEmacs.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shCoreFadeToGrey.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shCoreMDUltra.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shCoreMidnight.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shCoreRDark.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeDefault.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeDjango.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeEclipse.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeEmacs.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeFadeToGrey.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeMDUltra.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeMidnight.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeRDark.css
+- lib/guides/templates/assets/stylesheets/syntaxhighlighter/shThemeRailsGuides.css
+- lib/guides/templates/guides.yml.tt
+- lib/guides/templates/source/_clickable_index.html.erb
+- lib/guides/templates/source/_full_index.html.erb
+- lib/guides/templates/source/_sections.html.erb
+- lib/guides/templates/source/contribute.textile
+- 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/version.rb
+- lib/guides/w3c_validator.rb
+has_rdoc: true
+homepage: http://yehudakatz.com
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+rubyforge_project: guides
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Extracting the Rails Guides framework for the rest of us
+test_files: []