inch 0.8.0 → 0.9.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29bc9c4b46f07aaf233599632985990b384221ba
-  data.tar.gz: df72afb72418770a8899c7043c0c461e21df9109
+  metadata.gz: 41b166a382d6ff1de903e59116bec0d8c6b37f5e
+  data.tar.gz: 9cafc658d7c863fe4f50a73679608c5cb9b5d15d
 SHA512:
-  metadata.gz: 17a83dc980f62350222348ac204d6a74c1bdfae464da29c01df42148d36a4f9fa64b4da3afeeae5eebc7bec18a1df649b961f5f44cabdc830e82cf4c17fc1dcc
-  data.tar.gz: a8673887c631d5113a65db7e2e3fa4f57438e3557cbfdc6642e71a419fa35483d9a98e68b3c6999f95a1a284ea350590d73a12b67c756987528c68979f7cd9a9
+  metadata.gz: d51519e786205c2a8f5e199b38625834dc8be8767850f9a964e799f27e4db53450ec5655d588a8fcb21aa609b080c7f7c3be6590be047e535862804d1975b4db
+  data.tar.gz: 5fa8fb528ccb9a94cb884f7eabbe0cd5c7163a5f9cbd196ca573cc93dda8b75351a3252d3a6e2fc5ff03510c9cb73f0a5aeddbf087e7a4d3d9ca1f1afb7373b7

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.9.0
+
+- Elixir: Add support for API format of InchEx v2
+
 ## 0.8.0
 
 - CLI: Do not include `Term::ANSIColor` into `String`

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

@@ -0,0 +1,92 @@
+require 'json'
+require 'inch/language/elixir/provider/reader/object'
+require 'inch/language/elixir/provider/reader_v2/object'
+
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        # Parses the source tree (using Reader)
+        class Parser
+          attr_reader :objects
+
+          # Helper method to parse an instance with the given +args+
+          #
+          # @see #parse
+          # @return [CodeObject::Provider::Reader::Parser] the instance that
+          #   ran
+          def self.parse(*args)
+            parser = new
+            parser.parse(*args)
+            parser
+          end
+
+          # @param dir [String] directory
+          # @param config [Inch::Config::Codebase] configuration for codebase
+          # @return [void]
+          def parse(dir, config)
+            raise "Directory does not exist: #{dir}" if !File.exist?(dir)
+            Dir.chdir(dir) do
+              parse_objects(config.included_files, config.excluded_files,
+                            config.read_dump_file)
+            end
+          end
+
+          private
+
+          def parse_objects(_paths, _excluded, read_dump_file = nil)
+            if read_dump_file.nil?
+              fail 'Elixir analysis only works with --read-from-dump.'
+            else
+              output = File.read(read_dump_file, :encoding => 'utf-8')
+            end
+
+            json = JSON[output]
+            is_version1 = !!json['objects']
+
+            if is_version1
+              @objects = parse_objects_v1 json['objects']
+            else
+              @objects = parse_objects_v2 json['results']
+            end
+          end
+
+          def parse_objects_v1(parsed_objects)
+            list = parsed_objects.map do |o|
+              Reader::Object.for(o) # unless IGNORE_TYPES.include?(o.type)
+            end.compact
+            children_map = {}
+            list.each do |object|
+              if object.parent_fullname
+                children_map[object.parent_fullname] ||= []
+                children_map[object.parent_fullname] << object.fullname
+              end
+            end
+            list.each do |object|
+              object.children_fullnames = children_map[object.fullname]
+            end
+            list
+          end
+
+          def parse_objects_v2(parsed_objects)
+            list = parsed_objects.map do |o|
+              ReaderV2::Object.for(o) # unless IGNORE_TYPES.include?(o.type)
+            end.compact
+            children_map = {}
+            list.each do |object|
+              if object.parent_fullname
+                children_map[object.parent_fullname] ||= []
+                children_map[object.parent_fullname] << object.fullname
+              end
+            end
+            list.each do |object|
+              object.children_fullnames = children_map[object.fullname]
+            end
+            list
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -1,4 +1,5 @@
 require 'json'
+require 'inch/language/elixir/provider/parser'
 
 module Inch
   module Language
@@ -15,5 +16,3 @@ module Inch
     end
   end
 end
-
-require 'inch/language/elixir/provider/reader/parser'

data/lib/inch/language/elixir/provider/reader_v2/docstring.rb

@@ -0,0 +1,13 @@
+
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module ReaderV2
+          class Docstring < Ruby::Provider::YARD::Docstring
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/elixir/provider/reader_v2/object.rb

