guider 0.0.5 → 0.0.6

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
+
+# prints command to standard out and executes it
+def echo_cmd(cmd)
+  puts cmd
+  system cmd
+end
+
+desc "Bumps Guider minor version number"
+task :bump do
+  # Extract version number and increment it
+  version_line = IO.read("guider.gemspec").lines.grep(/s\.version = /)[0]
+  version_line =~ /([0-9]+)\.([0-9]+).([0-9]+)/
+  old_version = "#{$1}.#{$2}.#{$3}"
+  new_version = "#{$1}.#{$2}.#{$3.to_i + 1}"
+  puts "Bumping from #{old_version} to #{new_version}"
+
+  # Replace it in guider.gemspec
+  contents = IO.read("guider.gemspec")
+  contents.sub!(/s\.version = '#{old_version}'/, "s.version = '#{new_version}'")
+  File.open("guider.gemspec", "w") {|f| f.write(contents) }
+
+  # Replace it in bin/guider
+  contents = IO.read("bin/guider")
+  contents.sub!(/VERSION = '#{old_version}'/, "VERSION = '#{new_version}'")
+  File.open("bin/guider", "w") {|f| f.write(contents) }
+
+  # Create a commit
+  echo_cmd("git commit guider.gemspec bin/guider -m 'Up version to #{new_version}.'")
+  # Create a tag
+  echo_cmd("git tag -a v#{new_version} -m 'Tagging #{new_version} release.'")
+end
+
+desc "Build Guider gem"
+task :gem do
+  system "gem build guider.gemspec"
+end
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["--color"]
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/bin/guider

@@ -7,8 +7,18 @@ require "rubygems"
 require "optparse"
 require "guider/app"
 
