guider 0.0.1 → 0.0.2

data/bin/guider

@@ -10,9 +10,11 @@ require "guider/guide"
 require "guider/config"
 require "guider/template"
 require "guider/index"
+require "guider/inline_tags"
 
 options = {
   :output => Dir.pwd + "/out",
+  :link_url => "http://localhost/extjs/",
 }
 
 input_files = OptionParser.new do |opts|
@@ -23,6 +25,10 @@ input_files = OptionParser.new do |opts|
     options[:output] = dir
   end
 
+  opts.on("--link-url=URL", "Base path for links created by {@link} tags.") do |url|
+    options[:link_url] = url
+  end
+
   opts.on("-h", "--help", "Show this help message") do
     puts opts
     exit
@@ -40,13 +46,17 @@ 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).guides
+guides = Guider::Config.new(config_file, tpl, inline_tags).guides
 
 guides.each do |guide|
   guide.write(options[:output])
@@ -59,7 +69,3 @@ html = index_tpl.apply({
   :title => "Guides",
   :content => "blah",
 })
-
-
-
-

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.1'
-  s.date = '2013-03-11'
+  s.version = '0.0.2'
+  s.date = '2013-03-15'
   s.summary = "Sencha guide generator"
   s.description = "JSDuck-compatible guides generator"
   s.homepage = "https://github.com/nene/guider"

data/lib/guider/config.rb

@@ -5,11 +5,11 @@ module Guider
   # Reads the guides config file.
   # Turns it into list Guide instances accessible through .guides attribute.
   class Config
-    def initialize(path, tpl)
+    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)
+      @guides = to_guides(guide_cfgs, tpl, inline_tags)
     end
 
     # List of Guide instances.
@@ -41,8 +41,8 @@ module Guider
     end
 
     # Turns guide configs to actual Guide instances
-    def to_guides(guide_cfgs, tpl)
-      guide_cfgs.find_all {|g| File.exists?(g[:path]) }.map {|g| Guide.new(g, tpl) }
+    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) }
     end
 
   end

data/lib/guider/guide.rb

@@ -1,12 +1,12 @@
 require "kramdown"
 require "fileutils"
-require "guider/inline_tags"
 
 module Guider
   class Guide
-    def initialize(cfg, tpl)
+    def initialize(cfg, tpl, inline_tags)
       @cfg = cfg
       @template = tpl
+      @inline_tags = inline_tags
       @markdown = IO.read(@cfg[:path]+"/README.md")
       @html = Kramdown::Document.new(@markdown).to_html
     end
@@ -19,7 +19,7 @@ module Guider
     end
 
     def write_html(filename)
-      html = InlineTags.replace(@html)
+      html = @inline_tags.replace(@html)
       html = @template.apply(:content => html, :title => title)
       File.open(filename, 'w') {|f| f.write(html) }
     end
@@ -49,10 +49,12 @@ module Guider
       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+"/**/*.{png,jpg,jpeg,gif}"].each do |img|
-        if !["icon.png", "icon-lg.png"].include?(File.basename(img))
-          FileUtils.cp(img, dest+"/"+File.basename(img))
+      Dir[src+"/*"].each do |img|
+        if !["README.md"].include?(File.basename(img))
+          FileUtils.cp_r(img, dest+"/"+File.basename(img))
         end
       end
     end

data/lib/guider/index.rb

@@ -1,7 +1,3 @@
-require "kramdown"
-require "fileutils"
-require "guider/inline_tags"
-
 module Guider
   class Index
     def initialize(guides, tpl)

data/lib/guider/inline_tags.rb

@@ -1,12 +1,21 @@
 module Guider
   class InlineTags
-    def self.replace(html)
+    # The base URL for links created by {@link} tags.
+    attr_accessor :link_url
+
+    def initialize
+      @link_url = ""
+    end
+
+    def replace(html)
       replace_link!(html)
       replace_img!(html)
       html
     end
 
-    def self.replace_link!(html)
+    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
@@ -20,12 +29,12 @@ module Guider
           apiref = cls
         end
 
-        url = "http://docs.sencha.com/ext-js/4-1/#!/api/" + apiref
+        url = @link_url + "#!/api/" + apiref
         "<a href='#{url}'>#{alt || ref}</a>"
       end
     end
 
-    def self.replace_img!(html)
+    def replace_img!(html)
       re = /\{@img\s+([^\s\}]*)(?:\s+([^\}]*))?}/
       html.gsub!(re) do |m|
         m =~ re # re-run regex to extract $1 $2 fields

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guider
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -86,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: guider
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Sencha guide generator