inch 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14108473ee83283cca8d56b272807810ab09056e
-  data.tar.gz: a51660cc84f73f11717335bb48d2c48b61c13d8c
+  metadata.gz: 66c43ca8174a8055673d9e535152eb2e74fd7b45
+  data.tar.gz: 703f6df47f294043330e98a63fcdb98f7194dcdd
 SHA512:
-  metadata.gz: fbc22fb1dd913d5b77ddd6097a079a060f1eb0bb2fe4ed801b057794e442e4ea6b6ef406727b7cae78e044f371682b29e69c91c1c6493d58cbd45bd3c49c7ed6
-  data.tar.gz: 7bb0049037d2abc2814e63934df47571afb9bf91a1f863bea16b303503fd120ff34286ad024a6e73da6782e869c1fe8c5dc2b814cc395dba5750e4cbdef18243
+  metadata.gz: fa6524451d1e4f9025b3838c76627d6f3e2dcb44df058238af3a09a378be973e385eb7f7b4f5593b8c92f2869ca2019ad3c42b90647f5a73560c80388dec8204
+  data.tar.gz: d2c6c94f942e26c5d8a265ab68f30f2bb501f10007ad2467afd5ea83546859009c6dac6e045cc7043ee2c41b8b5a7f6f9632f88353ed084706f08b1437c023ed

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.5.7
+
+- NodeJS: Add support for JSDoc's ClassObject
+
 ## 0.5.6
 
 - NodeJS: Fix bug regarding visibility of objects

data/config/nodejs.rb

@@ -27,6 +27,15 @@ Inch::Config.register(:nodejs) do
       unconsidered_tag    0.2
     end
 
+    schema(:ClassObject) do
+      docstring           1.0
+
+      # optional:
+      code_example_single 0.1
+      code_example_multi  0.2
+      unconsidered_tag    0.2
+    end
+
     schema(:FunctionObject) do
       docstring           0.5
       parameters          0.4

data/lib/inch/config/evaluation.rb

@@ -23,7 +23,8 @@ module Inch
       end
 
       def criteria_for(constant_name)
-        @criteria_blocks[constant_name.to_s]
+        @criteria_blocks[constant_name.to_s] ||
+          raise("No criteria for #{constant_name}")
       end
 
       # An Criteria describes how important certain parts of the docs are

data/lib/inch/language/nodejs/code_object/class_object.rb

@@ -0,0 +1,11 @@
+module Inch
+  module Language
+    module Nodejs
+      module CodeObject
+        # Proxy class for modules
+        class ClassObject < ModuleObject
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/evaluation/class_object.rb

@@ -0,0 +1,11 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        # Proxy class for classes
+        class ClassObject < ModuleObject
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/import.rb

@@ -9,11 +9,13 @@ require 'inch/language/nodejs/provider/jsdoc'
 
 require 'inch/language/nodejs/code_object/base'
 require 'inch/language/nodejs/code_object/module_object'
+require 'inch/language/nodejs/code_object/class_object'
 require 'inch/language/nodejs/code_object/function_object'
 require 'inch/language/nodejs/code_object/member_object'
 
 require 'inch/language/nodejs/evaluation/base'
 require 'inch/language/nodejs/evaluation/module_object'
+require 'inch/language/nodejs/evaluation/class_object'
 require 'inch/language/nodejs/evaluation/function_object'
 require 'inch/language/nodejs/evaluation/member_object'
 

data/lib/inch/language/nodejs/provider/jsdoc/object.rb

@@ -1,6 +1,7 @@
 require 'inch/language/nodejs/provider/jsdoc/object/base'
 require 'inch/language/nodejs/provider/jsdoc/object/function_object'
 require 'inch/language/nodejs/provider/jsdoc/object/module_object'
+require 'inch/language/nodejs/provider/jsdoc/object/class_object'
 require 'inch/language/nodejs/provider/jsdoc/object/member_object'
 
 module Inch

data/lib/inch/language/nodejs/provider/jsdoc/object/base.rb

@@ -220,7 +220,7 @@ module Inch
               protected
 
               def meta?
-                !meta.nil?
+                !meta.nil? && meta.is_a?(Hash)
               end
 
               def meta

data/lib/inch/language/nodejs/provider/jsdoc/object/class_object.rb

@@ -0,0 +1,18 @@
+module Inch
+  module Language
+    module Nodejs
+      module Provider
+        module JSDoc
+          module Object
+            # Proxy class for classes
+            class ClassObject < Base
+              def namespace?
+                true
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/provider/jsdoc/parser.rb

@@ -8,7 +8,8 @@ module Inch
         module JSDoc
           # Parses the source tree (using JSDoc)
           class Parser
-            IGNORE_TYPES = %w(member package)
+            # TODO: should we remove constant and namespace from this list?
+            IGNORE_TYPES = %w(member package constant namespace)
 
             attr_reader :parsed_objects
 

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = '0.5.6'
+  VERSION = '0.5.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - René Föhring
@@ -235,11 +235,13 @@ files:
 - lib/inch/language/elixir/roles/object.rb
 - lib/inch/language/elixir/roles/type.rb
 - lib/inch/language/nodejs/code_object/base.rb
+- lib/inch/language/nodejs/code_object/class_object.rb
 - lib/inch/language/nodejs/code_object/function_object.rb
 - lib/inch/language/nodejs/code_object/function_parameter_object.rb
 - lib/inch/language/nodejs/code_object/member_object.rb
 - lib/inch/language/nodejs/code_object/module_object.rb
 - lib/inch/language/nodejs/evaluation/base.rb
+- lib/inch/language/nodejs/evaluation/class_object.rb
 - lib/inch/language/nodejs/evaluation/function_object.rb
 - lib/inch/language/nodejs/evaluation/member_object.rb
 - lib/inch/language/nodejs/evaluation/module_object.rb
@@ -248,6 +250,7 @@ files:
 - lib/inch/language/nodejs/provider/jsdoc/docstring.rb
 - lib/inch/language/nodejs/provider/jsdoc/object.rb
 - lib/inch/language/nodejs/provider/jsdoc/object/base.rb
+- lib/inch/language/nodejs/provider/jsdoc/object/class_object.rb
 - lib/inch/language/nodejs/provider/jsdoc/object/function_object.rb
 - lib/inch/language/nodejs/provider/jsdoc/object/function_parameter_object.rb
 - lib/inch/language/nodejs/provider/jsdoc/object/member_object.rb