rdocjson 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f24a44ad54f006f588f5205998ba8b146613d0723a6f064425cddcf2b9ea685f
+  data.tar.gz: 5eb1ed1f2994bbc9bebedff15f5a4886b9c65ad3a88e465326d29e387da8aeae
+SHA512:
+  metadata.gz: aa4eca088c8afc2d100c7aafab784699637b4901f638f12d6b79ff1ead7063ab84e4f68aae2152810e47b76d35d92a8adaaba6a6564f25a1db64917e9fb3c7f5
+  data.tar.gz: 16af7a36c9c99811dbfc47ffaa2e601965128426b2d814d38e2d9b09d36c36b9bb7f6529385e6892c4d3f13151815dec4b6565403e16483d215d642035fabd8d

data/lib/rdoc/discover.rb

@@ -0,0 +1 @@
+require_relative "generator/rdocjson"

data/lib/rdoc/generator/rdocjson.rb

@@ -0,0 +1,110 @@
+gem "rdoc"
+
+require "pathname"
+require "fileutils"
+require "rdoc/rdoc"
+require "rdoc/generator"
+require "json"
+
+class RDoc::Generator::RDocJSON
+  include FileUtils
+
+  RDoc::RDoc.add_generator(self)
+
+  # Instanciates this generator. Automatically called
+  # by RDoc.
+  # ==Parameter
+  # [options]
+  #   RDoc passed the current RDoc::Options instance.
+  def initialize(store, options)
+    @store   = store
+    @options = options
+    @op_dir  = Pathname.pwd.expand_path + @options.op_dir
+  end
+
+  # Outputs a string on standard output, but only if RDoc
+  # was invoked with the <tt>--debug</tt> switch.
+  def debug(str)
+    puts(str) if $DEBUG_RDOC
+  end
+
+  # Main hook method called by RDoc, triggers the generation process.
+  def generate
+    debug "Sorting classes, modules, and methods..."
+
+    @toplevels = @store.all_files
+
+    @classes_and_modules = @store.all_classes_and_modules.sort_by do |klass|
+      klass.full_name
+    end
+
+    @methods = @classes_and_modules.map do |mod|
+      mod.method_list
+    end.flatten.sort
+
+    # Create the output directory
+    mkdir @op_dir unless @op_dir.exist?
+
+    generate_json_file
+  end
+
+  # Darkfish returns +nil+, hence we do this as well.
+  def file_dir
+    nil
+  end
+
+  # Darkfish returns +nil+, hence we do this as well.
+  def class_dir
+    nil
+  end
+
+  def generate_json_file
+    json = {}
+
+    json["toplevels"] = @toplevels.map do |toplevel|
+      {
+        name: toplevel.name,
+        description: toplevel.description
+      }
+    end
+
+    json["classes_and_modules"] = @classes_and_modules.map do |classmod|
+      {
+        name: classmod.full_name,
+        superclass: classmod.module? ? "" : classmod.superclass,
+        method_list: classmod.each_method.to_a.map do |method|
+          { name: method.pretty_name }
+        end,
+        description: classmod.description,
+        includes: classmod.includes.map do |included|
+          { name: included.full_name }
+        end,
+        constants: classmod.constants.map do |const|
+          {
+            name: const.name,
+            value: const.value,
+            description: const.description
+          }
+        end,
+        attributes: classmod.attributes.map do |attribute|
+          {
+            name: attribute.name,
+            description: attribute.description
+          }
+        end
+      }
+    end
+
+    json["methods"] = @methods.map do |method|
+      {
+        type: method.type,
+        visibility: method.visibility,
+        arglists: method.arglists,
+        description: method.description,
+        markup_code: method.markup_code,
+      }
+    end
+
+    File.write(@op_dir + "all.json", JSON.pretty_generate(json))
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: rdocjson
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dorian Marié
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description:
+email: dorian@dorianmarie.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/rdocjson.rb
+homepage: https://github.com/dorianmariefr/rdocjson
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: JSON from RDoc
+test_files: []