@@ -0,0 +1,61 @@
+require 'inch/language/elixir/provider/reader_v2/object/base'
+require 'inch/language/elixir/provider/reader_v2/object/function_object'
+require 'inch/language/elixir/provider/reader_v2/object/module_object'
+require 'inch/language/elixir/provider/reader_v2/object/type_object'
+
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module ReaderV2
+          # CodeObject::Provider::JSDoc::Object object represent code objects.
+          #
+          module Object
+            class << self
+              def clear_cache
+                @cache = {}
+              end
+
+              # Returns a Proxy object for the given +json_object+
+              #
+              # @param json_object [Hash]
+              # @return [Provider::JSDoc::Object]
+              def for(json_object)
+                @cache ||= {}
+
+                if (proxy_object = @cache[cache_key(json_object)])
+                  proxy_object
+                else
+                  @cache[cache_key(json_object)] =
+                    class_for(json_object).new(json_object)
+                end
+              end
+
+              private
+
+              # Returns a Proxy class for the given +json_object+
+              #
+              # @param json_object [Hash]
+              # @return [Class]
+              def class_for(json_object)
+                class_name = json_object['type'].capitalize + "Object"
+
+                ReaderV2::Object.const_get(class_name)
+              rescue NameError
+                ReaderV2::Object::Base
+              end
+
+              # Returns a cache key for the given +json_object+
+              #
+              # @param json_object [Hash]
+              # @return [String]
+              def cache_key(json_object)
+                json_object['name']
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,211 @@
+require 'inch/language/elixir/provider/reader_v2/docstring'
+require 'inch/utils/code_location'
+
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module ReaderV2
+          module Object
+            # @abstract
+            class Base
+              # @param hash [Hash] hash returned via JSON interface
+              def initialize(hash)
+                @hash = hash
+              end
+
+              def name
+                @hash['name']
+              end
+
+              def fullname
+                @hash['name']
+              end
+
+              def files
+                return [] if location.empty?
+                file, line_no = location[0], location[1]
+                [Inch::Utils::CodeLocation.new('', file, line_no)]
+              end
+
+              def filename
+                location[0]
+              end
+
+              attr_writer :children_fullnames
+              def children_fullnames
+                @children_fullnames ||= []
+              end
+
+              def parent_fullname
+                if depth == 1
+                  nil
+                else
+                  fullname.split('.')[0...-1].join('.')
+                end
+              end
+
+              def api_tag?
+                nil
+              end
+
+              def aliased_object_fullname
+                nil
+              end
+
+              def aliases_fullnames
+                nil
+              end
+
+              def attributes
+                []
+              end
+
+              def bang_name?
+                false
+              end
+
+              def constant?
+                false # raise NotImplementedError
+              end
+
+              def constructor?
+                false
+              end
+
+              def depth
+                fullname.split('.').size
+              end
+
+              # @return [Docstring]
+              def docstring
+                @docstring ||= Docstring.new(original_docstring)
+              end
+
+              def getter?
+                name =~ /^get_/ # raise NotImplementedError
+              end
+
+              def has_children?
+                !children_fullnames.empty?
+              end
+
+              def has_code_example?
+                docstring.code_examples.size > 0
+              end
+
+              def has_doc?
+                !undocumented?
+              end
+
+              def has_multiple_code_examples?
+                docstring.code_examples.size > 1
+              end
+
+              def has_unconsidered_tags?
+                false # raise NotImplementedError
+              end
+
+              def method?
+                false
+              end
+
+              HIDDEN_TYPES = %w(exception impl)
+              def nodoc?
+                @hash['doc'] == false ||
+                  HIDDEN_TYPES.include?(@hash['type'])
+              end
+
+              def namespace?
+                false
+              end
+
+              def original_docstring
+                @hash['doc']
+              end
+
+              def overridden?
+                false # raise NotImplementedError
+              end
+
+              def overridden_method_fullname
+                nil # raise NotImplementedError
+              end
+
+              def parameters
+                []
+              end
+
+              def private?
+                false
+              end
+
+              def tagged_as_internal_api?
+                false
+              end
+
+              def tagged_as_private?
+                nodoc?
+              end
+
+              def protected?
+                false
+              end
+
+              def public?
+                true
+              end
+
+              def questioning_name?
+                fullname =~ /\?$/
+              end
+
+              def return_described?
+                false # raise NotImplementedError
+              end
+
+              def return_mentioned?
+                false # raise NotImplementedError
+              end
+
+              def return_typed?
+                false # raise NotImplementedError
+              end
+
+              def in_root?
+                depth == 1
+              end
+
+              def setter?
+                name =~ /^set_/ # raise NotImplementedError
+              end
+
+              def source
+                nil
+              end
+
+              def unconsidered_tag_count
+                0
+              end
+
+              def undocumented?
+                original_docstring.nil? || original_docstring.to_s.strip.empty?
+              end
+
+              def visibility
+                :public
+              end
+
+              private
+
+              def location
+                @hash['location'].to_s.split(':')
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'inch/language/elixir/provider/reader_v2/object/function_parameter_object'
+
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module ReaderV2
+          module Object
+            # Proxy class for functions
+            class FunctionObject < Base
+              def method?
+                true
+              end
+
+              def parameters
+                names = FunctionSignature.new(@hash['signature']).parameter_names
+                names.map do |name|
+                  FunctionParameterObject.new(self, name)
+                end
+              end
+
+              private
+
+              class FunctionSignature < Struct.new(:signature)
+                def parameter_names
+                  return [] if signature.nil?
+                  signature.map do |tuple|
+                    name_from_tuple(*tuple)
+                  end
+                end
+
+                def name_from_tuple(a, _, b)
+                  if b.nil? || b == 'Elixir'
+                    a
+                  else
+                    if a == '\\\\'
+                      candidate = b.first
+                      if candidate.is_a?(Array)
+                        name_from_tuple(*candidate)
+                      else
+                        candidate
+                      end
+                    else
+                      warn "[WARN] could not parse FunctionSignature: #{[a, _, b].inspect}"
+                    end
+                  end
+                end
+              end
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module ReaderV2
+          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/provider/reader_v2/object/module_object.rb

