docurium 0.3.1 → 0.3.2

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'libs' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end

data/lib/docurium.rb

@@ -16,13 +16,17 @@ Rocco::Markdown = RedcarpetCompat
 class Docurium
   attr_accessor :branch, :output_dir, :data
 
-  def initialize(config_file)
+  def initialize(config_file, repo = nil)
     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 = {}
     @groups = {}
-    repo_path = Rugged::Repository.discover('.')
-    @repo = Rugged::Repository.new(repo_path)
+    if repo
+      @repo = repo
+    else
+      repo_path = Rugged::Repository.discover('.')
+      @repo = Rugged::Repository.new(repo_path)
+    end
     clear_data
   end
 
@@ -376,10 +380,12 @@ class Docurium
           @data[:types][r[:name]] ||= {}
           wanted[:types].each do |k|
             next unless r.has_key? k
+            contents = r[k]
             if k == :comments
               contents = md.render r[k]
-            else
-              contents = r[k]
+            elsif k == :block
+              old_block = @data[:types][r[:name]][k]
+              contents = old_block ? [old_block, r[k]].join("\n") : r[k]
             end
             @data[:types][r[:name]][k] = contents
           end

data/lib/docurium/cli.rb

@@ -14,7 +14,7 @@ temp = <<-TEMPLATE
  "github": "user/project",
  "input":  "include/lib",
  "prefix": "lib_",
- "output": "docs"
+ "branch": "gh-pages"
 }
 TEMPLATE
       puts "Writing to #{file}"

data/lib/docurium/version.rb

@@ -1,3 +1,3 @@
 class Docurium
-  Version = VERSION = '0.3.1'
+  Version = VERSION = '0.3.2'
 end

data/site/js/docurium.js

@@ -634,7 +634,7 @@ $(function() {
 	this.changelogView = new ChangelogView({model: this.doc})
       }
       this.doc.setVersion()
-      this.mainView.setActive(this.ChangelogView)
+      this.mainView.setActive(this.changelogView)
     },
   });
 

data/test/fixtures/git2/api.docurium

@@ -2,5 +2,5 @@
  "name":   "libgit2",
  "github": "libgit2/libgit2",
  "prefix": "git_",
- "output": "docs"
+ "branch": "gh-pages"
 }

data/test/fixtures/git2/index.h

@@ -44,7 +44,7 @@ GIT_BEGIN_DECL
 #define GIT_IDXENTRY_VALID     (0x8000)
 #define GIT_IDXENTRY_STAGESHIFT 12
 
-/*
+/**
  * Flags are divided into two parts: in-memory flags and
  * on-disk ones. Flags in GIT_IDXENTRY_EXTENDED_FLAGS
  * will get saved on-disk.
@@ -64,7 +64,7 @@ GIT_BEGIN_DECL
 #define GIT_IDXENTRY_UNPACKED          (1 << 8)
 #define GIT_IDXENTRY_NEW_SKIP_WORKTREE (1 << 9)
 
-/*
+/**
  * Extended on-disk flags:
  */
 #define GIT_IDXENTRY_INTENT_TO_ADD     (1 << 13)

data/test/gen_test.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'docurium'
+require 'docurium/cli'
+require 'tempfile'
+
+class GenTest < MiniTest::Unit::TestCase
+
+  # make sure we can read what we give the user
+  def test_read_generated_file
+    file = Tempfile.new 'docurium'
+    capture_io do
+      Docurium::CLI.gen(file.path)
+    end
+
+      Docurium.new file.path
+  end
+
+end

data/test/parser_test.rb

