guider 0.0.7 → 0.0.8

data/bin/guider

@@ -6,8 +6,9 @@ $:.unshift File.dirname(File.dirname(__FILE__)) + "/lib"
 require "rubygems"
 require "optparse"
 require "guider/app"
+require "guider/social"
 
-GUIDER_VERSION = '0.0.7'
+GUIDER_VERSION = '0.0.8'
 
 def format_footer(text)
   guider = "<a href='https://github.com/nene/guider'>Guider</a>"
@@ -22,6 +23,9 @@ options = {
   :link_url => "http://localhost/extjs/",
   :tpl_dir => File.dirname(File.dirname(__FILE__)) + "/template",
   :warnings => false,
+  :social => [],
+  :search => nil,
+  :analytics => nil,
 }
 
 input_files = OptionParser.new do |opts|
@@ -52,6 +56,24 @@ input_files = OptionParser.new do |opts|
     options[:index] = path
   end
 
+  opts.on("--social=google,twitter,facebook", Array, "Buttons to add to the page.") do |social|
+    social = social.map {|t| t.to_sym }
+    unsupported = social.find_all {|t| !Guider::Social.supported_types.include?(t) }
+    if unsupported.length > 0
+      $stderr.puts "ERROR: Unsupported social button type: " + unsupported.join(" ")
+      exit(1)
+    end
+    options[:social] = social
+  end
+
+  opts.on("--search=id", "ID of custom google search engine.") do |id|
+    options[:search] = id
+  end
+
+  opts.on("--analytics=id", "ID for Google Analytics tracking.") do |id|
+    options[:analytics] = id
+  end
+
   opts.on("--warnings", "Enables warnings.") do
     options[:warnings] = true
   end

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.7'
+  s.version = '0.0.8'
   s.date = Time.new.strftime('%Y-%m-%d')
   s.summary = "Sencha guide generator"
   s.description = "JSDuck-compatible guides generator"

data/lib/guider/analytics.rb

@@ -0,0 +1,27 @@
+module Guider
+  # Generates HTML for Google Analytics.
+  class Analytics
+    # Given the ID of Google analytics tracker, returns the tracker
+    # script.  Returns empty string when no ID given.
+    def self.to_html(id)
+      return "" unless id
+
+      <<-EOHTML
+      <script type="text/javascript">
+        var _gaq = _gaq || [];
+        _gaq.push(['_setAccount', '#{id}']);
+        _gaq.push(['_trackPageview']);
+        (function() {
+          var ga = document.createElement('script');
+          ga.type = 'text/javascript';
+          ga.async = true;
+          ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') +
+            '.google-analytics.com/ga.js';
+          var s = document.getElementsByTagName('script')[0];
+          s.parentNode.insertBefore(ga, s);
+        })();
+      </script>
+      EOHTML
+    end
+  end
+end

data/lib/guider/default_template.rb

@@ -0,0 +1,24 @@
+require 'guider/template'
+require 'guider/social'
+require 'guider/search'
+require 'guider/analytics'
+require 'guider/prettify'
+require 'guider/font'
+
+module Guider
+  # Initializes the common Guider template placeholders with default
+  # values generated from Guider options.
+  class DefaultTemplate < Template
+    def initialize(path, options)
+      super(path, {
+        :title => options[:title],
+        :footer => options[:footer],
+        :search => Social.to_html(options[:social]),
+        :search => Search.to_html(options[:search]),
+        :analytics => Analytics.to_html(options[:analytics]),
+        :prettify => Prettify.to_html,
+        :font => Font.to_html,
+      })
+    end
+  end
+end

data/lib/guider/font.rb

@@ -0,0 +1,15 @@
+module Guider
+  # Generates <script> tag for including google font.
+  class Font
+    def self.to_html
+      <<-EOHTML
+      <script type="text/javascript">
+      (function(){
+        var protocol = (document.location.protocol === "https:") ? "https:" : "http:";
+        document.write("<link href='"+protocol+"//fonts.googleapis.com/css?family=Exo' rel='stylesheet' type='text/css' />");
+      })();
+      </script>
+      EOHTML
+    end
+  end
+end

data/lib/guider/guide.rb

@@ -20,8 +20,6 @@ module Guider
       html = @inline_tags.replace(@html)
       html = @template.apply({
           :content => html,
-          :title => @options[:title],
-          :footer => @options[:footer],
           :guide_name => guide_name,
           :path => @rel_path,
         })

