docurium 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: de4d14a126896d40e80233637c2d761a962c6b5e
-  data.tar.gz: a84683f848370319cbdd40829cc7f12d4801fc92
+SHA256:
+  metadata.gz: 254c929d02d15703e7a653b44957e8a6e57dfadb3a0d2b62a419e31f44e8cda1
+  data.tar.gz: 9dc4b04e2e9b705448e3ff50bb4480fb5fd5466472dcf24a6b2823fdcaf9219d
 SHA512:
-  metadata.gz: 4e05fecc1654f57f2d21c4cf68e54bb87d850eaa4ae84f8d84dbc077b7a694079e49b328839c4d27620d90e3fcecce8229e188d30fb6905b1b2a6580fa78508d
-  data.tar.gz: 7111cfbab6de0b9987e314a065495e80cd9726f5e6e1d637199170b4d0bd7aefafdf20ff2b0fcad3aeaee767475f7f29a050ac1f981adf01dd45fab01ace6120
+  metadata.gz: 60e0579913e6f55fc4d34b5c0858cdaca36948425419a5023f080c4903ad1ad22ae62b53c338beee74247654d21400527c3d95cc96a7b4d5ca6b9e5a7110007b
+  data.tar.gz: cb64247b31745da479be5599fcf04f8b02a6337ea4e4867acee517b424a9492b1f9cec04b7cf594fa1161008fcf4f7db31c7a9527992f94fdbfb88aa2582d519

data/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
+dist: xenial
+addons:
+  apt:
+    packages:
+      - libclang-6.0-dev
+      - llvm-6.0
 rvm:
- - ruby-2.0
- - ruby-2.1
+ - ruby-2.4
+ - ruby-2.5
  - 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
+ - LLVM_CONFIG=llvm-config-6.0

data/Gemfile

@@ -1,11 +1,9 @@
 source "http://rubygems.org"
 
 platforms :rbx do
-  gem 'rubysl', '~> 2.0'
+  gem 'rubysl', '~> 2.2'
 end
 
 gemspec
 
-gem 'ffi-clang', :git => 'https://github.com/ioquatix/ffi-clang.git'
-
 # vim:ft=ruby

data/bin/cm

@@ -13,6 +13,7 @@ version Docurium::Version
 desc 'Generate HTML documentation'
 long_desc 'Generate HTML docs from a Docurium config file'
 command :doc do |c|
+  c.flag :for, :desc => "The version to generate", :multiple => true
   c.action do |global_options,options,args|
     file = args.first
     Docurium::CLI.doc(file, options)
@@ -34,8 +35,10 @@ pre { |global,command,options,args| true }
 post { |global,command,options,args| true }
 
 on_error do |exception|
-  puts exception
-  puts exception.backtrace
+  if !exception.is_a?(SystemExit)
+    puts exception
+    puts exception.backtrace
+  end
 end
 
 exit run(ARGV)

data/docurium.gemspec

@@ -14,14 +14,14 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
 
   s.add_dependency "version_sorter", "~>2.0"
-  s.add_dependency "mustache", "~> 0.99"
+  s.add_dependency "mustache", "~> 1.1"
   s.add_dependency "rocco", "~>0.8"
   s.add_dependency "gli", "~>2.5"
   s.add_dependency "rugged", "~>0.21"
   s.add_dependency "redcarpet", "~>3.0"
-  s.add_dependency "ffi-clang", "~> 0.2"
-  s.add_development_dependency "bundler",   "~>1.0"
-  s.add_development_dependency "rake", "~> 10.1"
+  s.add_dependency "ffi-clang", "~> 0.5"
+  s.add_development_dependency "rake", "~> 12"
+  s.add_development_dependency "minitest", "~> 5.11"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/docurium.rb

@@ -23,7 +23,7 @@ class Docurium
     raise "You need to specify a config file" if !config_file
     raise "You need to specify a valid config file" if !valid_config(config_file)
     @sigs = {}
-    @repo = repo || Rugged::Repository.discover('.')
+    @repo = repo || Rugged::Repository.discover(config_file)
   end
 
   def init_data(version = 'HEAD')
@@ -119,12 +119,22 @@ class Docurium
     data
   end
 
-  def generate_docs
+  def generate_docs(options)
     output_index = Rugged::Index.new
     write_site(output_index)
     @tf = File.expand_path(File.join(File.dirname(__FILE__), 'docurium', 'layout.mustache'))
     versions = get_versions
     versions << 'HEAD'
