sparql-doc 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9846edfd5ef98f3ae56e4767dfbe8058b46eab735c0cd149dbf2539a6b1234a8
+  data.tar.gz: d4c30f68264419a9d813688832e5293fe6439d47cbbaaa841096d77df91d25de
+SHA512:
+  metadata.gz: d09bea2e0730f3e136f0a3b36657844351c6c04fd7c76f8498a4c15616e8ce43329c891ef44d31a134d79c19bacd8ece8475db811b672b3579c832f754043524
+  data.tar.gz: 0e0239d5a8c85694db39de8768dd0ab6cb52104dfb33fba3f12c62e972859c5c53f8c7ea2547cf02973a8f356d1e503ae30b87af4f7c9a56128ec1614656aa7f

data/README.md

@@ -1,21 +1,21 @@
 # Generate HTML documentation from SPARQL queries
 
-`sparql-doc` provides a simple tool for generating browsable HTML documentation 
+`sparql-doc` provides a simple tool for generating browsable HTML documentation
 from SPARQL queries.
 
-This is particularly useful when preparing training materials or resources to 
+This is particularly useful when preparing training materials or resources to
 help developers to use a particular dataset or SPARQL endpoint.
 
 ## Documenting SPARQL queries
 
-`sparql-doc` supports markup for documenting sparql queries, as well as a 
+`sparql-doc` supports markup for documenting sparql queries, as well as a
 package metadata for a collection of queries.
 
 These features are described in the next sections.
 
 ### SPARQL Documentation Extensions
 
-`sparql-doc` processes your SPARQL queries and looks for comments. Like Javadoc, rdoc and 
+`sparql-doc` processes your SPARQL queries and looks for comments. Like Javadoc, rdoc and
 similar tools, the content of the comments are used to provide metadata
 
 All simple documentation lines at the start of a query will be treated as its description. E.g:
@@ -23,7 +23,7 @@ All simple documentation lines at the start of a query will be treated as its de
 	#This is a description
 	#of my query. It has multiple
 	#lines
-	DESCRIBE ?x 
+	DESCRIBE ?x
 
 Special tag can be used to specify other metadata, such as the title of a query:
 
@@ -31,7 +31,7 @@ Special tag can be used to specify other metadata, such as the title of a query:
 	#of my query. It has multiple
 	#lines
 	# @title My Query Title
-	DESCRIBE ?x 
+	DESCRIBE ?x
 
 The full list of supported tags is:
 
@@ -52,14 +52,14 @@ Here's an example that uses all these:
 	# @see http://www.isbn.org/
 	# @tag book
 	# @tag isbn
-	# @endpoint http://bnb.data.bl.uk/sparql 
-	PREFIX bibo: <http://purl.org/ontology/bibo/> 
+	# @endpoint http://bnb.data.bl.uk/sparql
+	PREFIX bibo: <http://purl.org/ontology/bibo/>
 	DESCRIBE ?uri WHERE {
 	  ?uri bibo:isbn10 "0261102214".
 	}
 
