guider 0.0.4 → 0.0.5

data/bin/guider

@@ -11,6 +11,7 @@ options = {
   :output => Dir.pwd + "/out",
   :link_url => "http://localhost/extjs/",
   :tpl_dir => File.dirname(File.dirname(__FILE__)) + "/template",
+  :warnings => false,
 }
 
 input_files = OptionParser.new do |opts|
@@ -31,13 +32,17 @@ input_files = OptionParser.new do |opts|
     options[:index] = path
   end
 
+  opts.on("--warnings", "Enables warnings.") do
+    options[:warnings] = true
+  end
+
   opts.on("-h", "--help", "Show this help message") do
     puts opts
     exit
   end
 
   opts.on("--version", "Prints guider version number.") do
-    puts "Guider 0.0.4"
+    puts "Guider 0.0.5"
     exit
   end
 end.parse!

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.4'
-  s.date = '2013-03-18'
+  s.version = '0.0.5'
+  s.date = Time.new.strftime('%Y-%m-%d')
   s.summary = "Sencha guide generator"
   s.description = "JSDuck-compatible guides generator"
   s.homepage = "https://github.com/nene/guider"

data/lib/guider/app.rb

@@ -1,12 +1,14 @@
 require "fileutils"
 require "guider/guide_factory"
 require "guider/index"
+require "guider/logger"
 
 module Guider
   class App
     def initialize(options)
       @options = options
       @guide_factory = Guider::GuideFactory.new(@options)
+      Logger.warnings = options[:warnings]
     end
 
     def run

data/lib/guider/config.rb

@@ -5,31 +5,32 @@ module Guider
   # Turns it into HTML table of contents.
   class Config
     def initialize(path)
-      @guides = flatten(JSON.parse(IO.read(path)))
+      @guides = JSON.parse(IO.read(path))
     end
 
-    # Returns flat HTML list of guide titles.
+    # Returns HTML list of guide titles.
     def to_html
-      "<ul>" + @guides.map {|g| to_link(g) }.join("\n") + "</ul>"
+      to_list(@guides)
     end
 
     private
 
-    # Turns grouped guides structure into flat list.
-    def flatten(group)
-      arr = []
-      group.each do |guide|
+    def to_list(items)
+      list = []
+
+      items.each do |guide|
         if guide["items"]
-          arr += flatten(guide["items"])
+          list << "<li>" + guide["title"] + "\n" + to_list(guide["items"]) + "</li>"
         else
-          arr << guide
+          list << "<li>#{to_link(guide)}</li>"
         end
       end
-      arr
+
+      "<ul>" + list.join("\n") + "</ul>"
     end
 
     def to_link(guide)
-      "<li><a href='#{to_href(guide)}'>#{guide['title']}</a></li>"
+      "<a href='#{to_href(guide)}'>#{guide['title']}</a>"
     end
 
     def to_href(guide)

data/lib/guider/guide.rb

@@ -1,17 +1,20 @@
 require "kramdown"
 require "pathname"
+require "guider/logger"
 
 module Guider
   class Guide
     def initialize(filename, tpl, inline_tags, options)
       @template = tpl
       @inline_tags = inline_tags
+      @input_filename = filename
       @markdown = IO.read(filename)
       @rel_path = relative_path(options[:input], filename)
       @html = Kramdown::Document.new(@markdown).to_html
     end
 
     def write(filename)
+      Logger.context = @input_filename
       html = @inline_tags.replace(@html)
       html = @template.apply({
           :content => html,

data/lib/guider/inline_tags.rb

@@ -1,3 +1,5 @@
+require 'guider/logger'
+
 module Guider
   class InlineTags
     # The base URL for links created by {@link} tags.
@@ -10,39 +12,59 @@ module Guider
     def replace(html)
       replace_link!(html)
       replace_img!(html)
+      replace_old_guide_links!(html)
       html
     end
 
     private
 
     def replace_link!(html)
-      re = /\{@link\s+([^\s\}]*)(?:\s+([^\}]*))?}/
-      html.gsub!(re) do |m|
-        m =~ re # re-run regex to extract $1 $2 fields
-        ref = $1
-        alt = $2
-
-        cls, mref = ref.split('#')
+      replace!(html, /\{@link\s+([^\s\}]*)(?:\s+([^\}]*))?}/) do |ref, alt|
+        cls, mref = ref.split(/#/)
         if mref
-          apiref = [cls, "method", mref].join("-")
+          parts = mref.split(/-/)
+
+          if parts.length < 2
+            Logger.warn("Ambiguous member reference: #{cls}##{mref}")
+            # Default unqualified member references to method
+            mref = "method-" + mref
+          end
+
+          api_ref = [cls, mref].join("-")
+          api_alt = [cls, parts.last].join(".")
         else
-          apiref = cls
+          api_ref = cls
+          api_alt = cls
         end
 
-        url = @link_url + "#!/api/" + apiref
-        "<a href='#{url}'>#{alt || ref}</a>"
+        url = @link_url + "#!/api/" + api_ref
+        "<a href='#{url}'>#{alt || api_alt}</a>"
       end
     end
 
     def replace_img!(html)
-      re = /\{@img\s+([^\s\}]*)(?:\s+([^\}]*))?}/
-      html.gsub!(re) do |m|
-        m =~ re # re-run regex to extract $1 $2 fields
-        ref = $1
-        alt = $2
+      replace!(html, /\{@img\s+([^\s\}]*)(?:\s+([^\}]*))?}/) do |ref, alt|
         "<img src='#{ref}' alt='#{alt}'>"
       end
     end
 
+    def replace_old_guide_links!(html)
+      replace!(html, /<a href="#!?\/guide\/(\w+)">/) do |name|
+        "<a href='../#{name}'>"
+      end
+    end
+
+    # Helper method to easily do a regex-replace with a block where
+    # the block gets called with a list of all the captured strings.
+    # The normal String#gsub! method only passes the full match to the
+    # block, so we have to do some tedious extra work to extract the
+    # actual captures.
+    def replace!(string, re, &block)
+      string.gsub!(re) do |m|
+        captures = re.match(m)[1..-1]
+        block.call(*captures)
+      end
+    end
+
   end
 end

data/lib/guider/logger.rb

@@ -0,0 +1,20 @@
+module Guider
+  class Logger
+    # Turns printing of warnings on or off.
+    def self.warnings=(enabled)
+      @warnings = enabled
+    end
+
+    # Sets file context for warnings
+    def self.context=(filename)
+      @context = filename
+    end
+
+    # Prints out a warning when warnings enabled.
+    def self.warn(msg)
+      file = @context ? @context + ": " : ""
+      $stderr.puts(file + msg) if @warnings
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guider
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -61,6 +61,7 @@ files:
 - lib/guider/guide_factory.rb
 - lib/guider/index.rb
 - lib/guider/inline_tags.rb
+- lib/guider/logger.rb
 - lib/guider/template.rb
 - template/favicon.ico
 - template/guide.html