inch 0.5.0.rc11 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d83477cb56f05fa36eae43b8a5207cccf6160b53
-  data.tar.gz: 89554aa7ecb0f7845ebeaca9851eb8daa0e735e3
+  metadata.gz: 99ee504d6210614f2efc8b488d61a6106e8943af
+  data.tar.gz: 483a0a52a59e8b601cb3c847c9d40f2b0f483ea4
 SHA512:
-  metadata.gz: 6d7282dabbec8ed4f730eac1d7511f507c3dd260f8820ee8edaefe0fd385e902c0b7003c455487b90ae91596f1d9e2a0235e7cb102f6b2ab52a999d5872d3c4e
-  data.tar.gz: f2ee1b8f2716a954873e14fb7d58f8b1bd11c18182e8c1ee3bddedaf80f580a99d82b6c1e6518b6346b9cf559f25e40a22ff48f3aa22a78b52f371ce6c149312
+  metadata.gz: bade489d8eccd40e48bef4dfb2a86529ca5e58d1b804f8d75e4f5f68629fc09780e456f340f41db576207d55a21b66b14f08df6cfeac20b7782b68690f9b2094
+  data.tar.gz: 589ef72d6e520477c5b5d0ac280759bfb17de27a1674f33e503c04ee1044e864ea2ae35f3197ab4c6a883ab843c5423914d1f741c117defae6e72f98abe60a12

data/.rubocop_todo.yml

@@ -1,11 +1,11 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-08-31 11:34:00 +0200 using RuboCop version 0.25.0.
+# on 2014-10-06 22:11:42 +0200 using RuboCop version 0.25.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 34
+# Offense count: 51
 Lint/AmbiguousOperator:
   Enabled: false
 
@@ -13,30 +13,38 @@ Lint/AmbiguousOperator:
 Lint/Debugger:
   Enabled: false
 
-# Offense count: 16
+# Offense count: 29
 Lint/SpaceBeforeFirstArg:
   Enabled: false
 
-# Offense count: 9
+# Offense count: 1
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+
+# Offense count: 12
 # Cop supports --auto-correct.
 Lint/UnusedMethodArgument:
+  Enabled: true
+
+# Offense count: 1
+Lint/UselessAccessModifier:
   Enabled: false
 
-# Offense count: 7
+# Offense count: 8
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 197
+  Max: 196
 
 # Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 7
 
-# Offense count: 1
+# Offense count: 9
 # Configuration parameters: AllowURI.
 Metrics/LineLength:
-  Max: 81
+  Max: 368
 
-# Offense count: 27
+# Offense count: 28
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 34
@@ -54,7 +62,13 @@ Style/AccessorMethodName:
 Style/ClassAndModuleChildren:
   Enabled: false
 
-# Offense count: 87
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredMethods.
+Style/CollectionMethods:
+  Enabled: false
+
+# Offense count: 90
 Style/Documentation:
   Enabled: false
 
@@ -62,10 +76,20 @@ Style/Documentation:
 Style/DoubleNegation:
   Enabled: false
 
-# Offense count: 11
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/EmptyLines:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundBody:
+  Enabled: false
+
+# Offense count: 12
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
-  Enabled: false
+  Enabled: true
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -78,23 +102,71 @@ Style/HashSyntax:
 Style/IfUnlessModifier:
   Enabled: false
 
-# Offense count: 43
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/LeadingCommentSpace:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/PerlBackrefs:
+  Enabled: false
+
+# Offense count: 54
 # Configuration parameters: NamePrefixBlacklist.
 Style/PredicateName:
   Enabled: false
 
+# Offense count: 1
+Style/RegexpLiteral:
+  MaxSlashes: 4
+
 # Offense count: 2
 # Configuration parameters: Methods.
 Style/SingleLineBlockParams:
   Enabled: false
 
-# Offense count: 82
+# Offense count: 104
 # Cop supports --auto-correct.
 Style/SingleSpaceBeforeFirstArg:
   Enabled: false
 
+# Offense count: 15
+# Cop supports --auto-correct.
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+# Offense count: 31
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/StringLiterals:
+  Enabled: true
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/TrailingBlankLines:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+Style/TrailingComma:
+  Enabled: false
+
 # Offense count: 4
 # Cop supports --auto-correct.
 # Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
 Style/TrivialAccessors:
   Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/WordArray:
+  MinSize: 2

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.0.0
+  - 2.0
   - 2.1
