inch 0.5.0.rc8 → 0.5.0.rc9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf685167eb90266f1ade2a603f466791804dcee0
-  data.tar.gz: fba628a914b7dc892d6e8fedfb8875348995961f
+  metadata.gz: 307bb0b28d76ee1c7f05a226cfaf421ba6620077
+  data.tar.gz: 4e9b727f8db07d2da162538d0db12eb143aa3d43
 SHA512:
-  metadata.gz: 13fca201ad1cd8a476dbff2f3161c6afe02cfda60086da40f9eed0edaf20db143b6fa435d1dc983371eef80a0b457baa4a6f92999ad10863d0f54009d1e24bb5
-  data.tar.gz: 59da30a14fb8c646a517c9aec2886e36769fc37d285e474eb52f973445c799dba31bc15d552c05da88438030e048ae863516f1e7a696ac3f20715391702af20a
+  metadata.gz: b5540bb674d846f63d1a41f530d2bdb9ad4b93555b3f837c728d0f2e082ecb1bf87615d0416d849a6ca7c05d77cb4c1588f09c8f4f630722648ab96e68e9e626
+  data.tar.gz: ffa06231bf7c91dc536ec131e3c0e9b2993207b7b022e3852db3304bb378f0eab3214f844dd2e98f3860126769eef50f959b6165adb2f9a831a09b7745879bbf

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.0
+ruby-2.1.3

data/lib/inch/language/elixir/code_object/function_object.rb

@@ -1,3 +1,5 @@
+require 'inch/language/elixir/code_object/function_parameter_object'
+
 module Inch
   module Language
     module Elixir
@@ -31,7 +33,7 @@ module Inch
 
           def parameters
             @parameters ||= self[:parameters].map do |param_attr|
-              MethodParameterObject.new(param_attr)
+              FunctionParameterObject.new(param_attr)
             end
           end
 

data/lib/inch/language/elixir/code_object/function_parameter_object.rb

@@ -0,0 +1,64 @@
+module Inch
+  module Language
+    module Elixir
+      module CodeObject
+        # Proxy class for method parameters
+        class FunctionParameterObject
+          def initialize(attributes)
+            @attributes = attributes
+          end
+
+          def [](key)
+            @attributes[key]
+          end
+
+          BAD_NAME_EXCEPTIONS = %w(id)
+          BAD_NAME_THRESHOLD = 3
+
+          # @return [Boolean] +true+ if the name of the parameter is
+          #   uncommunicative
+          def bad_name?
+            return false if BAD_NAME_EXCEPTIONS.include?(name)
+            name.size < BAD_NAME_THRESHOLD || name =~ /[0-9]$/
+          end
+
+          # @return [Boolean] +true+ if the parameter is a block
+          def block?
+            self[:block?]
+          end
+
+          # @return [Boolean] +true+ if an additional description given?
+          def described?
+            self[:described?]
+          end
+
+          # @return [Boolean] +true+ if the parameter is mentioned in the docs
+          def mentioned?
+            self[:mentioned?]
+          end
+
+          def name
+            self[:name]
+          end
+          alias_method :fullname, :name
+
+          # @return [Boolean] +true+ if the parameter is a splat argument
+          def splat?
+            self[:splat?]
+          end
+
+          # @return [Boolean] +true+ if the type of the parameter is defined
+          def typed?
+            self[:typed?]
+          end
+
+          # @return [Boolean] +true+ if the parameter is mentioned in the docs,
+          #   but not present in the method's signature
+          def wrongly_mentioned?
+            self[:wrongly_mentioned?]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/elixir/evaluation/function_object.rb

@@ -4,12 +4,28 @@ module Inch
       module Evaluation
         # Proxy class for functions
         class FunctionObject < Base
+          def evaluate
+            super
+            evaluate_parameters
+          end
+
           protected
 
           def relevant_roles
             relevant_base_roles.merge(relevant_function_roles)
           end
 
