rdoc-generator-fivefish 0.1.0.pre.87 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1c31edb8ff7f8f6979b5391984e439c9fa285a1
-  data.tar.gz: a82da0842d0ca0c73593cab01fecf212f43a2d88
+  metadata.gz: bc91a5bf6d446d2540e1ed7d30c2aee31ef3d084
+  data.tar.gz: f2090ba8575abc8db0c59752ff33b31c46cac72f
 SHA512:
-  metadata.gz: 1fc838df2a6111ff7c11fdda5b7ae803dec5b6cb73ccd5a793413c3b482c51ecc3faa1452e5aba2fbc85f1e8e8a199f2433a03ab869ef9fa14e8a012e3367df4
-  data.tar.gz: 6b265b5dc435fbc5c88d695dd63daa3aa37f590fca4b80e51e9c55a50218cb89c508cadcc6a19ce3445aa3a7b1b7c3acda01e1189910e2bf03400d2c4e5cc5ee
+  metadata.gz: 739d3fabcb43e04dfcebead109d2d32bbd25a4a41b711a5fad4443d0aa929762fab4a6936f187e89580d5e028cdab7e50a743bf360a9a5e1b2f8ad5f61d2014a
+  data.tar.gz: 2e99d4359a00d5cf334ab28ad3624b1e77de55278626f953f70acff05dc86905ad1a9dfc337df1fd6508e3aa34c6b36ff28629cd14e50979a15d890400212aa6

data/Manifest.txt

@@ -24,3 +24,6 @@ data/rdoc-generator-fivefish/templates/layout.tmpl
 lib/fivefish.rb
 lib/rdoc/discover.rb
 lib/rdoc/generator/fivefish.rb
+spec/fivefish_spec.rb
+spec/helpers.rb
+spec/rdoc/generator/fivefish_spec.rb

data/data/rdoc-generator-fivefish/css/bootstrap.min.css