+  - 2.2
   - ruby-head
   - jruby-head
   - jruby-19mode

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 
-## 0.4.11 (pre)
+## 0.5.0
+
+- Multi-language support was added
+- Basic Elixir capabilities were added
+- TomDoc compatibility was improved
+- stty warning when reading terminal size was fixed
+- Many Rubocop alerts were fixed (thanks @yous)
+
+## 0.4.11
 
 - Add `undefined` to the list of values used to indicate that a return value
   is not intended for further use. The current list is `nil`, `nothing`,

data/lib/inch/api/suggest.rb

@@ -69,7 +69,7 @@ module Inch
           priority_list.empty? ? list : priority_list)
       end
 
-      def all_filenames(objects)
+      def all_filenames(_objects)
         codebase.objects.map do |o|
           o.files.map(&:filename)
         end.flatten

data/lib/inch/cli/yardopts_helper.rb

@@ -17,7 +17,7 @@ module Inch
       # @param [Array<String>] args the arguments passed from input. This
       #   array will be modified.
       # @return [void]
-      def parse_yardopts_options(opts, args)
+      def parse_yardopts_options(_opts, args)
         wrapper = YardoptsWrapper.new
 
         dupped_args = args.dup

data/lib/inch/evaluation.rb

@@ -8,7 +8,7 @@ module Inch
 
     private
 
-    def self.class_for(language, code_object)
+    def self.class_for(_language, code_object)
       class_name = code_object.class.to_s.split('::').last
       language_namespace = Evaluation::Ruby
       language_namespace.const_get(class_name)

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

@@ -52,6 +52,10 @@ module Inch
             self[:typed?]
           end
 
+          def unnamed?
+            name == ''
+          end
+
           # @return [Boolean] +true+ if the parameter is mentioned in the docs,
           #   but not present in the method's signature
           def wrongly_mentioned?

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

@@ -41,14 +41,16 @@ module Inch
             }
           end
 
-          def relevant_parameter_roles(param, per_param)
+          def relevant_parameter_roles(_param, per_param)
+            score_for_mention = per_param
+            score_for_type = 0
             {
               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::WithMention => score_for_mention,
+              Role::FunctionParameter::WithoutMention => score_for_mention,
+              Role::FunctionParameter::WithType => score_for_type,
+              Role::FunctionParameter::WithoutType => score_for_type,
               Role::FunctionParameter::WithBadName => nil,
             }
           end

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

@@ -88,7 +88,7 @@ module Inch
               end
 
               def has_code_example?
-                false # raise NotImplementedError
+                docstring.code_examples.size > 0
               end
 
               def has_doc?
@@ -96,7 +96,7 @@ module Inch
               end
 
               def has_multiple_code_examples?
-                false # raise NotImplementedError
+                docstring.code_examples.size > 1
               end
 
               def has_unconsidered_tags?

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

@@ -41,7 +41,7 @@ module Inch
                   if b.nil? || b == 'Elixir'
                     a
                   else
-                    if a == "\\\\"
+                    if a == '\\\\'
                       name_from_tuple(*b.first)
                     else
                       warn "[WARN] could not parse FunctionSignature: #{[a, _, b].inspect}"

data/lib/inch/language/elixir/provider/reader/parser.rb

@@ -53,7 +53,7 @@ module Inch
 
             private
 
-            def parse_objects(paths, excluded, read_dump_file = nil)
+            def parse_objects(_paths, _excluded, read_dump_file = nil)
               if read_dump_file.nil?
                 fail 'Elixir analysis only works with --read-from-dump.'
               else

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

@@ -11,14 +11,19 @@ module Inch
             #
             # @see CodeObject::Ruby::MethodParameterObject#mentioned?
             class WithMention < Base
-              applicable_if :mentioned?
+              applicable_if do |p|
+                # unnamed parameters are mentioned implicitly
+                p.mentioned? || p.unnamed?
+              end
             end
 
             # Role assigned to parameters that are not mentioned in the docs
             #
             # @see CodeObject::Ruby::MethodParameterObject#mentioned?
             class WithoutMention < Missing
-              applicable_unless :mentioned?
+              applicable_if do |p|
+                !p.mentioned? && !p.unnamed?
+              end
 
               def suggestion
                 "Describe the parameter '#{object.name}'"

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

@@ -39,7 +39,7 @@ module Inch
             }
           end
 
-          def relevant_parameter_roles(param, per_param)
+          def relevant_parameter_roles(_param, per_param)
             {
               Role::FunctionParameter::WithWrongMention =>
                 -score_for(:parameters),

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

@@ -42,7 +42,7 @@ module Inch
 
             private
 
-            def parse_objects(paths, excluded, read_dump_file = nil)
+            def parse_objects(_paths, _excluded, read_dump_file = nil)
               if read_dump_file.nil?
                 fail 'NodeJS analysis only works with --read-from-dump.'
               else

data/lib/inch/language/ruby/evaluation/method_object.rb

@@ -51,7 +51,7 @@ module Inch
             }
           end
 
