analyst 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eab9524eb5763fcc6b6c96491d3eda6670cda02f
-  data.tar.gz: ad946eb37111ca6329f1b089a59d99c1234a4740
+  metadata.gz: 5de0cf0eb364543fc02960acae4d770d645b8f1c
+  data.tar.gz: 05116346c0e6798512e8ade4548887a1c763ddda
 SHA512:
-  metadata.gz: 84bd02e46b5745ae1f4b1847b61b3f003b014cb5370c71fdcd9bd9fdf56e6559441e70a11567d3932789061d2aed3dc9e04fadf61e395cd41fd14c2bc459982e
-  data.tar.gz: 3c539573aa32661008537ed3353a704a9f12b2f31d7166a770b6badabda94efa115ccd88d8d716d86141f83f22563202a557747b354529349ba05739652ce572
+  metadata.gz: 32aef9e181c88cea65fc48ed60684e171f8d89bd5e525fa6164d03b4bc6c54fc83409bafd0ebafde1b815379c0697da3e1c9b5511b57917d5c906e9f671e5104
+  data.tar.gz: 153b549fe20f35e0b659a79feed8cb64550e5570e5ca3e2adb210d12d96e986dafdfce24c60c4ee48cb3f67c78976beed8f0f390f00e104b983153067006fdc2

data/lib/analyst.rb

@@ -8,8 +8,6 @@ require_relative "analyst/version"
 require_relative "analyst/entities/mixins/has_methods"
 require_relative "analyst/entities/entity"
 require_relative "analyst/entities/root"
-require_relative "analyst/entities/file"
-require_relative "analyst/entities/source"
 require_relative "analyst/entities/code_block"
 require_relative "analyst/entities/module"
 require_relative "analyst/entities/class"

data/lib/analyst/entities/array.rb

@@ -8,7 +8,7 @@ module Analyst
       private
 
       def contents
-        @contents ||= ast.children.map { |child| process_node(child) }
+        @contents ||= process_nodes(ast.children)
       end
     end
   end

data/lib/analyst/entities/class.rb

@@ -36,3 +36,4 @@ module Analyst
     end
   end
 end
+

data/lib/analyst/entities/code_block.rb

@@ -9,7 +9,7 @@ module Analyst
       def_delegators :parent, :name, :full_name
 
       def contents
-        @contents ||= ast.children.map { |child| process_node(child) }
+        @contents ||= process_nodes(ast.children)
       end
 
     end

data/lib/analyst/entities/conditional.rb

@@ -12,7 +12,7 @@ module Analyst
       private
 
       def contents
-        @contents ||= ast.children.map { |child| process_node(child) }.compact
+        @contents ||= process_nodes(ast.children).compact
       end
     end
   end

data/lib/analyst/entities/constant.rb

@@ -28,10 +28,19 @@ module Analyst
       # and passing that node here would return [:CoolModule, :SubMod, :SweetClass]
       # TODO: should really be nested Entities::Constants all the way down.
       # ((cbase) can probably use the same Entity, or maybe it's a subclass of Constant)
+      #
+      # Note: if any node besides (const) or (cbase) is encountered, that part gets named
+      # '<`source`>' where source is the source code for that node.
+      # e.g. `@thing.class::Sub::Mod` parses to:
+      # (const
+      #   (const
+      #     (send
+      #       (ivar :@thing) :class) :Sub) :Mod)
+      # and the corresponding Entities::Constant gets named "<`@thing.class`>::Sub::Mod"
       def const_node_array(node)
         return [] if node.nil?
         return [''] if node.type == :cbase
-        raise "expected (const) or (cbase) node or nil, got (#{node.type})" unless node.type == :const
+        return ["<`#{node.location.expression.source}`>"] unless node.type == :const
         const_node_array(node.children.first) << node.children[1]
       end
 

data/lib/analyst/entities/entity.rb

@@ -11,6 +11,10 @@ module Analyst
         Analyst::Processor.register_processor(type, self)
       end
 
+      def self.process(ast, parent)
+        new(ast, parent)
+      end
+
       def initialize(ast, parent)
         @parent = parent
         @ast = ast
@@ -83,19 +87,15 @@ module Analyst
       end
 
       def file_path
-        parent.file_path
+        ast.location.expression.source_buffer.name
       end
 
       def line_number
-        ast.loc.line
+        ast.location.line
       end
 
       def source
-        origin_source[source_range]
-      end
-
-      def origin_source
-        parent.origin_source
+        ast.location.expression.source
       end
 
       def full_name
@@ -110,10 +110,6 @@ module Analyst
 
       private
 
-      def source_range
-        Range.new(ast.loc.expression.begin_pos, ast.loc.expression.end_pos)
-      end
-
       def contents_of_type(klass)
         contents.select { |entity| entity.is_a? klass }
       end

