guider 0.0.2 → 0.0.3

data/bin/guider

@@ -5,67 +5,44 @@ $:.unshift File.dirname(File.dirname(__FILE__)) + "/lib"
 
 require "rubygems"
 require "optparse"
-require "fileutils"
-require "guider/guide"
-require "guider/config"
-require "guider/template"
-require "guider/index"
-require "guider/inline_tags"
+require "guider/app"
 
 options = {
   :output => Dir.pwd + "/out",
   :link_url => "http://localhost/extjs/",
+  :tpl_dir => File.dirname(File.dirname(__FILE__)) + "/template",
 }
 
 input_files = OptionParser.new do |opts|
   opts.banner = "Generates a guide.\n\n" +
-    "Usage: guider <guides.json>\n\n"
+    "Usage: guider <guides/dir/>\n\n"
 
-  opts.on("-o", "--output=DIR", "Where to output the guides.") do |dir|
-    options[:output] = dir
+  opts.on("-o", "--output=DIR", "Where to output the guides.",
+    "Defaults to ./out") do |dir|
+    options[:output] = File.absolute_path(dir)
   end
 
-  opts.on("--link-url=URL", "Base path for links created by {@link} tags.") do |url|
+  opts.on("--link-url=URL", "Base path for links created by {@link} tags.",
+    "Defaults to http://localhost/extjs/") do |url|
     options[:link_url] = url
   end
 
+  opts.on("--index=PATH", "The guides.json file to create index.html from.") do |path|
+    options[:index] = path
+  end
+
   opts.on("-h", "--help", "Show this help message") do
     puts opts
     exit
   end
 end.parse!
 
-
-# clean output dir
-FileUtils.rm_rf(options[:output])
-FileUtils.mkdir(options[:output])
-
-# copy over main template resources
-tpl_dir = File.dirname(File.dirname(__FILE__)) + "/template"
-Dir[tpl_dir+"/*.{js,css,ico}"].each do |fname|
-  FileUtils.cp(fname, options[:output])
-end
-
-# Configure {@link} tags.
-inline_tags = Guider::InlineTags.new
-inline_tags.link_url = options[:link_url]
-
-# Read the template HTML file
-tpl = Guider::Template.new(tpl_dir + "/guide.html")
-
-# The guides.json file
-config_file = input_files[0]
-
-guides = Guider::Config.new(config_file, tpl, inline_tags).guides
-
-guides.each do |guide|
-  guide.write(options[:output])
+if input_files.length == 1
+  options[:input] = File.absolute_path(input_files[0])
+else
+  $stderr.puts "ERROR: Exactly one input directory must be specified."
+  exit(1)
 end
 
-index_tpl = Guider::Template.new(tpl_dir + "/index.html")
-Guider::Index.new(guides, index_tpl).write(options[:output])
 
-html = index_tpl.apply({
-  :title => "Guides",
-  :content => "blah",
-})
+Guider::App.new(options).run

data/guider.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.5"
 
   s.name = 'guider'
-  s.version = '0.0.2'
-  s.date = '2013-03-15'
+  s.version = '0.0.3'
+  s.date = '2013-03-18'
   s.summary = "Sencha guide generator"
   s.description = "JSDuck-compatible guides generator"
   s.homepage = "https://github.com/nene/guider"

data/lib/guider/app.rb

@@ -0,0 +1,52 @@
+require "fileutils"
+require "guider/guide_factory"
+require "guider/index"
+
+module Guider
+  class App
+    def initialize(options)
+      @options = options
+      @guide_factory = Guider::GuideFactory.new(@options)
+    end
+
+    def run
+      # clean output dir
+      FileUtils.rm_rf(@options[:output])
+
+      copy_dir(@options[:input], @options[:output])
+
+      copy_template_files
+
+      Index.new(@options).write if @options[:index]
+    end
+
+    private
+
+    # Copies all files and directories in source dir over to
+    # destination dir.  Processes all .md files.
+    def copy_dir(src, dest)
+      FileUtils.mkdir(dest)
+
+      Dir[src+"/*"].each do |filename|
+        target = dest+"/"+File.basename(filename)
+
+        if filename =~ /\/README\.md$/
+          @guide_factory.create(filename).write(target.sub(/\/README\.md$/, "/index.html"))
+        elsif filename =~ /\.md$/
+          @guide_factory.create(filename).write(target.sub(/.md$/, ".html"))
+        elsif File.directory?(filename)
+          copy_dir(filename, target)
+        else
+          FileUtils.cp_r(filename, target)
+        end
+      end
+    end
+
+    # Copies over main template resources
+    def copy_template_files
+      Dir[@options[:tpl_dir]+"/*.{js,css,ico}"].each do |fname|
+        FileUtils.cp(fname, @options[:output])
+      end
+    end
+  end
+end

