docurium 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dcfc42eb8c64c92839d2a857871dc250e0218a3
-  data.tar.gz: a62b2faed5fcaaffdc4d5fdd96edbddd18d6ee4a
+  metadata.gz: de4d14a126896d40e80233637c2d761a962c6b5e
+  data.tar.gz: a84683f848370319cbdd40829cc7f12d4801fc92
 SHA512:
-  metadata.gz: 676d2cf9763628d932da7b81b22b986ed18323774d3beb65045d0172ced8b7d6ca1cd51795d586327faf961e147826155f11e220ce613e840f68c536e41c2447
-  data.tar.gz: 4c3d5e0d1f86b0eeb5ffc8588470f88c78cffba34c7d3d56ceaad870bb4a782878a5657073b2ab1ebb420293c9fdcdf5b74d2268fcef2bec4cdc42bda8f20831
+  metadata.gz: 4e05fecc1654f57f2d21c4cf68e54bb87d850eaa4ae84f8d84dbc077b7a694079e49b328839c4d27620d90e3fcecce8229e188d30fb6905b1b2a6580fa78508d
+  data.tar.gz: 7111cfbab6de0b9987e314a065495e80cd9726f5e6e1d637199170b4d0bd7aefafdf20ff2b0fcad3aeaee767475f7f29a050ac1f981adf01dd45fab01ace6120

data/README.md

@@ -57,21 +57,6 @@ Docurium will write your docs directly into the specified Git branch.
 
     $ gem install docurium
 