data/lib/analyst/entities/method_call.rb

@@ -13,10 +13,7 @@ module Analyst
       end
 
       def arguments
-        @arguments ||= begin
-          args = ast.children[2..-1]
-          args.map { |arg| process_node(arg) }
-        end
+        @arguments ||= process_nodes(ast.children[2..-1])
       end
 
       private

data/lib/analyst/entities/root.rb

@@ -6,42 +6,25 @@ module Analyst
 
       handles_node :analyst_root
 
-      def initialize(ast, source_data)
-        @source_data = source_data
-        super(ast, nil)
-      end
-
       def full_name
         ""
       end
 
-      def source_data_for(entity)
-        source_data[actual_contents.index(entity)]
-      end
-
-      def file_path
-        throw "Entity tree malformed - Source or File should have caught this call"
-      end
-
-      def origin_source
-        throw "Entity tree malformed - Source or File hsould have caught this call"
-      end
-
       def inspect
         "\#<#{self.class}>"
       end
 
       def contents
-        # skip all top-level entities, cuz they're all Files and Sources
-        @contents ||= actual_contents.map(&:contents).flatten
+        @contents ||= actual_contents.map do |child|
+          # skip top-level CodeBlocks
+          child.is_a?(Entities::CodeBlock) ? child.contents : child
+        end.flatten
       end
 
       private
 
-      attr_reader :source_data
-
       def actual_contents
-        @actual_contents ||= ast.children.map { |child| process_node(child) }
+        @actual_contents ||= process_nodes(ast.children)
       end
 
     end

data/lib/analyst/parser.rb

@@ -1,5 +1,3 @@
-require 'fileutils'
-
 module Analyst
 
   class Parser
@@ -18,26 +16,42 @@ module Analyst
         end
       end.flatten
 
-      wrapped_asts = file_paths.map do |path|
-        ast = ::Parser::CurrentRuby.parse(File.open(path, 'r').read)
-        ::Parser::AST::Node.new(:analyst_file, [ast])
-      end
+      asts = file_paths.map do |path|
+        File.open(path) do |file|
+          parse_source(file.read, path)
+        end
+      end.compact
 
-      root_node = ::Parser::AST::Node.new(:analyst_root, wrapped_asts)
-      root = Entities::Root.new(root_node, file_paths)
-      new(root)
+      new(asts)
     end
 
     def self.for_source(source)
-      ast = ::Parser::CurrentRuby.parse(source)
-      wrapped_ast = ::Parser::AST::Node.new(:analyst_source, [ast])
-      root_node = ::Parser::AST::Node.new(:analyst_root, [wrapped_ast])
-      root = Entities::Root.new(root_node, [source])
-      new(root)
+      ast = parse_source(source)
+      new([ast].compact)
+    end
+
+    def self.parse_source(source, filename='(string)')
+      parser = ::Parser::CurrentRuby.new
+      parser.diagnostics.all_errors_are_fatal = true
+      parser.diagnostics.ignore_warnings      = true
+
+      buffer = ::Parser::Source::Buffer.new(filename)
+      buffer.source = source
+      parser.parse(buffer)
+    rescue ::Parser::SyntaxError => e
+      $stderr.puts "Error during parsing; #{filename == '(string)' ? 'string' : 'file'} will be skipped:"
+      $stderr.puts format_diagnostic_msg(e.diagnostic)
+    end
+    private_class_method :parse_source
+
+    def self.format_diagnostic_msg(diagnostic)
+      diagnostic.render.map { |line| "  #{line}" }.join("\n")
     end
+    private_class_method :format_diagnostic_msg
 
-    def initialize(root)
-      @root = root
+    def initialize(asts)
+      root_node = ::Parser::AST::Node.new(:analyst_root, asts)
+      @root = Processor.process_node(root_node, nil)
     end
 
     def inspect

data/lib/analyst/processor.rb

@@ -16,7 +16,7 @@ module Analyst
     def self.process_node(node, parent)
       return if node.nil?
       return unless node.respond_to?(:type)
-      PROCESSORS[node.type].new(node, parent)
+      PROCESSORS[node.type].process(node, parent)
     end
 
   end

data/lib/analyst/version.rb

@@ -1,3 +1,3 @@
 module Analyst
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

data/spec/entities/class_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Analyst::Entities::Class do
 
-  let(:parser) { Analyst.for_file("./spec/fixtures/music.rb") }
+  let(:parser) { Analyst.for_file("./spec/fixtures/music/music.rb") }
   let(:artist) { parser.classes.detect { |klass| klass.full_name == "Artist" } }
   let(:singer) { parser.classes.detect { |klass| klass.full_name == "Singer" } }
   let(:amp)    { parser.classes.detect { |klass| klass.full_name == "Performances::Equipment::Amp" }}

