docurium 0.0.1

data/test/fixtures/git2/types.h

@@ -0,0 +1,162 @@
+/*
+ * 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_types_h__
+#define INCLUDE_git_types_h__
+
+/**
+ * @file git2/types.h
+ * @brief libgit2 base & compatibility types
+ * @ingroup Git
+ * @{
+ */
+GIT_BEGIN_DECL
+
+/**
+ * Cross-platform compatibility types for off_t / time_t
+ *
+ * NOTE: This needs to be in a public header so that both the library
+ * implementation and client applications both agree on the same types.
+ * Otherwise we get undefined behavior.
+ *
+ * Use the "best" types that each platform provides. Currently we truncate
+ * these intermediate representations for compatibility with the git ABI, but
+ * if and when it changes to support 64 bit types, our code will naturally
+ * adapt.
+ * NOTE: These types should match those that are returned by our internal
+ * stat() functions, for all platforms.
+ */
+#include <sys/types.h>
+
+#if defined(_MSC_VER)
+
+typedef __int64 git_off_t;
+typedef __time64_t  git_time_t;
+
+#elif defined(__MINGW32__)
+
+typedef off64_t git_off_t;
+typedef __time64_t git_time_t;
+
+#else  /* POSIX */
+
+/* 
+ * Note: Can't use off_t since if a client program includes <sys/types.h>
+ * before us (directly or indirectly), they'll get 32 bit off_t in their client
+ * app, even though /we/ define _FILE_OFFSET_BITS=64.
+ */
+typedef int64_t git_off_t;
+typedef int64_t git_time_t;
+
+#endif
+
+/** Basic type (loose or packed) of any Git object. */
+typedef enum {
+	GIT_OBJ_ANY = -2,		/**< Object can be any of the following */
+	GIT_OBJ_BAD = -1,       /**< Object is invalid. */
+	GIT_OBJ__EXT1 = 0,      /**< Reserved for future use. */
+	GIT_OBJ_COMMIT = 1,     /**< A commit object. */
+	GIT_OBJ_TREE = 2,       /**< A tree (directory listing) object. */
+	GIT_OBJ_BLOB = 3,       /**< A file revision object. */
+	GIT_OBJ_TAG = 4,        /**< An annotated tag object. */
+	GIT_OBJ__EXT2 = 5,      /**< Reserved for future use. */
+	GIT_OBJ_OFS_DELTA = 6,  /**< A delta, base is given by an offset. */
+	GIT_OBJ_REF_DELTA = 7,  /**< A delta, base is given by object id. */
+} git_otype;
+
+/** An open object database handle. */
+typedef struct git_odb git_odb;
+
+/** A custom backend in an ODB */
+typedef struct git_odb_backend git_odb_backend;
+
+/** An object read from the ODB */
+typedef struct git_odb_object git_odb_object;
+
+/** A stream to read/write from the ODB */
+typedef struct git_odb_stream git_odb_stream;
+
+/**
+ * Representation of an existing git repository,
+ * including all its object contents
+ */
+typedef struct git_repository git_repository;
+
+/** Representation of a generic object in a repository */
+typedef struct git_object git_object;
+
+/** Representation of an in-progress walk through the commits in a repo */
+typedef struct git_revwalk git_revwalk;
+
+/** Parsed representation of a tag object. */
+typedef struct git_tag git_tag;
+
+/** In-memory representation of a blob object. */
+typedef struct git_blob git_blob;
+
+/** Parsed representation of a commit object. */
+typedef struct git_commit git_commit;
+
+/** Representation of each one of the entries in a tree object. */
+typedef struct git_tree_entry git_tree_entry;
+
+/** Representation of a tree object. */
+typedef struct git_tree git_tree;
+
+/** Constructor for in-memory trees */
+typedef struct git_treebuilder git_treebuilder;
+
+/** Memory representation of an index file. */
+typedef struct git_index git_index;
+
+/** Time in a signature */
+typedef struct git_time {
+	git_time_t time; /** time in seconds from epoch */
+	int offset; /** timezone offset, in minutes */
+} git_time;
+
+/** An action signature (e.g. for committers, taggers, etc) */
+typedef struct git_signature {
+	char *name; /** full name of the author */
+	char *email; /** email of the author */
+	git_time when; /** time when the action happened */
+} git_signature;
+
+/** In-memory representation of a reference. */
+typedef struct git_reference git_reference;
+
+/** Basic type of any Git reference. */
+typedef enum {
+	GIT_REF_INVALID = 0, /** Invalid reference */
+	GIT_REF_OID = 1, /** A reference which points at an object id */
+	GIT_REF_SYMBOLIC = 2, /** A reference which points at another reference */
+	GIT_REF_PACKED = 4,
+	GIT_REF_HAS_PEEL = 8,
+	GIT_REF_LISTALL = GIT_REF_OID|GIT_REF_SYMBOLIC|GIT_REF_PACKED,
+} git_rtype;
+
+/** @} */
+GIT_END_DECL
+
+#endif

