rdoc-generator-sixfish 0.1.0

data/spec/rdoc/generator/sixfish_spec.rb

@@ -0,0 +1,256 @@
+# -*- 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 "uses the index template to make the index page" do
+			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( :files= ).with( [@top_level] ).once
+			expect( index_template ).to receive( :classes= ).
+				with( @store.all_classes_and_modules.sort )
+			expect( index_template ).to receive( :methods= ).
+				with( @store.all_classes_and_modules.flat_map(&:method_list).sort )
+			expect( index_template ).to receive( :modsort= ) do |sorted_mods|
+				expect( sorted_mods ).to include( @store.find_class_named('Klass') )
+			end
+			expect( index_template ).to receive( :rdoc_options= ).with( @options )
+			expect( index_template ).to receive( :rdoc_version= ).with( RDoc::VERSION )
+			expect( index_template ).to receive( :sixfish_version= ).with( Sixfish.version_string )
+			expect( index_template ).to receive( :mainpage= ).with( @readme )
+			expect( index_template ).to receive( :synopsis= ).
+				with( %{<p>This is a readme for testing.</p>} )
+			expect( index_template ).to receive( :rel_prefix= ).with( Pathname('.') ).once
+			expect( index_template ).to receive( :pageclass= ).with( 'index-page' )
+
+			expect( index_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></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, 'Klass', alias_constant, 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 )
+
+		allow( layout_template ).to receive( :synopsis= )
+
+		# Work around caching
+		expect( layout_template ).to receive( :dup ).and_return( layout_template )
+
+		expect( layout_template ).to receive( :files= ).with( [@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( :mainpage= ).with( @readme )
+		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,19 @@
+# -*- 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
+
+	end
+
+end
+

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: rdoc-generator-sixfish
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Granger
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIID+DCCAmCgAwIBAgIBBDANBgkqhkiG9w0BAQsFADAiMSAwHgYDVQQDDBdnZWQv
+  REM9RmFlcmllTVVEL0RDPW9yZzAeFw0yMjAxMDcyMzU4MTRaFw0yMzAxMDcyMzU4
+  MTRaMCIxIDAeBgNVBAMMF2dlZC9EQz1GYWVyaWVNVUQvREM9b3JnMIIBojANBgkq
+  hkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAvyVhkRzvlEs0fe7145BYLfN6njX9ih5H
+  L60U0p0euIurpv84op9CNKF9tx+1WKwyQvQP7qFGuZxkSUuWcP/sFhDXL1lWUuIl
+  M4uHbGCRmOshDrF4dgnBeOvkHr1fIhPlJm5FO+Vew8tSQmlDsosxLUx+VB7DrVFO
+  5PU2AEbf04GGSrmqADGWXeaslaoRdb1fu/0M5qfPTRn5V39sWD9umuDAF9qqil/x
+  Sl6phTvgBrG8GExHbNZpLARd3xrBYLEFsX7RvBn2UPfgsrtvpdXjsHGfpT3IPN+B
+  vQ66lts4alKC69TE5cuKasWBm+16A4aEe3XdZBRNmtOu/g81gvwA7fkJHKllJuaI
+  dXzdHqq+zbGZVSQ7pRYHYomD0IiDe1DbIouFnPWmagaBnGHwXkDT2bKKP+s2v21m
+  ozilJg4aar2okb/RA6VS87o+d7g6LpDDMMQjH4G9OPnJENLdhu8KnPw/ivSVvQw7
+  N2I4L/ZOIe2DIVuYH7aLHfjZDQv/mNgpAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYD
+  VR0PBAQDAgSwMB0GA1UdDgQWBBRyjf55EbrHagiRLqt5YAd3yb8k4DANBgkqhkiG
+  9w0BAQsFAAOCAYEASrm1AbEoxACZ9WXJH3R5axV3U0CA4xaETlL2YT+2nOfVBMQ9
+  0ZlkPx6j4ghKJgAIi1TMfDM2JyPJsppQh8tiNccDjWc62UZRY/dq26cMqf/lcI+a
+  6YBuEYvzZfearwVs8tHnXtwYV3WSCoCOQaB+nq2lA1O+nkKNl41WOsVbNama5jx3
+  8cQtVSEEmZy6jIDJ8c5TmBJ7BQUDEUEWA/A3V42Xyctoj7DvUXWE0lP+X6ypAVSr
+  lFh3TS64D7NTvxkmg7natUoCvobl6kGl4yMaqE4YRTlfuzhpf91TSOntClqrAOsS
+  K1s56WndQj3IoBocdY9mQhDZLtLHofSkymoP8btBlj5SsN24TiF0VMSZlctSCYZg
+  GKyHim/MMlIfGOWsgfioq5jzwmql7W4CDubbb8Lkg70v+hN2E/MnNVAcNE3gyaGc
+  P5YP5BAbNW+gvd3QHRiWTTuhgHrdDnGdXg93N2M5KHn1ug8BtPLQwlcFwEpKnlLn
+  btEP+7EplFuoiMfd
+  -----END CERTIFICATE-----
+date: 2022-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inversion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: loggability
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+- !ruby/object:Gem::Dependency
+  name: rake-deveiate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: rdoc-generator-fivefish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: A readable HTML generator for RDoc. It uses the Bulma CSS framework.
+email:
+- ged@faeriemud.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- History.md
+- README.md
+- data/rdoc-generator-sixfish/css/fa-solid-900.515704be.ttf
+- data/rdoc-generator-sixfish/css/fa-solid-900.7ba04835.svg
+- data/rdoc-generator-sixfish/css/fa-solid-900.8c589fd1.eot
+- data/rdoc-generator-sixfish/css/fa-solid-900.c7b072c6.woff
+- data/rdoc-generator-sixfish/css/fa-solid-900.f2049a98.woff2
+- data/rdoc-generator-sixfish/css/sixfish.css
+- data/rdoc-generator-sixfish/css/sixfish.css.map
+- data/rdoc-generator-sixfish/js/sixfish.js
+- data/rdoc-generator-sixfish/js/sixfish.js.map
+- 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/inversion/template/striptag.rb
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/sixfish.rb
+- lib/sixfish.rb
+- lib/sixfish/patches.rb
+- spec/helpers.rb
+- spec/rdoc/generator/sixfish_spec.rb
+- spec/sixfish_spec.rb
+homepage: https://hg.sr.ht/~ged/Sixfish
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://hg.sr.ht/~ged/Sixfish
+  documentation_uri: https://deveiate.org/code/sixfish
+  source_uri: https://hg.sr.ht/~ged/Sixfish
+  bug_tracker_uri: https://todo.sr.ht/~ged/Sixfish
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A readable HTML generator for RDoc.
+test_files: []