docurium 0.4.1 → 0.7.0

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: docurium
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Carlos Martín Nieto
 - Scott Chacon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version_sorter
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.99'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.99'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rocco
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -101,42 +101,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
+        version: '1.20'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.20'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '5.11'
 description: A simpler, prettier Doxygen replacement.
 email:
 - cmn@dwim.me
@@ -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
@@ -183,9 +198,11 @@ files:
 - site/shared/images/next_step_arrow.gif
 - site/shared/images/qmark.png
 - site/shared/js/jquery.js
+- test/docurium_test.rb
 - test/fixtures/git2/api.docurium
 - test/fixtures/git2/blob.h
 - test/fixtures/git2/callback.h
+- test/fixtures/git2/cherrypick.h
 - test/fixtures/git2/commit.h
 - test/fixtures/git2/common.h
 - test/fixtures/git2/errors.h
@@ -204,13 +221,12 @@ files:
 - test/fixtures/git2/types.h
 - test/gen_test.rb
 - test/parser_test.rb
-- test/repo_test.rb
 - test/test_helper.rb
 homepage: https://github.com/libgit2/docurium
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,9 +241,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: A simpler, prettier Doxygen replacement.
 test_files: []

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-rvm:
- - ruby-2.0
- - ruby-2.1
- - ruby-head
- - rbx
-
-env:
- - LLVM_CONFIG=llvm-config-3.3
-
-before_install:
- - sudo apt-get update
- - sudo apt-get install libclang-3.3-dev llvm-3.3

data/test/repo_test.rb

@@ -1,136 +0,0 @@
-require 'minitest/autorun'
-require 'docurium'
-require 'rugged'
-
-class DocuriumTest < MiniTest::Unit::TestCase
-
-  def setup
-    @dir = Dir.mktmpdir()
-
-    @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/'
-    Dir.entries(headers).each do |rel_path|
-      path = File.join(headers, rel_path)
-      next if File.directory? path
-      id = @repo.write(File.read(path), :blob)
-      index.add(:path => rel_path, :oid => id, :mode => 0100644)
-    end
-
-    @path = File.dirname(__FILE__) + '/fixtures/git2/api.docurium'
-    @doc = Docurium.new(@path, @repo)
-    @data = @doc.parse_headers(index, 'HEAD')
-  end
-
-  def teardown
-    FileUtils.remove_entry(@dir)
-  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
-    assert_equal 154, @data[:functions].size
-  end
-
-  def test_can_extract_enum_from_define
-    skip("this isn't something we do")
-    assert_equal 41, @data[:globals].size
-    idxentry = @data[:types].find { |a| a[0] == 'GIT_IDXENTRY' }
-    assert idxentry
-    assert_equal 75, idxentry[1][:lineto]
-    # this one is on the last doc block
-    assert idxentry[1][:block].include? 'GIT_IDXENTRY_EXTENDED2'
-    # from an earlier block, should not get overwritten
-    assert idxentry[1][:block].include? 'GIT_IDXENTRY_UPDATE'
-  end
-
-  def test_can_extract_structs_and_enums
-    skip("we don't auto-create enums, so the number is wrong")
-    assert_equal 25, @data[:types].size
-  end
-
-  def test_can_find_type_usage
-    oid = @data[:types].assoc('git_oid')
-    assert_equal 10, oid[1][:used][:returns].size
-    assert_equal 39, oid[1][:used][:needs].size
-  end
-
-  def test_can_parse_normal_functions
-    func = @data[:functions]['git_blob_rawcontent']
-    assert_equal "<p>Get a read-only buffer with the raw content of a blob.</p>\n",  func[:description]
-    assert_equal 'const void *',  func[:return][:type]
-    assert_equal ' the pointer; NULL if the blob has no contents',  func[:return][:comment]
-    assert_equal 84,              func[:line]
-    assert_equal 84,              func[:lineto]
-    assert_equal 'blob.h',        func[:file]
-    assert_equal 'git_blob *blob',func[:argline]
-    assert_equal 'blob',          func[:args][0][:name]
-    assert_equal 'git_blob *',    func[:args][0][:type]
-    assert_equal 'pointer to the blob',  func[:args][0][:comment]
-  end
-
-  def test_can_parse_defined_functions
-    func = @data[:functions]['git_tree_lookup']
-    assert_equal 'int',     func[:return][:type]
-    assert_equal ' 0 on success; error code otherwise',     func[:return][:comment]
-    assert_equal 50,        func[:line]
-    assert_equal 'tree.h',  func[:file]
-    assert_equal 'id',               func[:args][2][:name]
-    assert_equal 'const git_oid *',  func[:args][2][:type]
-    assert_equal 'identity of the tree to locate.',  func[:args][2][:comment]
-  end
-
-  def test_can_parse_function_cast_args
-    func = @data[:functions]['git_reference_listcb']
-    assert_equal 'int',             func[:return][:type]
-    assert_equal ' 0 on success; error code otherwise',  func[:return][:comment]
-    assert_equal 321,               func[:line]
-    assert_equal 'refs.h',          func[:file]
-    assert_equal 'repo',              func[:args][0][:name]
-    assert_equal 'git_repository *',  func[:args][0][:type]
-    assert_equal 'list_flags',      func[:args][1][:name]
-    assert_equal 'unsigned int',    func[:args][1][:type]
-    assert_equal 'callback',        func[:args][2][:name]
-    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]
-    assert_equal 8, func[:comments].split("\n").size
-  end
-
-  def test_can_get_the_full_description_from_multi_liners
-    func = @data[:functions]['git_commit_create_o']
-    desc = "<p>Create a new commit in the repository using <code>git_object</code>\n instances as parameters.</p>\n"
-    assert_equal desc, func[:description]
-  end
-
-  def test_can_group_functions
-    assert_equal 15, @data[:groups].size
-    group, funcs = @data[:groups].first
-    assert_equal 'blob', group
-    assert_equal 6, funcs.size
-  end
-
-  def test_can_store_mutliple_enum_doc_sections
-    skip("this isn't something we do")
-    idxentry = @data[:types].find { |a| a[0] == 'GIT_IDXENTRY' }
-    assert idxentry, "GIT_IDXENTRY did not get automatically created"
-    assert_equal 2, idxentry[1][:sections].size
-  end
-
-  def test_can_parse_callback
-    cb = @data[:callbacks]['git_callback_do_work']
-    # we can mostly assume that the rest works as it's the same as for the functions
-    assert_equal 'int', cb[:return][:type]
-  end
-
-end