sdoc_local_editor 0.3.17

data/lib/sdoc_local_editor/github.rb

@@ -0,0 +1,61 @@
+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)
+      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
+        end
+      end
+    end
+    @github_url_cache[path]
+  end
+  
+  protected
+
+  def have_git?
+    @have_git = system('git --version > /dev/null 2>&1') if @have_git.nil?
+    @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}`
+    end
+    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
+      `git config --get remote.origin.url`
+    end
+    m = s.match(%r{github.com[/:](.*)\.git$})
+    m ? "https://github.com/#{m[1]}/blob/" : false
+  end
+
+  def path_relative_to_repository(path)
+    absolute_path = File.join(base_dir, path)
+    root = path_to_git_dir(File.dirname(absolute_path))
+    absolute_path[root.size..absolute_path.size]
+  end
+
+  def path_to_git_dir(path)
+    while !path.empty? && path != '.'
+      if (File.exists? File.join(path, '.git')) 
+        return path
+      end
+      path = File.dirname(path)
+    end
+    ''
+  end
+end

data/lib/sdoc_local_editor/helpers.rb

@@ -0,0 +1,26 @@
+module SDoc::Helpers
+  def each_letter_group(methods, &block)
+    group = {:name => '', :methods => []}
+    methods.sort{ |a, b| a.name <=> b.name }.each do |method|
+      gname = group_name method.name
+      if gname != group[:name]
+        yield group unless group[:methods].size == 0
+        group = {
+          :name => gname,
+          :methods => []
+        }
+      end
+      group[:methods].push(method)
+    end
+    yield group unless group[:methods].size == 0
+  end
+  
+protected
+  def group_name name
+    if match = name.match(/^([a-z])/i)
+      match[1].upcase
+    else
+      '#'
+    end
+  end
+end

data/lib/sdoc_local_editor/merge.rb

@@ -0,0 +1,223 @@
+require 'optparse'
+require 'pathname'
+require 'fileutils'
+
+if Gem::Specification.respond_to?(:find_by_name) ? Gem::Specification::find_by_name("json") : Gem.available?("json")
+  gem "json", ">= 1.1.3"
+else
+  gem "json_pure", ">= 1.1.3"
+end
+require 'json'
+
+require 'sdoc_local_editor/templatable'
+
+class SDoc::Merge
+  include SDoc::Templatable
+
+  FLAG_FILE = "created.rid"
+
+  def initialize()
+    @names = []
+    @urls = []
+    @op_dir = 'doc'
+    @title = ''
+    @directories = []
+  end
+
+  def merge(options)
+    parse_options options
+
+		@outputdir = Pathname.new( @op_dir )
+
+    check_directories
+    setup_output_dir
+    setup_names
+    copy_files
+    copy_docs if @urls.empty?
+    merge_search_index
+    merge_tree
+    generate_index_file
+  end
+
+  def parse_options(options)
+    opts = OptionParser.new do |opt|
+      opt.banner = "Usage: sdoc-merge [options] directories"
+
+      opt.on("-n", "--names [NAMES]", "Names of merged repositories. Comma separated") do |v|
+        @names = v.split(',').map{|name| name.strip }
+      end
+
+      opt.on("-o", "--op [DIRECTORY]", "Set the output directory") do |v|
+        @op_dir = v
+      end
+
+      opt.on("-t", "--title [TITLE]", "Set the title of merged file") do |v|
+        @title = v
+      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|
+        @urls = v.split(' ').map{|name| name.strip }
+      end
+    end
+    opts.parse! options
+    @template_dir = Pathname.new(RDoc::Options.new.template_dir_for 'merge')
+    @directories = options.dup
+  end
+
+  def merge_tree
+    tree = []
+    @directories.each_with_index do |dir, i|
+      name = @names[i]
+      url = @urls.empty? ? name : @urls[i]
+      filename = File.join dir, RDoc::Generator::SDoc::TREE_FILE
+      data = open(filename).read.sub(/var tree =\s*/, '')
+      subtree = JSON.parse(data, :max_nesting => 0)
+      item = [
+        name,
+        url + '/' + extract_index_path(dir),
+        '',
+        append_path(subtree, url)
+      ]
+      tree << item
+    end
+
+    dst = File.join @op_dir, RDoc::Generator::SDoc::TREE_FILE
+    FileUtils.mkdir_p File.dirname(dst)
+    File.open(dst, "w", 0644) do |f|
+      f.write('var tree = '); f.write(tree.to_json(:max_nesting => 0))
+    end
+  end
+
+  def append_path subtree, path
+    subtree.map do |item|
+      item[1] = path + '/' + item[1] unless item[1].empty?
+      item[3] = append_path item[3], path
+      item
+    end
+  end
+
+  def merge_search_index
+    items = []
+    @indexes = {}
+    @directories.each_with_index do |dir, i|
+      name = @names[i]
+      url = @urls.empty? ? name : @urls[i]
+      filename = File.join dir, RDoc::Generator::SDoc::SEARCH_INDEX_FILE
+      data = open(filename).read.sub(/var search_data =\s*/, '')
+      subindex = JSON.parse(data, :max_nesting => 0)
+      @indexes[name] = subindex
+
+      searchIndex = subindex["index"]["searchIndex"]
+      longSearchIndex = subindex["index"]["longSearchIndex"]
+      subindex["index"]["info"].each_with_index do |info, j|
+        info[2] = url + '/' + info[2]
+        info[6] = i
+        items << {
+          :info => info,
+          :searchIndex => searchIndex[j],
+          :longSearchIndex => name + ' ' + longSearchIndex[j]
+        }
+      end
+    end
+    items.sort! do |a, b|
+      # type (class/method/file) or name or doc part or namespace
+      [a[:info][5], a[:info][0], a[:info][6], a[:info][1]] <=> [b[:info][5], b[:info][0], b[:info][6], b[:info][1]]
+    end
+
+    index = {
+      :searchIndex => items.map{|item| item[:searchIndex]},
+      :longSearchIndex => items.map{|item| item[:longSearchIndex]},
+      :info => items.map{|item| item[:info]}
+    }
+    search_data = {
+      :index => index,
+      :badges => @names
+    }
+
+    dst = File.join @op_dir, RDoc::Generator::SDoc::SEARCH_INDEX_FILE
+    FileUtils.mkdir_p File.dirname(dst)
+    File.open(dst, "w", 0644) do |f|
+      f.write('var search_data = '); f.write(search_data.to_json(:max_nesting => 0))
+    end
+  end
+
+  def extract_index_path dir
+    filename = File.join dir, 'index.html'
+    content = File.open(filename) { |f| f.read }
+    match = content.match(/<frame\s+src="([^"]+)"\s+name="docwin"/mi)
+    if match
+      match[1]
+    else
+      ''
+    end
+  end
+
+  def generate_index_file
+    templatefile = @template_dir + 'index.rhtml'
+    outfile      = @outputdir + 'index.html'
+    url          = @urls.empty? ? @names[0] : @urls[0]
+    index_path   = url + '/' + extract_index_path(@directories[0])
+
+    render_template templatefile, binding(), outfile
+  end
+
+  def setup_names
+    unless @names.size > 0
+      @directories.each do |dir|
+        name = File.basename dir
+        name = File.basename File.dirname(dir) if name == 'doc'
+        @names << name
+      end
+    end
+  end
+
+  def copy_docs
+    @directories.each_with_index do |dir, i|
+      name = @names[i]
+      index_dir = File.dirname(RDoc::Generator::SDoc::TREE_FILE)
+      FileUtils.mkdir_p(File.join(@op_dir, name))
+
+      Dir.new(dir).each do |item|
+        if File.directory?(File.join(dir, item)) && item != '.' && item != '..' && item != index_dir
+          FileUtils.cp_r File.join(dir, item), File.join(@op_dir, name, item), :preserve => true
+        end
+      end
+    end
+  end
+
+  def copy_files
+    dir = @directories.first
+    Dir.new(dir).each do |item|
+      if item != '.' && item != '..' && item != RDoc::Generator::SDoc::FILE_DIR && item != RDoc::Generator::SDoc::CLASS_DIR
+        FileUtils.cp_r File.join(dir, item), @op_dir, :preserve => true
+      end
+    end
+  end
+
+  def setup_output_dir
+    if File.exists? @op_dir
+      error "#{@op_dir} allready exists"
+    end
+    FileUtils.mkdir_p @op_dir
+  end
+
+  def check_directories
+    @directories.each do |dir|
+      unless File.exists?(File.join(dir, FLAG_FILE)) &&
+      File.exists?(File.join(dir, RDoc::Generator::SDoc::TREE_FILE)) &&
+      File.exists?(File.join(dir, RDoc::Generator::SDoc::SEARCH_INDEX_FILE))
+        error "#{dir} does not seem to be an sdoc directory"
+      end
+    end
+  end
+
+  ##
+  # Report an error message and exit
+
+  def error(msg)
+    raise RDoc::Error, msg
+  end
+
+end

data/lib/sdoc_local_editor/templatable.rb

@@ -0,0 +1,60 @@
+require 'erb'
+require "sdoc_local_editor"
+
+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.
+  def eval_template(templatefile, context)
+		template_src = templatefile.read
+		template = ERB.new( template_src, nil, '<>' )
+		template.filename = templatefile.to_s
+
+    begin
+      template.result( context )
+    rescue NoMethodError => err
+      raise RDoc::Error, "Error while evaluating %s: %s (at %p)" % [
+        templatefile.to_s,
+        err.message,
+        eval( "_erbout[-50,50]", context )
+        ], 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 = {})
+    source = local_assigns.keys.map { |key| "#{key} = local_assigns[:#{key}];" }.join
+    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
+        encoding = output.encoding
+        output = output.force_encoding('ASCII-8BIT').gsub('<script>', '&lt;script;&gt;').force_encoding(encoding)
+      else
+        output = output.gsub('<script>', '&lt;script&gt;')
+      end
+    rescue Exception => e
+
+    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_local_editor.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "sdoc_local_editor"
+  s.version = "0.3.17"
+
+  s.authors = ["Vladimir Kolesnikov"]
+  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.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if
+    s.respond_to? :required_rubygems_version=
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = ["README.rdoc"]
+
+  s.add_runtime_dependency('rdoc', "~> 3.10")
+  if defined?(JRUBY_VERSION)
+    s.platform = Gem::Platform.new(['universal', 'java', nil])
+    s.add_runtime_dependency("json_pure", ">= 1.1.3")
+  else
+    s.add_runtime_dependency("json", ">= 1.1.3")
+  end
+
+  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
+

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: sdoc_local_editor
+version: !ruby/object:Gem::Version
+  version: 0.3.17
+  prerelease: 
+platform: ruby
+authors:
+- Vladimir Kolesnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-13 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !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
+description: rdoc generator html with javascript search index.
+email: voloko@gmail.com
+executables:
+- sdoc_local_editor
+- sdoc_local_editor_merge
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- .rake_tasks~
+- LICENSE
+- README.rdoc
+- Rakefile
+- bin/sdoc_local_editor
+- bin/sdoc_local_editor_merge
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/template/merge/index.rhtml
+- lib/rdoc/generator/template/rails/_context.rhtml
+- lib/rdoc/generator/template/rails/_head.rhtml
+- lib/rdoc/generator/template/rails/class.rhtml
+- lib/rdoc/generator/template/rails/file.rhtml
+- lib/rdoc/generator/template/rails/index.rhtml
+- lib/rdoc/generator/template/rails/resources/apple-touch-icon.png
+- lib/rdoc/generator/template/rails/resources/css/github.css
+- lib/rdoc/generator/template/rails/resources/css/main.css
+- lib/rdoc/generator/template/rails/resources/css/panel.css
+- lib/rdoc/generator/template/rails/resources/css/reset.css
+- lib/rdoc/generator/template/rails/resources/favicon.ico
+- lib/rdoc/generator/template/rails/resources/i/arrows.png
+- lib/rdoc/generator/template/rails/resources/i/results_bg.png
+- lib/rdoc/generator/template/rails/resources/i/tree_bg.png
+- lib/rdoc/generator/template/rails/resources/js/highlight.pack.js
+- lib/rdoc/generator/template/rails/resources/js/jquery-1.3.2.min.js
+- lib/rdoc/generator/template/rails/resources/js/jquery-effect.js
+- 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/sdoc/_context.rhtml
+- lib/rdoc/generator/template/sdoc/_head.rhtml
+- lib/rdoc/generator/template/sdoc/class.rhtml
+- lib/rdoc/generator/template/sdoc/file.rhtml
+- lib/rdoc/generator/template/sdoc/index.rhtml
+- lib/rdoc/generator/template/sdoc/resources/apple-touch-icon.png
+- lib/rdoc/generator/template/sdoc/resources/css/github.css
+- lib/rdoc/generator/template/sdoc/resources/css/main.css
+- lib/rdoc/generator/template/sdoc/resources/css/panel.css
+- lib/rdoc/generator/template/sdoc/resources/css/reset.css
+- lib/rdoc/generator/template/sdoc/resources/favicon.ico
+- lib/rdoc/generator/template/sdoc/resources/i/arrows.png
+- lib/rdoc/generator/template/sdoc/resources/i/results_bg.png
+- lib/rdoc/generator/template/sdoc/resources/i/tree_bg.png
+- lib/rdoc/generator/template/sdoc/resources/js/highlight.pack.js
+- lib/rdoc/generator/template/sdoc/resources/js/jquery-1.3.2.min.js
+- lib/rdoc/generator/template/sdoc/resources/js/jquery-effect.js
+- 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/sdoc_local_editor.rb
+- lib/sdoc_local_editor/generator.rb
+- lib/sdoc_local_editor/github.rb
+- lib/sdoc_local_editor/helpers.rb
+- lib/sdoc_local_editor/merge.rb
+- lib/sdoc_local_editor/templatable.rb
+- sdoc_local_editor.gemspec
+homepage: http://github.com/voloko/sdoc
+licenses: []
+post_install_message: 
+rdoc_options:
+- --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
+signing_key: 
+specification_version: 3
+summary: rdoc html with javascript search index.
+test_files: []
+has_rdoc: