RubyGems - sdoc - Versions diffs - 1.0.0.rc1 → 1.0.0.rc2 - Mend

sdoc 1.0.0.rc1 → 1.0.0.rc2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

checksums.yaml +4 -4
data/.travis.yml +4 -1
data/LICENSE +2 -1
data/lib/rdoc/discover.rb +1 -1
data/lib/rdoc/generator/template/merge/index.rhtml +3 -5
data/lib/rdoc/generator/template/sdoc/resources/panel/index.html +2 -6
data/lib/sdoc/generator.rb +49 -135
data/lib/sdoc/version.rb +1 -1
data/sdoc.gemspec +1 -1
data/spec/rdoc_generator_spec.rb +0 -22
data/spec/spec_helper.rb +0 -3
metadata +7 -7

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79aa2679a85d70fadc495af08d22465c9d0e3f29
-  data.tar.gz: 46cff4fae2eabb253e9b1dc0126ac852b2369b1e
+  metadata.gz: fd8f108539b22e091aee84678e782138bb18aa53
+  data.tar.gz: 6155efbb4da708d34160dd72c7b3d6cc961713fc
 SHA512:
-  metadata.gz: 267aef85a4093c76084a039a2710a37e6b72bdf2652a424b4bfc2d1e36d6046a2986e90d982f5378271fe69d7342feebf8f85707262e05cfbc57e86a95ab343c
-  data.tar.gz: ef5a370a6f3b6c9d6552cd94aa5c2b84f6eaa46a1ea98bf35e92fa795bdcee439aa14fb8a13cd28e605adedd4cbe1fe324e454f04a8d6f4bb5c78a00abb1c94d
+  metadata.gz: 1f279d16a4661525a966e664a26572e787e53383c91dd050a8a24037b277fd005394c48cb0856d495a15b36928c035d50872c28909fce411440b540639c81572
+  data.tar.gz: 5ed8e231e52ac56ba9f959780cb2307637e35d85d02b193de0d369b67af50bd512d0235bc800d1037e1b7f0c84489168d5c99eb5fa24f1dfacd873affcd686da

data/.travis.yml CHANGED Viewed

@@ -1,4 +1,5 @@
----
+language: ruby
+cache: bundler
 before_install:
   - gem install bundler
 rvm:
@@ -7,12 +8,14 @@ rvm:
   - 2.1.0
   - 2.2.0
   - 2.3.0
+  - 2.4.0
   - ruby-head
   - jruby-19mode
   - jruby-head
 matrix:
   allow_failures:
     - env: rdoc=master
+    - rvm: jruby-head
   include:
     - { rvm: 1.9.3, env: rdoc=master }
     - { rvm: 2.0.0, env: rdoc=master }

data/LICENSE CHANGED Viewed

@@ -1,4 +1,5 @@
-Copyright (c) 2014 Zachary Scott, Vladimir Kolesnikov, and Nathan Broadbent
+Copyright (c) 2014 Vladimir Kolesnikov, and Nathan Broadbent
+Copyright (c) 2014-2017 Zachary Scott
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/rdoc/discover.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 begin
-  gem 'rdoc', '~> 4.0.0'
+  gem 'rdoc', '~> 5.0'
   require File.join(File.dirname(__FILE__), '/../sdoc')
 rescue Gem::LoadError
 end

data/lib/rdoc/generator/template/merge/index.rhtml CHANGED Viewed

@@ -1,9 +1,7 @@
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!DOCTYPE html>
+<html lang="en">
 <head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+  <meta charset="utf-8">
   <title><%= @title %></title>
 </head>

data/lib/rdoc/generator/template/sdoc/resources/panel/index.html CHANGED Viewed

@@ -1,9 +1,5 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
-    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<!DOCTYPE html>
+<html lang="en">
 <head>
   <title>search index</title>
   <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" charset="utf-8" />

data/lib/sdoc/generator.rb CHANGED Viewed

@@ -122,7 +122,6 @@ class RDoc::Generator::SDoc
   def self.setup_options(options)
     @github = false
-    options.search_index = true
     opt = options.option_parser
     opt.separator nil
@@ -134,18 +133,6 @@ class RDoc::Generator::SDoc
     end
     opt.separator nil
