cuporter 0.3.5 → 0.3.6

data/README.textile

@@ -115,34 +115,46 @@ h4. help
   $ cuporter -h
 
   Usage: cuporter [options]
-  
+
       -r, --report [tag|feature|tree]  View, or type of report.
                                            Default: "tag"
-            
+
       -f, --format [xml|html|csv|text] Output format.
-                                           Default: text (it's pretty, though!)
-            
+      Default: text (it's pretty, though!)
+
       -i, --input-dir DIR              Root directory of *.feature files.
                                            Default: "features"
-       
+
                                            Used to build the glob pattern '[--input-dir]/**/*.feature', which is really most likely
                                            "features/**/*.features" and finds all feature files anywhere under "features" or
                                            your custom root supplied with this option.
                                            Overridden by "--file-input'.
-            
+
       -I, --file-input FILE            Single *.feature file.  Full name with extension, like 'path/to/file.feature.'
                                            Overrides "--input-dir" and used mostly for testing.
-            
+
       -o, --output-file FILE           Output file path, like 'tmp/cucumber/tag_report.html'.
-            
+
       -t, --tags TAG_EXPRESSION        Filter on tags for name report.
                                            TAG_EXPRESSION rules:
                                                1. $ cucumber --help
                                                2. http://github.com/aslakhellesoy/cucumber/wiki/Tags
-            
+
       -T, --title STRING               Override report default title, which is different for each view/report.
                                            This affects the xml 'report' node title and the html head > title attributes.
-            
+CSS and Javascript asset options:
+
+    -a, --assets-dir PATH            Path to folder for CSS and Javascript assets.
+                                           Only applies with '--link-assets', which is off by default.
+                                           Setting this will cause assets to be copied from 'public';
+                                           otherwise, the html will link to the files under 'cuporter/public' in
+                                           your gempath.
+
+    -l, --link-assets                Do not inline CSS and js in <style/> and <script/> tags, but link to
+                                       external files instead.
+                                           Default:  'false' for the tag and feature views, not optional for the
+                                                     tree view, which requires external gifs.
+
   Reporting options: on by default but can be turned off:
   
           --no-sort                    Do not sort tags, features, scenarios, or outlines

data/Rakefile

@@ -65,7 +65,7 @@ namespace :cuporter do
 
   spec = Gem::Specification.new do |s|
     s.name = 'cuporter'
-    s.version = '0.3.5'
+    s.version = '0.3.6'
     s.rubyforge_project = s.name
 
     s.platform = Gem::Platform::RUBY

data/bin/cuporter

@@ -14,7 +14,8 @@ when 'csv'
 when 'text', 'pretty'
   report.doc.to_text
 when 'html'
-  html = Cuporter::Document.new_html(Cuporter.options[:report])
+  Cuporter.options[:link_assets] = true if Cuporter.options[:report] == "tree"
+  html = Cuporter::Document.new_html(Cuporter.options[:report], Cuporter.options[:link_assets], Cuporter.options[:assets_dir])
   formatters = File.expand_path("../lib/cuporter/formatters", File.dirname(__FILE__))
   xslt = Nokogiri::XSLT(File.read("#{formatters}/xml_to_html.xslt"))
   html.add_report(xslt.transform(report.doc).at('.report'))

data/lib/cuporter/cli/options.rb

@@ -25,6 +25,15 @@ module Cuporter
         @@args
       end
 
+      
+      def self.full_path(path)
+        expanded_path = File.expand_path(path)
+        path_nodes = expanded_path.split(File::SEPARATOR)
+        file = path_nodes.pop
+        FileUtils.makedirs(path_nodes.join(File::SEPARATOR))
+        expanded_path
+      end
+
       def self.parse
         @@args = ARGV.dup
         @options = {}
@@ -63,15 +72,9 @@ module Cuporter
             @options[:input_file] = file
           end
           
-          @options[:output_file]
           opts.on("-o", "--output-file FILE", %Q{Output file path, like 'tmp/cucumber/tag_report.html'.
           }) do |o|
-            full_path = File.expand_path(o)
-            path = full_path.split(File::SEPARATOR)
-            file = path.pop
-            FileUtils.makedirs(path.join(File::SEPARATOR))
-            
-            @options[:output_file] = full_path
+            @options[:output_file] = full_path(o)
           end
 
           @options[:tags] = []
@@ -89,6 +92,24 @@ module Cuporter
             @options[:title] = title
           end
 
+          opts.separator "CSS and Javascript asset options:\n\n"
+          opts.on("-a", "--assets-dir PATH", %Q{Path to folder for CSS and Javascript assets.
+                                           Only applies with '--link-assets', which is off by default.
+                                           Setting this will cause assets to be copied from 'public';
+                                           otherwise, the html will link to the files under 'cuporter/public' in
+                                           your gempath.
+          }) do |a|
+            @options[:assets_dir] = full_path(a)
+          end
+
+          opts.on("-l", "--link-assets", %Q{Do not inline CSS and js in <style/> and <script/> tags, but link to
+                                       external files instead.
+                                           Default:  'false' for the tag and feature views, not optional for the
+                                                     tree view, which requires external gifs.
+          }) do |l|
+            @options[:link_assets] = l
+          end
+
           opts.separator "Reporting options: on by default but can be turned off:\n\n"
           @options[:sort] = true
           opts.on("--no-sort", "Do not sort tags, features, scenarios, or outlines\n") do |n|

data/lib/cuporter/document/html_document.rb

@@ -2,7 +2,7 @@
 module Cuporter
   module Document
     module Html
-      attr_accessor :view
+      attr_accessor :view, :link_assets, :assets_dir
 
       def add_report(node)
         root << head(node['title'])
@@ -26,43 +26,46 @@ module Cuporter
 
         case view
         when "tree"
-          h << link_js("jquery-min.js")
-          h << link_js("jquery.treeview.js")
-          h << link_css("jquery.treeview.css")
-          h << link_js("treeview-loader.js")
-          h << link_css("cuporter.css")
-          h << link_css("#{view}_style.css")
+          h << link_js("javascripts/jquery-min.js")
+          h << link_js("jquery.treeview/jquery.treeview.js")
+          h << link_css("jquery.treeview/jquery.treeview.css")
+          h << link_js("javascripts/treeview-loader.js")
+          h << link_css("stylesheets/cuporter.css")
+          h << link_css("stylesheets/#{view}_style.css")
         else
-          h << script_js("jquery-min.js")
-          h << style_css("cuporter.css")
-          h << style_css("#{view}_style.css")
-          h << script_js("expand-collapse.js")
+          if link_assets
+            h << link_js("javascripts/jquery-min.js")
+            h << link_css("stylesheets/cuporter.css")
+            h << link_css("stylesheets/#{view}_style.css")
+            h << link_js("javascripts/expand-collapse.js")
+          else
+            h << script_js("javascripts/jquery-min.js")
+            h << style_css("stylesheets/cuporter.css")
+            h << style_css("stylesheets/#{view}_style.css")
+            h << script_js("javascripts/expand-collapse.js")
+          end
         end
         h
       end
 
-      def assets_dir
-        @assets_dir ||= File.expand_path('public', File.dirname(__FILE__) + "/../../../")
-      end
-
       def style_css(file)
         style = new_node('style', 'type' => 'text/css')
-        style << file_contents("#{assets_dir}/stylesheets/#{file}")
+        style << file_contents("#{assets_dir}/#{file}")
         style
       end
 
       def script_js(file)
         script = new_node('script', 'type' => 'text/javascript')
-        script << file_contents("#{assets_dir}/javascripts/#{file}")
+        script << file_contents("#{assets_dir}/#{file}")
         script
       end
 
       def link_css(file)
-        new_node('link', 'type' => 'text/css', 'rel' => 'stylesheet', 'href' => "#{assets_dir}/stylesheets/#{file}")
+        new_node('link', 'type' => 'text/css', 'rel' => 'stylesheet', 'href' => "#{assets_dir}/#{file}")
       end
 
       def link_js(file)
-        new_node('script', 'type' => 'text/javascript', 'src' => "#{assets_dir}/javascripts/#{file}")
+        new_node('script', 'type' => 'text/javascript', 'src' => "#{assets_dir}/#{file}")
       end
 
       def file_contents(file_name)

data/lib/cuporter/document.rb

@@ -10,10 +10,20 @@ module Cuporter
       doc
     end
 
-    def self.new_html(view)
+    def self.new_html(view, link_assets, assets_dir)
       Nokogiri::XML::Document.send(:include, Cuporter::Document::Html)
       doc =  Nokogiri::XML::Document.new
       doc.view = view
+      doc.link_assets = link_assets
+      project_assets = File.expand_path( "public", File.dirname(__FILE__) + "../../../")
+
+      # we count on the dirs being created by the option parser
+      if assets_dir
+        FileUtils.cp_r("#{project_assets}/.", assets_dir)
+        doc.assets_dir = assets_dir
+      else
+        doc.assets_dir = project_assets
+      end
       root = Nokogiri::XML::Node.new('html', doc)
       root.create_internal_subset( 'html', "-//W3C//DTD XHTML 1.0 Strict//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd")
       doc << root

data/public/{stylesheets → jquery.treeview}/jquery.treeview.css

@@ -10,7 +10,7 @@
 }
 
 .treeview .hitarea {
-    background: url(../images/treeview-default.gif) -64px -25px no-repeat;
+    background: url(images/treeview-default.gif) -64px -25px no-repeat;
     height: 16px;
     width: 16px;
     margin-left: -16px;
@@ -36,32 +36,32 @@
 
 .treeview .hover { color: red; cursor: pointer; }
 
-.treeview li { background: url(../images/treeview-default-line.gif) 0 0 no-repeat; }
+.treeview li { background: url(images/treeview-default-line.gif) 0 0 no-repeat; }
 .treeview li.collapsable, .treeview li.expandable { background-position: 0 -176px; }
 
 .treeview .expandable-hitarea { background-position: -80px -3px; }
 
 .treeview li.last { background-position: 0 -1766px }
-.treeview li.lastCollapsable, .treeview li.lastExpandable { background-image: url(../images/treeview-default.gif); }  
+.treeview li.lastCollapsable, .treeview li.lastExpandable { background-image: url(images/treeview-default.gif); }  
 .treeview li.lastCollapsable { background-position: 0 -111px }
 .treeview li.lastExpandable { background-position: -32px -67px }
 
 .treeview div.lastCollapsable-hitarea, .treeview div.lastExpandable-hitarea { background-position: 0; }
 
-.treeview-red li { background-image: url(../images/treeview-red-line.gif); }
-.treeview-red .hitarea, .treeview-red li.lastCollapsable, .treeview-red li.lastExpandable { background-image: url(../images/treeview-red.gif); } 
+.treeview-red li { background-image: url(images/treeview-red-line.gif); }
+.treeview-red .hitarea, .treeview-red li.lastCollapsable, .treeview-red li.lastExpandable { background-image: url(images/treeview-red.gif); } 
 
-.treeview-black li { background-image: url(../images/treeview-black-line.gif); }
-.treeview-black .hitarea, .treeview-black li.lastCollapsable, .treeview-black li.lastExpandable { background-image: url(../images/treeview-black.gif); }  
+.treeview-black li { background-image: url(images/treeview-black-line.gif); }
+.treeview-black .hitarea, .treeview-black li.lastCollapsable, .treeview-black li.lastExpandable { background-image: url(images/treeview-black.gif); }  
 
-.treeview-gray li { background-image: url(../images/treeview-gray-line.gif); }
-.treeview-gray .hitarea, .treeview-gray li.lastCollapsable, .treeview-gray li.lastExpandable { background-image: url(../images/treeview-gray.gif); } 
+.treeview-gray li { background-image: url(images/treeview-gray-line.gif); }
+.treeview-gray .hitarea, .treeview-gray li.lastCollapsable, .treeview-gray li.lastExpandable { background-image: url(images/treeview-gray.gif); } 
 
-.treeview-famfamfam li { background-image: url(../images/treeview-famfamfam-line.gif); }
-.treeview-famfamfam .hitarea, .treeview-famfamfam li.lastCollapsable, .treeview-famfamfam li.lastExpandable { background-image: url(../images/treeview-famfamfam.gif); } 
+.treeview-famfamfam li { background-image: url(images/treeview-famfamfam-line.gif); }
+.treeview-famfamfam .hitarea, .treeview-famfamfam li.lastCollapsable, .treeview-famfamfam li.lastExpandable { background-image: url(images/treeview-famfamfam.gif); } 
 
 .treeview .placeholder {
-    background: url(../images/ajax-loader.gif) 0 0 no-repeat;
+    background: url(images/ajax-loader.gif) 0 0 no-repeat;
     height: 16px;
     width: 16px;
     display: block;
@@ -69,7 +69,7 @@
 
 .filetree li { padding: 3px 0 2px 16px; }
 .filetree span.folder, .filetree span.file { padding: 1px 0 1px 16px; display: block; }
-.filetree span.folder { background: url(../images/folder.gif) 0 0 no-repeat; }
-.filetree li.expandable span.folder { background: url(../images/folder-closed.gif) 0 0 no-repeat; }
-.filetree span.file { background: url(../images/file.gif) 0 0 no-repeat; }
+.filetree span.folder { background: url(images/folder.gif) 0 0 no-repeat; }
+.filetree li.expandable span.folder { background: url(images/folder-closed.gif) 0 0 no-repeat; }
+.filetree span.file { background: url(images/file.gif) 0 0 no-repeat; }
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuporter
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 3
-  - 5
-  version: 0.3.5
+  - 6
+  version: 0.3.6
 platform: ruby
 authors: 
 - Tim Camper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-29 00:00:00 -04:00
+date: 2011-05-08 00:00:00 -04:00
 default_executable: cuporter
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,31 +73,31 @@ files:
 - lib/cuporter.rb
 - lib/cuporter/formatters/xml_to_html.xslt
 - bin/cuporter
+- public/jquery.treeview/jquery.treeview.css
 - public/stylesheets/cuporter.css
 - public/stylesheets/feature_style.css
-- public/stylesheets/jquery.treeview.css
 - public/stylesheets/tag_style.css
 - public/stylesheets/tree_style.css
 - public/javascripts/expand-collapse.js
 - public/javascripts/jquery-min.js
-- public/javascripts/jquery.treeview.js
 - public/javascripts/treeview-loader.js
-- public/images/ajax-loader.gif
-- public/images/file.gif
-- public/images/folder-closed.gif
-- public/images/folder.gif
-- public/images/minus.gif
-- public/images/plus.gif
-- public/images/treeview-black-line.gif
-- public/images/treeview-black.gif
-- public/images/treeview-default-line.gif
-- public/images/treeview-default.gif
-- public/images/treeview-famfamfam-line.gif
-- public/images/treeview-famfamfam.gif
-- public/images/treeview-gray-line.gif
-- public/images/treeview-gray.gif
-- public/images/treeview-red-line.gif
-- public/images/treeview-red.gif
+- public/jquery.treeview/jquery.treeview.js
+- public/jquery.treeview/images/ajax-loader.gif
+- public/jquery.treeview/images/file.gif
+- public/jquery.treeview/images/folder-closed.gif
+- public/jquery.treeview/images/folder.gif
+- public/jquery.treeview/images/minus.gif
+- public/jquery.treeview/images/plus.gif
+- public/jquery.treeview/images/treeview-black-line.gif
+- public/jquery.treeview/images/treeview-black.gif
+- public/jquery.treeview/images/treeview-default-line.gif
+- public/jquery.treeview/images/treeview-default.gif
+- public/jquery.treeview/images/treeview-famfamfam-line.gif
+- public/jquery.treeview/images/treeview-famfamfam.gif
+- public/jquery.treeview/images/treeview-gray-line.gif
+- public/jquery.treeview/images/treeview-gray.gif
+- public/jquery.treeview/images/treeview-red-line.gif
+- public/jquery.treeview/images/treeview-red.gif
 has_rdoc: true
 homepage: http://github.com/twcamper/cuporter
 licenses: []