rdoc-generator-sixfish 0.5.0.pre20180710102525

data/spec/rdoc/generator/sixfish_spec.rb

@@ -0,0 +1,250 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require_relative '../../helpers'
+
+require 'tmpdir'
+require 'rspec'
+require 'rdoc/generator/sixfish'
+
+describe RDoc::Generator::Sixfish 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
+		@libdir = Pathname.pwd + 'lib'
+		@datadir = RDoc::Generator::Sixfish::DATADIR
+		@tmpdir = Pathname( Dir.tmpdir ) + "test_rdoc_generator_sixfish_#{$$}"
+		@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['SIXFISH_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['SIXFISH_DEVELMODE']
+	end
+
+
+	#
+	# Examples
+	#
+
+	it "registers itself as a generator" do
+		expect( RDoc::RDoc::GENERATORS ).to include( 'sixfish' => described_class )
+	end
+
+
+	it "configures Inversion to load templates from its data directory" do
+		expect( Inversion::Template.template_paths ).to eq( [@datadir + 'templates'] )
+	end
+
+
+	describe "additional-stylesheet option" do
+
+		it "is added to the options by the setup_options callback" do
+			@options.setup_generator( 'sixfish' )
+			expect( @options.option_parser.to_a.join ).to 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 = double( "index template" )
+			expect( Inversion::Template ).to receive( :load ).
+				with( 'index.tmpl', encoding: 'utf-8' ).
+				and_return( index_template )
+
+			expect( index_template ).to receive( :dup ).and_return( index_template )
+			expect( index_template ).to receive( :mainpage= ).with( @readme )
+			expect( index_template ).to 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="#top">&uarr;</a></span></h1>} +
+				      %{<p>This is a readme for testing.</p>} )
+
+			expect( layout_template ).to receive( :contents= ).with( index_template )
+			expect( layout_template ).to receive( :pageclass= ).with( 'index-page' )
+			expect( layout_template ).to receive( :rel_prefix= ).with( Pathname('.') )
+
+			expect( layout_template ).to 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 = double( "class template" )
+			expect( Inversion::Template ).to receive( :load ).
+				with( 'class.tmpl', encoding: 'utf-8' ).
+				and_return( class_template )
+			expect( class_template ).to receive( :dup ).and_return( class_template )
+
+			classes.each do |klass|
+				expect( class_template ).to receive( :klass= ).with( klass )
+			end
+
+			expect( layout_template ).to receive( :contents= ).with( class_template ).
+				exactly( classes.length ).times
+			expect( layout_template ).to receive( :pageclass= ).with( 'class-page' ).
+				exactly( classes.length ).times
+			expect( layout_template ).to receive( :rel_prefix= ).with( Pathname('.') ).
+				exactly( classes.length ).times
+
+			expect( layout_template ).to 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 = double( "file template" )
+			expect( Inversion::Template ).to receive( :load ).
+				with( 'file.tmpl', encoding: 'utf-8' ).
+				and_return( file_template )
+			expect( file_template ).to receive( :dup ).and_return( file_template )
+			expect( file_template ).to 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="#top">&uarr;</a></span></h1>} )
+			expect( file_template ).to 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} )
+
+			expect( file_template ).to receive( :file= ).with( @readme )
+
+			expect( layout_template ).to receive( :contents= ).with( file_template ).once
+			expect( layout_template ).to receive( :pageclass= ).with( 'file-page' )
+			expect( layout_template ).to receive( :rel_prefix= ).with( Pathname('.') )
+			expect( layout_template ).to 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 = double( "layout template" )
+		expect( Inversion::Template ).to receive( :load ).
+			with( 'layout.tmpl', encoding: 'utf-8' ).
+			and_return( layout_template )
+
+		# Work around caching
+		expect( layout_template ).to receive( :dup ).and_return( layout_template )
+
+		expect( layout_template ).to receive( :files= ).with( [@readme, @top_level] )
+		expect( layout_template ).to receive( :classes= ).
+			with( @store.all_classes_and_modules.sort )
+		expect( layout_template ).to receive( :methods= ).
+			with( @store.all_classes_and_modules.flat_map(&:method_list).sort )
+		expect( layout_template ).to receive( :modsort= ) do |sorted_mods|
+			expect( sorted_mods ).to include( @store.find_class_named('Klass') )
+		end
+		expect( layout_template ).to receive( :rdoc_options= ).with( @options )
+		expect( layout_template ).to receive( :rdoc_version= ).with( RDoc::VERSION )
+		expect( layout_template ).to receive( :sixfish_version= ).with( Sixfish.version_string )
+
+		return layout_template
+	end
+
+end
+

data/spec/sixfish_spec.rb

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'helpers'
+require 'rspec'
+require 'sixfish'
+
+describe Sixfish do
+
+	describe "version methods" do
+		it "returns a version string if asked" do
+			expect( described_class.version_string ).to match( /\w+ [\d.]+/ )
+		end
+
+
+		it "returns a version string with a build number if asked" do
+			expect( described_class.version_string(true) ).
+				to match( /\w+ [\d.]+ \(build [[:xdigit:]]+\)/ )
+		end
+	end
+
+end
+

metadata