@@ -0,0 +1,122 @@
+require 'minitest/autorun'
+require 'docurium'
+
+class TestParser < Minitest::Unit::TestCase
+
+  def setup
+    @parser = Docurium::CParser.new
+  end
+
+  # e.g. parse('git2/refs.h')
+  def parse(path)
+    realpath = File.dirname(__FILE__) + '/fixtures/' + path
+
+    parser = Docurium::CParser.new
+    parser.parse_text(path, File.read(realpath))
+  end
+
+  def test_single_function
+    name = 'function.h'
+    contents = <<EOF
+/**
+* Do something
+*
+* More explanation of what we do
+* 
+* @param string a sequence of characters
+* @return an integer value
+*/
+int some_function(char *string);
+EOF
+
+    raw_comments = <<EOF
+Do something
+
+More explanation of what we do
+
+@param string a sequence of characters
+@return an integer value
+EOF
+
+    actual = @parser.parse_text(name, contents)
+    expected = [{:file => "function.h",
+                  :line => 9,
+                  :body => 'int some_function(char *string);',
+                  :rawComments => raw_comments.strip,
+                  :type => :function,
+                  :args => [{
+                              :name => 'string',
+                              :type => 'char *',
+                              :comment => 'a sequence of characters'
+                            }],
+                  :return => {
+                    :type => 'int',
+                    :comment => 'an integer value'
+                  },
+                  :argline => 'char *string',
+                  :sig => 'char *',
+                  :description => 'Do something',
+                  :lineto => 9,
+                  :comments => "More explanation of what we do\n",
+                  :decl => 'int some_function(char *string)',
+                  :name => 'some_function'}]
+
+    assert_equal expected, actual
+  end
+
+  def test_single_multiline_function
+    name = 'function.h'
+    contents = <<EOF
+/**
+* Do something
+*
+* More explanation of what we do
+* 
+* @param string a sequence of characters
+* @return an integer value
+*/
+int some_function(
+    char *string,
+    size_t len);
+EOF
+
+    raw_comments = <<EOF
+Do something
+
+More explanation of what we do
+
+@param string a sequence of characters
+@return an integer value
+EOF
+
+    actual = @parser.parse_text(name, contents)
+    expected = [{:file => "function.h",
+                  :line => 9,
+                  :decl => "int some_function(\n    char *string,\n    size_t len)",
+                  :body => "int some_function(\n    char *string,\n    size_t len);",
+                  :rawComments => raw_comments.strip,
+                  :type => :function,
+                  :args => [{
+                              :name => 'string',
+                              :type => 'char *',
+                              :comment => 'a sequence of characters'
+                            },
+                            {
+                              :name => 'len',
+                              :type => 'size_t',
+                            }],
+                  :return => {
+                    :type => 'int',
+                    :comment => 'an integer value'
+                  },
+                  :argline => "char *string,\n    size_t len",
+                  :sig => 'char *::size_t',
+                  :description => 'Do something',
+                  :lineto => 11,
+                  :comments => "More explanation of what we do\n",
+                  :name => 'some_function'}]
+
+    assert_equal expected, actual
+  end
+
+end

data/test/repo_test.rb

@@ -1,52 +1,76 @@
-require File.expand_path "../test_helper", __FILE__
-require 'base64'
+require 'minitest/autorun'
+require 'docurium'
+require 'rugged'
 
-context "Docurium Header Parsing" do
-  setup do
-    @path = File.dirname(__FILE__) + '/fixtures/git2/api.docurium'
-    @doc  = Docurium.new(@path)
-    Dir.chdir(File.dirname(@path)) do
-      @doc.parse_headers
+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)
+    @doc.parse_headers(index)
     @data = @doc.data
   end
 
-  test "can parse header files" do
+  def teardown
+    FileUtils.remove_entry(@dir)
+  end
+
+  def test_can_parse_headers
     keys = @data.keys.map { |k| k.to_s }.sort
     assert_equal ['files', 'functions', 'globals', 'groups', 'prefix', 'types'], keys
-    assert_equal 150, @data[:functions].size
+    assert_equal 153, @data[:functions].size
   end
 
-  test "can extract globals" do
-    assert_equal 55, @data[:globals].size
-    entry = @data[:globals]['GIT_IDXENTRY_EXTENDED2']
-    assert_equal "index.h", entry[:file]
-    assert_equal 73, entry[:line]
+  def test_can_extract_enum_from_define
+    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
 
-  test "can extract structs and enums" do
+  def test_can_extract_structs_and_enums
     assert_equal 25, @data[:types].size
   end
 
-  test "can parse sequential sigs" do
-    func = @data[:functions]['git_odb_backend_pack']
-    assert_equal 'const char *', func[:args][1][:type]
-    func = @data[:functions]['git_odb_backend_loose']
-    assert_equal 'const char *', func[:args][1][:type]
-  end
-
-  test "can find type usage" do
+  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
 
-  test "can parse normal functions" do
+  def test_can_parse_normal_functions
     func = @data[:functions]['git_blob_rawcontent']
-    assert_equal 'Get a read-only buffer with the raw content of a blob.',  func[:description]
+    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 73,              func[:line]
+    assert_equal 84,              func[:line]
     assert_equal 84,              func[:lineto]
     assert_equal 'blob.h',        func[:file]
     assert_equal 'git_blob *blob',func[:argline]
