docrb 0.2.0

data/lib/docrb.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "parser/current"
+require "forwardable"
+require "json"
+require "redcarpet"
+require "rouge"
+require "rouge/plugins/redcarpet"
+require "rubygems"
+
+Parser::Builders::Default.emit_lambda              = true
+Parser::Builders::Default.emit_procarg0            = true
+Parser::Builders::Default.emit_encoding            = true
+Parser::Builders::Default.emit_index               = true
+Parser::Builders::Default.emit_arg_inside_procarg0 = true
+Parser::Builders::Default.emit_forward_arg         = true
+Parser::Builders::Default.emit_kwargs              = true
+Parser::Builders::Default.emit_match_pattern       = true
+
+require_relative "docrb/version"
+require_relative "docrb/ruby_parser"
+require_relative "docrb/module_extensions"
+
+# Docrb implements a source and documentation parser for Ruby projects
+module Docrb
+  # Error class from which all other Docrb errors derive from
+  class Error < StandardError; end
+
+  autoload :CommentParser, "docrb/comment_parser"
+  autoload :DocCompiler, "docrb/doc_compiler"
+  autoload :Resolvable, "docrb/resolvable"
+  autoload :Markdown, "docrb/markdown"
+  autoload :Spec, "docrb/spec"
+
+  # Public: Parses a single file under a provided path
+  #
+  # path - Path to the file to be parsed
+  #
+  # Returns an object representing the parsed source and documentation
+  def self.parse(path)
+    inst = RubyParser.new(path)
+    inst.parse
+    inst
+  end
+
+  # Public: Parses a given input folder recursivelly and returns all sources
+  # and documentations
+  #
+  # inp - Folder to be parsed. Finds all .rb files recursivelly from this path.
+  #
+  # Returns an array with all parsed files
+  def self.parse_folder(inp)
+    output = []
+    Dir["#{inp}/**/*.rb"].each do |f|
+      inst = parse(f)
+      inst.classes.each do |c|
+        c[:filename] = f
+        output << c
+      end
+      inst.modules.each do |c|
+        c[:filename] = f
+        output << c
+      end
+      inst.methods.each do |c|
+        c[:filename] = f
+        output << c
+      end
+    end
+    output
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: docrb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Victor Gama
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docrb-html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: An opinionated documentation parser
+email:
+- hey@vito.io
+executables:
+- docrb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/console
+- bin/json
+- bin/md
+- bin/setup
+- docrb.gemspec
+- exe/docrb
+- lib/docrb.rb
+- lib/docrb/comment_parser.rb
+- lib/docrb/comment_parser/code_example_block.rb
+- lib/docrb/comment_parser/code_example_parser.rb
+- lib/docrb/comment_parser/field_block.rb
+- lib/docrb/comment_parser/field_list_parser.rb
+- lib/docrb/comment_parser/text_block.rb
+- lib/docrb/doc_compiler.rb
+- lib/docrb/doc_compiler/base_container.rb
+- lib/docrb/doc_compiler/base_container/computations.rb
+- lib/docrb/doc_compiler/doc_attribute.rb
+- lib/docrb/doc_compiler/doc_blocks.rb
+- lib/docrb/doc_compiler/doc_class.rb
+- lib/docrb/doc_compiler/doc_method.rb
+- lib/docrb/doc_compiler/doc_module.rb
+- lib/docrb/doc_compiler/file_ref.rb
+- lib/docrb/doc_compiler/object_container.rb
+- lib/docrb/markdown.rb
+- lib/docrb/module_extensions.rb
+- lib/docrb/resolvable.rb
+- lib/docrb/ruby_parser.rb
+- lib/docrb/spec.rb
+- lib/docrb/version.rb
+homepage: https://github.com/heyvito/docrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/heyvito/docrb
+  source_code_uri: https://github.com/heyvito/docrb/tree/trunk/lib/docrb
+  changelog_uri: https://github.com/heyvito/docrb
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.2
+signing_key:
+specification_version: 4
+summary: An opinionated documentation parser
+test_files: []