inch 0.5.0.rc3 → 0.5.0.rc4

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

@@ -0,0 +1,27 @@
+module Inch
+  module Language
+    module Elixir
+      module Evaluation
+        # Proxy class for modules
+        class ModuleObject < Base
+          protected
+
+          def relevant_roles
+            relevant_base_roles.merge(relevant_namespace_roles)
+          end
+
+          # @see Evaluation::Ruby::Base
+          def relevant_namespace_roles
+            {
+              Role::Module::WithoutChildren => nil,
+              Role::Module::WithChildren => nil,
+              Role::Module::WithManyChildren => nil,
+              Role::Module::WithoutMethods => nil,
+              Role::Module::Pure => nil
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Inch
+  module Language
+    module Elixir
+      module Evaluation
+        # Proxy class for types
+        class TypeObject < Base
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module Inch
+  module Language
+    module Elixir
+    end
+  end
+end
+
+require "inch/language/elixir/provider/reader"
+
+require "inch/language/elixir/code_object/base"
+require "inch/language/elixir/code_object/module_object"
+require "inch/language/elixir/code_object/function_object"
+require "inch/language/elixir/code_object/type_object"
+
+require "inch/language/elixir/evaluation/base"
+require "inch/language/elixir/evaluation/module_object"
+require "inch/language/elixir/evaluation/function_object"
+require "inch/language/elixir/evaluation/type_object"
+
+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/type"

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

@@ -0,0 +1,19 @@
+require 'json'
+
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        # Parses the source tree (using Reader)
+        module Reader
+          # @see Provider.parse
+          def self.parse(dir, config)
+            Parser.parse(dir, config)
+          end
+        end
+      end
+    end
+  end
+end
+
+require "inch/language/elixir/provider/reader/parser"

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

@@ -0,0 +1,63 @@
+require "inch/language/elixir/provider/reader/object/base"
+require "inch/language/elixir/provider/reader/object/function_object"
+require "inch/language/elixir/provider/reader/object/module_object"
+require "inch/language/elixir/provider/reader/object/type_object"
+
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module Reader
+          # 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['object_type']
+                Reader::Object.const_get(class_name)
+              rescue NameError
+                Reader::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['id'],
+                  json_object['module_id'],
+                  json_object['signature']
+                ].map(&:to_s).join('.')
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,191 @@
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module Reader
+          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
+                raise NotImplementedError
+              end
+
+              def files
+                []
+              end
+
+              def filename
+                nil
+              end
+
+              def children_fullnames
+                [] # raise NotImplementedError
+              end
+
+              def parent_fullname
+                false # raise NotImplementedError
+              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
+
+              def docstring
+                @hash['doc'] # raise NotImplementedError
+              end
+
+              def getter?
+                name =~ /^get_/ # raise NotImplementedError
+              end
+
+              def has_children?
+                false # raise NotImplementedError
+              end
+
+              def has_code_example?
+                false # raise NotImplementedError
+              end
+
+              def has_doc?
+                !undocumented?
+              end
+
+              def has_multiple_code_examples?
+                false # raise NotImplementedError
+              end
+
+              def has_unconsidered_tags?
+                false # raise NotImplementedError
+              end
+
+              def method?
+                false
+              end
+
+              def nodoc?
+                @hash['doc'] == false
+              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
+                [] # raise NotImplementedError
+              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?
+                @hash['doc'].nil?
+              end
+
+              def visibility
+                :public
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module Reader
+          module Object
+            # Proxy class for functions
+            class FunctionObject < Base
+              def name
+                @hash['id']
+              end
+
+              def fullname
+                @hash['module_id'] + "." + @hash['id']
+              end
+
+              def method?
+                true
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Inch
+  module Language
+    module Elixir
+      module Provider
+        module Reader
+          module Object
+            # Proxy class for modules
+            class ModuleObject < Base
+              def fullname
+                @hash['id']
+              end
+
+              def namespace?
+                true
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,55 @@
+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)
+              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 ||= parsed_objects.map do |o|
+                Reader::Object.for(o) # unless IGNORE_TYPES.include?(o.type)
+              end.compact
+            end
+
+            private
+
+            def parse_objects(paths, excluded, read_dump_file = nil)
+              if read_dump_file.nil?
+                raise "Elixir analysis only works with --read-from-dump."
+              else
+                output = File.read(read_dump_file)
+              end
+              @parsed_objects = JSON[output]['objects']
+            end
+          end
+        end
+      end
+    end
+  end
+end