inch 0.5.9 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02e3f6cdb3de9a2b6952487a90108cb60ac2b1e3
-  data.tar.gz: 70040714c0aa9af08b2b61e3e7eb52a58d915959
+  metadata.gz: 72f3a96a1d7027c5f7e4f02377a3d2c7e6ab0483
+  data.tar.gz: 9d37e5e3c38c2cd9e2e73a8d4346bc14056b9d01
 SHA512:
-  metadata.gz: 4cecb783fe62af643de866676580afb2fdf5e9b2932f69964434e546c8858d9b20d32076e897b42a7c4724d4346f1cb2bfcfabb23e642b76d14be3098dbbb34a
-  data.tar.gz: 09fc41f600d83bfaf291999783f06e2171feea6cd8d8dacb614e98f69c8dec848f97953d6878dc9081a10226a732e5dba12e1c15f40263da1f476fa8183cf608
+  metadata.gz: c1c444e52a2a5c52b488fda70e7fe7d2997fdee57e23003964134f4d32c4e700e2ad711a9ae4ffb4fc028b266f82635a13f72039d0a0ad5114166f38e30d1aa8
+  data.tar.gz: b634cae70beb91a1c6675d0cdac62bf6011a0b756476a04eee564808e32c5662a7403264ad6ceeb39c4b50e273d3a7b159187be00ce80c675b688794c61d10b9

data/lib/inch/cli.rb

@@ -15,7 +15,12 @@ module Inch
           default
         else
           rows_cols = str.split(' ').map(&:to_i)
-          rows_cols[1] || default
+          cols = rows_cols[1]
+          if cols == 0
+            default
+          else
+            cols || default
+          end
         end
       rescue
         default

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

@@ -7,16 +7,8 @@ module Inch
           class Docstring < Ruby::Provider::YARD::Docstring
             VISIBILITIES = %w(public protected private)
 
-            # Removes the comment markers // /* */ from the docstring.
-            #
-            #   Docstring.new("// test").without_comment_markers
-            #   # => "test"
-            #
-            # @return [String]
-            def without_comment_markers
-              @text.lines.map do |line|
-                line.strip.gsub(/^(\s*(\/\*+|\/\/|\*+\/|\*)+\s?)/m, '')
-              end.join("\n").strip
+            def initialize(text)
+              @text = without_comment_markers(text)
             end
 
             def describes_internal_api?
@@ -26,7 +18,8 @@ module Inch
             def describes_parameter?(name)
               return false if name.nil?
               parameter = parameter_notations(name)