-The query description can be written in [Markdown](http://daringfireball.net/projects/markdown/). So 
-you can include embedded markup, e.g. links, that help to further document a query. 
+The query description can be written in [Markdown](http://daringfireball.net/projects/markdown/). So
+you can include embedded markup, e.g. links, that help to further document a query.
 For example:
 
 	#This query illustrates how to describe a resource which is identified
@@ -68,40 +68,40 @@ For example:
 	# @author Leigh Dodds
 	# @tag book
 	# @tag isbn
-	# @endpoint http://bnb.data.bl.uk/sparql 
-	PREFIX bibo: <http://purl.org/ontology/bibo/> 
+	# @endpoint http://bnb.data.bl.uk/sparql
+	PREFIX bibo: <http://purl.org/ontology/bibo/>
 	DESCRIBE ?uri WHERE {
 	  ?uri bibo:isbn10 "0261102214".
 	}
 
 ### Overview Documentation
 
-When processing a directory of queries, `sparql-doc` will automatically look for a file called 
-`overview.md`. If found, this file will be automatically parsed as Markdown and its contents included 
+When processing a directory of queries, `sparql-doc` will automatically look for a file called
+`overview.md`. If found, this file will be automatically parsed as Markdown and its contents included
 in an Overview section on the homepage of the documentation.
 
-While the `description` in the `package.json` file is intended to provide a one line summary of the 
-package, the `overview.md` file is intended to provide a more detailed introduction. Both are optional, 
+While the `description` in the `package.json` file is intended to provide a one line summary of the
+package, the `overview.md` file is intended to provide a more detailed introduction. Both are optional,
 so authors can choose which approach they prefer.
 
 ### Package Metadata
 
-`sparql-doc` considers a directory of SPARQL queries to be a _package_. Metadata that describes a package 
-and how its documentation should be generated is provided by a valid JSON file called `package.json` which 
+`sparql-doc` considers a directory of SPARQL queries to be a _package_. Metadata that describes a package
+and how its documentation should be generated is provided by a valid JSON file called `package.json` which
 is found in the same directory.
 
-The following example of a package.json file shows how to provide a title and a short description 
+The following example of a package.json file shows how to provide a title and a short description
 of a package of files. The title and description will automatically be injected into the documentation.
 
 	{
 	 "title": "BNB SPARQL Queries",
 	 "description": "A collection of SPARQL queries for the British National Bibliography"
-	}	 
+	}
 
-It is common for a collection of queries to be written by the same person, be tagged in the same 
-way, or be useful against the same collection of endpoints. Rather than repeatedly apply the 
-`@author`, `@tag` and `@endpoint` annotations to all queries in a package, default values can be 
-specified in the `package.json` file. 
+It is common for a collection of queries to be written by the same person, be tagged in the same
+way, or be useful against the same collection of endpoints. Rather than repeatedly apply the
+`@author`, `@tag` and `@endpoint` annotations to all queries in a package, default values can be
+specified in the `package.json` file.
 
 The following example shows how to do this:
 
@@ -112,20 +112,20 @@ The following example shows how to do this:
 	 "endpoint": ["http://bnb.data.bl.uk/sparql"]
 	}
 
-Note that because `@author`, `@tag` and `@endpoint` are all multi-valued annotations, their values 
+Note that because `@author`, `@tag` and `@endpoint` are all multi-valued annotations, their values
 must be specified as a JSON array.
 
-The `package.json` file can also be used to indicate that extra files in the query directory should be 
+The `package.json` file can also be used to indicate that extra files in the query directory should be
 processed and included in the documentation. E.g.:
 
 	{
 	 "title": "BNB SPARQL Queries",
 	 "description": "A collection of SPARQL queries for the British National Bibliography"
 	 "extra-files": ["more-info.md"]
-	}	 
+	}
 
-This will trigger `sparql-doc` to process the `more-info.md` file as Markdown, converting it to 
-`more-info.html` which is added to the output directory. A link to `more-info` will be automatically 
+This will trigger `sparql-doc` to process the `more-info.md` file as Markdown, converting it to
+`more-info.html` which is added to the output directory. A link to `more-info` will be automatically
 added to the header navigation
 
 ## Example
@@ -142,23 +142,22 @@ Here's [the example output](http://ldodds.github.com/sparql-doc/) using the exam
 
 You'll need to make sure you have the following installed:
 
-* Ruby 1.9.3
+* Ruby 2.5.0+
 * RubyGems
+* Bundler
 * Rake
 
-The code uses two gems which you'll need to have installed: JSON and [Redcarpet](https://github.com/vmg/redcarpet):
-
-	[sudo] gem install json redcarpet
-
-Once you have those installed, clone the repository and run the provided rake targets to build and install the gem 
+Once you have those installed, clone the repository and run the provided rake targets to build and install the gem
 locally:
 
 	git clone https://github.com/ldodds/sparql-doc.git
 	cd sparql-doc
-	rake package
-	rake install
-	
-Once installed you should have a `sparql-doc` command-line tool.
+
+The code uses two gems which you'll need to have installed: JSON and [Redcarpet](https://github.com/vmg/redcarpet):
+
+	bundle install
+
+Once installed you should be able to run the `bin/sparql-doc` command-line tool.
 
 ## Usage
 
@@ -168,12 +167,12 @@ This takes two parameters:
 
 * The input directory. The tool will process all `.rq` files in that directory
 * The output directory. All HTML output and required assets will be placed here
-	
+
 E.g. you can run:
 
 	sparql-doc examples/bnb /your/output/directory
