sdoc 1.0.0.rc3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 120a6beabf68f2666569422df6ec1016eed0bd0c
-  data.tar.gz: 031417023b90f2454f88667848fecd9d681e244a
+  metadata.gz: 29716368d7c072908ecc4b13c04570fe435166e6
+  data.tar.gz: 706d48301caebca63b188da2033a7dee963bfaa8
 SHA512:
-  metadata.gz: ba5f3f336a41df54bb8354d422c01a7a7b039f9924f24563dfb0577b7540cb0ba131c239ab3d074bd2acc136adc05b7fdcc616a0d0409c525dcc1c1f18f62447
-  data.tar.gz: f405fc8f95d5c64fbcb0686b30f790dca1374f70d066dfde434425aa9e0a76131acf1898b8c86b0443a8f5bde3cd01498e6f7ea225d39080526ead3008cd7410
+  metadata.gz: 94539d716999ecf5b07ba5b93a2974e5fdc22b8f231449195c70129a74856e4ce9ef68bfff8d80ded0bcf4852b14be66110510fa62a7a4200dc04620f3ce0203
+  data.tar.gz: 42a050c73aa5ab6fc403d3b4f37fd66261b9edb78b974ec2bf2b76289f9734e3ce8b4e8a348a0d6e0743b89ff924dcf571cddf1a078ddbe051fc5f310eb90abc

data/.travis.yml

@@ -6,24 +6,22 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - 2.2.0
-  - 2.3.0
-  - 2.4.0
+  - 2.2.9
+  - 2.3.6
+  - 2.4.2
+  - 2.5.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 }
-    - { rvm: 2.1.0, env: rdoc=master }
-    - { rvm: 2.2.0, env: rdoc=master }
-    - { rvm: 2.3.0, env: rdoc=master }
+    - { rvm: 2.2.9, env: rdoc=master }
+    - { rvm: 2.3.6, env: rdoc=master }
+    - { rvm: 2.4.2, env: rdoc=master }
+    - { rvm: 2.5.0, env: rdoc=master }
     - { rvm: ruby-head, env: rdoc=master }
-    - { rvm: jruby-19mode, env: rdoc=master }
     - { rvm: jruby-head, env: rdoc=master }
 notifications:
   email:

data/Gemfile

@@ -7,5 +7,5 @@ gem "minitest"
 gem "hoe"
 
 if ENV["rdoc"] == "master"
-  gem "rdoc", :github => "rdoc/rdoc"
+  gem "rdoc", :github => "ruby/rdoc"
 end

data/Rakefile

@@ -1,5 +1,3 @@
-require 'rubygems'
-
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

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

@@ -103,7 +103,7 @@
       <!-- Section constants -->
       <div class="sectiontitle">Constants</div>
       <table border='0' cellpadding='5'>
-        <% context.each_constant do |const| %>
+        <% constants.each do |const| %>
           <tr valign='top'>
             <td class="attr-name"><%= h const.name %></td>
             <td>=</td>
@@ -182,7 +182,7 @@
           <% end %>
 
           <% if method.token_stream %>
-            <% markup = method.sdoc_markup_code %>
+            <% markup = method.markup_code %>
             <div class="sourcecode">
               <%
                 # generate github link
@@ -209,8 +209,8 @@
             </div>
             <% end %>
           </div>
-        <% end #methods.each %>
-      <% end #visibilities.each %>
-    <% end #context.methods_by_type %>
-  <% end #context.each_section %>
+        <% end %><%# methods.each %>
+      <% end %><%# visibilities.each %>
+    <% end %><%# context.methods_by_type %>
+  <% end %><%# context.each_section %>
 </div>

data/lib/rdoc/generator/template/rails/resources/css/main.css

@@ -193,6 +193,7 @@ pre
   margin: 2em;
   margin-left: 3.5em;
   margin-right: 3.5em;
+  max-width: 980px;
 }
 
 
@@ -361,3 +362,13 @@ tt {
   animation-name: highlight;
   animation-duration: 1s;
 }
