inch 0.5.0.rc5 → 0.5.0.rc6

data/lib/inch/rake.rb

@@ -1,2 +1,2 @@
-require "inch"
-require "inch/rake/suggest"
+require 'inch'
+require 'inch/rake/suggest'

data/lib/inch/rake/suggest.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-require "rake"
-require "rake/tasklib"
-require "inch/cli"
+require 'rake'
+require 'rake/tasklib'
+require 'inch/cli'
 
 module Inch
   # Holds all Rake tasks
@@ -17,12 +17,12 @@ module Inch
       # @param name [String] name of the Rake task
       # @param *args [Array] arguments to be passed to Suggest.run
       # @param &block [Proc] optional, evaluated inside the task definition
-      def initialize(name = "inch", *args, &block)
+      def initialize(name = 'inch', *args, &block)
         @name = name
         @args = args
         block.call(self) if block
 
-        desc "Suggest objects to add documention to"
+        desc 'Suggest objects to add documention to'
         task(@name) { suggest }
       end
 

data/lib/inch/utils/code_location.rb

@@ -0,0 +1,12 @@
+module Inch
+  module Utils
+    # CodeLocation is a utility class to find declarations of objects
+    # in files
+    class CodeLocation < Struct.new(:base_dir, :relative_path,
+                                    :line_no)
+      def filename
+        File.join(base_dir, relative_path)
+      end
+    end
+  end
+end

data/lib/inch/utils/read_write_methods.rb

@@ -21,7 +21,7 @@ module Inch
       #
       # @return [void]
       def rw_method(name)
-        class_eval """
+        class_eval ''"
           def #{name}(value = nil)
             if value.nil?
               @#{name}
@@ -29,7 +29,7 @@ module Inch
               @#{name} = value
             end
           end
-        """
+        "''
       end
 
       # Implements multiple read(write) methods with the given +names+

data/lib/inch/utils/ui.rb

@@ -10,18 +10,18 @@ module Inch
       end
 
       def debug(msg)
-        return unless ENV["DEBUG"]
+        return unless ENV['DEBUG']
         msg.to_s.lines.each do |line|
-          trace edged :dark, line.gsub(/\n$/, "").dark
+          trace edged :dark, line.gsub(/\n$/, '').dark
         end
       end
 
-      def sub(msg = "")
+      def sub(msg = '')
         color = @current_header_color || :white
         trace __edged(color, msg)
       end
 
-      def edged(color, msg, edge = "┃ ")
+      def edged(color, msg, edge = '┃ ')
         trace __edged(color, msg, edge)
       end
 
@@ -29,7 +29,7 @@ module Inch
       #
       # @param text [String]
       # @return [void]
-      def trace(text = "")
+      def trace(text = '')
         @current_header_color = nil if text.to_s.empty?
         out.puts text
       end
@@ -38,7 +38,7 @@ module Inch
       #
       # @param text [String]
       # @return [void]
-      def warn(text = "")
+      def warn(text = '')
         err.puts text
       end
 
@@ -55,7 +55,7 @@ module Inch
 
       private
 
-      def __edged(color, msg, edge = "┃ ")
+      def __edged(color, msg, edge = '┃ ')
         edge.color(color) + msg
       end
 
@@ -63,7 +63,7 @@ module Inch
         bg_color ||= "intense_#{color}"
         bar = " #{text}".ljust(CLI::COLUMNS - 1)
                 .on_color(bg_color).color(:color16)
-        "#".color(color).on_color(color) + bar
+        '#'.color(color).on_color(color) + bar
       end
     end
   end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.5.0.rc5"
+  VERSION = '0.5.0.rc6'
 end

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