+          private
+
+          def evaluate_parameters
+            params = object.parameters
+            per_param = score_for_single_parameter
+            params.each do |param|
+              role_classes = relevant_parameter_roles(param, per_param)
+              __evaluate(param, role_classes)
+            end
+          end
+
           def relevant_function_roles
             {
               Role::Function::Getter => nil,
@@ -24,6 +40,23 @@ module Inch
               Role::Function::WithQuestioningName => nil
             }
           end
+
+          def relevant_parameter_roles(param, per_param)
+            {
+              Role::FunctionParameter::WithWrongMention =>
+                -score_for(:parameters),
+              Role::FunctionParameter::WithMention => per_param * 0.5,
+              Role::FunctionParameter::WithoutMention => per_param * 0.5,
+              Role::FunctionParameter::WithType => per_param * 0.5,
+              Role::FunctionParameter::WithoutType => per_param * 0.5,
+              Role::FunctionParameter::WithBadName => nil,
+            }
+          end
+
+          def score_for_single_parameter
+            @param_score ||= score_for(:parameters) / object.parameters.size
+          end
+
         end
       end
     end

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

@@ -21,4 +21,5 @@ require 'inch/language/elixir/roles/base'
 require 'inch/language/elixir/roles/object'
 require 'inch/language/elixir/roles/module'
 require 'inch/language/elixir/roles/function'
+require 'inch/language/elixir/roles/function_parameter'
 require 'inch/language/elixir/roles/type'

data/lib/inch/language/elixir/provider/reader/object/base.rb

@@ -128,7 +128,7 @@ module Inch
               end
 
               def parameters
-                [] # raise NotImplementedError
+                []
               end
 
               def private?
@@ -190,6 +190,7 @@ module Inch
               def visibility
                 :public
               end
+
             end
           end
         end

data/lib/inch/language/elixir/provider/reader/object/function_object.rb

@@ -1,3 +1,5 @@
+require 'inch/language/elixir/provider/reader/object/function_parameter_object'
+
 module Inch
   module Language
     module Elixir
@@ -17,6 +19,28 @@ module Inch
               def method?
                 true
               end