data/lib/guider/config.rb

@@ -1,48 +1,43 @@
 require "json"
-require "guider/guide"
 
 module Guider
   # Reads the guides config file.
-  # Turns it into list Guide instances accessible through .guides attribute.
+  # Turns it into HTML table of contents.
   class Config
-    def initialize(path, tpl, inline_tags)
-      guide_cfgs = flatten(JSON.parse(IO.read(path)))
-      guide_cfgs.each {|g| keys_to_symbols(g) }
-      guide_cfgs.each {|g| add_path(g, path) }
-      @guides = to_guides(guide_cfgs, tpl, inline_tags)
+    def initialize(path)
+      @guides = flatten(JSON.parse(IO.read(path)))
     end
 
-    # List of Guide instances.
-    attr_reader :guides
+    # Returns flat HTML list of guide titles.
+    def to_html
+      "<ul>" + @guides.map {|g| to_link(g) }.join("\n") + "</ul>"
+    end
 
     private
 
     # Turns grouped guides structure into flat list.
-    def flatten(groups)
+    def flatten(group)
       arr = []
-      groups.each do |group|
-        group["items"].each {|guide| arr << guide }
+      group.each do |guide|
+        if guide["items"]
+          arr += flatten(guide["items"])
+        else
+          arr << guide
+        end
       end
       arr
     end
 
-    # Turns all string keys in Hash into symbols
-    def keys_to_symbols(hash)
-      hash.keys.each do |k|
-        hash[k.to_sym] = hash[k]
-        hash.delete(k)
-      end
-      hash
+    def to_link(guide)
+      "<li><a href='#{to_href(guide)}'>#{guide['title']}</a></li>"
     end
 