-	
-This will generate documentation from the bundled examples and place it into the specified 
+
+This will generate documentation from the bundled examples and place it into the specified
 directory.
 
 Later versions will support additional command-line options

data/Rakefile

@@ -3,7 +3,7 @@ require 'rdoc/task'
 require 'rake/testtask'
 require 'rake/clean'
 
-CLEAN.include ['*.gem', 'pkg']  
+CLEAN.include ['*.gem', 'pkg']
 
 $spec = eval(File.read('sparql-doc.gemspec'))
 
@@ -11,19 +11,19 @@ Rake::RDocTask.new do |rdoc|
     rdoc.rdoc_dir = 'doc/rdoc'
     rdoc.options += RDOC_OPTS
     rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
-    rdoc.main = "README.md"    
+    rdoc.main = "README.md"
 end
 
 Rake::TestTask.new do |test|
   test.test_files = FileList['tests/tc_*.rb']
 end
-  
+
 task :package do
-  sh %{gem build sparql-doc.gemspec}  
+  sh %{gem build sparql-doc.gemspec}
 end
 
 task :install do
-  sh %{sudo gem install --no-ri --no-rdoc sparql-doc-#{$spec.version}.gem}
+  sh %{sudo gem install --no-document sparql-doc-#{$spec.version}.gem}
 end
 
 desc "Uninstall the gem"

data/lib/sparql-doc/generator.rb

@@ -1,30 +1,30 @@
 module SparqlDoc
-  
+
   class Generator
-    
+
     attr_reader :dir, :graph, :queries, :package
-        
+
     def initialize(dir, output_dir, view_dir=nil, asset_dir=nil)
       @dir = dir
-      @output_dir = output_dir                  
-      @asset_dir = asset_dir || File.join( File.dirname( __FILE__ ) , "assets")     
+      @output_dir = output_dir
+      @asset_dir = asset_dir || File.join( File.dirname( __FILE__ ) , "assets")
       @view_dir = view_dir || File.join( File.dirname( __FILE__ ) , "views")
       @package = parse_package()
-      @queries = parse_queries()                      
+      @queries = parse_queries()
     end
 
     def read_template(name)
       File.read(File.join(@view_dir, "#{name}.erb"))
     end
-        
+
     def parse_package()
       package = File.join(@dir, "package.json")
       if File.exists?(package)
-        return JSON.load( File.open(package) )        
+        return JSON.load( File.open(package) )
       end
       Hash.new
     end
-    
+
     def parse_queries()
       queries = []
       Dir.glob("#{@dir}/*.rq") do |file|
@@ -32,17 +32,17 @@ module SparqlDoc
         path = file.gsub("#{@dir}/", "")
         queries << SparqlDoc::Query.new(path, content, @package)
       end
-      queries.sort! {|x,y| x.title <=> y.title }      
+      queries.sort! {|x,y| x.title <=> y.title }
       queries
     end
-    
+
     def run()
       copy_assets()
       generate_index()
       generate_query_pages()
       copy_extra_files()
     end
-  
+
     def copy_assets(asset_dir=@asset_dir)
       $stderr.puts("Copying assets");
       if !File.exists?(@output_dir)
@@ -50,17 +50,17 @@ module SparqlDoc
       end
       Dir.new(asset_dir).each() do |file|
         if file != "." and file != ".."
-          FileUtils.cp( File.join(asset_dir, file), 
+          FileUtils.cp( File.join(asset_dir, file),
             File.join(@output_dir, file) )
         end
       end
     end
-      
+
     def copy_extra_files()
       @package["extra-files"].each do |file|
         markup = File.read( File.join(@dir, file) )
         renderer = Redcarpet::Render::HTML.new({})
-        markdown = Redcarpet::Markdown.new(renderer, {})      
+        markdown = Redcarpet::Markdown.new(renderer, {})
         html = layout do
           markdown.render(markup)
         end
@@ -70,23 +70,23 @@ module SparqlDoc
         end
       end if @package["extra-files"]
     end
-    
+
     def get_overview()
       overview = File.join(@dir, "overview.md")
       if File.exists?( overview )
         markup = File.read( overview )
         renderer = Redcarpet::Render::HTML.new({})
         markdown = Redcarpet::Markdown.new(renderer, {})
-        return markdown.render(markup)        
-      end      
+        return markdown.render(markup)
+      end
       nil
     end
-    
+
     def generate_index()
       $stderr.puts("Generating index.html");
-      title = @package["title"] || "Sparql Query Documentation"
-      overview = get_overview()
-      description = @package["description"] || ""
+      _title = @package["title"] || "Sparql Query Documentation"
+      _overview = get_overview()
+      _description = @package["description"] || ""
       template = ERB.new( read_template(:index) )
       html = layout do
         b = binding
@@ -96,29 +96,29 @@ module SparqlDoc
         f.puts(html)
       end
     end
-    
+
     def layout
-      b = binding      
-      title = @package["title"] || "Sparql Query Documentation"
-      overview = get_overview()
+      b = binding
+      _title = @package["title"] || "Sparql Query Documentation"
+      _overview = get_overview()
       ERB.new( read_template(:layout) ).result(b)
     end
-    
+
     def generate_query_pages()
       template = ERB.new( read_template(:query) )
       @queries.each do |query|
         $stderr.puts("Generating docs for #{query.path}")
         File.open( File.join(@output_dir, query.output_filename), "w" ) do |f|
-          b = binding                          
-          title = @package["title"] || "Sparql Query Documentation"
-          overview = get_overview()       
+          b = binding
+          _title = @package["title"] || "Sparql Query Documentation"
+          _overview = get_overview()
           html = layout do
             template.result(b)
-          end               
+          end
           f.puts( html )
-        end        
-      end     
+        end
+      end
     end
-  
+
   end
-end  
+end

data/lib/sparql-doc/query.rb

@@ -1,22 +1,22 @@
 module SparqlDoc
 
-  #Wrapper for SPARQL query  
+  #Wrapper for SPARQL query
   class Query
-    
+
     attr_reader :path, :query, :raw_query, :prefixes, :type, :package
 
     ANNOTATIONS = {
       :author => {
-        :multi => true 
+        :multi => true
       },
       :see => {
-        :multi => true 
-      },  
+        :multi => true
+      },
       :tag => {
-        :multi => true 
-      },  
+        :multi => true
+      },
       :title => {
-        :multi => false 
+        :multi => false
       },
       :endpoint => {
         :multi => true
@@ -25,11 +25,11 @@ module SparqlDoc
         :multi => true
       }
     }
-        
+
     ANNOTATIONS.each do |var, config|
       attr_reader(var)
     end
-    
+
     def initialize(path, query, package={})
       ANNOTATIONS.each do |var, config|
         if config[:multi]
@@ -40,23 +40,23 @@ module SparqlDoc
       end
       @path = path
       @query = query
-      @raw_query = query      
+      @raw_query = query
       @title = @path
       @description = ""
       @prefixes = {}
-        
+
       ["endpoint", "author", "tag"].each do |annotation|
         if package[annotation]
           instance_variable_set( "@#{annotation}", package[annotation])
         end
-      end  
+      end
       parseQuery()
     end
-    
+
     def output_filename
       return "#{path.gsub(".rq", "")}.html"
     end
-    
+
     def description(html=false)
       if html
         renderer = Redcarpet::Render::HTML.new({})
@@ -65,45 +65,45 @@ module SparqlDoc
       end
       @description
     end
-    
+
     def query_string
       CGI::escape( @query )
     end
-    
+
     private
-    
-      def parseQuery
-        query_lines = []
-        header = true
-        description = false 
-        description_lines = []
-        @raw_query.split("\n").each do |line|
-          if ( header && line.match(/^#/) )
-            if ( matches = line.match(/^# *@([a-zA-Z]+) *(.+)$/i) )
-              annotation = matches[1]
-              config = ANNOTATIONS[ annotation.intern ] 
-              if config
-                if config[:multi]
-                  val = instance_variable_get("@#{annotation}")
-                  val << matches[2].strip
-                else
-                  instance_variable_set("@#{annotation}", matches[2].strip)
-                end                
-                description = true
+
+    def parseQuery
+      query_lines = []
+      header = true
+      description = false
+      description_lines = []
+      @raw_query.split("\n").each do |line|
+        if ( header && line.match(/^#/) )
+          if ( matches = line.match(/^# *@([a-zA-Z]+) *(.+)$/i) )
+            annotation = matches[1]
+            config = ANNOTATIONS[ annotation.intern ]
+            if config
+              if config[:multi]
+                val = instance_variable_get("@#{annotation}")
+                val << matches[2].strip
               else
-                $stderr.puts("Ignoring unknown annotation: @#{annotation}")
+                instance_variable_set("@#{annotation}", matches[2].strip)
               end
-            else if (description == false) 
-              description_lines << line[1..-1].strip
+              description = true
+            else
+              $stderr.puts("Ignoring unknown annotation: @#{annotation}")
             end
-          end
           else
-            header = false
-            query_lines << line  
+            if (description == false)
+              description_lines << line[1..-1].strip
+            end
           end
+        else
+          header = false
+          query_lines << line
         end
         @description = description_lines.join("\n") unless description_lines.empty?
-        @query = query_lines.join("\n") unless query_lines.empty?    
+        @query = query_lines.join("\n") unless query_lines.empty?
         @query.strip!
         query_lines.each do |line|
           if (matches = line.match(/^ *PREFIX *([a-zA-Z_-]+) *: *<(.+)>$/i) )
@@ -112,7 +112,9 @@ module SparqlDoc
           if (matches = line.match(/^ *(SELECT|CONSTRUCT|DESCRIBE|ASK) */i) )
             @type = matches[1].upcase
           end
-        end              
+        end
       end
+    end
   end
-end
+
+end

data/lib/sparql-doc/views/index.erb

@@ -1,23 +1,23 @@
 <div class="container">
       <div class="hero-unit">
-        	<h1><%= title %></h1>
+        	<h1><%= _title %></h1>
       </div>
 
       <div class="row">
         <div class="span12">
-          <p><%= description %></p>
+          <p><%= _description %></p>
         </div>
       </div>
 
-	  <% if overview %>
+	  <% if _overview %>
       	<div class="row">
         	<div class="span12">
         		<h3 id="overview">Overview</h3>
-          		<%= overview %>
+          		<%= _overview %>
         	</div>
       	</div>
-	  <% end %>      	
-      
+	  <% end %>
+
       <div class="row">
         <div class="span12">
           <h3>Queries</h3>
@@ -34,7 +34,7 @@
            		  <td><a href="<%= query.output_filename %>"><%= query.title %></a></td><td><code><%= query.path %></code></td>
            		</tr>
            		<% end %>
-			</tbody>           		
+			</tbody>
           </table>
         </div>
       </div>

data/lib/sparql-doc/views/layout.erb

@@ -1,7 +1,7 @@
 <html>
   <head>
     <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-    <title><%= title %></title>
+    <title><%= _title %></title>
     <link href="bootstrap.min.css" rel="stylesheet">
     <link rel="stylesheet" href="codemirror.css">
     <style type="text/css">
@@ -12,23 +12,23 @@
       .sidebar-nav {
         padding: 9px 0;
       }
-    </style>    
-	<script src="jquery.js"></script> 		
+    </style>
+	<script src="jquery.js"></script>
 	<script src="bootstrap.min.js"></script>
-	
-	<script src="codemirror.js" type="text/javascript"></script> 		 				
-	<script src="sparql.js"></script>    
+
+	<script src="codemirror.js" type="text/javascript"></script>
+	<script src="sparql.js"></script>
   </head>
   <body>
-  
+
     <div class="navbar navbar-inverse navbar-fixed-top">
       <div class="navbar-inner">
         <div class="container-fluid">
-          <a class="brand" href="index.html"><%= title %></a>
+          <a class="brand" href="index.html"><%= _title %></a>
           <ul class="nav">
-          	<% if overview %>
+          	<% if _overview %>
 		  		<li><a href="index.html#overview">Overview</a></li>
-		  	<% end %>		  	
+		  	<% end %>
 		  	<% if @package["extra-files"] %>
 		  	  <% @package["extra-files"].each do |file| %>
 		  	    <li><a href="<%= file.gsub(".md", ".html") %>">
@@ -40,9 +40,7 @@
         </div>
       </div>
     </div>
-    
+
    <%= yield %>
-  </body>	
+  </body>
 </html>
-    
-   

data/tests/tc_query.rb

@@ -3,8 +3,8 @@ require 'sparql-doc'
 require 'test/unit'
 
 class QueryTest < Test::Unit::TestCase
-  
-  def test_basic    
+
+  def test_basic
     query = SparqlDoc::Query.new("/path/to/query.rq", "DESCRIBE ?x")
     assert_equal("/path/to/query.rq", query.title)
     assert_equal("", query.description)
@@ -14,19 +14,19 @@ class QueryTest < Test::Unit::TestCase
     assert_equal([], query.author)
     assert_equal([], query.endpoint)
     assert_equal([], query.param)
-    assert_equal("DESCRIBE ?x", query.query)  
+    assert_equal("DESCRIBE ?x", query.query)
     assert_equal("DESCRIBE ?x", query.raw_query)
     assert_equal("DESCRIBE+%3Fx", query.query_string)
     assert_equal("DESCRIBE", query.type)
   end
 
-  def test_type    
+  def test_type
     query = SparqlDoc::Query.new("/path/to/query.rq", "describe ?x")
     assert_equal("DESCRIBE", query.type)
-  end    
-  
+  end
+
   def test_prefixes
-    sparql=<<-EOL     
+    sparql=<<-EOL
 #Description
 PREFIX foaf: <http://xmlns.com/foaf/0.1/>
 prefix foo: <http://example.org/foo>
@@ -35,28 +35,28 @@ prefix   baz  : <http://example.org/baz#>
 DESCRIBE ?x
 EOL
     query = SparqlDoc::Query.new("/path/to/query.rq", sparql)
-    assert_equal("DESCRIBE", query.type)    
+    assert_equal("DESCRIBE", query.type)
     assert_equal( 4, query.prefixes.size )
     assert_equal( "http://xmlns.com/foaf/0.1/", query.prefixes["foaf"] )
     assert_equal( "http://example.org/foo", query.prefixes["foo"] )
     assert_equal( "http://example.org/bar", query.prefixes["bar"] )
     assert_equal( "http://example.org/baz#", query.prefixes["baz"] )
   end
-  
-  def test_description    
-    sparql=<<-EOL     
+
+  def test_description
+    sparql=<<-EOL
 #Description
 DESCRIBE ?x
 EOL
     query = SparqlDoc::Query.new("/path/to/query.rq", sparql)
     assert_equal("/path/to/query.rq", query.title)
     assert_equal("Description", query.description)
-    assert_equal("DESCRIBE ?x", query.query)  
-    assert_equal("#Description\nDESCRIBE ?x\n", query.raw_query)
+    assert_equal("DESCRIBE ?x", query.query)
+    assert_equal("#Description\nDESCRIBE ?x", query.raw_query)
   end
-  
-  def test_description    
-    sparql=<<-EOL     
+
+  def test_description_multiple_lines
+    sparql=<<-EOL
 #Description
 #Over multiple
 #...lines
@@ -65,73 +65,73 @@ EOL
     query = SparqlDoc::Query.new("/path/to/query.rq", sparql)
     assert_equal("/path/to/query.rq", query.title)
     assert_equal("Description\nOver multiple\n...lines", query.description)
-    assert_equal("DESCRIBE ?x", query.query)  
-    assert_equal("#Description\n#Over multiple\n#...lines\nDESCRIBE ?x\n", query.raw_query)
-  end  
-  
-  def test_title    
-    sparql=<<-EOL     
+    assert_equal("DESCRIBE ?x", query.query)
+    assert_equal("#Description\n#Over multiple\n#...lines\nDESCRIBE ?x", query.raw_query)
+  end
+
+  def test_title
+    sparql=<<-EOL
 #Description
-# @title My Query    
+# @title My Query
 DESCRIBE ?x
 EOL
     query = SparqlDoc::Query.new("/path/to/query.rq", sparql)
     assert_equal("My Query", query.title)
     assert_equal("Description", query.description)
-    assert_equal("DESCRIBE ?x", query.query)  
+    assert_equal("DESCRIBE ?x", query.query)
   end
-  
+
   def test_all
-    sparql=<<-EOL     
+    sparql=<<-EOL
 #Description
-# @title My Query   
+# @title My Query
 # @author leigh@ldodds.com
 # @tag demo
 # @tag test
-# @see http://github.com/ldodds/sparql-doc                     
+# @see http://github.com/ldodds/sparql-doc
 DESCRIBE ?x
 EOL
     query = SparqlDoc::Query.new("/path/to/query.rq", sparql)
     assert_equal("My Query", query.title)
     assert_equal("Description", query.description)
-    assert_equal("DESCRIBE ?x", query.query)  
+    assert_equal("DESCRIBE ?x", query.query)
     assert_equal(["leigh@ldodds.com"], query.author)
     assert_equal(["http://github.com/ldodds/sparql-doc"], query.see)
-    assert_equal(["demo", "test"], query.tag)            
-  end  
+    assert_equal(["demo", "test"], query.tag)
+  end
 
-  def test_markdown    
-    sparql=<<-EOL     
+  def test_markdown
+    sparql=<<-EOL
 #Description
 DESCRIBE ?x
 EOL
     query = SparqlDoc::Query.new("/path/to/query.rq", sparql)
-    assert_equal("<p>Description<p>", query.description(true))
-    assert_equal("DESCRIBE ?x", query.query)  
-  end  
-  
-  def test_markdown    
-    sparql=<<-EOL     
+    assert_equal("<p>Description</p>\n", query.description(true))
+    assert_equal("DESCRIBE ?x", query.query)
+  end
+
+  def test_markdown_more
+    sparql=<<-EOL
 #See [my website](http://example.org)
 DESCRIBE ?x
 EOL
     query = SparqlDoc::Query.new("/path/to/query.rq", sparql)
     assert_equal("<p>See <a href=\"http://example.org\">my website</a></p>\n", query.description(true))
-    assert_equal("DESCRIBE ?x", query.query)  
-  end    
+    assert_equal("DESCRIBE ?x", query.query)
+  end
 
   def test_provide_default_authors
     query = SparqlDoc::Query.new("/path/to/query.rq", "DESCRIBE ?x", {"author" => ["Leigh Dodds"]})
-    assert_equal(["Leigh Dodds"], query.author)          
-  end    
+    assert_equal(["Leigh Dodds"], query.author)
+  end
 
   def test_provide_default_endpoint
     query = SparqlDoc::Query.new("/path/to/query.rq", "DESCRIBE ?x", {"endpoint" => ["http://example.org"]})
-    assert_equal(["http://example.org"], query.endpoint)          
-  end    
+    assert_equal(["http://example.org"], query.endpoint)
+  end
 
   def test_provide_default_tag
     query = SparqlDoc::Query.new("/path/to/query.rq", "DESCRIBE ?x", {"tag" => ["foo"]})
-    assert_equal(["foo"], query.tag)          
-  end    
+    assert_equal(["foo"], query.tag)
+  end
 end

metadata

@@ -1,65 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: sparql-doc
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Leigh Dodds
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.5.1
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: SPARQL documentation generator
+        version: 1.3.2
+description: Generates HTML documentation for a collection of sparql queries
 email: leigh@ldodds.com
 executables:
 - sparql-doc
@@ -70,49 +63,48 @@ files:
 - README.md
 - Rakefile
 - bin/sparql-doc
-- tests/ts_sparql_doc.rb
-- tests/tc_generator.rb
-- tests/tc_query.rb
 - lib/sparql-doc.rb
-- lib/sparql-doc/query.rb
-- lib/sparql-doc/assets/codemirror.js
-- lib/sparql-doc/assets/sparql.js
 - lib/sparql-doc/assets/bootstrap.min.css
+- lib/sparql-doc/assets/bootstrap.min.js
 - lib/sparql-doc/assets/codemirror.css
+- lib/sparql-doc/assets/codemirror.js
 - lib/sparql-doc/assets/jquery.js
-- lib/sparql-doc/assets/bootstrap.min.js
+- lib/sparql-doc/assets/sparql.js
+- lib/sparql-doc/generator.rb
+- lib/sparql-doc/query.rb
 - lib/sparql-doc/views/index.erb
 - lib/sparql-doc/views/layout.erb
 - lib/sparql-doc/views/query.erb
-- lib/sparql-doc/generator.rb
+- tests/tc_generator.rb
+- tests/tc_query.rb
+- tests/ts_sparql_doc.rb
 homepage: http://github.com/ldodds/sparql-doc
-licenses: []
+licenses:
+- CC0-1.0
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --quiet
-- --title
+- "--quiet"
+- "--title"
 - SPARQL Doc Reference
-- --main
+- "--main"
 - README
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SPARQL documentation generator
 test_files:
 - tests/ts_sparql_doc.rb