data/test/fixtures/git2/zlib.h

@@ -0,0 +1,58 @@
+/*
+ * 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

data/test/repo_test.rb

@@ -0,0 +1,101 @@
+require File.expand_path "../test_helper", __FILE__
+require 'base64'
+
+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
+    end
+    @data = @doc.data
+  end
+
+  test "can parse header files" do
+    keys = @data.keys.map { |k| k.to_s }.sort
+    assert_equal ['files', 'functions', 'globals', 'groups', 'prefix', 'types'], keys
+    assert_equal 150, @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]
+  end
+
+  test "can extract structs and enums" do
+    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
+    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
+    func = @data[:functions]['git_blob_rawcontent']
+    assert_equal 'Get a read-only buffer with the raw content of a blob.',  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[: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
+
+  test "can parse defined functions" do
+    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 '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
+    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 '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
+
+  test "can get the full description from multi liners" do
+    func = @data[:functions]['git_commit_create_o']
+    desc = "Create a new commit in the repository using `git_object` instances as parameters."
+    assert_equal desc, func[:description]
+  end
+
+  test "can group functions" do
+    assert_equal 15, @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

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+$TESTING = true
+require 'test/unit'
+require 'rubygems'
+require 'docurium'
+require 'pp'
+
+##
+# test/spec/mini 3
+# http://gist.github.com/25455
+# chris@ozmm.org
+#
+def context(*args, &block)
+  return super unless (name = args.first) && block
+  require 'test/unit'
+  klass = Class.new(defined?(ActiveSupport::TestCase) ? ActiveSupport::TestCase : Test::Unit::TestCase) do
+    def self.test(name, &block)
+      define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
+    end
+    def self.xtest(*args) end
+    def self.setup(&block) define_method(:setup, &block) end
+    def self.teardown(&block) define_method(:teardown, &block) end
+  end
+  (class << klass; self end).send(:define_method, :name) { name.gsub(/\W/,'_') }
+  klass.class_eval &block
+  ($contexts ||= []) << klass # make sure klass doesn't get GC'd
+  klass
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: docurium
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Chacon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: version_sorter
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id002
+description: A simpler, prettier Doxygen replacement.
+email: 
+- schacon@gmail.com
+executables: 
+- cm
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENCE
+- README.md
+- TODO.txt
+- bin/cm
+- docurium.gemspec
+- lib/docurium.rb
+- lib/docurium/cli.rb
+- site/css/style.css
+- site/images/search_icon.png
+- site/index.html
+- site/js/backbone.js
+- site/js/docurium.js
+- site/js/json2.js
+- site/js/underscore.js
+- site/shared/css/documentation.css
+- site/shared/css/pygments.css
+- site/shared/images/active-arrow.png
+- site/shared/images/background-v2.png
+- site/shared/images/background-white.png
+- site/shared/images/dropdown_sprites.jpg
+- site/shared/images/footer_logo.png
+- site/shared/images/logo.png
+- site/shared/images/nav-rule.png
+- site/shared/images/next_step_arrow.gif
+- site/shared/images/qmark.png
+- site/shared/js/documentation.js
+- site/shared/js/jquery.js
+- test/fixtures/git2/api.docurium
+- test/fixtures/git2/blob.h
+- test/fixtures/git2/commit.h
+- test/fixtures/git2/common.h
+- test/fixtures/git2/errors.h
+- test/fixtures/git2/index.h
+- test/fixtures/git2/object.h
+- test/fixtures/git2/odb.h
+- test/fixtures/git2/odb_backend.h
+- test/fixtures/git2/oid.h
+- test/fixtures/git2/refs.h
+- test/fixtures/git2/repository.h
+- test/fixtures/git2/revwalk.h
+- test/fixtures/git2/signature.h
+- test/fixtures/git2/tag.h
+- test/fixtures/git2/thread-utils.h
+- test/fixtures/git2/tree.h
+- test/fixtures/git2/types.h
+- test/fixtures/git2/zlib.h
+- test/repo_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/schacon/docurium
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: docurium
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simpler, prettier Doxygen replacement.
+test_files: 
+- test/fixtures/git2/api.docurium
+- test/fixtures/git2/blob.h
+- test/fixtures/git2/commit.h
+- test/fixtures/git2/common.h
+- test/fixtures/git2/errors.h
+- test/fixtures/git2/index.h
+- test/fixtures/git2/object.h
+- test/fixtures/git2/odb.h
+- test/fixtures/git2/odb_backend.h
+- test/fixtures/git2/oid.h
+- test/fixtures/git2/refs.h
+- test/fixtures/git2/repository.h
+- test/fixtures/git2/revwalk.h
+- test/fixtures/git2/signature.h
+- test/fixtures/git2/tag.h
+- test/fixtures/git2/thread-utils.h
+- test/fixtures/git2/tree.h
+- test/fixtures/git2/types.h
+- test/fixtures/git2/zlib.h
+- test/repo_test.rb
+- test/test_helper.rb