docurium 0.6.0 → 0.7.0

data/test/docurium_test.rb

@@ -9,15 +9,6 @@ class DocuriumTest < Minitest::Test
 
     @repo = Rugged::Repository.init_at(@dir, :bare)
 
-    config = <<END
-{
- "name":   "libgit2",
- "github": "libgit2/libgit2",
- "prefix": "git_",
- "branch": "gh-pages"
-}
-END
-
     # Create an index as we would have read from the user's repository
     index = Rugged::Index.new
     headers = File.dirname(__FILE__) + '/fixtures/git2/'
@@ -29,7 +20,7 @@ END
     end
 
     @path = File.dirname(__FILE__) + '/fixtures/git2/api.docurium'
-    @doc = Docurium.new(@path, @repo)
+    @doc = Docurium.new(@path, {}, @repo)
     @data = @doc.parse_headers(index, 'HEAD')
   end
 
@@ -37,6 +28,13 @@ END
     FileUtils.remove_entry(@dir)
   end
 
+  def test_can_parse
+    refute_nil @data
+    assert_equal [:files, :functions, :callbacks, :globals, :types, :prefix, :groups], @data.keys
+    files = %w(blob.h callback.h cherrypick.h commit.h common.h errors.h index.h object.h odb.h odb_backend.h oid.h refs.h repository.h revwalk.h signature.h tag.h tree.h types.h)
+    assert_equal files, @data[:files].map {|d| d[:file] }
+  end
+
   def test_can_parse_headers
     keys = @data.keys.map { |k| k.to_s }.sort
     assert_equal ['callbacks', 'files', 'functions', 'globals', 'groups', 'prefix', 'types'], keys
@@ -61,7 +59,7 @@ END
   end
 
   def test_can_find_type_usage