-          def relevant_parameter_roles(param, per_param)
+          def relevant_parameter_roles(_param, per_param)
             {
               Role::MethodParameter::WithWrongMention =>
                 -score_for(:parameters),

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

@@ -44,14 +44,14 @@ module Inch
 
             def mentions_return?
               last_lines.any? do |line|
-                line =~ /^#{tomdoc_modifiers}Returns\ /
+                line =~ /^#{tomdoc_modifiers}(Returns|Gets|Sets|Gets\/Sets)\ /
               end
             end
 
             def describes_return?
               last_lines.any? do |line|
-                line =~ /^#{tomdoc_modifiers}Returns\ (\w+\s){2,}/i ||
-                  line =~ /^#{tomdoc_modifiers}Returns\ (nil|nothing)\.*/i
+                line =~ /^#{tomdoc_modifiers}(Returns|Gets|Sets|Gets\/Sets)\ (\w+\s){2,}/i ||
+                  line =~ /^#{tomdoc_modifiers}(Returns|Gets|Sets|Gets\/Sets)\ (nil|nothing)\.*/i
               end
             end
 
@@ -111,7 +111,7 @@ module Inch
                 /\+#{expr}\+\:\:/,        # +param1+::
                 /<tt>#{expr}<\/tt>/,      # <tt>param1</tt>
                 /<tt>#{expr}<\/tt>\:\:/,  # <tt>param1</tt>::
-                /^#{expr}\ \-\ /          # param1 -
+                /^#{expr}\ +\-\ /         # param1 -
               ]
             end
 

data/lib/inch/utils/buffered_ui.rb

@@ -3,7 +3,7 @@ module Inch
     class BufferedUI < UI
       attr_reader :out, :err
 
-      def initialize(stdout = $stdout, stderr = $stderr)
+      def initialize(_stdout = $stdout, _stderr = $stderr)
         @io = StringIO.new
         super(@io, @io)
       end

data/lib/inch/version.rb

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

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