@@ -0,0 +1,265 @@
+--- !ruby/object:Gem::Specification
+name: rdoc-generator-sixfish
+version: !ruby/object:Gem::Version
+  version: 0.5.0.pre20180710102525
+platform: ruby
+authors:
+- Michael Granger
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQUFADA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  HhcNMTcwOTI3MDAzMDQ0WhcNMTgwOTI3MDAzMDQ0WjA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC/JWGRHO+USzR97vXjkFgt
+  83qeNf2KHkcvrRTSnR64i6um/ziin0I0oX23H7VYrDJC9A/uoUa5nGRJS5Zw/+wW
+  ENcvWVZS4iUzi4dsYJGY6yEOsXh2CcF46+QevV8iE+UmbkU75V7Dy1JCaUOyizEt
+  TH5UHsOtUU7k9TYARt/TgYZKuaoAMZZd5qyVqhF1vV+7/Qzmp89NGflXf2xYP26a
+  4MAX2qqKX/FKXqmFO+AGsbwYTEds1mksBF3fGsFgsQWxftG8GfZQ9+Cyu2+l1eOw
+  cZ+lPcg834G9DrqW2zhqUoLr1MTly4pqxYGb7XoDhoR7dd1kFE2a067+DzWC/ADt
+  +QkcqWUm5oh1fN0eqr7NsZlVJDulFgdiiYPQiIN7UNsii4Wc9aZqBoGcYfBeQNPZ
+  soo/6za/bWajOKUmDhpqvaiRv9EDpVLzuj53uDoukMMwxCMfgb04+ckQ0t2G7wqc
+  /D+K9JW9DDs3Yjgv9k4h7YMhW5gftosd+NkNC/+Y2CkCAwEAAaN1MHMwCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFHKN/nkRusdqCJEuq3lgB3fJvyTg
+  MBwGA1UdEQQVMBOBEWdlZEBGYWVyaWVNVUQub3JnMBwGA1UdEgQVMBOBEWdlZEBG
+  YWVyaWVNVUQub3JnMA0GCSqGSIb3DQEBBQUAA4IBgQB/qyi5pCjK8ceoKalfVAjS
+  vG64FEnLnD1bm39T5UaFIRmo+abZtfpg2QhwKvPbPjOicau2+m+MDQ2Cc3tgyaC3
+  dZxcP6w8APFg4AId09uWAZKf0xajvBMS2aOz8Bbmag6fwqRRkTMqsNYnmqcF7aRT
+  DuEzbEMfaOUYjU9RuB48vr4q8yRft0ww+3jq5iwNkrX1buL2pwBbyvgms6D/BV41
+  MaTVMjsHqJUwU2xVfhGtxGAWAer5S1HGYHkbio6mGVtiie0uWjmnzi7ppIlMr48a
+  7BNTsoZ+/JRk3iQWmmNsyFT7xfqBKye7cH11BX8V8P4MeGB5YWlMI+Myj5DZY3fQ
+  st2AGD4rb1l0ia7PfubcBThSIdz61eCb8gRi/RiZZwb3/7+eyEncLJzt2Ob9fGSF
+  X0qdrKi+2aZZ0NGuFj9AItBsVmAvkBGIpX4TEKQp5haEbPpmaqO5nIIhV26PXmyT
+  OMKv6pWsoS81vw5KAGBmfX8nht/Py90DQrbRvakATGI=
+  -----END CERTIFICATE-----
+date: 2018-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inversion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: loggability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: hoe-deveiate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: hoe-mercurial
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: hoe-highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: |-
+  A(nother) HTML(5) generator for RDoc.
+
+  It uses the {Skeleton Responsive CSS Boilerplate}[http://getskeleton.com/] for
+  the layout stuff, doesn't take up valuable horizontal real estate space with
+  indexes and stuff, and has a QuickSilver-like incremental searching.
+email:
+- ged@FaerieMUD.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.md
+- Manifest.txt
+- README.md
+files:
+- ".editorconfig"
+- ".ruby-gemset"
+- ".ruby-version"
+- ChangeLog
+- History.md
+- Manifest.txt
+- README.md
+- data/rdoc-generator-sixfish/css/sixfish.css
+- data/rdoc-generator-sixfish/css/sixfish.css.map
+- data/rdoc-generator-sixfish/fa/light.js
+- data/rdoc-generator-sixfish/fa/light.svg
+- data/rdoc-generator-sixfish/fa/loader.js
+- data/rdoc-generator-sixfish/fa/regular.js
+- data/rdoc-generator-sixfish/fa/regular.svg
+- data/rdoc-generator-sixfish/fa/solid.js
+- data/rdoc-generator-sixfish/fa/solid.svg
+- data/rdoc-generator-sixfish/images/glyphicons-28-search.png
+- data/rdoc-generator-sixfish/js/jquery-3.1.1.js
+- data/rdoc-generator-sixfish/js/sixfish.min.js
+- data/rdoc-generator-sixfish/templates/class.tmpl
+- data/rdoc-generator-sixfish/templates/file.tmpl
+- data/rdoc-generator-sixfish/templates/index.tmpl
+- data/rdoc-generator-sixfish/templates/layout.tmpl
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/sixfish.rb
+- lib/sixfish.rb
+- spec/helpers.rb
+- spec/rdoc/generator/sixfish_spec.rb
+- spec/sixfish_spec.rb
+homepage: https://bitbucket.org/ged/rdoc-generator-sixfish
+licenses:
+- BSD-3-Clause
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A(nother) HTML(5) generator for RDoc
+test_files: []