-    oid = @data[:types].assoc('git_oid')
+    oid = @data[:types].find {|a| a[0] == 'git_oid' }
     oid_returns = [
       "git_commit_id",
       "git_commit_parent_oid",
@@ -161,11 +159,50 @@ END
     assert_equal 'int (*)(const char *, void *)', func[:args][2][:type]
     assert_equal 'Function which will be called for every listed ref', func[:args][2][:comment]
     expect_comment =<<-EOF
-    <p>The listed references may be filtered by type, or using a bitwise OR of several types. Use the magic value <code>GIT_REF_LISTALL</code> to obtain all references, including packed ones.</p>
-
-    <p>The <code>callback</code> function will be called for each of the references in the repository, and will receive the name of the reference and the <code>payload</code> value passed to this method.</p>
+<p>The listed references may be filtered by type, or using
+ a bitwise OR of several types. Use the magic value
+ <code>GIT_REF_LISTALL</code> to obtain all references, including
+ packed ones.</p>
+
+<p>The <code>callback</code> function will be called for each of the references
+ in the repository, and will receive the name of the reference and
+ the <code>payload</code> value passed to this method.</p>
     EOF
-    assert_equal expect_comment.split("\n").map(&:strip), func[:comments].split("\n")
+    assert_equal expect_comment.split("\n"), func[:comments].split("\n")
+  end
+
+  def test_can_handle_bulleted_lists
+    type = @data[:types].find {|name, data| name == 'git_repository_init_options' }
+    refute_nil type
+    expect_comment = <<-EOF
+<p>This contains extra options for <code>git_repository_init_ext</code> that enable
+ additional initialization features.  The fields are:</p>
+
+<ul>
+<li>flags - Combination of GIT_REPOSITORY_INIT flags above.</li>
+<li>mode  - Set to one of the standard GIT_REPOSITORY_INIT_SHARED_...
+    constants above, or to a custom value that you would like.</li>
+<li>workdir_path - The path to the working dir or NULL for default (i.e.
+    repo_path parent on non-bare repos).  IF THIS IS RELATIVE PATH,
+    IT WILL BE EVALUATED RELATIVE TO THE REPO_PATH.  If this is not
+    the &quot;natural&quot; working directory, a .git gitlink file will be
+    created here linking to the repo_path.</li>
+<li>description - If set, this will be used to initialize the &quot;description&quot;
+    file in the repository, instead of using the template content.</li>
+<li>template_path - When GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE is set,
+    this contains the path to use for the template directory.  If
+    this is NULL, the config or default directory options will be
+    used instead.</li>
+<li>initial_head - The name of the head to point HEAD at.  If NULL, then
+    this will be treated as &quot;master&quot; and the HEAD ref will be set
+    to &quot;refs/heads/master&quot;.  If this begins with &quot;refs/&quot; it will be
+    used verbatim; otherwise &quot;refs/heads/&quot; will be prefixed.</li>
+<li>origin_url - If this is non-NULL, then after the rest of the
+    repository initialization is completed, an &quot;origin&quot; remote
+    will be added pointing to this URL.</li>
+</ul>
+EOF
+    assert_equal expect_comment, type[1][:comments]
   end
 
   def test_can_get_the_full_description_from_multi_liners

data/test/fixtures/git2/cherrypick.h

@@ -15,3 +15,5 @@ GIT_BEGIN_DECL
 GIT_EXTERN(int) git_cherrypick(char *input);
 
 GIT_END_DECL
+
+#endif

data/test/fixtures/git2/common.h

@@ -28,6 +28,7 @@
 #include "thread-utils.h"
 #include <time.h>
 #include <stdlib.h>
+#include <stdint.h>
 
 #ifdef __cplusplus
 # define GIT_BEGIN_DECL  extern "C" {
@@ -39,12 +40,6 @@
 # define GIT_END_DECL    /* empty */
 #endif
 
-/*
- * libclang won't consider anything with size_t to have comments unless we use
- * this hack.
- */
-typedef size_t size_t;
-
 /** Declare a public function exported for application use. */
 #ifdef __GNUC__
 # define GIT_EXTERN(type) extern \

data/test/fixtures/git2/repository.h

@@ -212,6 +212,45 @@ GIT_EXTERN(const char *) git_repository_path(git_repository *repo);
  */
 GIT_EXTERN(const char *) git_repository_workdir(git_repository *repo);
 
+/**
+ * Extended options structure for `git_repository_init_ext`.
+ *
+ * This contains extra options for `git_repository_init_ext` that enable
+ * additional initialization features.  The fields are:
+ *
+ * * flags - Combination of GIT_REPOSITORY_INIT flags above.
+ * * mode  - Set to one of the standard GIT_REPOSITORY_INIT_SHARED_...
+ *        constants above, or to a custom value that you would like.
+ * * workdir_path - The path to the working dir or NULL for default (i.e.
+ *        repo_path parent on non-bare repos).  IF THIS IS RELATIVE PATH,
+ *        IT WILL BE EVALUATED RELATIVE TO THE REPO_PATH.  If this is not
+ *        the "natural" working directory, a .git gitlink file will be
+ *        created here linking to the repo_path.
+ * * description - If set, this will be used to initialize the "description"
+ *        file in the repository, instead of using the template content.
+ * * template_path - When GIT_REPOSITORY_INIT_EXTERNAL_TEMPLATE is set,
+ *        this contains the path to use for the template directory.  If
+ *        this is NULL, the config or default directory options will be
+ *        used instead.
+ * * initial_head - The name of the head to point HEAD at.  If NULL, then
+ *        this will be treated as "master" and the HEAD ref will be set
+ *        to "refs/heads/master".  If this begins with "refs/" it will be
+ *        used verbatim; otherwise "refs/heads/" will be prefixed.
+ * * origin_url - If this is non-NULL, then after the rest of the
+ *        repository initialization is completed, an "origin" remote
+ *        will be added pointing to this URL.
+ */
+typedef struct {
+	unsigned int version;
+	uint32_t    flags;
+	uint32_t    mode;
+	const char *workdir_path;
+	const char *description;
+	const char *template_path;
+	const char *initial_head;
+	const char *origin_url;
+} git_repository_init_options;
+
 /** @} */
 GIT_END_DECL
 #endif

data/test/fixtures/git2/types.h

@@ -25,6 +25,8 @@
 #ifndef INCLUDE_git_types_h__
 #define INCLUDE_git_types_h__
 
+#include "common.h"
+
 /**
  * @file git2/types.h
  * @brief libgit2 base & compatibility types

data/test/parser_test.rb

@@ -4,13 +4,17 @@ require 'pp'
 
 class ParserTest < Minitest::Test
 
-  def setup
-    @parser = Docurium::DocParser.new
+  def teardown
+    @parser.cleanup! if @parser
   end
 
   # e.g. parse('git2/refs.h')
+  # contents is either a string (the contents of "path")
+  # or a hash of paths => contents
   def parse(path, contents)
-    @parser.parse_file(path, [[path, contents]])
+    contents = [[path, contents]] if contents.is_a? String
+    @parser = Docurium::DocParser.new(contents)
+    @parser.parse_file(path)
   end
 
   def test_single_function
@@ -122,7 +126,7 @@ EOF
 GIT_EXTERN(int) some_public_function(int val);
 EOF
 
-    actual = @parser.parse_file(name_b, [[name_a, contents_a], [name_b, contents_b]])
+    actual = parse(name_b, [[name_a, contents_a], [name_b, contents_b]])
     # "Fix" the path so we remove the temp dir
     actual[0][:file] = File.split(actual[0][:file])[-1]
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: docurium
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Carlos Martín Nieto
 - Scott Chacon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-18 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version_sorter
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -109,20 +109,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -146,8 +160,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENCE
 - README.md
@@ -159,6 +173,7 @@ files:
 - lib/docurium/cli.rb
 - lib/docurium/cparser.rb
 - lib/docurium/css.css
+- lib/docurium/debug.rb
 - lib/docurium/docparser.rb
 - lib/docurium/layout.mustache
 - lib/docurium/layout.rb
@@ -211,7 +226,7 @@ homepage: https://github.com/libgit2/docurium
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -226,9 +241,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: A simpler, prettier Doxygen replacement.
 test_files: []

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-dist: xenial
-addons:
-  apt:
-    packages:
-      - libclang-6.0-dev
-      - llvm-6.0
-rvm:
- - ruby-2.4
- - ruby-2.5
- - ruby-head
-
-env:
- - LLVM_CONFIG=llvm-config-6.0