+
+p code {
+  background: #eeeeee;
+  border-radius: 2px;
+  border: 1px solid #dddddd;
+  font-family: Consolas, Menlo, Courier, monospace;
+  font-size: 14px;
+  margin-bottom: 1px;
+  padding: 0 5px;
+}

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

@@ -182,7 +182,7 @@
           <% end %>
 
           <% if method.token_stream %>
-            <% markup = method.sdoc_markup_code %>
+            <% markup = method.markup_code %>
             <div class="sourcecode">
               <%
                 # generate github link
@@ -209,8 +209,8 @@
             </div>
             <% end %>
           </div>
-        <% end #methods.each %>
-      <% end #visibilities.each %>
-    <% end #context.methods_by_type %>
-  <% end #context.each_section %>
+        <% end %><%# methods.each %>
+      <% end %><%# visibilities.each %>
+    <% end %><%# context.methods_by_type %>
+  <% end %><%# context.each_section %>
 </div>

data/lib/sdoc.rb

@@ -1,5 +1,3 @@
-$:.unshift File.dirname(__FILE__)
-require "rubygems"
 gem 'rdoc'
 
 module SDoc; end

data/lib/sdoc/generator.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'erb'
 require 'pathname'
 require 'fileutils'
@@ -20,77 +19,6 @@ class RDoc::Options
   attr_accessor :search_index
 end
 