-    opt.on("--without-search", "-s",
-            "Do not generate index file for search engines.",
-            "SDoc uses javascript to reference individual documentation pages.",
-            "Search engine crawlers are not smart enough to find all the",
-            "referenced pages.",
-            "To help them SDoc generates a static file with links to every",
-            "documentation page. This file is not shown to the user."
-            ) do
-      options.search_index = false
-    end
-    opt.separator nil
   end
   def initialize(store, options)
@@ -170,12 +157,14 @@ class RDoc::Generator::SDoc
     # Now actually write the output
     copy_resources
-    generate_class_tree
     @json_index.generate
+    @json_index.generate_gzipped
+    generate_search_index
+    generate_class_tree
+    generate_index_file
     generate_file_files
     generate_class_files
-    generate_index_file
-    generate_search_index if @options.search_index
   end
   def class_dir
@@ -193,108 +182,13 @@ class RDoc::Generator::SDoc
     $stderr.puts( *msg )
   end
-  ### Create class tree structure and write it as json
-  def generate_class_tree
-    debug_msg "Generating class tree"
-    topclasses = @classes.select {|klass| !(RDoc::ClassModule === klass.parent) }
-    tree = generate_file_tree + generate_class_tree_level(topclasses)
-    debug_msg "  writing class tree to %s" % TREE_FILE
-    File.open(TREE_FILE, "w", 0644) do |f|
-      f.write('var tree = '); f.write(tree.to_json(:max_nesting => 0))
-    end unless @options.dry_run
-  end
-  ### Recursivly build class tree structure
-  def generate_class_tree_level(classes, visited = {})
-    tree = []
-    classes.select do |klass|
-      !visited[klass] && klass.with_documentation?
-    end.sort.each do |klass|
-      visited[klass] = true
-      item = [
-        klass.name,
-        klass.document_self_or_methods ? klass.path : '',
-        klass.module? ? '' : (klass.superclass ? " < #{String === klass.superclass ? klass.superclass : klass.superclass.full_name}" : ''),
-        generate_class_tree_level(klass.classes_and_modules, visited)
-      ]
-      tree << item
-    end
-    tree
-  end
-  ### Add files to search +index+ array
-  def add_file_search_index(index)
-    debug_msg "  generating file search index"
-    @files.select { |file|
-      file.document_self
-    }.sort.each do |file|
-      debug_msg "    #{file.path}"
-      index[:searchIndex].push( search_string(file.name) )
-      index[:longSearchIndex].push( search_string(file.path) )
-      index[:info].push([
-        file.name,
-        file.path,
-        file.path,
-        '',
-        snippet(file.comment),
-        TYPE_FILE
-      ])
-    end
-  end
-  ### Add classes to search +index+ array
-  def add_class_search_index(index)
-    debug_msg "  generating class search index"
-    @classes.uniq.select { |klass|
-      klass.document_self_or_methods
-    }.sort.each do |klass|
-      modulename = klass.module? ? '' : (klass.superclass ? (String === klass.superclass ? klass.superclass : klass.superclass.full_name) : '')
-      debug_msg "    #{klass.parent.full_name}::#{klass.name}"
-      index[:searchIndex].push( search_string(klass.name) )
-      index[:longSearchIndex].push( search_string(klass.parent.full_name) )
-      files = klass.in_files.map{ |file| file.absolute_name }
-      index[:info].push([
-        klass.name,
-        files.include?(klass.parent.full_name) ? files.first : klass.parent.full_name,
-        klass.path,
-        modulename ? " < #{modulename}" : '',
-        snippet(klass.comment),
-        TYPE_CLASS
-      ])
-    end
-  end
-  ### Add methods to search +index+ array
-  def add_method_search_index(index)
-    debug_msg "  generating method search index"
-    list = @classes.uniq.map do |klass|
-      klass.method_list
-    end.flatten.sort do |a, b|
-      a.name == b.name ?
-        a.parent.full_name <=> b.parent.full_name :
-        a.name <=> b.name
-    end.select do |method|
-      method.document_self
-    end.find_all do |m|
-      m.visibility == :public || m.visibility == :protected ||
-      m.force_documentation
-    end
+  ### Create index.html with frameset
+  def generate_index_file
+    debug_msg "Generating index file in #@outputdir"
+    templatefile = @template_dir + 'index.rhtml'
+    outfile      = @outputdir + 'index.html'
-    list.each do |method|
-      debug_msg "    #{method.full_name}"
-      index[:searchIndex].push( search_string(method.name) + '()' )
-      index[:longSearchIndex].push( search_string(method.parent.full_name) )
-      index[:info].push([
-        method.name,
-        method.parent.full_name,
-        method.path,
-        method.params,
-        snippet(method.comment),
-        TYPE_METHOD
-      ])
-    end
+    self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
   end
   ### Generate a documentation file for each class