data/spec/entities/entity_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Analyst::Entities::Entity do
 
-  let(:parser) { Analyst.for_file("./spec/fixtures/music.rb") }
+  let(:parser) { Analyst.for_file("./spec/fixtures/music/music.rb") }
   let(:singer) { parser.classes.detect{ |klass| klass.name == "Singer" }}
 
   describe "#constants" do
@@ -62,52 +62,36 @@ describe Analyst::Entities::Entity do
     end
   end
 
-  describe "(private) #source_range" do
-    let(:code) do <<-CODE
-class Foo
-  attr_accessor :bar
-end
+  describe "#file_path" do
+    let(:parser) { Analyst.for_files("./spec/fixtures/music") }
+    let(:singer) { parser.classes.detect { |klass| klass.name == "Singer" } }
 
-class Baz
-  def initialize
-    puts "Fresh Baz!"
-  end
-end
-    CODE
+    it "reports the path of the source file" do
+      expect(singer.file_path).to eq "./spec/fixtures/music/music.rb"
     end
 
-    let(:parser) { Analyst.for_source(code) }
-
-    context "returns the source code location" do
-      let(:baz) { parser.classes.detect {|klass| klass.name == "Baz"} }
-      let(:source_range) { baz.send :source_range }
-
-      it "includes the start position" do
-        expect(source_range.begin).to eq code.index("class Baz")
-      end
-
-      it "includes the end position" do
-        expect(source_range.end).to eq code.size - 1
-      end
+    it "works for non-top-level Entities too" do
+      a_method = singer.methods.first
+      expect(a_method.file_path).to eq "./spec/fixtures/music/music.rb"
     end
-  end
 
-  describe "#file_path" do
-    let(:parser) { Analyst.for_files("./spec/fixtures") }
-    let(:singer) { parser.classes.detect { |klass| klass.name == "Singer" } }
+    context "when the source is a string" do
+      let(:parser) { Analyst.for_source("class Foo; end") }
+      let(:foo_class) { parser.classes.first }
 
-    it "reports the path of the source file" do
-      expect(singer.file_path).to eq "./spec/fixtures/music.rb"
+      it "returns '(string)'" do
+        expect(foo_class.file_path).to eq '(string)'
+      end
     end
   end
 
   describe "#location" do
-    let(:parser) { Analyst.for_files("./spec/fixtures") }
+    let(:parser) { Analyst.for_files("./spec/fixtures/music") }
     let(:singer) { parser.classes.detect { |klass| klass.name == "Singer" } }
     let(:songs)  { singer.imethods.detect { |meth| meth.name == "songs" } }
 
     it "reports the location of the source for the entity" do
-      expect(songs.location).to eq "./spec/fixtures/music.rb:41"
+      expect(songs.location).to eq "./spec/fixtures/music/music.rb:41"
     end
   end
 
@@ -115,7 +99,7 @@ end
     let(:test_method) { singer.imethods.first }
 
     it "correctly maps to the source" do
-      method_text = "def status\n    if self.album_sales > HIPSTER_THRESHOLD\n      \"sellout\"\n    else\n      \"cool\"\n    end\n  end\n"
+      method_text = "def status\n    if self.album_sales > HIPSTER_THRESHOLD\n      \"sellout\"\n    else\n      \"cool\"\n    end\n  end"
 
       expect(test_method.source).to eq(method_text)
     end

data/spec/fixtures/syntax_errors/bad.rb

@@ -0,0 +1,6 @@
+class Bad
+  def illegal+character
+    "you can't have a + in there, dummy!"
+  end
+end
+

data/spec/fixtures/syntax_errors/good.rb

@@ -0,0 +1,7 @@
+class Good
+  def beautiful_syntax
+    "there's nothing wrong with this file"
+  end
+end
+
+

data/spec/parser_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "Parser" do
 
-  let(:parser) { Analyst.for_file("./spec/fixtures/music.rb") }
+  let(:parser) { Analyst.for_file("./spec/fixtures/music/music.rb") }
 
   describe "#top_level_classes" do
 
@@ -28,5 +28,62 @@ describe "Parser" do
     end
   end
 