data/lib/guider/guide_factory.rb

@@ -1,4 +1,4 @@
-require "guider/template"
+require "guider/default_template"
 require "guider/inline_tags"
 require "guider/guide"
 
@@ -11,7 +11,7 @@ module Guider
       @inline_tags.link_url = options[:link_url]
 
       # Create guide rendering template
-      @tpl = Template.new(options[:tpl_dir] + "/guide.html")
+      @tpl = DefaultTemplate.new(options[:tpl_dir] + "/guide.html", options)
 
       @options = options
     end

data/lib/guider/index.rb

@@ -1,4 +1,4 @@
-require 'guider/template'
+require 'guider/default_template'
 require 'guider/config'
 
 module Guider
@@ -6,13 +6,11 @@ module Guider
     def initialize(options)
       @options = options
       @config = Config.new(@options[:index])
-      @tpl = Template.new(@options[:tpl_dir] + "/index.html")
+      @tpl = DefaultTemplate.new(@options[:tpl_dir] + "/index.html", @options)
     end
 
     def write
       html = @tpl.apply({
-        :title => @options[:title],
-        :footer => @options[:footer],
         :content => @config.to_html,
       })
       File.open(@options[:output] + "/index.html", 'w') {|f| f.write(html) }

data/lib/guider/prettify.rb

@@ -0,0 +1,19 @@
+module Guider
+  # Generates <script> tag for syntax-highlighting code blocks.
+  class Prettify
+    def self.to_html
+      <<-EOHTML
+      <script type="text/javascript">
+      (function(){
+        var pres = document.getElementsByTagName("pre");
+        for (var len=pres.length, i=0; i < len; i++) {
+          var code = pres[i].getElementsByTagName("code")[0];
+          if (code) code.className = "prettyprint";
+        }
+        prettyPrint();
+      })();
+      </script>
+      EOHTML
+    end
+  end
+end

data/lib/guider/search.rb

@@ -0,0 +1,27 @@
+module Guider
+  # Generates HTML for Google search.
+  class Search
+    # Given the ID of custom google search engine, returns the script
+    # for generating the search box.  Returns empty string when no ID
+    # given.
+    def self.to_html(id)
+      return "" unless id
+
+      <<-EOHTML
+      <script>
+      (function() {
+        var cx = '#{id}';
+        var gcse = document.createElement('script');
+        gcse.type = 'text/javascript';
+        gcse.async = true;
+        gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') +
+            '//www.google.com/cse/cse.js?cx=' + cx;
+        var s = document.getElementsByTagName('script')[0];
+        s.parentNode.insertBefore(gcse, s);
+      })();
+      </script>
+      <gcse:searchbox-only></gcse:searchbox-only>
+      EOHTML
+    end
+  end
+end

data/lib/guider/social.rb

@@ -0,0 +1,49 @@
+module Guider
+  # Generates HTML for Like-buttons of various social services.
+  class Social
+    # Given array of social button type names, returns HTML for
+    # rendering all these buttons.
+    def self.to_html(types)
+      types.map {|t| send(t) }.compact.join("\n")
+    end
+
+    # Returns array of supported social button types
+    def self.supported_types
+      [:google, :twitter, :facebook]
+    end
+
+    def self.google
+      <<-EOHTML
+      <div class="g-plusone" data-annotation="none"></div>
+      <script type="text/javascript">
+        (function() {
+          var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
+          po.src = 'https://apis.google.com/js/plusone.js';
+          var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
+        })();
+      </script>
+      EOHTML
+    end
+
+    def self.twitter
+      <<-EOHTML
+      <a href="https://twitter.com/share" class="twitter-share-button">Tweet</a>
+      <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
+      EOHTML
+    end
+
+    def self.facebook
+      <<-EOHTML
+      <div id="fb-root"></div>
+      <script>(function(d, s, id) {
+        var js, fjs = d.getElementsByTagName(s)[0];
+        if (d.getElementById(id)) return;
+        js = d.createElement(s); js.id = id;
+        js.src = "//connect.facebook.net/et_EE/all.js#xfbml=1";
+        fjs.parentNode.insertBefore(js, fjs);
+      }(document, 'script', 'facebook-jssdk'));</script>
+      <div class="fb-like" data-send="false" data-layout="button_count" data-width="450" data-show-faces="true"></div>
+      EOHTML
+    end
+  end
+end