-class RDoc::AnyMethod
-
-  TITLE_AFTER = %w(def class module)
-
-  ##
-  # Turns the method's token stream into HTML.
-  #
-  # Prepends line numbers if +add_line_numbers+ is true.
-
-  def sdoc_markup_code
-    return '' unless @token_stream
-
-    src = ""
-    starting_title = false
-
-    @token_stream.each do |t|
-      next unless t
-
-      style = case t
-              when RDoc::RubyToken::TkFLOAT    then 'ruby-number'
-              when RDoc::RubyToken::TkINTEGER  then 'ruby-number'
-              when RDoc::RubyToken::TkCONSTANT then 'ruby-constant'
-              when RDoc::RubyToken::TkKW       then 'ruby-keyword'
-              when RDoc::RubyToken::TkIVAR     then 'ruby-ivar'
-              when RDoc::RubyToken::TkOp       then 'ruby-operator'
-              when RDoc::RubyToken::TkId       then 'ruby-identifier'
-              when RDoc::RubyToken::TkNode     then 'ruby-node'
-              when RDoc::RubyToken::TkCOMMENT  then 'ruby-comment'
-              when RDoc::RubyToken::TkREGEXP   then 'ruby-regexp'
-              when RDoc::RubyToken::TkSTRING   then 'ruby-string'
-              when RDoc::RubyToken::TkVal      then 'ruby-value'
-              end
-
-      if RDoc::RubyToken::TkId === t && starting_title
-        starting_title = false
-        style = 'ruby-keyword ruby-title'
-      end
-
-      if RDoc::RubyToken::TkKW === t && TITLE_AFTER.include?(t.text)
-        starting_title = true
-      end
-
-      text = CGI.escapeHTML t.text
-
-      if style then
-        src << "<span class=\"#{style}\">#{text}</span>"
-      else
-        src << text
-      end
-    end
-
-    # dedent the source
-    indent = src.length
-    lines = src.lines.to_a
-    lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment
-    lines.each do |line|
-      if line =~ /^ *(?=\S)/
-        n = $&.length
-        indent = n if n < indent
-        break if n == 0
-      end
-    end
-    src.gsub!(/^#{' ' * indent}/, '') if indent > 0
-
-    add_line_numbers(src) if self.class.add_line_numbers
-
-    src
-  end
-
-end
-
 class RDoc::Generator::SDoc
   RDoc::RDoc.add_generator self
 
@@ -121,8 +49,6 @@ class RDoc::Generator::SDoc
   attr_reader :store
 
   def self.setup_options(options)
-    @github = false
-
     opt = options.option_parser
     opt.separator nil
     opt.separator "SDoc generator options:"

data/lib/sdoc/github.rb

@@ -1,16 +1,15 @@
 module SDoc::GitHub
   def github_url(path)
+    return false unless have_git?
+
     unless @github_url_cache.has_key? path
       @github_url_cache[path] = false
       file = @store.find_file_named(path)
       if file
         base_url = repository_url(path)
         if base_url
-          sha1 = commit_sha1(path)
-          if sha1
-            relative_url = path_relative_to_repository(path)
-            @github_url_cache[path] = "#{base_url}#{sha1}#{relative_url}"
-          end
+          relative_url = path_relative_to_repository(path)
+          @github_url_cache[path] = "#{base_url}#{last_commit_sha1}#{relative_url}"
         end
       end
     end
@@ -24,23 +23,23 @@ module SDoc::GitHub
     @have_git
   end
 
-  def commit_sha1(path)
-    return false unless have_git?
-    name = File.basename(path)
-    s = Dir.chdir(File.join(base_dir, File.dirname(path))) do
-      `git log -1 --pretty=format:"commit %H" #{name}`
+  def last_commit_sha1
+    return @sha1 if defined?(@sha1)
+
+    @sha1 = Dir.chdir(base_dir) do
+      `git rev-parse HEAD`.chomp
     end
-    m = s.match(/commit\s+(\S+)/)
-    m ? m[1] : false
   end
 
   def repository_url(path)
-    return false unless have_git?
+    return @repository_url if defined?(@repository_url)
+
     s = Dir.chdir(File.join(base_dir, File.dirname(path))) do
       `git config --get remote.origin.url`
     end
+
     m = s.match(%r{github.com[/:](.*)\.git$})
-    m ? "https://github.com/#{m[1]}/blob/" : false
+    @repository_url = m ? "https://github.com/#{m[1]}/blob/" : false
   end
 
   def path_relative_to_repository(path)

data/lib/sdoc/helpers.rb

@@ -21,7 +21,7 @@ module SDoc::Helpers
   #
   #   strip_tags("<strong>Hello world</strong>") => "Hello world"
   def strip_tags(text)
-    text.gsub(/\<\/?[a-zA-Z\s"\.\/\=]+\>/, "")
+    text.gsub(%r{</?[^>]+?>}, "")
   end
 
   # Truncates a given string. It tries to take whole sentences to have

data/lib/sdoc/version.rb

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

data/sdoc.gemspec

@@ -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")
+  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/helpers_spec.rb

@@ -10,10 +10,12 @@ describe SDoc::Helpers do
   describe "#strip_tags" do
     it "should strip out HTML tags from the given string" do
       strings = [
-        [ %(<strong>Hello world</strong>),                 "Hello world"       ],
-        [ %(<a href="Streams.html">Streams</a> are great), "Streams are great" ],
-        [ %(<a href="../Base.html">Base</a>),              "Base"              ],
-        [ %(Some<br>\ntext),                               "Some\ntext"        ]
+        [ %(<strong>Hello world</strong>),                                      "Hello world"          ],
+        [ %(<a href="Streams.html">Streams</a> are great),                      "Streams are great"    ],
+        [ %(<a href="https://github.com?x=1&y=2#123">zzak/sdoc</a> Standalone), "zzak/sdoc Standalone" ],
+        [ %(<h1 id="module-AR::Cb-label-Foo+Bar">AR Cb</h1>),                   "AR Cb"                ],
+        [ %(<a href="../Base.html">Base</a>),                                   "Base"                 ],
+        [ %(Some<br>\ntext),                                                    "Some\ntext"           ]
       ]
 
       strings.each do |(html, stripped)|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0
 platform: ruby
 authors:
 - Vladimir Kolesnikov
@@ -11,20 +11,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-26 00:00:00.000000000 Z
+date: 2018-02-06 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'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
 description: rdoc generator html with javascript search index.
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: rdoc html with javascript search index.