@@ -463,7 +463,7 @@ table [class*=span],.row-fluid table [class*=span]{display:table-cell;float:none
 .dropdown-menu .active>a,.dropdown-menu .active>a:hover{color:#ffffff;text-decoration:none;outline:0;background-color:#0088cc;background-color:#0081c2;background-image:-moz-linear-gradient(top, #0088cc, #0077b3);background-image:-webkit-gradient(linear, 0 0, 0 100%, from(#0088cc), to(#0077b3));background-image:-webkit-linear-gradient(top, #0088cc, #0077b3);background-image:-o-linear-gradient(top, #0088cc, #0077b3);background-image:linear-gradient(to bottom, #0088cc, #0077b3);background-repeat:repeat-x;filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff0088cc', endColorstr='#ff0077b3', GradientType=0);}
 .dropdown-menu .disabled>a,.dropdown-menu .disabled>a:hover{color:#999999;}
 .dropdown-menu .disabled>a:hover{text-decoration:none;background-color:transparent;cursor:default;}
-.open{*z-index:1000;}.open >.dropdown-menu{display:block;}
+.open{*z-index:1000;}.open>.dropdown-menu{display:block;}
 .pull-right>.dropdown-menu{right:0;left:auto;}
 .dropup .caret,.navbar-fixed-bottom .dropdown .caret{border-top:0;border-bottom:4px solid #000000;content:"";}
 .dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:1px;}

data/lib/rdoc/generator/fivefish.rb

@@ -263,7 +263,7 @@ class RDoc::Generator::Fivefish
 	def copy_static_assets
 		asset_paths = self.find_static_assets
 
-		self.log.debug "Copying assets from paths:", *asset_paths
+		self.log.debug "Copying assets from paths: %s" % [ asset_paths.join(', ') ]
 
 		asset_paths.each do |path|
 

data/spec/fivefish_spec.rb

@@ -0,0 +1,22 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'helpers'
+require 'rspec'
+require 'fivefish'
+
+describe Fivefish do
+
+	describe "version methods" do
+		it "returns a version string if asked" do
+			described_class.version_string.should =~ /\w+ [\d.]+/
+		end
+
+
+		it "returns a version string with a build number if asked" do
+			described_class.version_string(true).should =~ /\w+ [\d.]+ \(build [[:xdigit:]]+\)/
+		end
+	end
+
+end
+

data/spec/helpers.rb

@@ -0,0 +1,42 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+# SimpleCov test coverage reporting; enable this using the :coverage rake task
+if ENV['COVERAGE']
+	$stderr.puts "\n\n>>> Enabling coverage report.\n\n"
+	require 'simplecov'
+	SimpleCov.start do
+		add_filter 'spec'
+		add_group "Needing tests" do |file|
+			file.covered_percent < 90
+		end
+	end
+end
+
+
+require 'loggability'
+require 'loggability/spechelpers'
+
+require 'rspec'
+require 'fivefish'
+
+Loggability.format_with( :color ) if $stdout.tty?
+
+
+### RSpec helper functions.
+module Fivefish::SpecHelpers
+
+
+end
+
+
+### Mock with RSpec
+RSpec.configure do |c|
+	c.mock_with( :rspec )
+
+	c.include( Loggability::SpecHelpers )
+	c.include( Fivefish::SpecHelpers )
+end
+
+# vim: set nosta noet ts=4 sw=4:
+

data/spec/rdoc/generator/fivefish_spec.rb

@@ -0,0 +1,246 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'helpers'
+require 'tmpdir'
+require 'rspec'
+require 'rdoc/generator/fivefish'
+
+describe RDoc::Generator::Fivefish do
+
+	# Lots of the setup and the examples in this file are ported from
+	# the test_rdoc_generator_darkfish.rb file from RDoc itself.
+	# Used under the second option in the LICENSE.rdoc file:
+	#   https://github.com/rdoc/rdoc/blob/master/LICENSE.rdoc
+
+	before( :all ) do
+		setup_logging()
+
+		@libdir = Pathname.pwd + 'lib'
+		@datadir = RDoc::Generator::Fivefish::DATADIR
+		@tmpdir = Pathname( Dir.tmpdir ) + "test_rdoc_generator_fivefish_#{$$}"
+		@opdir     = @tmpdir + 'docs'
+		@storefile = @tmpdir + '.rdoc_store'
+
+		@options = RDoc::Options.new
+		@options.option_parser = OptionParser.new
+
+		@options.op_dir = @opdir.to_s
+		@options.generator = described_class
+		@options.template_dir = @datadir.to_s
+
+		@tmpdir.mkpath
+		@store = RDoc::Store.new( @storefile.to_s )
+		@store.load_cache
+
+		$stderr.puts "Tmpdir is: %s" % [@tmpdir] if ENV['FIVEFISH_DEVELMODE']
+	end
+
+	before( :each ) do
+		@generator          = described_class.new( @store, @options )
+
+		@rdoc               = RDoc::RDoc.new
+		@rdoc.options       = @options
+		@rdoc.store         = @store
+		@rdoc.generator     = @generator
+
+		@top_level, @readme = add_code_objects( @store )
+	end
+
+	around( :each ) do |example|
+		@opdir.mkpath
+		Dir.chdir( @opdir ) { example.run }
+		@opdir.rmtree unless ENV['FIVEFISH_DEVELMODE']
+	end
+
+
+	#
+	# Examples
+	#
+
+	it "registers itself as a generator" do
+		RDoc::RDoc::GENERATORS.include?( described_class )
+	end
+
+	it "configures Inversion to load templates from its data directory" do
+		Inversion::Template.template_paths.should == [ @datadir + 'templates' ]
+	end
+
+
+	describe "additional-stylesheet option" do
+
+		it "is added to the options by the setup_options callback" do
+			@options.setup_generator( 'fivefish' )
+			@options.option_parser.to_a.join.should include( '--additional-stylesheet=URL' )
+		end
+
+	end
+
+
+	describe "generation" do
+
+		before( :each ) do
+			@generator.populate_data_objects
+		end
+
+
+		it "combines an index template with the layout template to make the index page" do
+			layout_template = get_fixtured_layout_template_mock()
+
+			index_template = mock( "index template" )
+			Inversion::Template.stub( :load ).with( 'index.tmpl', encoding: 'utf-8' ).
+				and_return( index_template )
+
+			index_template.should_receive( :dup ).and_return( index_template )
+			index_template.should_receive( :mainpage= ).with( @readme )
+			index_template.should_receive( :synopsis= ).
+				with( %{<h1 id="label-Testing+README">Testing <a href="README_md} +
+				      %{.html">README</a><span><a href="#label-Testing+README">} +
+				      %{&para;</a> <a href="#documentation">&uarr;</a></span></h1>} +
+				      %{<p>This is a readme for testing.</p>} )
+
+			layout_template.should_receive( :contents= ).with( index_template )
+			layout_template.should_receive( :pageclass= ).with( 'index-page' )
+			layout_template.should_receive( :rel_prefix= ).with( Pathname('.') )
+
+			layout_template.should_receive( :render ).and_return( 'Index page!' )
+
+			@generator.generate_index_page
+		end
+
+
+		it "combines a class template with the layout template to make class pages" do
+			classes = @store.all_classes_and_modules
+
+			layout_template = get_fixtured_layout_template_mock()
+
+			class_template = mock( "class template" )
+			Inversion::Template.stub( :load ).with( 'class.tmpl', encoding: 'utf-8' ).
+				and_return( class_template )
+			class_template.should_receive( :dup ).and_return( class_template )
+
+			classes.each do |klass|
+				class_template.should_receive( :klass= ).with( klass )
+			end
+
+			layout_template.should_receive( :contents= ).with( class_template ).
+				exactly( classes.length ).times
+			layout_template.should_receive( :pageclass= ).with( 'class-page' ).
+				exactly( classes.length ).times
+			layout_template.should_receive( :rel_prefix= ).with( Pathname('.') ).
+				exactly( classes.length ).times
+
+			layout_template.should_receive( :render ).
+				and_return( *classes.map {|k| "#{k.name} class page!"} )
+
+			@generator.generate_class_files
+		end
+
+
+		it "combines a file template with the layout template to make file pages" do
+			files = @store.all_files
+
+			layout_template = get_fixtured_layout_template_mock()
+
+			file_template = mock( "file template" )
+			Inversion::Template.stub( :load ).with( 'file.tmpl', encoding: 'utf-8' ).
+				and_return( file_template )
+			file_template.should_receive( :dup ).and_return( file_template )
+			file_template.should_receive( :header= ).
+				with( %{<h1 id="label-Testing+README">Testing <a href="README_md} +
+				      %{.html">README</a><span><a href="#label-Testing+README">} +
+				      %{&para;</a> <a href="#documentation">&uarr;</a></span></h1>} )
+			file_template.should_receive( :description= ).
+				with( %{\n<p>This is a readme for testing.</p>\n\n<p>It has some more} +
+				      %{ stuff</p>\n\n<p>And even more stuff.</p>\n} )
+
+			file_template.should_receive( :file= ).with( @readme )
+
+			layout_template.should_receive( :contents= ).with( file_template ).once
+			layout_template.should_receive( :pageclass= ).with( 'file-page' )
+			layout_template.should_receive( :rel_prefix= ).with( Pathname('.') )
+			layout_template.should_receive( :render ).and_return( "README file page!" )
+
+			@generator.generate_file_files
+		end
+
+	end
+
+
+
+	#
+	# Helpers
+	#
+
+	def any_method( name, comment=nil )
+		return RDoc::AnyMethod.new( comment, name )
+	end
+
+
+	def add_code_objects( store )
+		top_level = store.add_file( 'file.rb' )
+		top_level.parser = RDoc::Parser::Ruby
+
+		# Klass
+		klass = top_level.add_class( RDoc::NormalClass, 'Klass' )
+
+		# Klass::A
+		alias_constant = RDoc::Constant.new( 'A', nil, '' )
+		alias_constant.record_location( top_level )
+		top_level.add_constant( alias_constant )
+
+		# ::A = ::Klass (?)
+		klass.add_module_alias( klass, 'A', top_level )
+
+		# Klass#method
+		meth = RDoc::AnyMethod.new( nil, 'method' )
+		klass.add_method( meth )
+
+		# Klass#method!
+		meth_bang = RDoc::AnyMethod.new( nil, 'method!' )
+		klass.add_method( meth_bang )
+
+		# attr_accessor :name
+		name_attr = RDoc::Attr.new( nil, 'name', 'RW', '' )
+		klass.add_attribute( name_attr )
+
+		# Ignored class ::Ignored
+		ignored = top_level.add_class( RDoc::NormalClass, 'Ignored' )
+		ignored.ignore
+
+		readme = store.add_file( 'README.md' )
+		readme.parser = RDoc::Parser::Markdown
+		readme.comment = "= Testing README\n\nThis is a readme for testing.\n\n" +
+			"It has some more stuff\n\nAnd even more stuff.\n\n"
+
+		store.complete :private
+
+		return top_level, readme
+	end
+
+
+	def get_fixtured_layout_template_mock
+		layout_template = mock( "layout template" )
+		Inversion::Template.stub( :load ).with( 'layout.tmpl', encoding: 'utf-8' ).
+			and_return( layout_template )
+
+		# Work around caching
+		layout_template.should_receive( :dup ).and_return( layout_template )
+
+		layout_template.should_receive( :files= ).with( [@readme, @top_level] )
+		layout_template.should_receive( :classes= ).
+			with( @store.all_classes_and_modules.sort )
+		layout_template.should_receive( :methods= ).
+			with( @store.all_classes_and_modules.flat_map(&:method_list).sort )
+		layout_template.should_receive( :modsort= ).with do |sorted_mods|
+			sorted_mods.should include( @store.find_class_named('Klass') )
+		end
+		layout_template.should_receive( :rdoc_options= ).with( @options )
+		layout_template.should_receive( :rdoc_version= ).with( RDoc::VERSION )
+		layout_template.should_receive( :fivefish_version= ).with( Fivefish.version_string )
+
+		return layout_template
+	end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-generator-fivefish
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.87
+  version: 0.1.0
 platform: ruby
 authors:
 - Michael Granger
@@ -30,7 +30,7 @@ cert_chain:
   6mKCwjpegytE0oifXfF8k75A9105cBnNiMZOe1tXiqYc/exCgWvbggurzDOcRkZu
   /YSusaiDXHKU2O3Akc3htA==
   -----END CERTIFICATE-----
-date: 2013-03-25 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inversion
@@ -213,6 +213,9 @@ files:
 - lib/fivefish.rb
 - lib/rdoc/discover.rb
 - lib/rdoc/generator/fivefish.rb
+- spec/fivefish_spec.rb
+- spec/helpers.rb
+- spec/rdoc/generator/fivefish_spec.rb
 - .gemtest
 homepage: http://deveiate.org/fivefish.html
 licenses: