yard-dash 1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzZjMGQ2YzVjN2VmYTliNGIzZWE4OGE4N2I1M2IyNTgwZDBiZTJiMg==
+  data.tar.gz: !binary |-
+    MmUxZDMzZWIxMzhmOWY4ZjRjMjllZDk0NTExNjhkYmU3NTNiMWIzOA==
+SHA512:
+  metadata.gz: !binary |-
+    OWFmNjZiODI1OWE0ZTY0MmNhZGY2MDA0OGQ4MjM2MmNlZTBmNDk3OGUwYTE3
+    YWMwM2FkMDViMGFmMWM2NWM1N2I2YjkwYjA2ODM4N2RhNTAzMWE3ZWVjMzk4
+    ODYwNTI3ZjVjYjBiM2M4NjBmNzg2NjA3NzU0YzFlM2YxNzY0MDI=
+  data.tar.gz: !binary |-
+    ZWFhZjJiZDYxMmRkMDUyZGJjNjk0Y2UwNWY0ZDUwOGUzMGQzNzBhOTUzMDI3
+    ZWYyN2ZkMTM2NWJiMDk4YzY0YWRjYTU2MWFiYmZmOTkwZWU0Y2ZiNDBmMmJl
+    YTZmYTZmN2E4Y2NiNjg2NDcyNWQ1ZDI3OTE0NmMwOTFiZjEzOTQ=

data/README.md

@@ -0,0 +1,26 @@
+# yard-dash
+
+This `yard` plugin will generate a `Dash` **dockset** in addition to the normal HTML directory for a gem. The HTML code is copied from the standard yard source and is unchanged.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yard-dash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yard-dash
+
+## Usage
+
+Just run `yardoc` and the **dockset** will be created on top off the standard HTML tree.
+The name of the gem inside **dockset** will be defined by the name inside the `gemspec` file.
+
+

data/lib/yard-dash/base_helper.rb