@@ -0,0 +1,321 @@
+{
+    "objects": [
+        {
+            "id": "InchEx",
+            "module": "Elixir.InchEx",
+            "moduledoc": null,
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "id": "InchEx.Config",
+            "module": "Elixir.InchEx.Config",
+            "moduledoc": null,
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "id": "InchEx.Docs.Formatter",
+            "module": "Elixir.InchEx.Docs.Formatter",
+            "moduledoc": "Provide JSON-formatted documentation\n",
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "id": "InchEx.Docs.Retriever",
+            "module": "Elixir.InchEx.Docs.Retriever",
+            "moduledoc": "Functions to extract documentation information from modules.\n",
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "id": "InchEx.Docs.Retriever.Error",
+            "module": "Elixir.InchEx.Docs.Retriever.Error",
+            "moduledoc": null,
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": "exception",
+            "typespecs": []
+        },
+        {
+            "id": "InchEx.FunctionObject",
+            "module": "Elixir.InchEx.FunctionObject",
+            "moduledoc": null,
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "id": "InchEx.ModuleObject",
+            "module": "Elixir.InchEx.ModuleObject",
+            "moduledoc": null,
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "id": "InchEx.Reporter.Local",
+            "module": "Elixir.InchEx.Reporter.Local",
+            "moduledoc": null,
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "id": "InchEx.Reporter.Remote",
+            "module": "Elixir.InchEx.Reporter.Remote",
+            "moduledoc": null,
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "id": "InchEx.TypeObject",
+            "module": "Elixir.InchEx.TypeObject",
+            "moduledoc": null,
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "id": "Mix.Tasks.Inch",
+            "module": "Elixir.Mix.Tasks.Inch",
+            "moduledoc": null,
+            "object_type": "ModuleObject",
+            "source": null,
+            "type": null,
+            "typespecs": []
+        },
+        {
+            "arity": 3,
+            "doc": false,
+            "id": "generate_docs/3",
+            "module_id": "InchEx",
+            "name": "generate_docs",
+            "object_type": "FunctionObject",
+            "signature": "generate_docs(project, version, options)",
+            "source": null,
+            "specs": [],
+            "type": "def"
+        },
+        {
+            "arity": 2,
+            "doc": "Generate JSON documentation for the given modules\n",
+            "id": "run/2",
+            "module_id": "InchEx.Docs.Formatter",
+            "name": "run",
+            "object_type": "FunctionObject",
+            "signature": "run(modules, config)",
+            "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": "InchEx.Docs.Retriever",
+            "name": "docs_from_dir",
+            "object_type": "FunctionObject",
+            "signature": "docs_from_dir(dir, config)",
+            "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": "InchEx.Docs.Retriever",
+            "name": "docs_from_files",
+            "object_type": "FunctionObject",
+            "signature": "docs_from_files(files, config)",
+            "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": "InchEx.Docs.Retriever",
+            "name": "docs_from_modules",
+            "object_type": "FunctionObject",
+            "signature": "docs_from_modules(modules, config)",
+            "source": null,
+            "specs": [],
+            "type": "def"
+        },
+        {
+            "arity": 1,
+            "doc": "Callback implementation of `Exception.exception/1`.",
+            "id": "exception/1",
+            "module_id": "InchEx.Docs.Retriever.Error",
+            "name": "exception",
+            "object_type": "FunctionObject",
+            "signature": "exception(args)",
+            "source": null,
+            "specs": [
+                [
+                    "::",
+                    {
+                        "line": 19
+                    },
+                    [
+                        [
+                            "exception",
+                            {
+                                "line": 19
+                            },
+                            [
+                                [
+                                    [
+                                        ".",
+                                        {
+                                            "line": 19
+                                        },
+                                        [
+                                            "Elixir.Keyword",
+                                            "t"
+                                        ]
+                                    ],
+                                    {
+                                        "line": 19
+                                    },
+                                    []
+                                ]
+                            ]
+                        ],
+                        [
+                            [
+                                ".",
+                                {
+                                    "line": 19
+                                },
+                                [
+                                    "Elixir.Exception",
+                                    "t"
+                                ]
+                            ],
+                            {
+                                "line": 19
+                            },
+                            []
+                        ]
+                    ]
+                ]
+            ],
+            "type": "def"
+        },
+        {
+            "arity": 1,
+            "doc": "Callback implementation of `Exception.message/1`.",
+            "id": "message/1",
+            "module_id": "InchEx.Docs.Retriever.Error",
+            "name": "message",
+            "object_type": "FunctionObject",
+            "signature": "message(exception)",
+            "source": null,
+            "specs": [
+                [
+                    "::",
+                    {
+                        "line": 19
+                    },
+                    [
+                        [
+                            "message",
+                            {
+                                "line": 19
+                            },
+                            [
+                                [
+                                    [
+                                        ".",
+                                        {
+                                            "line": 19
+                                        },
+                                        [
+                                            "Elixir.Exception",
+                                            "t"
+                                        ]
+                                    ],
+                                    {
+                                        "line": 19
+                                    },
+                                    []
+                                ]
+                            ]
+                        ],
+                        [
+                            [
+                                ".",
+                                {
+                                    "line": 19
+                                },
+                                [
+                                    "Elixir.String",
+                                    "t"
+                                ]
+                            ],
+                            {
+                                "line": 19
+                            },
+                            []
+                        ]
+                    ]
+                ]
+            ],
+            "type": "def"
+        },
+        {
+            "arity": 1,
+            "doc": "  Runs inch locally, if installed. If you want to force usage of a particular\n  inch installation, set INCH_PATH environment variable to it.\n\n    export INCH_PATH=/home/rrrene/projects/inch\n",
+            "id": "run/1",
+            "module_id": "InchEx.Reporter.Local",
+            "name": "run",
+            "object_type": "FunctionObject",
+            "signature": "run(filename)",
+            "source": null,
+            "specs": [],
+            "type": "def"
+        },
+        {
+            "arity": 2,
+            "doc": "  Runs inch remotely, if already invented.\n",
+            "id": "run/2",
+            "module_id": "InchEx.Reporter.Remote",
+            "name": "run",
+            "object_type": "FunctionObject",
+            "signature": "run(filename, config \\\\ Mix.Project.config())",
+            "source": null,
+            "specs": [],
+            "type": "def"
+        },
+        {
+            "arity": 4,
+            "doc": false,
+            "id": "run/4",
+            "module_id": "Mix.Tasks.Inch",
+            "name": "run",
+            "object_type": "FunctionObject",
+            "signature": "run(args, config \\\\ Mix.Project.config(), generator \\\\ :erlang.make_fun(InchEx, :generate_docs, 3), reporter \\\\ InchEx.Reporter.Local)",
+            "source": null,
+            "specs": [],
+            "type": "def"
+        }
+    ]
+}