-    # adds :path fields to the configs of all the guides
-    def add_path(guide, path)
-      guide[:path] = File.dirname(path) + "/guides/" + guide[:name]
-    end
-
-    # Turns guide configs to actual Guide instances
-    def to_guides(guide_cfgs, tpl, inline_tags)
-      guide_cfgs.find_all {|g| File.exists?(g[:path]) }.map {|g| Guide.new(g, tpl, inline_tags) }
+    def to_href(guide)
+      if guide['url']
+        guide['url'].sub(/^guides\//)
+      else
+        guide['name']
+      end
     end
 
   end

data/lib/guider/guide.rb

@@ -1,62 +1,46 @@
 require "kramdown"
-require "fileutils"
+require "pathname"
 
 module Guider
   class Guide
-    def initialize(cfg, tpl, inline_tags)
-      @cfg = cfg
+    def initialize(filename, tpl, inline_tags, options)
       @template = tpl
       @inline_tags = inline_tags
-      @markdown = IO.read(@cfg[:path]+"/README.md")
+      @markdown = IO.read(filename)
+      @rel_path = relative_path(options[:input], filename)
       @html = Kramdown::Document.new(@markdown).to_html
     end
 
-    def write(path)
-      guide_path = path + "/" + @cfg[:name]
-      FileUtils.mkdir(guide_path)
-      write_html(guide_path+"/index.html")
-      copy_images(@cfg[:path], guide_path)
-    end
-
-    def write_html(filename)
+    def write(filename)
       html = @inline_tags.replace(@html)
-      html = @template.apply(:content => html, :title => title)
+      html = @template.apply({
+          :content => html,
+          :title => title,
+          :path => @rel_path,
+        })
       File.open(filename, 'w') {|f| f.write(html) }
     end
 
+    def relative_path(filename, base_dir)
+      Pathname.new(filename).relative_path_from(Pathname.new(base_dir)).dirname
+    end
+
     # Extracts the first line from markdown
     def title
       @markdown =~ /\A(.*?)$/
       result = $1.sub(/^#/, '').strip
 
-      # When guide name missing, take it from config file
-      if result == ""
-        @cfg[:title]
-      else
-        result
-      end
-    end
-
-    # Returns the name of a guide, for use in links
-    def name
-      @cfg[:name]
+      return (result == "") ? "Untitled" : result
     end
 
     # Lists all h2 level headings within the guide
-    def chapters
+    #
+    # XXX: Currently this is dead code.
+    def toc
       @html.scan(/<h2[^>]*id="(\S*)"[^>]*>([^\n]*)<\/h2>/).map do |m|
-        {:href => @cfg[:name] + "#" + m[0], :title => m[1]}
+        {:href => "#" + m[0], :title => m[1]}
       end
     end
 
-    # Copies all files and directories in source dir over to
-    # destination dir.  Skips README.md, which is treated separately.
-    def copy_images(src, dest)
-      Dir[src+"/*"].each do |img|
-        if !["README.md"].include?(File.basename(img))
-          FileUtils.cp_r(img, dest+"/"+File.basename(img))
-        end
-      end
-    end
   end
 end

data/lib/guider/guide_factory.rb

@@ -0,0 +1,25 @@
+require "guider/template"
+require "guider/inline_tags"
+require "guider/guide"
+
+module Guider
+  # Creates Guide instances
+  class GuideFactory
+    def initialize(options)
+      # Configure {@link} tags.
+      @inline_tags = InlineTags.new
+      @inline_tags.link_url = options[:link_url]
+
+      # Create guide rendering template
+      @tpl = Template.new(options[:tpl_dir] + "/guide.html")
+
+      @options = options
+    end
+
+    # Creates new Guide instance from filename
+    def create(filename)
+      Guide.new(filename, @tpl, @inline_tags, @options)
+    end
+
+  end
+end

data/lib/guider/index.rb

@@ -1,26 +1,17 @@
+require 'guider/template'
+require 'guider/config'
+
 module Guider
   class Index
-    def initialize(guides, tpl)
-      @guides = guides
-      @template = tpl
-    end
-
-    def write(path)
-      html = @template.apply(:title => "Guides", :content => guide_list)
-      File.open(path + "/index.html", 'w') {|f| f.write(html) }
+    def initialize(options)
+      @options = options
+      @config = Config.new(@options[:index])
+      @tpl = Template.new(@options[:tpl_dir] + "/index.html")
     end
 
-    private
-
-    def guide_list
-      list = @guides.map {|g| "<li><a href='#{g.name}'>#{g.title}</a>#{chapters_list(g.chapters)}</li>" }.join("\n")
-      "<ul>#{list}</ul>"
-    end
-
-    def chapters_list(chapters)
-      return "" if chapters.length == 0
-
-      "\n<ul>" + chapters.map {|c| "<li><a href='#{c[:href]}'>#{c[:title]}</a></li>" }.join("\n") + "</ul>\n"
+    def write
+      html = @tpl.apply(:title => "Guides", :content => @config.to_html)
+      File.open(@options[:output] + "/index.html", 'w') {|f| f.write(html) }
     end
 
   end

data/lib/guider/template.rb

@@ -1,5 +1,3 @@
-require "json"
-
 module Guider
   # Reads a template from file.
   # Allows replacing {placeholders} inside it.

data/template/guide.html

@@ -3,10 +3,10 @@
 <head>
   <title>{title}</title>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-  <link rel="shortcut icon" type="image/ico" href="../favicon.ico" />
-  <link rel="stylesheet" type="text/css" href="../styles.css" />
-  <link rel="stylesheet" type="text/css" href="../prettify.css" />
-  <script type="text/javascript" src="../prettify.js"></script>
+  <link rel="shortcut icon" type="image/ico" href="{path}/favicon.ico" />
+  <link rel="stylesheet" type="text/css" href="{path}/styles.css" />
+  <link rel="stylesheet" type="text/css" href="{path}/prettify.css" />
+  <script type="text/javascript" src="{path}/prettify.js"></script>
 </head>
 <body>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guider
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -55,8 +55,10 @@ files:
 - README.md
 - bin/guider
 - guider.gemspec
+- lib/guider/app.rb
 - lib/guider/config.rb
 - lib/guider/guide.rb
+- lib/guider/guide_factory.rb
 - lib/guider/index.rb
 - lib/guider/inline_tags.rb
 - lib/guider/template.rb