@@ -0,0 +1,219 @@
+include YARD
+include Templates
+require "sqlite3"
+
+#
+# Module YardDashHelper provides the logic to create the Dash
+# docset.
+#
+# @author Fred Appelman <fred@appelman.net>
+#
+module YardDashHelper
+
+  # @return [String] The name of the subdirectory in the docset Documents
+  #   directory
+  DOC_DIR = "docs"
+
+  # @return [String] The suffix for a dash docset
+  DOC_SET = ".docset"
+
+  # The tags found during scanning
+  @@docset_data = []
+
+  #
+  # Convert a name as return by the AST parser into a name
+  # suitable for the documentation.
+  # @example
+  #   'GemLogic.gem_lib_dir' => 'GemLogic'
+  # @example
+  #   'PidFile#release' => 'PidFile'
+  # @example
+  #   'XmlSimple::Cache#get_from_memory_cache' => 'XmlSimple/Cache'
+  #
+  # @param [<Yardoc class>,<Yardoc constant>, <Yardoc method>,
+  #   <Yardoc module>] m The class/constant/method/module to convert
+  #
+  # @return [String] The converted name
+  #
+  def transpose(m)
+    base_name = m.to_s.gsub(%r{\..*$},"")
+    base_name = base_name.gsub(%r{#.*$},"")
+    base_name.gsub(%r[::],"/")
+  end
+  private :transpose
+
+
+  #
+  # Return the full HTML path given the class/constant/method or module m.
+  #
+  # @param [<Yardoc class>,<Yardoc constant>, <Yardoc method>,
+  #   <Yardoc module>] m The class/constant/method/module to convert
+  #
+  # @return [String] The full path
+  #
+  def html_path(m)
+    base_name = transpose(m)
+    "#{DOC_DIR}/" + base_name + ".html"
+  end
+  private :html_path
+
+  #
+  # Return the readable name for the supplied class/constant/method
+  # or module m.
+  #
+  # @param [<Yardoc class>,<Yardoc constant>, <Yardoc method>,
+  #   <Yardoc module>] m The class/constant/method/module to convert
+  #
+  # @return [String] The readable path
+  #
+  def name(m)
+    case m.scope
+    when :instance
+      m.to_s.sub(%r{#([^#]*?)$},'.\1')
+    when :class
+      m.to_s
+    else
+      abort("Scope: #{m.scope} unknown")
+    end
+  end
+  private :name
+
+  # Called by the ERB to process all methods in the Registry.
+  #
+  # @return [void]
+  #
+  def all_methods
+    Registry.all(:method).map do |m|
+      t = if m.to_s.match(/^#/)
+        # Top level namespace
+        [name(m), "Method", "#{DOC_DIR}/top-level-namespace.html" + '#' + "#{m.name}-#{m.scope}_method"]
+      else
+        [name(m), "Method", html_path(m) + '#' + "#{m.name}-#{m.scope}_method"]
+      end
+      @@docset_data << t unless @@docset_data.include?(t)
+    end
+  end
+  private :all_methods
+
+
+  # Called by the ERB to process all classes in the Registry.
+  #
+  # @return [void]
+  #
+  def all_classes
+    Registry.all(:class).map do |m|
+      t = [m.to_s, "Class", html_path(m)]
+      @@docset_data << t unless @@docset_data.include?(t)
+    end
+  end
+  private :all_classes
+
+  # Called by the ERB to process all modules in the Registry.
+  #
+  # @return [void]
+  #
+  def all_modules
+    Registry.all(:module).map do |m|
+      t = [m.to_s, "Module", html_path(m)]
+      @@docset_data << t unless @@docset_data.include?(t)
+    end
+  end
+  private :all_modules
+
+  # Called by the ERB to process all constants in the Registry.
+  #
+  # @return [void]
+  #
+  def all_constants
+    Registry.all(:constant).map do |m|
+      # This is an example of a constant:
+      #    Vlogger::Severity::SEVERITY_TO_COLOR
+      # The name of the constant is as above. The name of the file
+      # is the Vlogger/Severity.html
+      t = [m.to_s, "Constant", "#{DOC_DIR}/" + transpose(m).sub(%r{/[^/]*?$},"") + ".html"]
+      @@docset_data << t unless @@docset_data.include?(t)
+    end
+  end
+  private :all_constants
+
+  #
+  # Return a plist as a string
+  #
+  # @param [String] package The name of the package
+  #
+  # @return [String] The plist
+  #
+  def plist(package)
+    <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+  <key>CFBundleIdentifier</key>
+  <string>#{package}</string>
+  <key>CFBundleName</key>
+  <string>#{package}</string>
+  <key>DocSetPlatformFamily</key>
+  <string>ruby</string>
+  <key>isDashDocset</key>
+  <true/>
+</dict>
+</plist>
+      XML
+  end
+  private :plist
+
+  #
+  # Write the docset
+  #
+  # @return [void]
+  #
+  def write_docset
+    gemspecs = Dir[%q{*.gemspec}]
+    abort("Cannot find gemspec file") if gemspecs.size == 0
+    abort("Too many gemspec files ") if gemspecs.size > 1
+    package = gemspecs.shift.gsub(".gemspec",'')
+    target = package + ".docset"
+    # Remove the previous content
+    FileUtils.rm_rf(target) if Dir.exist?(target)
+    # Create the docset
+    FileUtils.mkdir_p(target)
+    FileUtils.mkdir_p(target + '/' + 'Contents/Resources/Documents/')
+    # Create Info.plist file
+    plist = plist(package)
+    File.open(target + '/Contents/Info.plist', 'w+') { |file| file.write plist }
+    # Copy the doc directory
+    new_doc_path  = target + '/Contents/Resources/Documents/'
+    FileUtils.cp_r "doc", new_doc_path
+    FileUtils.mv File.join(new_doc_path,"doc"), File.join(new_doc_path,"docs")
+    # Create the database
+    @db = SQLite3::Database.new(target + '/Contents/Resources/docSet.dsidx')
+    @db.execute('CREATE TABLE searchIndex(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT)')
+    @db.execute('CREATE UNIQUE INDEX anchor ON searchIndex (name, type, path)')
+    # Add the methods, classes, modules and constants
+    @@docset_data.each do |docset_element|
+      @db.execute("insert into searchIndex (name, type, path) VALUES(?, ?, ?)",*docset_element)
+    end
+  end
+  private :write_docset
+
+
+  #
+  # Process all constants, classes, methods and modules and
+  # write the docset.
+  #
+  # @return [<type>] <description>
+  #
+  def do_dash
+    all_constants
+    all_classes
+    all_methods
+    all_modules
+    write_docset
+  end
+
+end
+
+
+
+

data/lib/yard-dash/setup.rb

@@ -0,0 +1,58 @@
+require "tmpdir"
+
+#
+# Module YardDashSetup provides the setup logic for yard-dash
+#
+# @author Fred Appelman <fred@appelman.net>
+#
+module YardDashSetup
+  module_function
+
+  #
+  # @return [String] The file in the yad package that needs patching
+  ERB = 'full_list.erb'
+
+  #
+  # Create a temporary directory. This directory is constant
+  # during a run and is removed when the application exits.
+  #
+  #
+  # @return [String] The name of the created directory
+  #
+  def tmpdir
+    @tmpdir ||= begin
+      Dir.mktmpdir
+    end
+  end
+
+
+  #
+  # Setup the override of the erb file. We copy one file from
+  # the standard yard directory and copy that file to a temporary
+  # directory after which the copied file is patched. A few hooks
+  # that trigger the logic in the base_helper file.
+  #
+  #
+  # @return [void]
+  #
+  def setup_override
+    spec = Gem::Specification.find_by_name 'yard'
+    erb = File.join(spec.gem_dir,"templates","default","fulldoc","html",ERB)
+    # Create the subdirectory structure
+    subdir = File.join(tmpdir,"default","fulldoc","html")
+    FileUtils.mkdir_p subdir
+    # Copy the erb
+    target_file = File.join(subdir,ERB)
+    FileUtils.cp(erb,target_file)
+    # Open the file and add the anchors
+    open(target_file,'a') do |file|
+      file.write "<% do_dash %>\n"
+    end
+  end
+
+  # Remove the directory at the end of the run
+  END {
+    # Remove the temp directory
+    FileUtils.rm_rf tmpdir
+  }
+end

data/lib/yard-dash/version.rb

@@ -0,0 +1,11 @@
+#
+# Module Yard-dashVersion provides a version number
+# for the application 'yard-dash''
+#
+# @author Fred Appelman <fred@appelman.net>
+#
+module YardDashVersion
+  #
+  # @return [String] The application version number
+  NUMBER = "1.0"
+end

data/lib/yard-dash.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+
+require "yard-dash/setup"
+require "yard-dash/base_helper"
+require "yard-dash/version"
+
+# Setup the yard-dash override directory
+YardDashSetup::setup_override
+# Add the template helper
+Template.extra_includes << YardDashHelper
+# Override the default template for the given file
+YARD::Templates::Engine.register_template_path YardDashSetup::tmpdir
+

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: yard-dash
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Fred Appelman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-17 00:00:00.000000000 Z
+dependencies: []
+description: Yard-dash generates a docset for Dash
+email: fred@appelman.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/yard-dash.rb
+- lib/yard-dash/base_helper.rb
+- lib/yard-dash/setup.rb
+- lib/yard-dash/version.rb
+homepage: http://fred.appelman.net
+licenses:
+- (c) Fred Appelman
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Generate beside the standard HTML documentation a docset to be used by Dash
+  from the standard yard inline documentation.
+test_files: []
+has_rdoc: false