data/lib/guider/template.rb

@@ -2,13 +2,19 @@ module Guider
   # Reads a template from file.
   # Allows replacing {placeholders} inside it.
   class Template
-    def initialize(path)
+    # Takes path to the template and an optional defaults hash mapping
+    # placeholders to values.  These are the default values for
+    # placeholders for which no value is given in the hash passed to
+    # #apply method.
+    def initialize(path, defaults={})
       @template = IO.read(path)
+      @defaults = defaults
     end
 
     # Sets the values for placeholders inside template.
     # Returns the template text with placeholders replaced.
     def apply(hash)
+      hash = @defaults.merge(hash)
       @template.gsub(/\{\w+\}/) do |placeholder|
         placeholder =~ /\{(.*)\}/
         hash[$1.to_sym]

data/template/guide.html

@@ -12,11 +12,14 @@
 
 <div id="container">
 <div id="header">
+  <div class="google-search">{search}</div>
   <h1><a href="{path}">{title}</a></h1>
 </div>
 
 <div id="content">
-{content}
+  {content}
+
+  {social}
 </div>
 </div>
 
@@ -24,23 +27,9 @@
   <p>{footer}</p>
 </div>
 
-<script type="text/javascript">
-(function(){
-  var protocol = (document.location.protocol === "https:") ? "https:" : "http:";
-  document.write("<link href='"+protocol+"//fonts.googleapis.com/css?family=Exo' rel='stylesheet' type='text/css' />");
-})();
-</script>
-
-<script type="text/javascript">
-(function(){
-  var pres = document.getElementsByTagName("pre");
-  for (var len=pres.length, i=0; i < len; i++) {
-    var code = pres[i].getElementsByTagName("code")[0];
-    if (code) code.className = "prettyprint";
-  }
-  prettyPrint();
-})();
-</script>
+{font}
+{prettify}
+{analytics}
 
 </body>
 </html>

data/template/index.html

@@ -5,11 +5,14 @@
   <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>
 </head>
 <body id="index-page">
 
 <div id="container">
 <div id="header">
+  <div class="google-search">{search}</div>
   <h1><a href="{path}">{title}</a></h1>
 </div>
 
@@ -22,12 +25,9 @@
   <p>{footer}</p>
 </div>
 
-<script type="text/javascript">
-(function(){
-  var protocol = (document.location.protocol === "https:") ? "https:" : "http:";
-  document.write("<link href='"+protocol+"//fonts.googleapis.com/css?family=Exo' rel='stylesheet' type='text/css' />");
-})();
-</script>
+{font}
+{prettify}
+{analytics}
 
 </body>
 </html>

data/template/styles.css

@@ -54,6 +54,13 @@ img {
     color: white;
 }
 
+#header .google-search {
+    position: absolute;
+    top: 3px;
+    right: 20px;
+    width: 250px;
+}
+
 #content {
     max-width: 900px;
     margin: 0 auto;

metadata

@@ -1,76 +1,74 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: guider
-version: !ruby/object:Gem::Version 
-  hash: 17
+version: !ruby/object:Gem::Version
+  version: 0.0.8
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 7
-  version: 0.0.7
 platform: ruby
-authors: 
+authors:
 - Rene Saarsoo
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-04-03 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: kramdown
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 0
-        - 14
-        - 2
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.14.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 7
-        - 5
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.7.5
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.5
 description: JSDuck-compatible guides generator
 email: rene.saarsoo@sencha.com
-executables: 
+executables:
 - guider
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - COPYING
 - README.md
 - Rakefile
 - bin/guider
 - guider.gemspec
+- lib/guider/analytics.rb
 - lib/guider/app.rb
 - lib/guider/config.rb
+- lib/guider/default_template.rb
+- lib/guider/font.rb
 - lib/guider/guide.rb
 - lib/guider/guide_factory.rb
 - lib/guider/index.rb
 - lib/guider/inline_tags.rb
 - lib/guider/logger.rb
+- lib/guider/prettify.rb
+- lib/guider/search.rb
+- lib/guider/social.rb
 - lib/guider/template.rb
 - template/favicon.ico
 - template/guide.html
@@ -81,38 +79,26 @@ files:
 - template/styles.css
 homepage: https://github.com/nene/guider
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 17
-      segments: 
-      - 1
-      - 3
-      - 5
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-
 rubyforge_project: guider
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Sencha guide generator
 test_files: []
-