+VERSION = '0.0.6'
+
+def format_footer(text)
+  guider = "<a href='https://github.com/nene/guider'>Guider</a>"
+  date = Time.new.strftime('%a %d %b %Y %H:%M:%S')
+  text.gsub(/\{VERSION\}/, VERSION).gsub(/\{GUIDER\}/, guider).gsub(/\{DATE\}/, date)
+end
+
 options = {
   :output => Dir.pwd + "/out",
+  :title => "Guides",
+  :footer => format_footer("Generated on {DATE} by {GUIDER} {VERSION}."),
   :link_url => "http://localhost/extjs/",
   :tpl_dir => File.dirname(File.dirname(__FILE__)) + "/template",
   :warnings => false,
@@ -23,6 +33,16 @@ input_files = OptionParser.new do |opts|
     options[:output] = File.absolute_path(dir)
   end
 
+  opts.on("--title=TEXT", "The title for the whole set of guides.",
+    "Defaults to: Guides.") do |title|
+    options[:title] = title
+  end
+
+  opts.on("--footer=TEXT", "The footer text.",
+    "Defaults to: Generated on {DATE} by {GUIDER} {VERSION}.") do |footer|
+    options[:footer] = format_footer(footer)
+  end
+
   opts.on("--link-url=URL", "Base path for links created by {@link} tags.",
     "Defaults to http://localhost/extjs/") do |url|
     options[:link_url] = url
@@ -42,7 +62,7 @@ input_files = OptionParser.new do |opts|
   end
 
   opts.on("--version", "Prints guider version number.") do
-    puts "Guider 0.0.5"
+    puts "Guider #{VERSION}"
     exit
   end
 end.parse!

data/guider.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.5"
 
   s.name = 'guider'
-  s.version = '0.0.5'
+  s.version = '0.0.6'
   s.date = Time.new.strftime('%Y-%m-%d')
   s.summary = "Sencha guide generator"
   s.description = "JSDuck-compatible guides generator"

data/lib/guider/app.rb

@@ -46,7 +46,7 @@ module Guider
 
     # Copies over main template resources
     def copy_template_files
-      Dir[@options[:tpl_dir]+"/*.{js,css,ico}"].each do |fname|
+      Dir[@options[:tpl_dir]+"/*.{js,css,ico,png}"].each do |fname|
         FileUtils.cp(fname, @options[:output])
       end
     end

data/lib/guider/config.rb

@@ -20,7 +20,7 @@ module Guider
 
       items.each do |guide|
         if guide["items"]
-          list << "<li>" + guide["title"] + "\n" + to_list(guide["items"]) + "</li>"
+          list << "<li><span>" + guide["title"] + "</span>\n" + to_list(guide["items"]) + "</li>"
         else
           list << "<li>#{to_link(guide)}</li>"
         end

data/lib/guider/guide.rb

@@ -8,6 +8,7 @@ module Guider
       @template = tpl
       @inline_tags = inline_tags
       @input_filename = filename
+      @options = options
       @markdown = IO.read(filename)
       @rel_path = relative_path(options[:input], filename)
       @html = Kramdown::Document.new(@markdown).to_html
@@ -15,10 +16,13 @@ module Guider
 
     def write(filename)
       Logger.context = @input_filename
+      @inline_tags.base_url = @rel_path
       html = @inline_tags.replace(@html)
       html = @template.apply({
           :content => html,
-          :title => title,
+          :title => @options[:title],
+          :footer => @options[:footer],
+          :guide_name => guide_name,
           :path => @rel_path,
         })
       File.open(filename, 'w') {|f| f.write(html) }
@@ -29,7 +33,7 @@ module Guider
     end
 
     # Extracts the first line from markdown
-    def title
+    def guide_name
       @markdown =~ /\A(.*?)$/
       result = $1.sub(/^#/, '').strip
 

data/lib/guider/index.rb

@@ -10,7 +10,11 @@ module Guider
     end
 
     def write
-      html = @tpl.apply(:title => "Guides", :content => @config.to_html)
+      html = @tpl.apply({
+        :title => @options[:title],
+        :footer => @options[:footer],
+        :content => @config.to_html,
+      })
       File.open(@options[:output] + "/index.html", 'w') {|f| f.write(html) }
     end
 

data/lib/guider/inline_tags.rb

@@ -4,9 +4,12 @@ module Guider
   class InlineTags
     # The base URL for links created by {@link} tags.
     attr_accessor :link_url
+    # The base URL for referencing guides from root dir.
+    attr_accessor :base_url
 
     def initialize
       @link_url = ""
+      @base_url = "."
     end
 
     def replace(html)
@@ -49,8 +52,12 @@ module Guider
     end
 
     def replace_old_guide_links!(html)
-      replace!(html, /<a href="#!?\/guide\/(\w+)">/) do |name|
-        "<a href='../#{name}'>"
+      replace!(html, /<a href="#!?\/guide\/([^"]+)">/) do |name|
+        # Transform links to .md files into .html file links
+        name.sub!(/README\.md$/, "index.html")
+        name.sub!(/\.md$/, ".html")
+
+        "<a href='#{@base_url}/#{name}'>"
       end
     end
 

data/template/guide.html

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>{title}</title>
+  <title>{guide_name} - {title}</title>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <link rel="shortcut icon" type="image/ico" href="{path}/favicon.ico" />
   <link rel="stylesheet" type="text/css" href="{path}/styles.css" />
@@ -10,7 +10,19 @@
 </head>
 <body>
 
+<div id="container">
+<div id="header">
+  <h1><a href="{path}">{title}</a></h1>
+</div>
+
+<div id="content">
 {content}
+</div>
+</div>
+
+<div id="footer">
+  <p>{footer}</p>
+</div>
 
 <script type="text/javascript">
 (function(){

data/template/index.html

@@ -8,9 +8,19 @@
 </head>
 <body id="index-page">
 
-<h1>{title}</h1>
+<div id="container">
+<div id="header">
+  <h1><a href="{path}">{title}</a></h1>
+</div>
 
+<div id="content">
 {content}
+</div>
+</div>
+
+<div id="footer">
+  <p>{footer}</p>
+</div>
 
 <script type="text/javascript">
 (function(){

data/template/styles.css

@@ -4,8 +4,8 @@ body {
     line-height: 1.231;
     color: #484848;
     background: #f8f8f8;
-    max-width: 900px;
-    margin: 0 auto;
+    margin: 0;
+    padding: 0;
 }
 
 h1 {
@@ -39,10 +39,62 @@ img {
     margin: 0 auto;
 }
 
+/* Page header and content sections */
+
+#header {
+    background: #074E7C url(sencha-logo.png) 5px center no-repeat;
+    padding-left: 30px;
+}
+#header h1 {
+    margin: 0;
+    font-size: 16px;
+    line-height: 40px;
+}
+#header a {
+    color: white;
+}
+
+#content {
+    max-width: 900px;
+    margin: 0 auto;
+    padding: 1em;
+}
+
+/* Create sticky footer */
+html, body, #container {
+    height: 100%;
+}
+body > #container {
+    height: auto;
+    min-height: 100%;
+}
+#footer {
+    clear: both;
+    position: relative;
+    z-index: 10;
+    height: 20px;
+    margin-top: -20px;
+}
+
+/* Other footer styles */
+#footer {
+    text-align: right;
+    font-size: 10px;
+    width: 100%;
+}
+#footer p {
+    padding-right: 20px;
+    margin: 0;
+}
 
 /* Special styles for guides list in index page */
 
-body#index-page > ul > li {margin-bottom: 0.5em;}
-body#index-page > ul > li > ul {margin: 0.5em 0; font-size: smaller;}
-body#index-page > ul > li > a:link {font-weight: bold; }
+body#index-page #content > ul > li {margin-bottom: 0.5em; }
+body#index-page #content > ul > li > ul {margin: 0.5em 0; font-size: smaller; }
+body#index-page #content > ul > li > a:link {font-weight: bold; }
 
+body#index-page #content > ul > li > span {
+    color: #66ab16;
+    font-family: "Exo", sans-serif;
+    font-weight: bold;
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guider
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-25 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -53,6 +53,7 @@ files:
 - .gitignore
 - COPYING
 - README.md
+- Rakefile
 - bin/guider
 - guider.gemspec
 - lib/guider/app.rb
@@ -68,6 +69,7 @@ files:
 - template/index.html
 - template/prettify.css
 - template/prettify.js
+- template/sencha-logo.png
 - template/styles.css
 homepage: https://github.com/nene/guider
 licenses: []