documented 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5026a405923100cfe8ea3f484fe324b3588a3481369fd954b7d5645537227672
+  data.tar.gz: b9d86b71d1a7dfc1018edc79922a54fd2013245d95c17eb9d902d5dd8160f100
+SHA512:
+  metadata.gz: 55480519881df342fcbff4d0b7ea3b7aef9a6ca96805c3eb18283faf3f43b3e83d8e3df00219310e75293123fd801993848630a7c446626407812b745ae6c896
+  data.tar.gz: 994c10ccf460e023790c8caaa4198f5bf63f06b41b6ebebefc604b1752af27f1d4610d3f62297f08f0e124f62d7a1786af8ad16e2e9e8e5e31d1bb86db269df4

data/lib/accessor.rb

@@ -0,0 +1,31 @@
+################################################################################
+# Access variables via one object to avoid polluting the caller's scope.
+#
+# @pattern Singleton
+################################################################################
+
+module Documented
+  class Accessor
+    attr_accessor :initialized
+    attr_accessor :error
+
+    attr_accessor :config
+    attr_accessor :renderer
+
+    attr_accessor :package_path
+    attr_accessor :project_path
+    attr_accessor :output_path
+
+    def initialize()
+      @initialized = false
+      @error = nil
+
+      @config = nil
+      @renderer = nil
+
+      @package_path = nil
+      @project_path = nil
+      @output_path = nil
+    end
+  end
+end

data/lib/config.rb

@@ -0,0 +1,46 @@
+module Documented
+  class Config
+    attr_accessor :blocklist
+    attr_accessor :duplicates
+    attr_accessor :project_path
+    attr_accessor :output_directory
+
+    def initialize()
+      @blocklist = [
+        '#<Class:Bundler',
+        '#<Class:#<Class',
+        '#<Class:0x0000',
+        '#<Class:Cucumber',
+        '#<Class:JSON>',
+        '#<Class:Net::',
+        '#<Class:Time',
+        '#<Class:URI::Generic>',
+        '#<Class:URI>',
+        '#<Module',
+        '#<refinement',
+        'BasicSocket',
+        'Bundler',
+        'Cucumber',
+        'Datadog',
+        'Float',
+        'Helpers',
+        'Integer',
+        'Kernel',
+        'Net::',
+        'NilClass',
+        'Set',
+        'Thread',
+        'Timeout::Request',
+        'TracePoint',
+        'URI::',
+        'URI::Generic',
+      ]
+
+      # An absolute path to the project root directory. Defaults to current execution path.
+      @project_path = Dir.pwd
+
+      # Name of output directory.
+      @output_directory = "documented"
+    end
+  end
+end

data/lib/documented.rb

@@ -0,0 +1,82 @@
+require 'set'
+require 'erb'
+
+require_relative 'accessor'
+require_relative 'config'
+require_relative 'renderer'
+
+module Documented
+  def documented
+    events = []
+    calls = ['Start']
+  
+    trace = TracePoint.new(:call, :return) do |tp|
+      # file = File.open("#{__dir__}/../../doc/diagrams/input.mmd")
+      # file.write("sequenceDiagram\n")
+  
+      # file.close
+      caller = calls.last.to_s
+      callee = tp.defined_class.to_s
+      event = tp.event
+  
+      unless blocklist.any? { |e| callee.to_s.start_with? e }
+        unless calls.last == callee
+          if event == :return
+            calls.pop
+          elsif calls.last != callee
+            calls << callee
+          end
+        end
+  
+        unless callee == caller
+          caller = caller.gsub('::','.')
+          callee = callee.gsub('::','.')
+          p "#{caller}->>#{callee}: #{tp.method_id}"
+        end
+      end
+    end
+  
+    trace.enable
+  
+    yield
+  
+    trace.disable
+  
+    ap events
+  end
+
+  def self.configure
+    documented_setup_class()
+
+    yield(@@documented.config)
+  end
+
+  def self.included(base)
+    documented_setup_class()
+  end
+
+  private
+
+  ##
+  # Setup class.
+  #
+  # @paths
+  #   - package_path [String] Absolute path to the library itself.
+  #   - project_path [String] Absolute path to the project root.
+  #   - output_path [String] Absolute path to the documented directory.
+  ##
+  def self.documented_setup_class()
+    @@documented = Accessor.new()
+    @@documented.config = Config.new()
+
+    # Setup paths.
+    @@documented.package_path = File.dirname(File.realpath(__FILE__))
+    @@documented.project_path = @@documented.config.project_path
+    @@documented.output_path = File.join(@@documented.project_path, @@documented.config.output_directory)
+    unless Dir.exist? @@documented.output_path
+      Dir.mkdir(@@documented.output_path)
+    end
+
+    @@documented.renderer = Renderer.new(@@documented.package_path, @@documented.output_path)
+  end
+end

data/lib/output/README.md

@@ -0,0 +1,3 @@
+# Documented
+
+As you test the application documentation will be added to `/documented`.

data/lib/output/gitignore.txt

@@ -0,0 +1,2 @@
+.gitignore
+README.md

data/lib/renderer.rb

@@ -0,0 +1,27 @@
+module Documented
+  class Renderer
+    def initialize(package_path, output_path)
+      @package_path = package_path
+      @output_path = output_path
+    end
+
+    # Place files in output path.
+    def render()
+      filenames = [
+        "README.md",
+      ]
+
+      filenames.each do |filename|
+        file = File.read(File.join(@package_path, "output", filename))
+        File.open(File.join(@output_path, filename), 'w+') do |f|
+          f.write file
+        end
+      end
+
+      file = File.read(File.join(@package_path, "output", "gitignore.txt"))
+      File.open(File.join(@output_path, ".gitignore"), 'w+') do |f|
+        f.write file
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: documented
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Maedi Prichard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Documentation that's completely automated.
+email: maediprichard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/accessor.rb
+- lib/config.rb
+- lib/documented.rb
+- lib/output/README.md
+- lib/output/gitignore.txt
+- lib/renderer.rb
+homepage: https://github.com/greensync/documented
+licenses:
+- MPL-2.0
+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.4.10
+signing_key:
+specification_version: 4
+summary: Automated documentation.
+test_files: []