data/test/integration/api/compare/codebases.rb

@@ -1,9 +1,9 @@
-require File.expand_path(File.dirname(__FILE__) + "/../../../test_helper")
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
 
 describe ::Inch::API::Compare::Codebases do
   let(:described_class) { ::Inch::API::Compare::Codebases }
 
-  it "should run" do
+  it 'should run' do
     codebase1 = Inch::Codebase.parse fixture_path(:ruby, :diff1)
     codebase2 = Inch::Codebase.parse fixture_path(:ruby, :diff2)
 
@@ -11,23 +11,23 @@ describe ::Inch::API::Compare::Codebases do
     refute compare.comparisons.empty?
 
     # Foo#a is added in diff2
-    comparison = compare.find("Foo#a")
+    comparison = compare.find('Foo#a')
     assert comparison.added?
 
     # Foo#b is improved in diff2
-    comparison = compare.find("Foo#b")
+    comparison = compare.find('Foo#b')
     assert comparison.present?
     assert comparison.changed?
     assert comparison.improved?
 
     # Foo#c stayed the same
-    comparison = compare.find("Foo#c")
+    comparison = compare.find('Foo#c')
     assert comparison.present?
     assert comparison.unchanged?
     refute comparison.changed?
 
     # Foo#d is removed in diff2
-    comparison = compare.find("Foo#d")
+    comparison = compare.find('Foo#d')
     refute comparison.present?
     assert comparison.removed?
   end