+
+              def parameters
+                names = FunctionSignature.new(name, @hash['signature']).parameter_names
+                names.map do |name|
+                  FunctionParameterObject.new(self, name)
+                end
+              end
+
+              private
+
+              class FunctionSignature < Struct.new(:fun_name, :signature)
+                def parameter_names
+                  base_name = fun_name.split('/').first
+                  signature.gsub(/^(#{base_name}\()/, '').gsub(/(\))$/, '')
+                    .gsub( /\([^\)]+\)/, '' )
+                    .split(',')
+                    .map do |param|
+                      name = param.split("\\\\").first
+                      name && name.strip
+                    end.compact
+                end
+              end
             end
           end
         end

data/lib/inch/language/elixir/provider/reader/object/function_parameter_object.rb

@@ -0,0 +1,66 @@
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module Reader
+          module Object
+            # Proxy class for function parameters
+            class FunctionParameterObject
+              attr_reader :name # @return [String]
+
+              # @param method [YARD::Object::MethodObject] the method the
+              #   parameter belongs to
+              # @param name [String] the name of the parameter
+              def initialize(method, name)
+                @method = method
+                @name = name
+              end
+
+              # @return [Boolean] +true+ if the parameter is a block
+              def block?
+                false
+              end
+
+              # @return [Boolean] +true+ if an additional description is given?
+              def described?
+                described_by_docstring?
+              end
+
+              # @return [Boolean] +true+ if the parameter is mentioned in the
+              #   docs
+              def mentioned?
+                mentioned_by_docstring?
+              end
+
+              # @return [Boolean] +true+ if the parameter is a splat argument
+              def splat?
+                false
+              end
+
+              # @return [Boolean] +true+ if the type of the parameter is defined
+              def typed?
+                false # TODO: parse types of params
+              end
+
+              # @return [Boolean] +true+ if the parameter is mentioned in the
+              #   docs, but not present in the method's signature
+              def wrongly_mentioned?
+                false
+              end
+
+              private
+
+              def described_by_docstring?
+                @method.docstring.describes_parameter?(name)
+              end
+
+              def mentioned_by_docstring?
+                @method.docstring.mentions_parameter?(name)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/elixir/roles/function_parameter.rb

@@ -0,0 +1,84 @@
+module Inch
+  module Language
+    module Elixir
+      module Evaluation
+        module Role
+          # Roles assigned to method parameters
+          #
+          # @note The +object+ is a MethodParameterObject here!
+          module FunctionParameter
+            # Role assigned to parameters that are mentioned in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#mentioned?
+            class WithMention < Base
+              applicable_if :mentioned?
+            end
+
+            # Role assigned to parameters that are not mentioned in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#mentioned?
+            class WithoutMention < Missing
+              applicable_unless :mentioned?
+
+              def suggestion
+                "Describe the parameter '#{object.name}'"
+              end
+            end
+
+            # Role assigned to parameters that are typed in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#typed?
+            class WithType < Base
+              applicable_if :typed?
+            end
+
+            # Role assigned to parameters that are not typed in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#typed?
+            class WithoutType < Missing
+              applicable_unless :typed?
+            end
+
+            # Role assigned to parameters that are spalts, e.g. +*args+
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#splat?
+            class Splat < Base
+              applicable_if :splat?
+              priority      +1
+            end
+
+            # Role assigned to parameters that are blocks, e.g. +&block+
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#block?
+            class Block < Base
+              applicable_if :block?
+              priority      +1
+            end
+
+            # Role assigned to parameters that are documented, but not part of
+            # the method signature
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#wrongly_mentioned?
+            class WithWrongMention < Base
+              applicable_if :wrongly_mentioned?
+              priority      +1
+
+              def suggestion
+                "The parameter '#{object.name}' seems not to be part of the " \
+                  'signature.'
+              end
+            end
+
+            # Role assigned to parameters that have a 'bad' name
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#bad_name?
+            class WithBadName < Base
+              applicable_if :bad_name?
+              priority      +1
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,5 @@
+require 'inch/language/nodejs/code_object/function_parameter_object'
+
 module Inch
   module Language
     module Nodejs
@@ -31,7 +33,7 @@ module Inch
 
           def parameters
             @parameters ||= self[:parameters].map do |param_attr|
-              MethodParameterObject.new(param_attr)
+              FunctionParameterObject.new(param_attr)
             end
           end
 

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

@@ -0,0 +1,64 @@
+module Inch
+  module Language
+    module Nodejs
+      module CodeObject
+        # Proxy class for method parameters
+        class FunctionParameterObject
+          def initialize(attributes)
+            @attributes = attributes
+          end
+
+          def [](key)
+            @attributes[key]
+          end
+
+          BAD_NAME_EXCEPTIONS = %w(id)
+          BAD_NAME_THRESHOLD = 3
+
+          # @return [Boolean] +true+ if the name of the parameter is
+          #   uncommunicative
+          def bad_name?
+            return false if BAD_NAME_EXCEPTIONS.include?(name)
+            name.size < BAD_NAME_THRESHOLD || name =~ /[0-9]$/
+          end
+
+          # @return [Boolean] +true+ if the parameter is a block
+          def block?
+            self[:block?]
+          end
+
+          # @return [Boolean] +true+ if an additional description given?
+          def described?
+            self[:described?]
+          end
+
+          # @return [Boolean] +true+ if the parameter is mentioned in the docs
+          def mentioned?
+            self[:mentioned?]
+          end
+
+          def name
+            self[:name]
+          end
+          alias_method :fullname, :name
+
+          # @return [Boolean] +true+ if the parameter is a splat argument
+          def splat?
+            self[:splat?]
+          end
+
+          # @return [Boolean] +true+ if the type of the parameter is defined
+          def typed?
+            self[:typed?]
+          end
+
+          # @return [Boolean] +true+ if the parameter is mentioned in the docs,
+          #   but not present in the method's signature
+          def wrongly_mentioned?
+            self[:wrongly_mentioned?]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,12 +4,28 @@ module Inch
       module Evaluation
         # Proxy class for functions
         class FunctionObject < Base
+          def evaluate
+            super
+            evaluate_parameters
+          end
+
           protected
 
           def relevant_roles
             relevant_base_roles.merge(relevant_function_roles)
           end
 
+          private
+
+          def evaluate_parameters
+            params = object.parameters
+            per_param = score_for_single_parameter
+            params.each do |param|
+              role_classes = relevant_parameter_roles(param, per_param)
+              __evaluate(param, role_classes)
+            end
+          end
+
           def relevant_function_roles
             {
               Role::Function::Getter => nil,
@@ -19,11 +35,25 @@ module Inch
                   object.overridden_method.score
                 else
                   nil
-                end,
-              Role::Function::WithBangName => nil,
-              Role::Function::WithQuestioningName => nil
+                end
             }
           end
+
+          def relevant_parameter_roles(param, per_param)
+            {
+              Role::FunctionParameter::WithWrongMention =>
+                -score_for(:parameters),
+              Role::FunctionParameter::WithMention => per_param * 0.5,
+              Role::FunctionParameter::WithoutMention => per_param * 0.5,
+              Role::FunctionParameter::WithType => per_param * 0.5,
+              Role::FunctionParameter::WithoutType => per_param * 0.5,
+              Role::FunctionParameter::WithBadName => nil,
+            }
+          end
+
+          def score_for_single_parameter
+            @param_score ||= score_for(:parameters) / object.parameters.size
+          end
         end
       end
     end

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

@@ -21,4 +21,5 @@ require 'inch/language/nodejs/roles/base'
 require 'inch/language/nodejs/roles/object'
 require 'inch/language/nodejs/roles/module'
 require 'inch/language/nodejs/roles/function'
+require 'inch/language/nodejs/roles/function_parameter'
 require 'inch/language/nodejs/roles/member'

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

@@ -5,6 +5,58 @@ module Inch
       module Provider
         module JSDoc
           class Docstring < Ruby::Provider::YARD::Docstring
+            # 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
+            end
+
+            def describes_internal_api?
+              tag?(:api, :private) || super
+            end
+
+            def describes_parameter?(name)
+              return false if name.nil?
+              parameter = parameter_notations(name)
+              tag?(:param, /#{parameter}\s+\S+/)
+            end
+
+            def mentions_parameter?(name)
+              return false if name.nil?
+              parameter = parameter_notations(name)
+              tag?(:param, /#{parameter}/) || super
+            end
+
+            def mentions_return?
+              tag?(:return) || super
+            end
+
+            def describes_return?
+              type_notation = /(\{[^\}]+\}|\[[^\]]+\])/
+              tag?(:return, /#{type_notation}*(\s\w+)/) || super
+            end
+
+            def visibility
+              %w(public protected private).detect do |v|
+                tag?(v)
+              end || 'public'
+            end
+
+            def tag?(tagname, regex = nil)
+              if without_comment_markers =~ /^\s*\@#{tagname}([^\n]*)$/m
+                if regex.nil?
+                  true
+                else
+                  $1 =~ /#{regex}/
+                end
+              end
+            end
           end
         end
       end

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

@@ -147,7 +147,14 @@ module Inch
               end
 
               def parameters
-                [] # raise NotImplementedError
+                if meta? && meta['code']
+                  names = meta['code']['paramnames'] || []
+                  names.map do |name|
+                    FunctionParameterObject.new(self, name)
+                  end
+                else
+                  []
+                end
               end
 
               def private?
@@ -207,7 +214,7 @@ module Inch
               end
 
               def visibility
-                :public
+                docstring.visibility
               end
 
               protected

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

@@ -1,3 +1,5 @@
+require 'inch/language/nodejs/provider/jsdoc/object/function_parameter_object'
+
 module Inch
   module Language
     module Nodejs

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

@@ -0,0 +1,66 @@
+module Inch
+  module Language
+    module Nodejs
+      module Provider
+        module JSDoc
+          module Object
+            # Proxy class for function parameters
+            class FunctionParameterObject
+              attr_reader :name # @return [String]
+
+              # @param method [YARD::Object::MethodObject] the method the
+              #   parameter belongs to
+              # @param name [String] the name of the parameter
+              def initialize(method, name)
+                @method = method
+                @name = name
+              end
+
+              # @return [Boolean] +true+ if the parameter is a block
+              def block?
+                false
+              end
+
+              # @return [Boolean] +true+ if an additional description is given?
+              def described?
+                described_by_docstring?
+              end
+
+              # @return [Boolean] +true+ if the parameter is mentioned in the
+              #   docs
+              def mentioned?
+                mentioned_by_docstring?
+              end
+
+              # @return [Boolean] +true+ if the parameter is a splat argument
+              def splat?
+                false
+              end
+
+              # @return [Boolean] +true+ if the type of the parameter is defined
+              def typed?
+                false # TODO: parse types of params
+              end
+
+              # @return [Boolean] +true+ if the parameter is mentioned in the
+              #   docs, but not present in the method's signature
+              def wrongly_mentioned?
+                false
+              end
+
+              private
+
+              def described_by_docstring?
+                @method.docstring.describes_parameter?(name)
+              end
+
+              def mentioned_by_docstring?
+                @method.docstring.mentions_parameter?(name)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/nodejs/roles/function_parameter.rb

@@ -0,0 +1,84 @@
+module Inch
+  module Language
+    module Nodejs
+      module Evaluation
+        module Role
+          # Roles assigned to method parameters
+          #
+          # @note The +object+ is a MethodParameterObject here!
+          module FunctionParameter
+            # Role assigned to parameters that are mentioned in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#mentioned?
+            class WithMention < Base
+              applicable_if :mentioned?
+            end
+
+            # Role assigned to parameters that are not mentioned in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#mentioned?
+            class WithoutMention < Missing
+              applicable_unless :mentioned?
+
+              def suggestion
+                "Describe the parameter '#{object.name}'"
+              end
+            end
+
+            # Role assigned to parameters that are typed in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#typed?
+            class WithType < Base
+              applicable_if :typed?
+            end
+
+            # Role assigned to parameters that are not typed in the docs
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#typed?
+            class WithoutType < Missing
+              applicable_unless :typed?
+            end
+
+            # Role assigned to parameters that are spalts, e.g. +*args+
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#splat?
+            class Splat < Base
+              applicable_if :splat?
+              priority      +1
+            end
+
+            # Role assigned to parameters that are blocks, e.g. +&block+
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#block?
+            class Block < Base
+              applicable_if :block?
+              priority      +1
+            end
+
+            # Role assigned to parameters that are documented, but not part of
+            # the method signature
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#wrongly_mentioned?
+            class WithWrongMention < Base
+              applicable_if :wrongly_mentioned?
+              priority      +1
+
+              def suggestion
+                "The parameter '#{object.name}' seems not to be part of the " \
+                  'signature.'
+              end
+            end
+
+            # Role assigned to parameters that have a 'bad' name
+            #
+            # @see CodeObject::Ruby::MethodParameterObject#bad_name?
+            class WithBadName < Base
+              applicable_if :bad_name?
+              priority      +1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/ruby/provider/yard/docstring.rb

@@ -59,7 +59,7 @@ module Inch
               @text
             end
 
-            private
+            protected
 
             def first_line
               @first_line ||= @text.lines.to_a.first
@@ -103,23 +103,29 @@ module Inch
             # @param name [String] the name of the method parameter
             # @return [Array<Regexp>]
             def mention_parameter_patterns(name)
+              expr = parameter_notations(name)
+              [
+                /#{expr}\:\:/,            # param1::
+                /\`#{expr}\`/,            # `param1`
+                /\+#{expr}\+/,            # +param1+
+                /\+#{expr}\+\:\:/,        # +param1+::
+                /<tt>#{expr}<\/tt>/,      # <tt>param1</tt>
+                /<tt>#{expr}<\/tt>\:\:/,  # <tt>param1</tt>::
+                /^#{expr}\ \-\ /          # param1 -
+              ]
+            end
+
+            # Returns possible notations for +name+.
+            # matches "param1" and "param1<String,nil>"
+            # @return [Regexp]
+            def parameter_notations(name)
               escaped_name = Regexp.escape(name)
               type = /<[^>]+>/
-              [
-                escaped_name,
-                /#{escaped_name}#{type}/ # matches "param1<String,nil>"
-              ].map do |expr|
-                [
-                  /#{expr}\:\:/,            # param1::
-                  /\+#{expr}\+/,            # +param1+
-                  /\+#{expr}\+\:\:/,        # +param1+::
-                  /<tt>#{expr}<\/tt>/,      # <tt>param1</tt>
-                  /<tt>#{expr}<\/tt>\:\:/,  # <tt>param1</tt>::
-                  /^#{expr}\ \-\ /          # param1 -
-                ]
-              end.flatten
+              /(#{escaped_name}|#{escaped_name}#{type})/
             end
 
+            # Returns regexes to match parameter description on the next
+            # line.
             def describe_parameter_extra_regexps(name)
               [
                 "#{name}::",

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = '0.5.0.rc8'
+  VERSION = '0.5.0.rc9'
 end

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

@@ -10,7 +10,7 @@ describe ::Inch::Language::Elixir::CodeObject::FunctionObject do
     #
     it 'should not' do
       m = @objects.find('InchEx.generate_docs/3')
-      assert m.score > 50
+      assert m.score >= 50
     end
   end
 
@@ -32,4 +32,16 @@ describe ::Inch::Language::Elixir::CodeObject::FunctionObject do
     m = @objects.find('InchEx.Docs.Formatter.run/2')
     assert_equal 4, m.depth
   end
+
+  it "should parse parameters correctly" do
+    m = @objects.find("Mix.Tasks.Inch.run/4")
+    #assert_equal 4, m.parameters.size
+  end
+
+  # TODO: move to own test file
+  it "should parse parameters correctly 1" do
+    klass = ::Inch::Language::Elixir::Provider::Reader::Object::FunctionObject::FunctionSignature
+    fn = klass.new('run/4', "run(args, config \\\\ Mix.Project.config(), generator \\\\ :erlang.make_fun(InchEx, :generate_docs, 3), reporter \\\\ InchEx.Reporter.Local)")
+    assert_equal %w(args config generator reporter), fn.parameter_names
+  end
 end

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

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../../../test_helper')
+
+describe ::Inch::Language::Nodejs::Provider::JSDoc::Docstring do
+  let(:described_class) { ::Inch::Language::Nodejs::Provider::JSDoc::Docstring }
+
+  #
+  # JSDoc compatibility
+  #
+
+  it 'should notice things in jsdoc style docs' do
+    text = <<-DOC
+  /**
+   * Set or get the context `Runnable` to `runnable`.
+   *
+   * @param {Runnable} runnable the runnable to execute
+   * @return {Context} the context
+   * @api private
+   */
+    DOC
+    docstring = described_class.new(text)
+    assert docstring.mentions_parameter?(:runnable)
+    assert docstring.describes_parameter?(:runnable)
+    assert docstring.describes_internal_api?
+    assert docstring.mentions_return?
+    assert docstring.describes_return?
+  end
+
+  it 'should notice things in jsdoc style docs 2' do
+    text = <<-DOC
+  /**
+   * Set or get the context `Runnable` to `runnable`.
+   *
+   * @param {Runnable} runnable
+   * @return {Context}
+   */
+    DOC
+    docstring = described_class.new(text)
+    assert docstring.mentions_parameter?(:runnable)
+    refute docstring.describes_parameter?(:runnable)
+    refute docstring.describes_internal_api?
+    assert docstring.mentions_return?
+    refute docstring.describes_return?
+  end
+
+  it 'should notice things in jsdoc style docs' do
+    %w(public protected private).each do |visibility|
+      text = <<-DOC
+    /**
+     * Set or get the context `Runnable` to `runnable`.
+     *
+     * @#{visibility}
+     */
+      DOC
+      docstring = described_class.new(text)
+      assert_equal visibility, docstring.visibility
+    end
+  end
+
+
+  # removing comment slashes
+
+  it 'should remove comment markers for parsing 1' do
+    text = <<-DOC
+  /**
+   * Set or get the context `Runnable` to `runnable`.
+   *
+   * @param {Runnable} runnable the runnable to execute
+   * @return {Context} the context
+   * @api private
+   */
+    DOC
+    without_comment_markers = <<-DOC
+Set or get the context `Runnable` to `runnable`.
+
+@param {Runnable} runnable the runnable to execute
+@return {Context} the context
+@api private
+    DOC
+    docstring = described_class.new(text)
+    assert_equal without_comment_markers.strip, docstring.without_comment_markers
+  end
+
+  it 'should remove comment markers for parsing 2' do
+    text = <<-DOC
+  /*
+   * Set or get the context `Runnable` to `runnable`.
+   *
+   */
+    DOC
+    without_comment_markers = <<-DOC
+Set or get the context `Runnable` to `runnable`.
+    DOC
+    docstring = described_class.new(text)
+    assert_equal without_comment_markers.strip, docstring.without_comment_markers
+  end
+
+
+  it 'should remove comment markers for parsing 3' do
+    text = <<-DOC
+    //Set or get the context `Runnable` to `runnable`.
+    DOC
+    without_comment_markers = <<-DOC
+Set or get the context `Runnable` to `runnable`.
+    DOC
+    docstring = described_class.new(text)
+    assert_equal without_comment_markers.strip, docstring.without_comment_markers
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.5.0.rc8
+  version: 0.5.0.rc9
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2014-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -211,6 +211,7 @@ files:
 - lib/inch/language.rb
 - lib/inch/language/elixir/code_object/base.rb
 - lib/inch/language/elixir/code_object/function_object.rb
+- lib/inch/language/elixir/code_object/function_parameter_object.rb
 - lib/inch/language/elixir/code_object/module_object.rb
 - lib/inch/language/elixir/code_object/type_object.rb
 - lib/inch/language/elixir/evaluation/base.rb
@@ -223,16 +224,19 @@ files:
 - lib/inch/language/elixir/provider/reader/object.rb
 - lib/inch/language/elixir/provider/reader/object/base.rb
 - lib/inch/language/elixir/provider/reader/object/function_object.rb
+- lib/inch/language/elixir/provider/reader/object/function_parameter_object.rb
 - lib/inch/language/elixir/provider/reader/object/module_object.rb
 - lib/inch/language/elixir/provider/reader/object/type_object.rb
 - lib/inch/language/elixir/provider/reader/parser.rb
 - lib/inch/language/elixir/roles/base.rb
 - lib/inch/language/elixir/roles/function.rb
+- lib/inch/language/elixir/roles/function_parameter.rb
 - lib/inch/language/elixir/roles/module.rb
 - 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/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
@@ -245,11 +249,13 @@ files:
 - lib/inch/language/nodejs/provider/jsdoc/object.rb
 - lib/inch/language/nodejs/provider/jsdoc/object/base.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
 - lib/inch/language/nodejs/provider/jsdoc/object/module_object.rb
 - lib/inch/language/nodejs/provider/jsdoc/parser.rb
 - lib/inch/language/nodejs/roles/base.rb
 - lib/inch/language/nodejs/roles/function.rb
+- lib/inch/language/nodejs/roles/function_parameter.rb
 - lib/inch/language/nodejs/roles/member.rb
 - lib/inch/language/nodejs/roles/module.rb
 - lib/inch/language/nodejs/roles/object.rb
@@ -359,6 +365,7 @@ files:
 - test/unit/config_test.rb
 - test/unit/evaluation/role_test.rb
 - test/unit/language/elixir/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
 - test/unit/language/ruby/provider/yard/docstring_test.rb
@@ -451,6 +458,7 @@ test_files:
 - test/unit/config_test.rb
 - test/unit/evaluation/role_test.rb
 - test/unit/language/elixir/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
 - test/unit/language/ruby/provider/yard/docstring_test.rb