miniyard 0.0.4 → 0.0.5

data/bin/miniyard

@@ -8,6 +8,7 @@ options = {
   root: Dir.pwd,
   doc: nil,
   cov: nil,
+  ci: nil,
   name: nil
 }
 
@@ -19,9 +20,12 @@ OptionParser.new do |opts|
   opts.on("-d SOURCE_DOCS""--doc=SOURCE_DOCS", "Docs folder to copy (requires --name option)") do |v|
     options[:doc] = v
   end
-  opts.on("-c SOURCE_COVERAGE", "--cov=SOURCE_COVERAGE", "Coverage folder to copy (requires --name option)") do |v|
+  opts.on("-o SOURCE_COVERAGE", "--cov=SOURCE_COVERAGE", "Coverage folder to copy (requires --name option)") do |v|
     options[:cov] = v
   end
+  opts.on("-u CI_URL", "--url=CI_URL", "Full URL to CI for project") do |v|
+    options[:ci] = v
+  end
   opts.on("-n NAME", "--name=NAME", "The name of the application folder in root. (Only applies to --cpdoc or --cpcov flags)") do |v|
     options[:name] = v
   end
@@ -31,4 +35,4 @@ if options[:doc] || options[:cov]
   MiniYard::Copy.new(options).run
 end
 
-MiniYard::Generate.new(options[:root]).run
+MiniYard::Generate.new(options).run

data/lib/miniyard.rb

@@ -1,17 +1,20 @@
 require "miniyard/version"
+require "miniyard/folder"
 require 'fileutils'
 require 'haml'
 
 module MiniYard
   class Generate
     
-    def initialize(root)
-      raise 'Unable to generate MiniYard at path %s: not a directory' % path unless File.directory?(root)
-      @root = File.expand_path(root)
+    def initialize(options)
+      raise 'Unable to generate MiniYard at path %s: not a directory' % path unless File.directory?(options[:root])
+      @options = options
+      @root = File.expand_path(@options[:root])
     end
     
     def run
       $stdout.puts('Generating miniyard at '+@root)
+      write_ci_url if @options[:ci]
       FileUtils.rm(index_file) if index_exists?
       output = haml_render(index_template)
       write_file(index_file, output)
@@ -19,7 +22,7 @@ module MiniYard
     end
     
     def folders
-      @folders ||= Dir[File.join(@root, '*')].sort.select{|n| File.directory?(n) }.map{|n| File.basename(n) }
+      @folders ||= Dir[File.join(@root, '*')].sort.select{|n| File.directory?(n) }.map{|n| MiniYard::Folder.new(n) }
     end
     
     def index_template
@@ -53,6 +56,14 @@ module MiniYard
       end
     end
     
+    def write_ci_url
+      File.open(ci_path, 'w'){|f| f.write(@options[:ci]) }
+    end
+    
+    def ci_path
+      File.join(@root, @options[:name], 'ci.url')
+    end
+    
     def bootstrap_version
       "1.4.0"
     end

data/lib/miniyard/folder.rb

@@ -0,0 +1,23 @@
+module MiniYard
+  class Folder
+    attr_reader :name, :doc, :cov, :ci
+    
+    def initialize(path)
+      @path = path
+      @name = File.basename(path)
+      @doc = File.directory?(File.join(path, 'doc')) ? "yes" : "no"
+      @cov = File.directory?(File.join(path, 'cov')) ? "yes" : "no"
+      @ci = get_ci_url
+    end
+    
+    def get_ci_url
+      ci_file = File.join(@path, 'ci.url')
+      if File.file?(ci_file)
+        File.open(ci_file, 'r'){|f| @ci_file = f.read.chop.strip }
+      else
+        "no"
+      end
+    end
+    
+  end
+end

data/lib/miniyard/version.rb

@@ -1,3 +1,3 @@
 module MiniYard
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/templates/index.haml

@@ -4,18 +4,35 @@
     %title [ MiniYard ]
     %link{rel: 'stylesheet', type: 'text/css', href: './bootstrap.1.4.0.min.css'}
     :javascript