-# Screenshots
-
-## Main Page
-
-![Main Page](https://img.skitch.com/20110614-c98pp6c9p9mn35jn4iskjim7hk.png)
-
-Each version of your app has a landing page that lists out all the functions available.  Functions that are new in that version from the previous version are highlighted in green, functions that have changed signatures are in orange.
-
-## Function Page
-
-![Func Page](https://img.skitch.com/20110614-mdasyhip3swxtngwxrce8wqy3h.png)
-
-Each function has a page showing all the relevant info for that function including metadata extracted from Doxygen-style comments.  I also list all the versions of the library that this function is included in and in which versions the signature changed.
-
-
 # Contributing
 
 If you want to fix or change something, please fork on GitHub, push your change to a branch named after your change and send me a pull request.

data/lib/docurium.rb

@@ -167,6 +167,7 @@ class Docurium
 
       # There's still some work we need to do serially
       tally_sigs!(version, data)
+      force_utf8(data)
       sha = @repo.write(data.to_json, :blob)
 
       print "Generating documentation [#{i}/#{nversions}]\r"
@@ -225,6 +226,21 @@ class Docurium
     puts "\tupdated #{br}"
   end
 
+  def force_utf8(data)
+    # Walk the data to force strings encoding to UTF-8.
+    if data.instance_of? Hash
+      data.each do |key, value|
+        if [:comment, :comments, :description].include?(key)
+          data[key] = value.force_encoding('UTF-8') unless value.nil?
+        else
+          force_utf8(value)
+        end
+      end
+    elsif data.respond_to?(:each)
+      data.each { |x| force_utf8(x) }
+    end
+  end
+
   def show_warnings(data)
     out '* checking your api'
 
@@ -362,17 +378,20 @@ class Docurium
   end
 
   def find_type_usage!(data)
-    # go through all the functions and see where types are used and returned
+    # go through all the functions and callbacks and see where other types are used and returned
     # store them in the types data
-    data[:functions].each do |func, fdata|
+    h = {}
+    h.merge!(data[:functions])
+    h.merge!(data[:callbacks])
+    h.each do |func, fdata|
       data[:types].each_with_index do |tdata, i|
         type, typeData = tdata
         data[:types][i][1][:used] ||= {:returns => [], :needs => []}
-        if fdata[:return][:type].index(/#{type}[ ;\)\*]/)
+        if fdata[:return][:type].index(/#{type}[ ;\)\*]?/)
           data[:types][i][1][:used][:returns] << func
           data[:types][i][1][:used][:returns].sort!
         end
-        if fdata[:argline].index(/#{type}[ ;\)\*]/)
+        if fdata[:argline].index(/#{type}[ ;\)\*]?/)
           data[:types][i][1][:used][:needs] << func
           data[:types][i][1][:used][:needs].sort!
         end

data/lib/docurium/docparser.rb

@@ -26,7 +26,7 @@ class Docurium
 
       # Override the path we want to filter by
       filename = File.join(tmpdir, orig_filename)
-      tu = Index.new.parse_translation_unit(filename, [], unsaved, {:detailed_preprocessing_record => 1})
+      tu = Index.new.parse_translation_unit(filename, ["-DDOCURIUM=1"], unsaved, {:detailed_preprocessing_record => 1})
 
       FileUtils.remove_entry(tmpdir)
 
@@ -149,7 +149,8 @@ class Docurium
 
     def extract_subject_desc(comment)
       subject = comment.child.text
-      desc = (comment.find_all { |cmt| cmt.kind == :comment_paragraph }).drop(1).map(&:text).join("\n\n")
+      paras = comment.find_all { |cmt| cmt.kind == :comment_paragraph }.drop(1).map { |p| p.map(&:text).join() }
+      desc = paras.join("\n\n")
       return subject, desc
     end
 

data/lib/docurium/version.rb

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

data/lib/libdetect.rb

@@ -15,7 +15,7 @@ module LibDetect
     ENV['LIBCLANG'] = DARWIN_LIBCLANG
   when /linux/
     prog = 'llvm-config'
-    if find_executable(prog)
+    if find_executable(prog) and not ENV.has_key?('LLVM_CONFIG')
       ENV['LLVM_CONFIG'] = prog
     end
   end

data/site/index.html

@@ -92,6 +92,7 @@
 	 <% }) %>
        </ul>
      </li>
+     <% if (examples.length > 0) { %>
      <li>
        <h3><a href="#">Examples</a></h3>
        <ul>
@@ -102,6 +103,7 @@
 	 <% }) %>
        </ul>
      </li>
+    <% } %> <!-- if we have examples -->
     </script>
 
     <!-- Listing of the details of a single function -->
@@ -162,14 +164,14 @@
      </ul>
      </div>
      <% } %> <!-- if we have examples -->
-     <% if (alsoLinks) { %>
+     <% if (alsoLinks && (alsoLinks.length > 0)) { %>
      <div class="also">
        Also in <a href="<%= alsoGroup %>"><%= groupName %></a> group: <br/>
        <% _.each(_.initial(alsoLinks), function(link) { %>
        <a href="<%= link.url %>"><%= link.name %></a>, 
        <% }) %>
        <% var link = _.last(alsoLinks) %>
-       <a href="<%= link.url %>"><%= link.name %></a>
+       <a href="<%= link.url %>"><%= link.name %></a>.
      </div>
      <% } %> <!-- if we have "also" links -->
     </script>
@@ -191,21 +193,21 @@
 
     <script type="text/template" id="uses-template">
       <% if (returns.length > 0) { %>
-      <h3>Returns</h3>
+      <h3>Returned by</h3>
       <% _.each(_.initial(returns), function(fun) { %>
-      <a href="<%= fun.url %>"><%= fun.name %></a>
+      <a href="<%= fun.url %>"><%= fun.name %></a>,
       <% }) %> <!-- loop over each 'return' -->
       <% var fun = _.last(returns) %>
-      <a href="<%= fun.url %>"><%= fun.name %></a>
+      <a href="<%= fun.url %>"><%= fun.name %></a>.
       <% } %> <!-- if we have 'returns' -->
 
       <% if (needs.length > 0) { %>
-      <h3>Argument In</h3>
+      <h3>Argument in</h3>
       <% _.each(_.initial(needs), function(fun) { %>
-      <a href="<%= fun.url %>"><%= fun.name %></a>
+      <a href="<%= fun.url %>"><%= fun.name %></a>,
       <% }) %> <!-- loop over each 'need' -->
       <% var fun = _.last(needs) %>
-      <a href="<%= fun.url %>"><%= fun.name %></a>
+      <a href="<%= fun.url %>"><%= fun.name %></a>.
       <% } %> <!-- if we have 'needs' -->
 
       <div class="fileLink">

data/site/js/docurium.js

@@ -17,6 +17,12 @@ $(function() {
 	return {name: name, link: link, num: group[1].length}
       })
 
+      // Callbacks
+      var callbacks = _.map(_.keys(data['callbacks']), function(name) {
+	var link = functionLink('callback', name, version)
+	return {name: name, link: link}
+      })
+
       // Types
       var getName = function(type) {
 	var name = type[0];
@@ -50,8 +56,8 @@ $(function() {
 	})
       }
 
-      this.set('data', {funs: funs, enums: enums, structs: structs, opaques: opaques,
-			files: files, examples: examples})
+      this.set('data', {funs: funs, callbacks: callbacks, enums: enums, structs: structs,
+	                opaques: opaques, files: files, examples: examples})
     },
   })
 
