sdoc 0.3.20 → 0.4.0.rc.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd2d4eb7ab04479c587beb38e4914c9dffccb38b
+  data.tar.gz: 19f04f53d7d8b389d1c89d626ec5e6eb5feb932f
+SHA512:
+  metadata.gz: 86e9f89fca9d9742202cc177ae9476129f0d1954a7490f79031ebfc284bbed35f42474c95e269a8e6c279901b8d8f56e15367552061c06e965f89de99a5ed343
+  data.tar.gz: ae5dd03a65d7fd05b1eff34c0ced235a9d24b00fb096bec1e8d9fecef843e7754a49ace874d879a4d97c10894d391b795140b708d8f41e17e7d8c8104bf39b4f

data/.gitignore

@@ -1,3 +1,6 @@
+*.gem
+.bundle
 pkg
 doc
-/test.rb
+/test.rb
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,12 @@
+---
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+notifications:
+  recipients:
+    - zachary@zacharyscott.net

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -1,5 +1,7 @@
 # SDoc
 
+[![Build Status](https://travis-ci.org/zzak/sdoc.png?branch=master)](https://travis-ci.org/zzak/sdoc)
+
 **Powering http://api.rubyonrails.org/ and http://railsapi.com/**
 
 ### What is sdoc?
@@ -7,7 +9,7 @@
 RDoc generator to build searchable HTML documentation for Ruby code.
 
 * `sdoc` - command line tool to run rdoc with `generator=shtml` (searchable HTML)
-* `sdoc-merge` - comand line tool to merge multiple sdoc folders into a single documentation site
+* `sdoc-merge` - command line tool to merge multiple sdoc folders into a single documentation site
 
 
 ### Getting Started
@@ -63,4 +65,5 @@ end
 # Who?
 
 * Vladimir Kolesnikov ([voloko](https://github.com/voloko))
-* Nathan Broadbent ([ndbroadbent](https://github.com/ndbroadbent))
+* Nathan Broadbent ([ndbroadbent](https://github.com/ndbroadbent))
+* Zachary Scott ([zzak](https://github.com/zzak))

data/Rakefile

@@ -3,10 +3,11 @@ require 'rubygems'
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-gem 'rspec', '>= 2.5.0'
-require 'rspec/core/rake_task'
+require 'rake/testtask'
 
-desc "Run all specs"
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
-task :test => :spec
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task :default => :test
+task :spec => :test

data/lib/rdoc/discover.rb

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

data/lib/rdoc/generator/template/rails/_context.rhtml

@@ -174,6 +174,12 @@
               end.join ", " %>
             </div>
           <% end %>
+
+          <% if method.is_alias_for then %>
+            <div class="aka">
+              Alias for: <a href="<%= context.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+            </div>
+          <% end %>
           
           <% if method.token_stream %>
             <% markup = method.sdoc_markup_code %>

data/lib/rdoc/generator/template/sdoc/_context.rhtml

@@ -174,6 +174,12 @@
               end.join ", " %>
             </div>
           <% end %>
+
+          <% if method.is_alias_for then %>
+            <div class="aka">
+              Alias for: <a href="<%= context.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+            </div>
+          <% end %>
           
           <% if method.token_stream %>
             <% markup = method.sdoc_markup_code %>

data/lib/rdoc/generator/template/sdoc/file.rhtml

@@ -18,7 +18,7 @@
         </h1>
         <ul class="files">
             <li><%= h file.relative_name %></li>
-            <li>Last modified: <%= file.file_stat.mtime %></li>
+            <li>Last modified: <%= file.last_modified %></li>
         </ul>
     </div>
 
@@ -26,4 +26,4 @@
         <%= include_template '_context.rhtml', {:context => file, :rel_prefix => rel_prefix} %>
     </div>
   </body>
-</html>
+</html>

data/lib/sdoc.rb

@@ -1,7 +1,7 @@
 $:.unshift File.dirname(__FILE__)
 require "rubygems"
-gem 'rdoc', '~> 3'
+gem 'rdoc'
 
 module SDoc end
-  
+
 require 'sdoc/generator'

data/lib/sdoc/generator.rb

@@ -22,7 +22,7 @@ end
 
 class RDoc::Options
   attr_accessor :github
-  attr_accessor :se_index
+  attr_accessor :search_index
 end
 
 class RDoc::AnyMethod
@@ -120,9 +120,14 @@ class RDoc::Generator::SDoc
 
   attr_reader :options
 
+  ##
+  # The RDoc::Store that is the source of the generated content
+
+  attr_reader :store
+
   def self.setup_options(options)
     @github = false
-    options.se_index = true
+    options.search_index = true
 
     opt = options.option_parser
     opt.separator nil
@@ -134,25 +139,27 @@ class RDoc::Generator::SDoc
     end
     opt.separator nil
 
-    opt.on("--no-se-index", "-ns",
+    opt.on("--without-search", "-s",
            "Do not generated index file for search engines.",
            "SDoc uses javascript to refrence 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 |value|
-      options.se_index = false
+           ) do
+      options.search_index = false
     end
     opt.separator nil
 
   end
 
-  def initialize(options)
+  def initialize(store, options)
+    @store   = store
     @options = options
     if @options.respond_to?('diagram=')
       @options.diagram = false
     end
+    @options.pipe = true
     @github_url_cache = {}
 
     @template_dir = Pathname.new(options.template_dir)
@@ -161,19 +168,19 @@ class RDoc::Generator::SDoc
     @json_index = RDoc::Generator::JsonIndex.new self, options
   end
 
-  def generate(top_levels)
+  def generate
     @outputdir = Pathname.new(@options.op_dir).expand_path(@base_dir)
-    @files = top_levels.sort
-    @classes = RDoc::TopLevel.all_classes_and_modules.sort
+    @files = @store.all_files.sort
+    @classes = @store.all_classes_and_modules.sort
 
     # Now actually write the output
     copy_resources
     generate_class_tree
-    @json_index.generate top_levels
+    @json_index.generate
     generate_file_files
     generate_class_files
     generate_index_file
-    generate_se_index if @options.se_index
+    generate_search_index if @options.search_index
   end
 
   def class_dir
@@ -352,9 +359,9 @@ class RDoc::Generator::SDoc
   end
 
   ### Generate file with links for the search engine
-  def generate_se_index
+  def generate_search_index
     debug_msg "Generating search engine index in #@outputdir"
-    templatefile = @template_dir + 'se_index.rhtml'
+    templatefile = @template_dir + 'search_index.rhtml'
     outfile      = @outputdir + 'panel/links.html'
 
     self.render_template( templatefile, binding(), outfile ) unless @options.dry_run

data/lib/sdoc/github.rb

@@ -2,7 +2,7 @@ module SDoc::GitHub
   def github_url(path)
     unless @github_url_cache.has_key? path
       @github_url_cache[path] = false
-      file = RDoc::TopLevel.find_file_named(path)
+      file = @store.find_file_named(path)
       if file
         base_url = repository_url(path)
         if base_url
@@ -16,7 +16,7 @@ module SDoc::GitHub
     end
     @github_url_cache[path]
   end
-  
+
   protected
 
   def have_git?
@@ -33,7 +33,7 @@ module SDoc::GitHub
     m = s.match(/commit\s+(\S+)/)
     m ? m[1] : false
   end
-  
+
   def repository_url(path)
     return false unless have_git?
     s = Dir.chdir(File.join(base_dir, File.dirname(path))) do
@@ -51,7 +51,7 @@ module SDoc::GitHub
 
   def path_to_git_dir(path)
     while !path.empty? && path != '.'
-      if (File.exists? File.join(path, '.git')) 
+      if (File.exists? File.join(path, '.git'))
         return path
       end
       path = File.dirname(path)

data/lib/sdoc/templatable.rb

@@ -20,7 +20,7 @@ module SDoc::Templatable
         ], err.backtrace
       end
   end
-  
+
   ### Load and render the erb template with the given +template_name+ within
   ### current context. Adds all +local_assigns+ to context
   def include_template(template_name, local_assigns = {})
@@ -28,13 +28,13 @@ module SDoc::Templatable
     templatefile = @template_dir + template_name
     eval("#{source};eval_template(templatefile, binding)")
   end
-  
+
 	### Load and render the erb template in the given +templatefile+ within the
 	### specified +context+ (a Binding object) and write it out to +outfile+.
 	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
 	def render_template( templatefile, context, outfile )
     output = eval_template(templatefile, context)
-    
+
     # TODO delete this dirty hack when documentation for example for GeneratorMethods will not be cutted off by <script> tag
     begin
       if output.respond_to? :force_encoding
@@ -44,9 +44,9 @@ module SDoc::Templatable
         output = output.gsub('<script>', '&lt;script&gt;')
       end
     rescue Exception => e
-      
+
     end
-    
+
 		unless $dryrun
 			outfile.dirname.mkpath
 			outfile.open( 'w', 0644 ) do |file|
@@ -56,5 +56,5 @@ module SDoc::Templatable
 			debug_msg "  would have written %d bytes to %s" %
 			[ output.length, outfile ]
 		end
-	end  
-end
+	end
+end

data/sdoc.gemspec

@@ -2,13 +2,14 @@
 
 Gem::Specification.new do |s|
   s.name = "sdoc"
-  s.version = "0.3.20"
+  s.version = "0.4.0.rc.1"
 
-  s.authors = ["Vladimir Kolesnikov", "Nathan Broadbent"]
+  s.authors = ["Vladimir Kolesnikov", "Nathan Broadbent", "Jean Mertz", "Zachary Scott"]
   s.description = %q{rdoc generator html with javascript search index.}
   s.summary = %q{rdoc html with javascript search index.}
   s.homepage = %q{http://github.com/voloko/sdoc}
   s.email = %q{voloko@gmail.com}
+  s.license = 'MIT'
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if
     s.respond_to? :required_rubygems_version=
@@ -16,7 +17,8 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = ["README.md"]
 
-  s.add_runtime_dependency('rdoc', "~> 3.10")
+  s.add_runtime_dependency('rdoc', "~> 4.0", "< 5.0")
+
   if defined?(JRUBY_VERSION)
     s.platform = Gem::Platform.new(['universal', 'java', nil])
     s.add_runtime_dependency("json_pure", ">= 1.1.3")
@@ -24,8 +26,11 @@ Gem::Specification.new do |s|
     s.add_runtime_dependency("json", ">= 1.1.3")
   end
 
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest", "~> 4.0"
+
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 end
-

data/spec/rdoc_generator_spec.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), '/spec_helper')
+
+describe RDoc::Generator::SDoc do
+  before :each do
+    @options = RDoc::Options.new
+    @options.setup_generator 'sdoc'
+    @parser = @options.option_parser
+  end
+
+  it "should find sdoc generator" do
+    RDoc::RDoc::GENERATORS.must_include 'sdoc'
+  end
+
+  it "should use sdoc generator" do
+    @options.generator.must_equal RDoc::Generator::SDoc
+    @options.generator_name.must_equal 'sdoc'
+  end
+
+  it "should parse github option" do
+    assert !@options.github
+
+    out, err = capture_io do
+      @parser.parse %w[--github]
+    end
+
+    err.wont_match /^invalid options/
+    @options.github.must_equal true
+  end
+
+  it "should parse github short-hand option" do
+    assert !@options.github
+
+    out, err = capture_io do
+      @parser.parse %w[-g]
+    end
+
+    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
+
+    out, 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
+    out, 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

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

metadata

@@ -1,49 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: sdoc
 version: !ruby/object:Gem::Version
-  version: 0.3.20
-  prerelease: 
+  version: 0.4.0.rc.1
 platform: ruby
 authors:
 - Vladimir Kolesnikov
 - Nathan Broadbent
+- Jean Mertz
+- Zachary Scott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-21 00:00:00.000000000 Z
+date: 2013-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 description: rdoc generator html with javascript search index.
 email: voloko@gmail.com
 executables:
@@ -53,8 +98,10 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .gitignore
-- .rake_tasks~
+- ".gitignore"
+- ".rake_tasks~"
+- ".travis.yml"
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
@@ -82,7 +129,7 @@ files:
 - lib/rdoc/generator/template/rails/resources/js/main.js
 - lib/rdoc/generator/template/rails/resources/js/searchdoc.js
 - lib/rdoc/generator/template/rails/resources/panel/index.html
-- lib/rdoc/generator/template/rails/se_index.rhtml
+- lib/rdoc/generator/template/rails/search_index.rhtml
 - lib/rdoc/generator/template/sdoc/_context.rhtml
 - lib/rdoc/generator/template/sdoc/_head.rhtml
 - lib/rdoc/generator/template/sdoc/class.rhtml
@@ -103,7 +150,7 @@ files:
 - lib/rdoc/generator/template/sdoc/resources/js/main.js
 - lib/rdoc/generator/template/sdoc/resources/js/searchdoc.js
 - lib/rdoc/generator/template/sdoc/resources/panel/index.html
-- lib/rdoc/generator/template/sdoc/se_index.rhtml
+- lib/rdoc/generator/template/sdoc/search_index.rhtml
 - lib/sdoc.rb
 - lib/sdoc/generator.rb
 - lib/sdoc/github.rb
@@ -111,30 +158,33 @@ files:
 - lib/sdoc/merge.rb
 - lib/sdoc/templatable.rb
 - sdoc.gemspec
+- spec/rdoc_generator_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/voloko/sdoc
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.0.rc.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: rdoc html with javascript search index.
-test_files: []
-has_rdoc: 
+test_files:
+- spec/rdoc_generator_spec.rb
+- spec/spec_helper.rb