+  describe "#constants" do
+    let(:code) { "Nice::Static::Constant; stupid.dynamic::Constant; @another.stupid::Constant" }
+    let(:parser) { Analyst.for_source(code) }
+
+    it "recognizes static constants" do
+      expect(parser.constants.map(&:name)).to include("Nice::Static::Constant")
+    end
+
+    it "recognizes dynamically-named constants" do
+      dynamic_constants = %w[<`stupid.dynamic`>::Constant <`@another.stupid`>::Constant]
+      expect(parser.constants.map(&:name)).to include(*dynamic_constants)
+    end
+  end
+
+  describe "::for_source" do
+    context "with syntax errors" do
+      let(:code) {<<-CODE
+        class Mail
+          def deliver
+            ship_to(PostOffice.nearest_to(recipient))
+          end
+        end
+
+        count_those_parentheses())
+      CODE
+      }
+
+      let(:parser) { Analyst.for_source(code) }
+
+      it "reports the error" do
+        error_line = Regexp.new(Regexp.quote("count_those_parentheses())"))
+        expect { parser }.to output(error_line).to_stderr
+      end
+
+      it "aborts parsing" do
+        allow($stderr).to receive(:puts) # suppress error reporting in spec output
+        expect(parser.classes).to be_empty
+      end
+    end
+  end
+
+  describe "::for_files" do
+    context "with syntax errors" do
+      let(:parser) { Analyst.for_files("./spec/fixtures/syntax_errors/") }
+
+      it "reports the error" do
+        error_line = Regexp.new(Regexp.quote("def illegal+character"))
+        expect { parser }.to output(error_line).to_stderr
+      end
+
+      it "omits the bad files, but parses the good ones" do
+        allow($stderr).to receive(:puts) # suppress error reporting in spec output
+        expect(parser.classes.map(&:name)).to eq ['Good']
+      end
+    end
+  end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analyst
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Coraline Ada Ehmke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-01 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -190,7 +190,6 @@ files:
 - lib/analyst/entities/constant.rb
 - lib/analyst/entities/constant_assignment.rb
 - lib/analyst/entities/entity.rb
-- lib/analyst/entities/file.rb
 - lib/analyst/entities/hash.rb
 - lib/analyst/entities/interpolated_string.rb
 - lib/analyst/entities/method.rb
@@ -200,7 +199,6 @@ files:
 - lib/analyst/entities/pair.rb
 - lib/analyst/entities/root.rb
 - lib/analyst/entities/singleton_class.rb
-- lib/analyst/entities/source.rb
 - lib/analyst/entities/string.rb
 - lib/analyst/entities/symbol.rb
 - lib/analyst/entities/unhandled.rb
@@ -217,7 +215,9 @@ files:
 - spec/entities/method_call_spec.rb
 - spec/entities/singleton_class_spec.rb
 - spec/entities/string_spec.rb
-- spec/fixtures/music.rb
+- spec/fixtures/music/music.rb
+- spec/fixtures/syntax_errors/bad.rb
+- spec/fixtures/syntax_errors/good.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -255,7 +255,8 @@ test_files:
 - spec/entities/method_call_spec.rb
 - spec/entities/singleton_class_spec.rb
 - spec/entities/string_spec.rb
-- spec/fixtures/music.rb
+- spec/fixtures/music/music.rb
+- spec/fixtures/syntax_errors/bad.rb
+- spec/fixtures/syntax_errors/good.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/analyst/entities/file.rb

@@ -1,46 +0,0 @@
-module Analyst
-
-  module Entities
-
-    class File < Entity
-
-      handles_node :analyst_file
-
-      def full_name
-        ""
-      end
-
-      def file_path
-        parent.source_data_for(self)
-      end
-
-      def location
-        file_path
-      end
-
-      def origin_source
-        ::File.open(file_path, 'r').read
-      end
-
-      def contents
-        @contents ||= actual_contents.map do |child|
-          # skip top-level CodeBlocks
-          child.is_a?(Entities::CodeBlock) ? child.contents : child
-        end.flatten
-      end
-
-      private
-
-      def source_range
-        0..-1
-      end
-
-      def actual_contents
-        @actual_contents ||= ast.children.map { |child| process_node(child) }
-      end
-
-    end
-
-  end
-
-end

data/lib/analyst/entities/source.rb

@@ -1,46 +0,0 @@
-module Analyst
-
-  module Entities
-
-    class Source < Entity
-
-      handles_node :analyst_source
-
-      def full_name
-        ""
-      end
-
-      def file_path
-        "$SOURCE$"
-      end
-
-      def location
-        file_path
-      end
-
-      def origin_source
-        parent.source_data_for(self)
-      end
-
-      def contents
-        @contents ||= actual_contents.map do |child|
-          # skip top-level CodeBlocks
-          child.is_a?(Entities::CodeBlock) ? child.contents : child
-        end.flatten
-      end
-
-      private
-
-      def source_range
-        0..-1
-      end
-
-      def actual_contents
-        @actual_contents ||= ast.children.map { |child| process_node(child) }
-      end
-
-    end
-
-  end
-
-end