-      function selectFolder(anchor, folder) {
-        document.getElementById('doc-frame-link').href = './'+folder+'/doc/index.html';
-        document.getElementById('cov-frame-link').href = './'+folder+'/cov/index.html';
+      function selectFolder(anchor) {
+        var docHref = updatePill(anchor.dataset.doc, 'doc-frame-link', './'+anchor.dataset.name+'/doc/index.html');
+        var covHref = updatePill(anchor.dataset.cov, 'cov-frame-link', './'+anchor.dataset.name+'/cov/index.html');
+        var ciHref = updatePill(anchor.dataset.ciurl, 'ci-frame-link', anchor.dataset.ciurl);
+        var frameSrc = (docHref != '#' ? docHref : (covHref != '#' ? covHref : ciHref));
+        if (frameSrc != 'javascript:void(0);')
+          document.getElementById('frame').src = frameSrc;
+        
         setActive(anchor);
         setActive(document.getElementById('doc-frame-link'));
       }
+      function updatePill(dataAttr, pillAnchorId, pillAnchorHref) {
+        var link = document.getElementById(pillAnchorId);
+        if (dataAttr == 'no') {
+          link.parentElement.classList.add('hide');
+          link.href = 'javascript:void(0);';
+        } else {
+          link.parentElement.classList.remove('hide');
+          link.href = pillAnchorHref;
+        }
+        return link.href;
+      }
       function setActive(anchor) {
         var ul = anchor.parentElement.parentElement;
         for (var i = 0; i < ul.children.length; i++)
           ul.children[i].classList.remove('active');
         anchor.parentNode.classList.add('active');
       }
+    
     :css
       html,body { height: 100%; margin: 0; padding: 0; }
       body { background: #333; color: #fff; }
@@ -30,6 +47,7 @@
       .sidebar ul li.active { font-weight: bold; background: #666; }
       .content ul.pills { margin-bottom: 0; }
       .content ul.pills a { color: #fff; text-shadow: 0 1px 1px #666; }
+      .content ul.pills li.hide { display: none }
       .content #frame { width: 100%; min-height: 90%; background: #fff; }
     
   %body
@@ -38,8 +56,8 @@
         %ul
           - folders.each do |folder|
             %li
-              %a{id: "#{folder}-link", href: "./#{folder}/doc/index.html", target: 'frame', onclick: "javascript: selectFolder(this, '#{folder}')"}
-                = folder
+              %a{id: "#{folder.name}-link", href: '#', 'data-name' => folder.name, 'data-doc' => folder.doc, 'data-cov' => folder.cov, 'data-ciurl' => folder.ci, onclick: "javascript: selectFolder(this);"}
+                = folder.name
             
       .content
         %ul#pill-nav.pills{"data-pills" => "pills"}
@@ -47,6 +65,8 @@
             %a{id: "doc-frame-link", href: 'javascript: void(0);', target: "frame", onclick: "javascript: setActive(this)"} Documentation
           %li
             %a{id: "cov-frame-link", href: 'javascript: void(0);', target: "frame", onclick: "javascript: setActive(this)"} Coverage
+          %li
+            %a{id: "ci-frame-link", href: 'javascript: void(0);', target: "frame", onclick: "javascript: setActive(this)"} CI
         %iframe#frame{name: 'frame', frameborder: '0'}
         %h3.title
           %span.bracket [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miniyard
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-23 00:00:00.000000000Z
+date: 2011-12-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &2153365140 !ruby/object:Gem::Requirement
+  requirement: &2164268180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153365140
+  version_requirements: *2164268180
 description: A static html framebuilder to host multiple documentation folders
 email:
 - bj.neilsen@gmail.com
@@ -36,6 +36,7 @@ files:
 - bin/miniyard
 - lib/miniyard.rb
 - lib/miniyard/copy.rb
+- lib/miniyard/folder.rb
 - lib/miniyard/version.rb
 - lib/templates/bootstrap.1.4.0.min.css
 - lib/templates/index.haml