sdoc 0.4.0.rc.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd2d4eb7ab04479c587beb38e4914c9dffccb38b
-  data.tar.gz: 19f04f53d7d8b389d1c89d626ec5e6eb5feb932f
+  metadata.gz: 067a0e0ce20ba977d36da7bb1973265df51a9e82
+  data.tar.gz: 9ace3bdb783a389d48fb306f2cb889c48e561512
 SHA512:
-  metadata.gz: 86e9f89fca9d9742202cc177ae9476129f0d1954a7490f79031ebfc284bbed35f42474c95e269a8e6c279901b8d8f56e15367552061c06e965f89de99a5ed343
-  data.tar.gz: ae5dd03a65d7fd05b1eff34c0ced235a9d24b00fb096bec1e8d9fecef843e7754a49ace874d879a4d97c10894d391b795140b708d8f41e17e7d8c8104bf39b4f
+  metadata.gz: 74a0a0ed5885d5a5476e0aeab695a8290e48021be825f012b3222609726f79314504d78b2845b9a0c8810cee95340a648800efc3dd876aa87a7a7c6aa41963a6
+  data.tar.gz: 5800a6d342566ee966a76c88d0ff51ffd834dda6954b6fb281cb54b4b2c8de7a44e967084ff281830cfff9ffd9f04956f2b3b31975aabe189614e461bb97c8b5

data/.gitignore

@@ -4,3 +4,5 @@ pkg
 doc
 /test.rb
 Gemfile.lock