@@ -55,47 +79,44 @@ context "Docurium Header Parsing" do
     assert_equal 'pointer to the blob',  func[:args][0][:comment]
   end
 
-  test "can parse defined functions" do
+  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 42,        func[:line]
+    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
 
-  test "can parse function cast args" do
+  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 301,               func[:line]
+    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 '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
 
-  test "can get the full description from multi liners" do
+  def test_can_get_the_full_description_from_multi_liners
     func = @data[:functions]['git_commit_create_o']
-    desc = "Create a new commit in the repository using `git_object` instances as parameters."
+    desc = "<p>Create a new commit in the repository using <code>git_object</code>\ninstances as parameters.</p>\n"
     assert_equal desc, func[:description]
   end
 
-  test "can group functions" do
-    assert_equal 15, @data[:groups].size
+  def test_can_group_functions
+    assert_equal 14, @data[:groups].size
     group, funcs = @data[:groups].first
     assert_equal 'blob', group
     assert_equal 6, funcs.size
   end
 
-  test "can parse data structures" do
-  end
-
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: docurium
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
+  prerelease: 
 platform: ruby
 authors:
 - Carlos Martín Nieto
@@ -9,11 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version_sorter
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -21,6 +23,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -28,20 +31,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.99.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.99.4
 - !ruby/object:Gem::Dependency
   name: rocco
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -49,6 +55,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -56,6 +63,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -63,6 +71,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,6 +79,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -77,6 +87,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -84,6 +95,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -91,6 +103,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -98,6 +111,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -105,6 +119,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -122,6 +137,7 @@ files:
 - Gemfile
 - LICENCE
 - README.md
+- Rakefile
 - TODO.txt
 - bin/cm
 - docurium.gemspec
@@ -169,31 +185,33 @@ files:
 - test/fixtures/git2/thread-utils.h
 - test/fixtures/git2/tree.h
 - test/fixtures/git2/types.h
-- test/fixtures/git2/zlib.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: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A simpler, prettier Doxygen replacement.
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 8f6af0d603518314439b2a7d5794f31987f2388c
-  data.tar.gz: b9c90aac1a2896c2ffefe5df0990544e9f4e1070
-SHA512:
-  metadata.gz: 5bb41fe37a9264465db9f4f686381b75c5f28e83567a973373f1a1d7d7a6c9eb26fb66d68f2749fcec02ec7c260f46823aec366c8d83fbf54abc2e841251e2fc
-  data.tar.gz: 02935bd2512cc021c6ae65ce7886d3c0562d064e2d40bcc9e5ad1804e3b3958965d49e265a6840bb2eaccd7291de5aa35f73f767b6dad7b4bd3565077ec538ca

data/test/fixtures/git2/zlib.h

@@ -1,58 +0,0 @@
-/*
- * This file is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License, version 2,
- * as published by the Free Software Foundation.
- *
- * In addition to the permissions in the GNU General Public License,
- * the authors give you unlimited permission to link the compiled
- * version of this file into combinations with other programs,
- * and to distribute those combinations without any restriction
- * coming from the use of this file.  (The General Public License
- * restrictions do apply in other respects; for example, they cover
- * modification of the file, and distribution when not linked into
- * a combined executable.)
- *
- * This file is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; see the file COPYING.  If not, write to
- * the Free Software Foundation, 51 Franklin Street, Fifth Floor,
- * Boston, MA 02110-1301, USA.
- */
-#ifndef INCLUDE_git_zlib_h__
-#define INCLUDE_git_zlib_h__
-
-#include <zlib.h>
-
-/**
- * @file git2/zlib.h
- * @brief Git data compression routines
- * @defgroup git_zlib Git data compression routines
- * @ingroup Git
- * @{
- */
-GIT_BEGIN_DECL
-
-#if defined(NO_DEFLATE_BOUND) || ZLIB_VERNUM < 0x1200
-/**
- * deflateBound returns an upper bound on the compressed size.
- *
- * This is a stub function used when zlib does not supply the
- * deflateBound() implementation itself.
- *
- * @param stream the stream pointer.
- * @param s total length of the source data (in bytes).
- * @return maximum length of the compressed data.
- */
-GIT_INLINE(size_t) deflateBound(z_streamp stream, size_t s)
-{
-	return (s + ((s + 7) >> 3) + ((s + 63) >> 6) + 11);
-}
-#endif
-
-/** @} */
-GIT_END_DECL
-#endif