-              tag?(:param, /#{parameter}\s+\S+/)
+              type_notation = /(\{[^\}]+\}|\[[^\]]+\])/
+              tag?(:param, /#{type_notation}\s+#{parameter}\s+\S+/)
             end
 
             def mentions_parameter?(name)
@@ -44,22 +37,39 @@ module Inch
               tag?(:return, /#{type_notation}*(\s\w+)/) || super
             end
 
-            def visibility
+            # @param access_value [nil,String] visibility in JSDoc output
+            def visibility(access_value = nil)
               tagged_value = VISIBILITIES.detect do |v|
                 tag?(v)
               end
-              (tagged_value || 'public').to_sym
+              (tagged_value || access_value || 'public').to_sym
             end
 
             def tag?(tagname, regex = nil)
-              if without_comment_markers =~ /^\s*\@#{tagname}([^\n]*)$/m
+              tag_regex = /^\s*\@#{tagname}([^\n]*)$/m
+              matches = @text.scan(tag_regex).flatten
+              if !matches.empty?
                 if regex.nil?
                   true
                 else
-                  $1 =~ /#{regex}/
+                  matches.any? do |matched|
+                    matched =~ /#{regex}/
+                  end
                 end
               end
             end
+
+            # Removes the comment markers // /* */ from the given +text+.
+            #
+            #   Docstring.new("// test").without_comment_markers
+            #   # => "test"
+            #
+            # @return [String]
+            def without_comment_markers(text)
+              text.to_s.lines.map do |line|
+                line.strip.gsub(/^(\s*(\/\*+|\/\/|\*+\/|\*)+\s?)/m, '')
+              end.join("\n").strip
+            end
           end
         end
       end

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

@@ -22,7 +22,7 @@ module Inch
               end
 
               def fullname
-                "#{@hash['longname']}"
+                @hash['longname']
               end
 
               # Returns all files declaring the object in the form of an Array
@@ -47,11 +47,7 @@ module Inch
               end
 
               def parent_fullname
-                if depth == 1
-                  nil
-                else
-                  fullname.split('.')[0...-1].join('.')
-                end
+                @hash['memberof'] || retrieve_parent_fullname
               end
 
               def api_tag?
@@ -100,7 +96,7 @@ module Inch
               end
 
               def has_code_example?
-                false # raise NotImplementedError
+                docstring.code_examples.size > 0
               end
 
               def has_doc?
@@ -108,7 +104,7 @@ module Inch
               end
 
               def has_multiple_code_examples?
-                false # raise NotImplementedError
+                docstring.code_examples.size > 1
               end
 
               def has_unconsidered_tags?
@@ -151,7 +147,7 @@ module Inch
               end
 
               def private?
-                false
+                visibility == 'private'
               end
 
               def tagged_as_internal_api?
@@ -163,11 +159,11 @@ module Inch
               end
 
               def protected?
-                false
+                visibility == 'protected'
               end
 
               def public?
-                true
+                visibility == 'public'
               end
 
               def questioning_name?
@@ -175,15 +171,15 @@ module Inch
               end
 
               def return_described?
-                false # raise NotImplementedError
+                docstring.describes_return?
               end
 
               def return_mentioned?
-                false # raise NotImplementedError
+                docstring.mentions_return?
               end
 
               def return_typed?
-                false # raise NotImplementedError
+                return_mentioned?
               end
 
               def in_root?
@@ -207,7 +203,7 @@ module Inch
               end
 
               def visibility
-                docstring.visibility
+                docstring.visibility(@hash['access'])
               end
 
               protected
@@ -219,6 +215,14 @@ module Inch
               def meta
                 @hash['meta']
               end
+
+              def retrieve_parent_fullname
+                if depth == 1
+                  nil
+                else
+                  fullname.split('.')[0...-1].join('.')
+                end
+              end
             end
           end
         end

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

@@ -39,7 +39,7 @@ module Inch
 
               # @return [Boolean] +true+ if the type of the parameter is defined
               def typed?
-                false # TODO: parse types of params
+                described_by_docstring?
               end
 
               # @return [Boolean] +true+ if the parameter is mentioned in the

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

@@ -6,10 +6,6 @@ module Inch
           module Object
             # Proxy class for modules
             class ModuleObject < Base
-              def fullname
-                @hash['id']
-              end
-
               def namespace?
                 true
               end

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

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

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = '0.5.9'
+  VERSION = '0.5.10'
 end

data/test/fixtures/nodejs/inch_test/all.json

@@ -0,0 +1,253 @@
+{
+    "args": [], 
+    "branch_name": "master", 
+    "client_name": "inchjs", 
+    "client_version": "0.1.4", 
+    "git_repo_url": "git@github.com:inch-ci/Hello-World-NodeJS.git", 
+    "language": "nodejs", 
+    "objects": [
+        {
+            "comment": "", 
+            "kind": "function", 
+            "longname": "InstanciatableClass", 
+            "meta": {
+                "code": {
+                    "id": "astnode100000004", 
+                    "name": "InstanciatableClass", 
+                    "type": "FunctionExpression", 
+                    "value": "function"
+                }, 
+                "filename": "inch_test.js", 
+                "lineno": 4, 
+                "path": "/src", 
+                "range": [
+                    20, 
+                    55
+                ]
+            }, 
+            "name": "InstanciatableClass", 
+            "scope": "global", 
+            "undocumented": true
+        }, 
+        {
+            "comment": "", 
+            "kind": "function", 
+            "longname": "InstanciatableClass#render", 
+            "memberof": "InstanciatableClass", 
+            "meta": {
+                "code": {
+                    "id": "astnode100000009", 
+                    "name": "InstanciatableClass.prototype.render", 
+                    "paramnames": [], 
+                    "type": "FunctionExpression", 
+                    "value": "function"
+                }, 
+                "filename": "inch_test.js", 
+                "lineno": 5, 
+                "path": "/src", 
+                "range": [
+                    57, 
+                    125
+                ]
+            }, 
+            "name": "render", 
+            "scope": "instance", 
+            "undocumented": true
+        }, 
+        {
+            "access": "private", 
+            "comment": "/**\n* @private\n*/", 
+            "kind": "function", 
+            "longname": "InchTest.generate_docs", 
+            "memberof": "InchTest", 
+            "meta": {
+                "code": {
+                    "id": "astnode100000024", 
+                    "name": "InchTest.generate_docs", 
+                    "paramnames": [
+                        "project", 
+                        "version", 
+                        "args", 
+                        "options"
+                    ], 
+                    "type": "FunctionExpression", 
+                    "value": "function"
+                }, 
+                "filename": "inch_test.js", 
+                "lineno": 13, 
+                "path": "/src", 
+                "range": [
+                    165, 
+                    236
+                ]
+            }, 
+            "name": "generate_docs", 
+            "scope": "static"
+        }, 
+        {
+            "comment": "// Generate JSON documentation for the given modules", 
+            "kind": "function", 
+            "longname": "InchTest.Docs.Formatter.run", 
+            "memberof": "InchTest.Docs.Formatter", 
+            "meta": {
+                "code": {
+                    "id": "astnode100000042", 
+                    "name": "run", 
+                    "type": "FunctionExpression", 
+                    "value": "function"
+                }, 
+                "filename": "inch_test.js", 
+                "lineno": 19, 
+                "path": "/src", 
+                "range": [
+                    333, 
+                    398
+                ]
+            }, 
+            "name": "run", 
+            "scope": "static", 
+            "undocumented": true
+        }, 
+        {
+            "comment": "/**\n*\n* This function takes `param1` and `param2` as arguments.\n*\n* @param {Number} param1 A number from 0 to 26 that will result in a letter a-z\n* @param {String} param2 A text\n* @return {String} A character from a-z based on the input number n\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/", 
+            "description": "This function takes `param1` and `param2` as arguments.", 
+            "kind": "function", 
+            "longname": "InchTest.Functions.full_doc", 
+            "memberof": "InchTest.Functions", 
+            "meta": {
+                "code": {
+                    "id": "astnode100000057", 
+                    "name": "InchTest.Functions.full_doc", 
+                    "paramnames": [
+                        "param1", 
+                        "param2"
+                    ], 
+                    "type": "FunctionExpression", 
+                    "value": "function"
+                }, 
+                "filename": "inch_test.js", 
+                "lineno": 41, 
+                "path": "/src", 
+                "range": [
+                    841, 
+                    914
+                ]
+            }, 
+            "name": "full_doc", 
+            "params": [
+                {
+                    "description": "A number from 0 to 26 that will result in a letter a-z", 
+                    "name": "param1", 
+                    "type": {
+                        "names": [
+                            "Number"
+                        ]
+                    }
+                }, 
+                {
+                    "description": "A text", 
+                    "name": "param2", 
+                    "type": {
+                        "names": [
+                            "String"
+                        ]
+                    }
+                }
+            ], 
+            "returns": [
+                {
+                    "description": "A character from a-z based on the input number n\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"", 
+                    "type": {
+                        "names": [
+                            "String"
+                        ]
+                    }
+                }
+            ], 
+            "scope": "static"
+        }, 
+        {
+            "comment": "/**\n*\n* This function takes a `param1` and a second parameter that is never used\n* (maybe, because it is a callback or something like that). However, the\n* second param should impact the evaluation by Inch.\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/", 
+            "description": "This function takes a `param1` and a second parameter that is never used\n(maybe, because it is a callback or something like that). However, the\nsecond param should impact the evaluation by Inch.\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"", 
+            "kind": "function", 
+            "longname": "InchTest.Functions.full_doc_second_parameter_unnamed", 
+            "memberof": "InchTest.Functions", 
+            "meta": {
+                "code": {
+                    "id": "astnode100000070", 
+                    "name": "InchTest.Functions.full_doc_second_parameter_unnamed", 
+                    "paramnames": [
+                        "param1", 
+                        "_"
+                    ], 
+                    "type": "FunctionExpression", 
+                    "value": "function"
+                }, 
+                "filename": "inch_test.js", 
+                "lineno": 57, 
+                "path": "/src", 
+                "range": [
+                    1271, 
+                    1364
+                ]
+            }, 
+            "name": "full_doc_second_parameter_unnamed", 
+            "scope": "static"
+        }, 
+        {
+            "comment": "/**\n*\n* This function takes no arguments.\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/", 
+            "description": "This function takes no arguments.\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"", 
+            "kind": "function", 
+            "longname": "InchTest.CodeExamples.single_code_example", 
+            "memberof": "InchTest.CodeExamples", 
+            "meta": {
+                "code": {
+                    "id": "astnode100000088", 
+                    "name": "single_code_example", 
+                    "type": "FunctionExpression", 
+                    "value": "function"
+                }, 
+                "filename": "inch_test.js", 
+                "lineno": 74, 
+                "path": "/src", 
+                "range": [
+                    1609, 
+                    1665
+                ]
+            }, 
+            "name": "single_code_example", 
+            "scope": "static"
+        }, 
+        {
+            "comment": "/**\n*\n* This function takes no arguments.\n*\n* Examples:\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*\n* In general, `underscore` can be thought of as the reverse ...\n*\n*   > InchTest.Naming.resource_name(MyApp.User)\n*   \"user\"\n*   > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n*   \"user\"\n*/", 
+            "description": "This function takes no arguments.\n\nExamples:\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"\n\nIn general, `underscore` can be thought of as the reverse ...\n\n  > InchTest.Naming.resource_name(MyApp.User)\n  \"user\"\n  > InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n  \"user\"", 
+            "kind": "function", 
+            "longname": "InchTest.CodeExamples.multiple_code_examples", 
+            "memberof": "InchTest.CodeExamples", 
+            "meta": {
+                "code": {
+                    "id": "astnode100000093", 
+                    "name": "multiple_code_examples", 
+                    "type": "FunctionExpression", 
+                    "value": "function"
+                }, 
+                "filename": "inch_test.js", 
+                "lineno": 95, 
+                "path": "/src", 
+                "range": [
+                    2094, 
+                    2153
+                ]
+            }, 
+            "name": "multiple_code_examples", 
+            "scope": "static"
+        }, 
+        {
+            "files": [
+                "/home/rf/devel/Hello-World-NodeJS/src/inch_test.js"
+            ], 
+            "kind": "package", 
+            "longname": "package:undefined"
+        }
+    ]
+}

data/test/unit/language/nodejs/code_object/function_object_test.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../../test_helper')
+
+describe ::Inch::Language::Elixir::CodeObject::FunctionObject do
+  before do
+    @codebase = fresh_codebase(:nodejs, :inch_test, 'all.json')
+    @objects = @codebase.objects
+  end
+
+  describe 'Scores' do
+    #
+    it 'should not' do
+      m = @objects.find('InchTest.generate_docs')
+      assert m.score >= 50
+    end
+  end
+
+  it 'should recognize the relationship between modules and functions' do
+    skip "InchTest is a member and therefore not counted at the moment"
+    mod = @objects.find('InchTest')
+    assert mod.has_children?
+    assert mod.children.size > 1
+    fun = @objects.find('InchTest.generate_docs')
+    assert_equal mod, fun.parent
+  end
+
+  it 'should recognize the depth of methods' do
+    m = @objects.find('InchTest')
+    m = @objects.find('InchTest.Docs.Formatter.run')
+    assert_equal 4, m.depth
+    skip "InchTest is a member and therefore not counted at the moment"
+
+    assert_equal 1, m.depth
+    m = @objects.find('InchTest.Config')
+    assert_equal 2, m.depth
+    m = @objects.find('InchTest.Docs.Formatter')
+    assert_equal 3, m.depth
+  end
+
+  it 'should parse parameters correctly' do
+    m = @objects.find('InchTest.generate_docs')
+    assert_equal 4, m.parameters.size
+  end
+
+  it 'should parse parameters correctly' do
+    m = @objects.find('InchTest.Functions.full_doc')
+    assert_equal 2, m.parameters.size
+    assert_equal 'A', m.grade.to_s
+  end
+
+  it 'should recognize code examples' do
+    m = @objects.find('InchTest.CodeExamples.single_code_example')
+    assert m.has_code_example?
+    refute m.has_multiple_code_examples?
+
+    m = @objects.find('InchTest.CodeExamples.multiple_code_examples')
+    assert m.has_code_example?
+    assert m.has_multiple_code_examples?
+  end
+end

data/test/unit/language/nodejs/provider/jsdoc/docstring_test.rb

@@ -42,6 +42,27 @@ describe ::Inch::Language::Nodejs::Provider::JSDoc::Docstring do
     refute docstring.describes_return?
   end
 
+  it 'should notice things in jsdoc style docs 3' do
+    text = <<-DOC
+  /**
+   *
+   * This function takes `param1` and `param2` as arguments.
+   *
+   * @param {Number} param1 A number from 0 to 26 that will result in a letter a-z
+   * @param {String} param2 A text
+   * @return {String} A character from a-z based on the input number n
+   *
+   */
+    DOC
+    docstring = described_class.new(text)
+    assert docstring.mentions_parameter?(:param1)
+    assert docstring.describes_parameter?(:param1)
+    assert docstring.mentions_parameter?(:param2)
+    assert docstring.describes_parameter?(:param2)
+    assert docstring.mentions_return?
+    assert docstring.describes_return?
+  end
+
   it 'should notice things in jsdoc style docs' do
     %w(public protected private).each do |visibility|
       text = <<-DOC
@@ -77,7 +98,7 @@ Set or get the context `Runnable` to `runnable`.
 @api private
     DOC
     docstring = described_class.new(text)
-    assert_equal without_comment_markers.strip, docstring.without_comment_markers
+    assert_equal without_comment_markers.strip, docstring.to_s
   end
 
   it 'should remove comment markers for parsing 2' do
@@ -91,19 +112,20 @@ Set or get the context `Runnable` to `runnable`.
 Set or get the context `Runnable` to `runnable`.
     DOC
     docstring = described_class.new(text)
-    assert_equal without_comment_markers.strip, docstring.without_comment_markers
+    assert_equal without_comment_markers.strip, docstring.to_s
   end
 
 
   it 'should remove comment markers for parsing 3' do
     text = <<-DOC
-    //Set or get the context `Runnable` to `runnable`.
+    // Set or get the context `Runnable` to `runnable`.
+    // Set or get the context `Runnable` to `runnable`.
     DOC
     without_comment_markers = <<-DOC
+Set or get the context `Runnable` to `runnable`.
 Set or get the context `Runnable` to `runnable`.
     DOC
     docstring = described_class.new(text)
-    assert_equal without_comment_markers.strip, docstring.without_comment_markers
+    assert_equal without_comment_markers.strip, docstring.to_s
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-10 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -311,6 +311,7 @@ files:
 - lib/inch/utils/weighted_list.rb
 - lib/inch/version.rb
 - test/fixtures/elixir/inch_test/all.json
+- test/fixtures/nodejs/inch_test/all.json
 - test/fixtures/ruby/alias_cycle/lib/alias.rb
 - test/fixtures/ruby/code_examples/lib/foo.rb
 - test/fixtures/ruby/diff1/lib/diff1.rb
@@ -369,6 +370,7 @@ files:
 - test/unit/evaluation/role_test.rb
 - test/unit/language/elixir/code_object/function_object_test.rb
 - test/unit/language/elixir/code_object/module_object_test.rb
+- test/unit/language/nodejs/code_object/function_object_test.rb
 - test/unit/language/nodejs/provider/jsdoc/docstring_test.rb
 - test/unit/language/ruby/code_object/alias_test.rb
 - test/unit/language/ruby/code_object/method_object_test.rb
@@ -405,6 +407,7 @@ specification_version: 4
 summary: Documentation measurement tool for Ruby
 test_files:
 - test/fixtures/elixir/inch_test/all.json
+- test/fixtures/nodejs/inch_test/all.json
 - test/fixtures/ruby/alias_cycle/lib/alias.rb
 - test/fixtures/ruby/code_examples/lib/foo.rb
 - test/fixtures/ruby/diff1/lib/diff1.rb
@@ -463,6 +466,7 @@ test_files:
 - test/unit/evaluation/role_test.rb
 - test/unit/language/elixir/code_object/function_object_test.rb
 - test/unit/language/elixir/code_object/module_object_test.rb
+- test/unit/language/nodejs/code_object/function_object_test.rb
 - test/unit/language/nodejs/provider/jsdoc/docstring_test.rb
 - test/unit/language/ruby/code_object/alias_test.rb
 - test/unit/language/ruby/code_object/method_object_test.rb