@@ -78,12 +84,24 @@ $(function() {
     render: function() {
       var data = this.model.get('data')
 
-      var enumList = this.typeTemplate({title: 'Enums', elements: data.enums})
-      var structList = this.typeTemplate({title: 'Structs', elements: data.structs})
-      var opaquesList = this.typeTemplate({title: 'Opaque Structs', elements: data.opaques})
       var menu = $(this.template({funs: data.funs, files: data.files, examples: data.examples}))
 
-      $('#types-list', menu).append(enumList, structList, opaquesList)
+      if (data.enums.length) {
+          var enumList = this.typeTemplate({title: 'Enums', elements: data.enums})
+          $('#types-list', menu).append(enumList)
+      }
+      if (data.structs.length) {
+          var structList = this.typeTemplate({title: 'Structs', elements: data.structs})
+          $('#types-list', menu).append(structList)
+      }
+      if (data.opaques.length) {
+          var opaquesList = this.typeTemplate({title: 'Opaque Structs', elements: data.opaques})
+          $('#types-list', menu).append(opaquesList)
+      }
+      if (data.callbacks.length) {
+          var callbacksList = this.typeTemplate({title: 'Callbacks', elements: data.callbacks})
+          $('#types-list', menu).append(callbacksList)
+      }
 
       this.$el.html(menu)
       return this
@@ -223,7 +241,7 @@ $(function() {
 	var cdata = docurium.get('data')['callbacks']
 	ldata = cdata
       } else {
-	var functions = group[1]
+	var functions = _.filter(group[1], function(f){ return f != fname})
       }
 
       // Function Arguments
@@ -391,6 +409,7 @@ $(function() {
       var cdata = o.callbacks
       var version = o.version
 
+      this.gname = gname.charAt(0).toUpperCase() + gname.substring(1).toLowerCase()
       this.functions = _.map(group[1], function(name) {
 	var url = '#' + functionLink(gname, name, version)
 	var d = fdata[name]
@@ -581,7 +600,7 @@ $(function() {
       })
     },
 
-    // look for structs and link them 
+    // look for structs and link them
     hotLink: function(text) {
       types = this.get('data')['types']
       var version = this.get('version')
@@ -606,7 +625,10 @@ $(function() {
     },
 
     groupOf: function (func) {
-      return this.get('data')['functions'][func]['group']
+      if(func in this.get('data')['functions']) {
+        return this.get('data')['functions'][func]['group']
+      }
+      return 'callback'
     },
 
     github_file: function(file, line, lineto) {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docurium
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Carlos Martín Nieto
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version_sorter
@@ -226,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simpler, prettier Doxygen replacement.