@@ -0,0 +1,18 @@
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module ReaderV2
+          module Object
+            # Proxy class for modules
+            class ModuleObject < Base
+              def namespace?
+                true
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/language/elixir/provider/reader_v2/object/type_object.rb

@@ -0,0 +1,15 @@
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module ReaderV2
+          module Object
+            # Proxy class for types
+            class TypeObject < Base
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = '0.8.0'
+  VERSION = '0.9.0.rc1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0.rc1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2018-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,6 +219,7 @@ files:
 - lib/inch/language/elixir/evaluation/module_object.rb
 - lib/inch/language/elixir/evaluation/type_object.rb
 - lib/inch/language/elixir/import.rb
+- lib/inch/language/elixir/provider/parser.rb
 - lib/inch/language/elixir/provider/reader.rb
 - lib/inch/language/elixir/provider/reader/docstring.rb
 - lib/inch/language/elixir/provider/reader/object.rb
@@ -227,7 +228,13 @@ files:
 - 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/provider/reader_v2/docstring.rb
+- lib/inch/language/elixir/provider/reader_v2/object.rb
+- lib/inch/language/elixir/provider/reader_v2/object/base.rb
+- lib/inch/language/elixir/provider/reader_v2/object/function_object.rb
+- lib/inch/language/elixir/provider/reader_v2/object/function_parameter_object.rb
+- lib/inch/language/elixir/provider/reader_v2/object/module_object.rb
+- lib/inch/language/elixir/provider/reader_v2/object/type_object.rb
 - lib/inch/language/elixir/roles/base.rb
 - lib/inch/language/elixir/roles/function.rb
 - lib/inch/language/elixir/roles/function_parameter.rb
@@ -400,9 +407,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.8

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

@@ -1,70 +0,0 @@
-require 'json'
-require 'inch/language/elixir/provider/reader/object'
-
-module Inch
-  module Language
-    module Elixir
-      module Provider
-        module Reader
-          # Parses the source tree (using Reader)
-          class Parser
-            attr_reader :parsed_objects
-
-            # Helper method to parse an instance with the given +args+
-            #
-            # @see #parse
-            # @return [CodeObject::Provider::Reader::Parser] the instance that
-            #   ran
-            def self.parse(*args)
-              parser = new
-              parser.parse(*args)
-              parser
-            end
-
-            # @param dir [String] directory
-            # @param config [Inch::Config::Codebase] configuration for codebase
-            # @return [void]
-            def parse(dir, config)
-              raise "Directory does not exist: #{dir}" if !File.exist?(dir)
-              Dir.chdir(dir) do
-                parse_objects(config.included_files, config.excluded_files,
-                              config.read_dump_file)
-              end
-            end
-
-            # @return [Array<YARD::Object::Base>]
-            def objects
-              @objects ||= begin
-                list = parsed_objects.map do |o|
-                  Reader::Object.for(o) # unless IGNORE_TYPES.include?(o.type)
-                end.compact
-                children_map = {}
-                list.each do |object|
-                  if object.parent_fullname
-                    children_map[object.parent_fullname] ||= []
-                    children_map[object.parent_fullname] << object.fullname
-                  end
-                end
-                list.each do |object|
-                  object.children_fullnames = children_map[object.fullname]
-                end
-                list
-              end
-            end
-
-            private
-
-            def parse_objects(_paths, _excluded, read_dump_file = nil)
-              if read_dump_file.nil?
-                fail 'Elixir analysis only works with --read-from-dump.'
-              else
-                output = File.read(read_dump_file, :encoding => 'utf-8')
-              end
-              @parsed_objects = JSON[output]['objects']
-            end
-          end
-        end
-      end
-    end
-  end
-end