@@ -0,0 +1,609 @@
+{
+    "args": [
+        "inspect", 
+        "InchTest.Functions."
+    ], 
+    "git_repo_url": "git@github.com:inch-ci/Hello-World-Elixir.git", 
+    "language": "elixir", 
+    "objects": [
+        {
+            "id": "InchTest", 
+            "module": "Elixir.InchTest", 
+            "moduledoc": null, 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.CodeExamples", 
+            "module": "Elixir.InchTest.CodeExamples", 
+            "moduledoc": null, 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.Config", 
+            "module": "Elixir.InchTest.Config", 
+            "moduledoc": null, 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.Docs.Formatter", 
+            "module": "Elixir.InchTest.Docs.Formatter", 
+            "moduledoc": "Provide JSON-formatted documentation\n", 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.Docs.Retriever", 
+            "module": "Elixir.InchTest.Docs.Retriever", 
+            "moduledoc": "Functions to extract documentation information from modules.\n", 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.Docs.Retriever.Error", 
+            "module": "Elixir.InchTest.Docs.Retriever.Error", 
+            "moduledoc": null, 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": "exception", 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.FunctionObject", 
+            "module": "Elixir.InchTest.FunctionObject", 
+            "moduledoc": null, 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.Functions", 
+            "module": "Elixir.InchTest.Functions", 
+            "moduledoc": "  In this module we define funs that are \"cases\" for our test suite.\n", 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.ModuleObject", 
+            "module": "Elixir.InchTest.ModuleObject", 
+            "moduledoc": null, 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.Naming", 
+            "module": "Elixir.InchTest.Naming", 
+            "moduledoc": null, 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "id": "InchTest.TypeObject", 
+            "module": "Elixir.InchTest.TypeObject", 
+            "moduledoc": null, 
+            "object_type": "ModuleObject", 
+            "source": null, 
+            "type": null, 
+            "typespecs": []
+        }, 
+        {
+            "arity": 4, 
+            "doc": false, 
+            "id": "generate_docs/4", 
+            "module_id": "InchTest", 
+            "name": "generate_docs", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "project", 
+                    [], 
+                    null
+                ], 
+                [
+                    "version", 
+                    [], 
+                    null
+                ], 
+                [
+                    "args", 
+                    [], 
+                    null
+                ], 
+                [
+                    "options", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 0, 
+            "doc": "Converts String to underscore case\n\n## Examples\n\n    iex> InchTest.Naming.underscore(\"MyApp\")\n    \"my_app\"\n\n    iex> InchTest.Naming.underscore(\"my-app\")\n    \"my_app\"\n\nIn general, `underscore` can be thought of as the reverse of\n`camelize`, however, in some cases formatting may be lost:\n\n    Naming.underscore \"SAPExample\"  #=> \"sap_example\"\n    Naming.camelize   \"sap_example\" #=> \"SapExample\"\n\n", 
+            "id": "multiple_code_examples/0", 
+            "module_id": "InchTest.CodeExamples", 
+            "name": "multiple_code_examples", 
+            "object_type": "FunctionObject", 
+            "signature": [], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 0, 
+            "doc": "Extracts the resource name from an alias\n\n## Examples\n\n    iex> InchTest.Naming.resource_name(MyApp.User)\n    \"user\"\n    iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n    \"user\"\n", 
+            "id": "single_code_example/0", 
+            "module_id": "InchTest.CodeExamples", 
+            "name": "single_code_example", 
+            "object_type": "FunctionObject", 
+            "signature": [], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 3, 
+            "doc": "Generate JSON documentation for the given modules\n", 
+            "id": "run/3", 
+            "module_id": "InchTest.Docs.Formatter", 
+            "name": "run", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "modules", 
+                    [], 
+                    null
+                ], 
+                [
+                    "args", 
+                    [], 
+                    null
+                ], 
+                [
+                    "config", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 2, 
+            "doc": "Extract documentation from all modules in the specified directory\n", 
+            "id": "docs_from_dir/2", 
+            "module_id": "InchTest.Docs.Retriever", 
+            "name": "docs_from_dir", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "dir", 
+                    [], 
+                    null
+                ], 
+                [
+                    "config", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 2, 
+            "doc": "Extract documentation from all modules in the specified list of files\n", 
+            "id": "docs_from_files/2", 
+            "module_id": "InchTest.Docs.Retriever", 
+            "name": "docs_from_files", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "files", 
+                    [], 
+                    null
+                ], 
+                [
+                    "config", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 2, 
+            "doc": "Extract documentation from all modules in the list `modules`\n", 
+            "id": "docs_from_modules/2", 
+            "module_id": "InchTest.Docs.Retriever", 
+            "name": "docs_from_modules", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "modules", 
+                    [], 
+                    null
+                ], 
+                [
+                    "config", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 1, 
+            "doc": "Callback implementation of `Exception.exception/1`.", 
+            "id": "exception/1", 
+            "module_id": "InchTest.Docs.Retriever.Error", 
+            "name": "exception", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "args", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [
+                [
+                    "::", 
+                    {
+                        "line": 21
+                    }, 
+                    [
+                        [
+                            "exception", 
+                            {
+                                "line": 21
+                            }, 
+                            [
+                                [
+                                    [
+                                        ".", 
+                                        {
+                                            "line": 21
+                                        }, 
+                                        [
+                                            "Elixir.Keyword", 
+                                            "t"
+                                        ]
+                                    ], 
+                                    {
+                                        "line": 21
+                                    }, 
+                                    []
+                                ]
+                            ]
+                        ], 
+                        [
+                            [
+                                ".", 
+                                {
+                                    "line": 21
+                                }, 
+                                [
+                                    "Elixir.Exception", 
+                                    "t"
+                                ]
+                            ], 
+                            {
+                                "line": 21
+                            }, 
+                            []
+                        ]
+                    ]
+                ]
+            ], 
+            "type": "def"
+        }, 
+        {
+            "arity": 1, 
+            "doc": "Callback implementation of `Exception.message/1`.", 
+            "id": "message/1", 
+            "module_id": "InchTest.Docs.Retriever.Error", 
+            "name": "message", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "exception", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [
+                [
+                    "::", 
+                    {
+                        "line": 21
+                    }, 
+                    [
+                        [
+                            "message", 
+                            {
+                                "line": 21
+                            }, 
+                            [
+                                [
+                                    [
+                                        ".", 
+                                        {
+                                            "line": 21
+                                        }, 
+                                        [
+                                            "Elixir.Exception", 
+                                            "t"
+                                        ]
+                                    ], 
+                                    {
+                                        "line": 21
+                                    }, 
+                                    []
+                                ]
+                            ]
+                        ], 
+                        [
+                            [
+                                ".", 
+                                {
+                                    "line": 21
+                                }, 
+                                [
+                                    "Elixir.String", 
+                                    "t"
+                                ]
+                            ], 
+                            {
+                                "line": 21
+                            }, 
+                            []
+                        ]
+                    ]
+                ]
+            ], 
+            "type": "def"
+        }, 
+        {
+            "arity": 2, 
+            "doc": "This fun takes `param1` and `param2` as arguments.\n\n## Examples\n\n    iex> InchTest.Naming.resource_name(MyApp.User)\n    \"user\"\n    iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n    \"user\"\n", 
+            "id": "full_doc/2", 
+            "module_id": "InchTest.Functions", 
+            "name": "full_doc", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "param1", 
+                    [], 
+                    null
+                ], 
+                [
+                    "param2", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 2, 
+            "doc": "This fun 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\n## Examples\n\n    iex> InchTest.Naming.resource_name(MyApp.User)\n    \"user\"\n    iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n    \"user\"\n", 
+            "id": "full_doc_second_parameter_unnamed/2", 
+            "module_id": "InchTest.Functions", 
+            "name": "full_doc_second_parameter_unnamed", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "param1", 
+                    [], 
+                    null
+                ], 
+                [
+                    "", 
+                    [], 
+                    "Elixir"
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 1, 
+            "doc": "Converts String to camel case\n\n## Examples\n\n    iex> InchTest.Naming.camelize(\"my_app\")\n    \"MyApp\"\n\nIn general, `camelize` can be thought of as the reverse of\n`underscore`, however, in some cases formatting may be lost:\n\n    InchTest.Naming.underscore \"SAPExample\"  #=> \"sap_example\"\n    InchTest.Naming.camelize   \"sap_example\" #=> \"SapExample\"\n\n", 
+            "id": "camelize/1", 
+            "module_id": "InchTest.Naming", 
+            "name": "camelize", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "arg1", 
+                    [], 
+                    "Elixir"
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 1, 
+            "doc": null, 
+            "id": "do_camelize/1", 
+            "module_id": "InchTest.Naming", 
+            "name": "do_camelize", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "arg1", 
+                    [], 
+                    "Elixir"
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 2, 
+            "doc": null, 
+            "id": "do_underscore/2", 
+            "module_id": "InchTest.Naming", 
+            "name": "do_underscore", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "arg1", 
+                    [], 
+                    "Elixir"
+                ], 
+                [
+                    "prev", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 2, 
+            "doc": null, 
+            "id": "remove_suffix/2", 
+            "module_id": "InchTest.Naming", 
+            "name": "remove_suffix", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "alias", 
+                    [], 
+                    null
+                ], 
+                [
+                    "suffix", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 2, 
+            "doc": "Extracts the resource name from an alias\n\n## Examples\n\n    iex> InchTest.Naming.resource_name(MyApp.User)\n    \"user\"\n    iex> InchTest.Naming.resource_name(MyApp.UserView, \"View\")\n    \"user\"\n\n", 
+            "id": "resource_name/2", 
+            "module_id": "InchTest.Naming", 
+            "name": "resource_name", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "alias", 
+                    [], 
+                    null
+                ], 
+                [
+                    "\\\\", 
+                    [], 
+                    [
+                        [
+                            "suffix", 
+                            [], 
+                            null
+                        ], 
+                        null
+                    ]
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 1, 
+            "doc": null, 
+            "id": "to_lower_char/1", 
+            "module_id": "InchTest.Naming", 
+            "name": "to_lower_char", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "char", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 1, 
+            "doc": null, 
+            "id": "to_upper_char/1", 
+            "module_id": "InchTest.Naming", 
+            "name": "to_upper_char", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "char", 
+                    [], 
+                    null
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }, 
+        {
+            "arity": 1, 
+            "doc": "Converts String to underscore case\n\n## Examples\n\n    iex> InchTest.Naming.underscore(\"MyApp\")\n    \"my_app\"\n\n    iex> InchTest.Naming.underscore(\"my-app\")\n    \"my_app\"\n\nIn general, `underscore` can be thought of as the reverse of\n`camelize`, however, in some cases formatting may be lost:\n\n    Naming.underscore \"SAPExample\"  #=> \"sap_example\"\n    Naming.camelize   \"sap_example\" #=> \"SapExample\"\n\n", 
+            "id": "underscore/1", 
+            "module_id": "InchTest.Naming", 
+            "name": "underscore", 
+            "object_type": "FunctionObject", 
+            "signature": [
+                [
+                    "arg1", 
+                    [], 
+                    "Elixir"
+                ]
+            ], 
+            "source": null, 
+            "specs": [], 
+            "type": "def"
+        }
+    ]
+}