@@ -327,6 +221,44 @@ class RDoc::Generator::SDoc
     end
   end
+  ### Generate file with links for the search engine
+  def generate_search_index
+    debug_msg "Generating search engine index in #@outputdir"
+    templatefile = @template_dir + 'search_index.rhtml'
+    outfile      = @outputdir + 'panel/links.html'
+    self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
+  end
+  ### Create class tree structure and write it as json
+  def generate_class_tree
+    debug_msg "Generating class tree"
+    topclasses = @classes.select {|klass| !(RDoc::ClassModule === klass.parent) }
+    tree = generate_file_tree + generate_class_tree_level(topclasses)
+    debug_msg "  writing class tree to %s" % TREE_FILE
+    File.open(TREE_FILE, "w", 0644) do |f|
+      f.write('var tree = '); f.write(tree.to_json(:max_nesting => 0))
+    end unless @options.dry_run
+  end
+  ### Recursivly build class tree structure
+  def generate_class_tree_level(classes, visited = {})
+    tree = []
+    classes.select do |klass|
+      !visited[klass] && klass.with_documentation?
+    end.sort.each do |klass|
+      visited[klass] = true
+      item = [
+        klass.name,
+        klass.document_self_or_methods ? klass.path : '',
+        klass.module? ? '' : (klass.superclass ? " < #{String === klass.superclass ? klass.superclass : klass.superclass.full_name}" : ''),
+        generate_class_tree_level(klass.classes_and_modules, visited)
+      ]
+      tree << item
+    end
+    tree
+  end
   ### Determines index path based on @options.main_page (or lack thereof)
   def index_path
     # Break early to avoid a big if block when no main page is specified
@@ -344,24 +276,6 @@ class RDoc::Generator::SDoc
     end
   end
-  ### Create index.html with frameset
-  def generate_index_file
-    debug_msg "Generating index file in #@outputdir"
-    templatefile = @template_dir + 'index.rhtml'
-    outfile      = @outputdir + 'index.html'
-    self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
-  end
-  ### Generate file with links for the search engine
-  def generate_search_index
-    debug_msg "Generating search engine index in #@outputdir"
-    templatefile = @template_dir + 'search_index.rhtml'
-    outfile      = @outputdir + 'panel/links.html'
-    self.render_template( templatefile, binding(), outfile ) unless @options.dry_run
-  end
   ### Copy all the resource files to output dir
   def copy_resources
     resources_path = @template_dir + RESOURCES_DIR

data/lib/sdoc/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module SDoc
-  VERSION = '1.0.0.rc1'
+  VERSION = '1.0.0.rc2'
 end

data/sdoc.gemspec CHANGED Viewed

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = ["README.md"]
-  s.add_runtime_dependency("rdoc", "5.0.0")
+  s.add_runtime_dependency("rdoc", "~> 5.0")
   s.files         = `git ls-files`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/spec/rdoc_generator_spec.rb CHANGED Viewed

@@ -37,26 +37,4 @@ describe RDoc::Generator::SDoc do
     err.wont_match(/^invalid options/)
     @options.github.must_equal true
   end
-  it "should parse no search engine index option" do
-    @options.search_index.must_equal true
-    _, err = capture_io do
-      @parser.parse %w[--without-search]
-    end
-    err.wont_match(/^invalid options/)
-    @options.search_index.must_equal false
-  end
-  it "should parse search-index shorthand option" do
-    @options.search_index.must_equal true
-    _, err = capture_io do
-      @parser.parse %w[-s]
-    end
-    err.wont_match(/^invalid options/)
-    @options.search_index.must_equal false
-  end
 end

data/spec/spec_helper.rb CHANGED Viewed

@@ -1,8 +1,5 @@
-require 'rubygems'
 require 'bundler/setup'
 require 'sdoc'
-require 'rdoc/test_case'
 require 'minitest/autorun'

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Vladimir Kolesnikov
@@ -11,22 +11,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-25 00:00:00.000000000 Z
+date: 2017-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
 description: rdoc generator html with javascript search index.
 email: voloko@gmail.com mail@zzak.io
 executables:
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project:
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key:
 specification_version: 4
 summary: rdoc html with javascript search index.