+    # If the user specified versions, validate them and overwrite
+    if !(vers = options[:for]).empty?
+      vers.each do |v|
+        next if versions.include?(v)
+        puts "Unknown version #{v}"
+        exit(false)
+      end
+      versions = vers
+    end
+
     nversions = versions.size
     output = Queue.new
     pipes = {}
@@ -364,9 +374,9 @@ class Docurium
         k = key
       end
       group, rest = k.split('_', 2)
-      next if group.empty?
-      if !rest
-        group = value[:file].gsub('.h', '').gsub('/', '_')
+      if group.empty?
+        puts "empty group for function #{key}"
+        next
       end
       data[:functions][key][:group] = group
       func[group] ||= []

data/lib/docurium/cli.rb

@@ -3,7 +3,7 @@ class Docurium
 
     def self.doc(idir, options)
       doc = Docurium.new(idir)
-      doc.generate_docs
+      doc.generate_docs(options)
     end
 
     def self.gen(file)

data/lib/docurium/docparser.rb

@@ -18,7 +18,7 @@ class Docurium
       unsaved = files.map do |name, contents|
         full_path = File.join(tmpdir, name)
         dirname = File.dirname(full_path)
-        FileUtils.mkdir_p(dirname) unless Dir.exists? dirname
+        FileUtils.mkdir_p(dirname) unless Dir.exist? dirname
         File.new(full_path, File::CREAT).close()
 
         UnsavedFile.new(full_path, contents)

data/lib/docurium/version.rb

@@ -1,3 +1,3 @@
 class Docurium
-  Version = VERSION = '0.5.0'
+  Version = VERSION = '0.6.0'
 end

data/test/{repo_test.rb → docurium_test.rb}

@@ -2,7 +2,7 @@ require 'minitest/autorun'
 require 'docurium'
 require 'rugged'
 
-class DocuriumTest < MiniTest::Unit::TestCase
+class DocuriumTest < Minitest::Test
 
   def setup
     @dir = Dir.mktmpdir()
@@ -40,7 +40,7 @@ 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
+    assert_equal 155, @data[:functions].size
   end
 
   def test_can_extract_enum_from_define
@@ -62,8 +62,64 @@ 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
+    oid_returns = [
+      "git_commit_id",
+      "git_commit_parent_oid",
+      "git_commit_tree_oid",
+      "git_object_id",
+      "git_odb_object_id",
+      "git_oid_shorten_new",
+      "git_reference_oid",
+      "git_tag_id",
+      "git_tag_target_oid",
+      "git_tree_entry_id",
+      "git_tree_id"
+    ]
+    assert_equal oid_returns, oid[1][:used][:returns]
+    oid_needs = [
+      "git_blob_create_frombuffer",
+      "git_blob_create_fromfile",
+      "git_blob_lookup",
+      "git_commit_create",
+      "git_commit_create_o",
+      "git_commit_create_ov",
+      "git_commit_create_v",
+      "git_commit_lookup",
+      "git_object_lookup",
+      "git_odb_exists",
+      "git_odb_hash",
+      "git_odb_open_rstream",
+      "git_odb_read",
+      "git_odb_read_header",
+      "git_odb_write",
+      "git_oid_allocfmt",
+      "git_oid_cmp",
+      "git_oid_cpy",
+      "git_oid_fmt",
+      "git_oid_mkraw",
+      "git_oid_mkstr",
+      "git_oid_pathfmt",
+      "git_oid_shorten_add",
+      "git_oid_shorten_free",
+      "git_oid_to_string",
+      "git_reference_create_oid",
+      "git_reference_create_oid_f",
+      "git_reference_set_oid",
+      "git_revwalk_hide",
+      "git_revwalk_next",
+      "git_revwalk_push",
+      "git_tag_create",
+      "git_tag_create_f",
+      "git_tag_create_fo",
+      "git_tag_create_frombuffer",
+      "git_tag_create_o",
+      "git_tag_lookup",
+      "git_tree_create_fromindex",
+      "git_tree_lookup",
+      "git_treebuilder_insert",
+      "git_treebuilder_write"
+    ]
+    assert_equal oid_needs, oid[1][:used][:needs].sort
   end
 
   def test_can_parse_normal_functions