+/.rake_tasks~
+/*.gem

data/bin/sdoc

@@ -2,7 +2,7 @@
 require 'sdoc'
 
 begin
-  ARGV.push('--format=sdoc') if ARGV.grep(/\A(-f|--fmt|--format|-r|-R|--ri|--ri-site)\b/).empty?
+  ARGV.unshift('--format=sdoc') if ARGV.grep(/\A(-f|--fmt|--format|-r|-R|--ri|--ri-site)\b/).empty?
   r = RDoc::RDoc.new
   r.document ARGV
 rescue SystemExit
@@ -24,4 +24,3 @@ rescue Exception => e
 
   exit 1
 end
-

data/bin/sdoc-merge

@@ -21,4 +21,3 @@ rescue Exception => e
   end
   exit 1
 end
-

data/lib/sdoc.rb

@@ -2,6 +2,8 @@ $:.unshift File.dirname(__FILE__)
 require "rubygems"
 gem 'rdoc'
 
-module SDoc end
+module SDoc
+  VERSION = "0.4.0"
+end
 
 require 'sdoc/generator'

data/lib/sdoc/generator.rb

@@ -134,19 +134,19 @@ class RDoc::Generator::SDoc
     opt.separator "SDoc generator options:"
     opt.separator nil
     opt.on("--github", "-g",
-           "Generate links to github.") do |value|
+            "Generate links to github.") do |value|
       options.github = true
     end
     opt.separator nil
 
     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
+            "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
       options.search_index = false
     end
     opt.separator nil

data/lib/sdoc/helpers.rb

@@ -14,7 +14,7 @@ module SDoc::Helpers
     end
     yield group unless group[:methods].size == 0
   end
-  
+
 protected
   def group_name name
     if match = name.match(/^([a-z])/i)
@@ -23,4 +23,4 @@ protected
       '#'
     end
   end
-end
+end

data/lib/sdoc/merge.rb

@@ -27,7 +27,7 @@ class SDoc::Merge
   def merge(options)
     parse_options options
 
-		@outputdir = Pathname.new( @op_dir )
+    @outputdir = Pathname.new( @op_dir )
 
     check_directories
     setup_output_dir
@@ -56,8 +56,8 @@ class SDoc::Merge
       end
 
       opt.on("-u", "--urls [URLS]", "Paths to merged docs. If you",
-                   "set this files and classes won't be actualy",
-                   "copied to merged build") do |v|
+                    "set this files and classes won't be actualy",
+                    "copied to merged build") do |v|
         @urls = v.split(' ').map{|name| name.strip }
       end
     end
@@ -198,7 +198,7 @@ class SDoc::Merge
 
   def setup_output_dir
     if File.exists? @op_dir
-      error "#{@op_dir} allready exists"
+      error "#{@op_dir} already exists"
     end
     FileUtils.mkdir_p @op_dir
   end

data/lib/sdoc/templatable.rb

@@ -2,13 +2,13 @@ require 'erb'
 require "sdoc"
 
 module SDoc::Templatable
-	### Load and render the erb template in the given +templatefile+ within the
-	### specified +context+ (a Binding object) and return output
-	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
+  ### Load and render the erb template in the given +templatefile+ within the
+  ### specified +context+ (a Binding object) and return output
+  ### Both +templatefile+ and +outfile+ should be Pathname-like objects.
   def eval_template(templatefile, context)
-		template_src = templatefile.read
-		template = ERB.new( template_src, nil, '<>' )
-		template.filename = templatefile.to_s
+    template_src = templatefile.read
+    template = ERB.new( template_src, nil, '<>' )
+    template.filename = templatefile.to_s
 
     begin
       template.result( context )
@@ -29,10 +29,10 @@ module SDoc::Templatable
     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 )
+  ### 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
@@ -47,14 +47,14 @@ module SDoc::Templatable
 
     end
 
-		unless $dryrun
-			outfile.dirname.mkpath
-			outfile.open( 'w', 0644 ) do |file|
-				file.print( output )
-			end
-		else
-			debug_msg "  would have written %d bytes to %s" %
-			[ output.length, outfile ]
-		end
-	end
+    unless $dryrun
+      outfile.dirname.mkpath
+      outfile.open( 'w', 0644 ) do |file|
+        file.print( output )
+      end
+    else
+      debug_msg "  would have written %d bytes to %s" %
+      [ output.length, outfile ]
+    end
+  end
 end

data/sdoc.gemspec

@@ -1,14 +1,15 @@
 # -*- encoding: utf-8 -*-
+require_relative 'lib/sdoc.rb'
 
 Gem::Specification.new do |s|
   s.name = "sdoc"
-  s.version = "0.4.0.rc.1"
+  s.version = SDoc::VERSION
 
   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.email = %q{voloko@gmail.com zachary@zacharyscott.net}
   s.license = 'MIT'
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if
@@ -21,9 +22,9 @@ Gem::Specification.new do |s|
 
   if defined?(JRUBY_VERSION)
     s.platform = Gem::Platform.new(['universal', 'java', nil])
-    s.add_runtime_dependency("json_pure", ">= 1.1.3")
+    s.add_runtime_dependency("json_pure", "~> 1.8")
   else
-    s.add_runtime_dependency("json", ">= 1.1.3")
+    s.add_runtime_dependency("json", "~> 1.8")
   end
 
   s.add_development_dependency "bundler", "~> 1.3"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdoc
 version: !ruby/object:Gem::Version
-  version: 0.4.0.rc.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Vladimir Kolesnikov
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-26 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -37,16 +37,16 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 description: rdoc generator html with javascript search index.
-email: voloko@gmail.com
+email: voloko@gmail.com zachary@zacharyscott.net
 executables:
 - sdoc
 - sdoc-merge
@@ -99,7 +99,6 @@ extra_rdoc_files:
 - README.md
 files:
 - ".gitignore"
-- ".rake_tasks~"
 - ".travis.yml"
 - Gemfile
 - LICENSE

data/.rake_tasks~

@@ -1,20 +0,0 @@
-build
-check_dependencies
-check_dependencies:development
-check_dependencies:runtime
-gem_file_list
-gemspec
-gemspec:debug
-gemspec:generate
-gemspec:validate
-ghost
-git:release
-github:release
-install
-release
-test
-version
-version:bump:major
-version:bump:minor
-version:bump:patch
-version:write