@@ -104,7 +160,12 @@ END
     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
+    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>
+    EOF
+    assert_equal expect_comment.split("\n").map(&:strip), func[:comments].split("\n")
   end
 
   def test_can_get_the_full_description_from_multi_liners
@@ -114,7 +175,8 @@ END
   end
 
   def test_can_group_functions
-    assert_equal 15, @data[:groups].size
+    groups = %w(blob cherrypick commit index lasterror object odb oid reference repository revwalk signature strerror tag tree treebuilder work)
+    assert_equal groups, @data[:groups].map {|g| g[0]}.sort
     group, funcs = @data[:groups].first
     assert_equal 'blob', group
     assert_equal 6, funcs.size

data/test/fixtures/git2/cherrypick.h

@@ -0,0 +1,17 @@
+#ifndef INCLUDE_git_blob_h__
+#define INCLUDE_git_blob_h__
+
+#include "common.h"
+#include "types.h"
+
+GIT_BEGIN_DECL
+
+/**
+ * Perform a cherry-pick
+ *
+ * @param input dummy input
+ * @returns the usual
+ */
+GIT_EXTERN(int) git_cherrypick(char *input);
+
+GIT_END_DECL

data/test/fixtures/git2/common.h

@@ -39,6 +39,12 @@
 # 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/gen_test.rb

@@ -3,7 +3,7 @@ require 'docurium'
 require 'docurium/cli'
 require 'tempfile'
 
-class GenTest < MiniTest::Unit::TestCase
+class GenTest < Minitest::Test
 
   # make sure we can read what we give the user
   def test_read_generated_file
@@ -12,7 +12,7 @@ class GenTest < MiniTest::Unit::TestCase
       Docurium::CLI.gen(file.path)
     end
 
-      Docurium.new file.path
+    assert_raises(Rugged::RepositoryError) { Docurium.new file.path }
   end
 
 end

data/test/parser_test.rb

@@ -2,7 +2,7 @@ require 'minitest/autorun'
 require 'docurium'
 require 'pp'
 
-class TestParser < Minitest::Unit::TestCase
+class ParserTest < Minitest::Test
 
   def setup
     @parser = Docurium::DocParser.new
@@ -70,7 +70,7 @@ EOF
 */
 int some_function(
     char *string,
-    size_t len);
+    int len);
 EOF
 
     actual = parse(name, contents)
@@ -80,10 +80,10 @@ EOF
                   :tdef => nil,
                   :type => :function,
                   :name => 'some_function',
-                  :body => "int some_function(char *string, size_t len);",
+                  :body => "int some_function(char *string, int len);",
                   :description => ' Do something',
                   :comments => " More explanation of what we do\n\n ",
-                  :sig => 'char *::size_t',
+                  :sig => 'char *::int',
                   :args => [{
                               :name => 'string',
                               :type => 'char *',
@@ -91,15 +91,15 @@ EOF
                             },
                             {
                               :name => 'len',
-                              :type => 'size_t',
+                              :type => 'int',
                               :comment => nil
                             }],
                   :return => {
                     :type => 'int',
                     :comment => ' an integer value'
                   },
-                  :decl => "int some_function(char *string, size_t len)",
-                  :argline => "char *string, size_t len",
+                  :decl => "int some_function(char *string, int len)",
+                  :argline => "char *string, int len",
                 }]
 
     assert_equal expected, actual
@@ -192,7 +192,7 @@ EOF
                   :argline => "git_tree *tree"
                 }]
 
-    assert_equal actual, expected
+    assert_equal expected, actual
 
   end
 
@@ -377,7 +377,7 @@ EOF
                   :underlying_type => "int"
                 }]
 
-    assert_equal actual, expected
+    assert_equal expected, actual
 
     name = 'typeref.h'
     contents = <<EOF
@@ -401,7 +401,7 @@ EOF
                   :comments => '',
                 }]
 
-    assert_equal actual, expected
+    assert_equal expected, actual
 
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docurium
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Carlos Martín Nieto
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-31 00:00:00.000000000 Z
+date: 2019-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version_sorter
@@ -31,14 +31,14 @@ dependencies:
     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
@@ -101,42 +101,42 @@ 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: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '12'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        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
@@ -183,9 +183,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,7 +206,6 @@ 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:
@@ -226,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A simpler, prettier Doxygen replacement.