analyst 0.13.1 → 0.14.0

data/spec/parser_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "Parser" do
+
+  let(:parser) { Analyst.new("./spec/fixtures/music.rb") }
+
+  describe "#top_level_classes" do
+
+    it "lists top-level classes" do
+      class_names = parser.top_level_classes.map(&:full_name)
+      expect(class_names).to match_array ["Artist", "Singer", "Song"]
+    end
+
+  end
+
+  describe "#classes" do
+    it "lists all classes from recursive search" do
+      all_classes = %w[Artist Singer Song
+                       Instruments::Stringed Instruments::Guitar
+                       Performances::Equipment::Amp]
+
+      class_names = parser.classes.map(&:full_name)
+
+      expect(class_names).to match_array all_classes
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -5,3 +5,4 @@ SimpleCov.start
 require 'rubygems'
 require 'rspec'
 require 'analyst'
+require 'pry'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analyst
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Coraline Ada Ehmke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ephemeral
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: poro_plus
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +179,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Engine for analyzing Ruby source code.
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A nice API for interacting with parsed Ruby source code.
 email:
 - coraline@idolhands.com
 - mikezx@gmail.com
@@ -197,68 +211,22 @@ files:
 - analyst.gemspec
 - lib/analyst.rb
 - lib/analyst/analyzer.rb
-- lib/analyst/cli.rb
-- lib/analyst/entity_parser/association.rb
-- lib/analyst/entity_parser/entities/class.rb
-- lib/analyst/entity_parser/entities/empty.rb
-- lib/analyst/entity_parser/entities/entity.rb
-- lib/analyst/entity_parser/entities/method.rb
-- lib/analyst/entity_parser/entities/module.rb
-- lib/analyst/formatters/base.rb
-- lib/analyst/formatters/csv.rb
-- lib/analyst/formatters/html.rb
-- lib/analyst/formatters/html_index.rb
-- lib/analyst/formatters/templates/index.html.haml
-- lib/analyst/formatters/templates/output.html.haml
-- lib/analyst/formatters/text.rb
-- lib/analyst/fukuzatsu/analyzer.rb
-- lib/analyst/fukuzatsu/cli.rb
-- lib/analyst/fukuzatsu/entity_parser/association.rb
-- lib/analyst/fukuzatsu/entity_parser/entities/class.rb
-- lib/analyst/fukuzatsu/entity_parser/entities/empty.rb
-- lib/analyst/fukuzatsu/entity_parser/entities/entity.rb
-- lib/analyst/fukuzatsu/entity_parser/entities/method.rb
-- lib/analyst/fukuzatsu/entity_parser/entities/module.rb
-- lib/analyst/fukuzatsu/formatters/base.rb
-- lib/analyst/fukuzatsu/formatters/csv.rb
-- lib/analyst/fukuzatsu/formatters/html.rb
-- lib/analyst/fukuzatsu/formatters/html_index.rb
-- lib/analyst/fukuzatsu/formatters/templates/index.html.haml
-- lib/analyst/fukuzatsu/formatters/templates/output.html.haml
-- lib/analyst/fukuzatsu/formatters/text.rb
-- lib/analyst/fukuzatsu/line_of_code.rb
-- lib/analyst/fukuzatsu/parsed_file.rb
-- lib/analyst/fukuzatsu/parsed_method.rb
-- lib/analyst/fukuzatsu/parser_original.rb
-- lib/analyst/fukuzatsu/rethink/parser.rb
-- lib/analyst/fukuzatsu/version.rb
-- lib/analyst/line_of_code.rb
-- lib/analyst/parsed_file.rb
-- lib/analyst/parsed_method.rb
+- lib/analyst/association.rb
+- lib/analyst/entities/begin.rb
+- lib/analyst/entities/class.rb
+- lib/analyst/entities/empty.rb
+- lib/analyst/entities/entity.rb
+- lib/analyst/entities/method.rb
+- lib/analyst/entities/method_call.rb
+- lib/analyst/entities/module.rb
+- lib/analyst/entities/root.rb
+- lib/analyst/entities/singleton_class.rb
 - lib/analyst/parser.rb
-- lib/analyst/rethink/parser.rb
 - lib/analyst/version.rb
-- spec/analyzer_spec.rb
-- spec/cli_spec.rb
-- spec/fixtures/eg_class.rb
-- spec/fixtures/eg_mod_class.rb
-- spec/fixtures/eg_mod_class_2.rb
-- spec/fixtures/eg_module.rb
-- spec/fixtures/module_with_class.rb
-- spec/fixtures/multiple_methods.rb
-- spec/fixtures/nested_methods.rb
-- spec/fixtures/program_1.rb
-- spec/fixtures/program_2.rb
-- spec/fixtures/program_3.rb
-- spec/fixtures/program_4.rb
-- spec/fixtures/single_class.rb
-- spec/fixtures/single_method.rb
-- spec/formatters/csv_spec.rb
-- spec/formatters/html_index_spec.rb
-- spec/formatters/html_spec.rb
-- spec/formatters/text_spec.rb
-- spec/parsed_file_spec.rb
-- spec/parsed_method_spec.rb
+- spec/class_spec.rb
+- spec/fixtures/music.rb
+- spec/method_spec.rb
+- spec/parser_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -283,28 +251,11 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Engine for analyzing Ruby source code.
+summary: A nice API for interacting with parsed Ruby source code.
 test_files:
-- spec/analyzer_spec.rb
-- spec/cli_spec.rb
-- spec/fixtures/eg_class.rb
-- spec/fixtures/eg_mod_class.rb
-- spec/fixtures/eg_mod_class_2.rb
-- spec/fixtures/eg_module.rb
-- spec/fixtures/module_with_class.rb
-- spec/fixtures/multiple_methods.rb
-- spec/fixtures/nested_methods.rb
-- spec/fixtures/program_1.rb
-- spec/fixtures/program_2.rb
-- spec/fixtures/program_3.rb
-- spec/fixtures/program_4.rb
-- spec/fixtures/single_class.rb
-- spec/fixtures/single_method.rb
-- spec/formatters/csv_spec.rb
-- spec/formatters/html_index_spec.rb
-- spec/formatters/html_spec.rb
-- spec/formatters/text_spec.rb
-- spec/parsed_file_spec.rb
-- spec/parsed_method_spec.rb
+- spec/class_spec.rb
+- spec/fixtures/music.rb
+- spec/method_spec.rb
+- spec/parser_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/analyst/cli.rb

@@ -1,42 +0,0 @@
-require 'thor'
-require 'Analyst'
-
-module Analyst
-
-  class CLI < Thor
-
-    desc_text = "Formats are text (default, to STDOUT), html, and csv. "
-    desc_text << "Example: fuku check foo/ -f html"
-
-    desc "check PATH_TO_FILE [-f FORMAT] [-t MAX_COMPLEXITY_ALLOWED]", desc_text
-    method_option :format, :type => :string, :default => 'text', :aliases => "-f"
-    method_option :threshold, :type => :numeric, :default => 0, :aliases => "-t"
-
-    def check(path="./")
-      parser = Analyst::Parser.new(
-        path,
-        formatter,
-        options['threshold']
-      )
-      parser.parse_files
-      parser.report
-    end
-
-    default_task :check
-
-    private
-
-    def formatter
-      case options['format']
-      when 'html'
-        Formatters::Html
-      when 'csv'
-        Formatters::Csv
-      else
-        Formatters::Text
-      end
-    end
-
-  end
-
-end

data/lib/analyst/entity_parser/entities/class.rb

@@ -1,92 +0,0 @@
-#TODO add == to association
-
-module Analyst
-
-  module EntityParser
-    module Entities
-      class ActiveModel < Entity
-
-        ASSOCIATIONS = [:belongs_to, :has_one, :has_many, :has_and_belongs_to_many]
-
-        attr_reader :associations
-
-        def initialize
-          @associations = []
-        end
-
-        def handle_send(node)
-          target, method_name, *args = node.children
-          if ASSOCIATIONS.include?(method_name)
-            add_association(method_name, args)
-          end
-        end
-
-        # When a class is reopened, merge its associations
-        def merge_associations_from(klass)
-          klass.associations.each do |association|
-            associations << Association.new(
-              type: association.type,
-              source: self,
-              target_class: association.target_class
-            )
-          end
-          associations.uniq!
-        end
-
-        def name
-          const_node_array(ast.children.first).join('::')
-        end
-
-        def full_name
-          parent.full_name.empty? ? name : parent.full_name + '::' + name
-        end
-
-        private
-
-        def add_association(method_name, args)
-          target_class = value_from_hash_node(args.last, :class_name)
-          target_class ||= begin
-                             symbol_node = args.first
-                             symbol_name = symbol_node.children.first
-                             symbol_name.pluralize.classify
-                           end
-          association = Association.new(type: method_name, source: self, target_class: target_class)
-          associations << association
-        end
-
-        private
-
-        # takes a (const) node and returns an array specifying the fully-qualified
-        # constant name that it represents.  ya know, so CoolModule::SubMod::SweetClass
-        # would be parsed to:
-        # (const
-        #   (const
-        #     (const nil :CoolModule) :SubMod) :SweetClass)
-        # and passing that node here would return [:CoolModule, :SubMod, :SweetClass]
-        def const_node_array(node)
-          return [] if node.nil?
-          raise "expected (const) node or nil, got (#{node.type})" unless node.type == :const
-          const_node_array(node.children.first) << node.children[1]
-        end
-
-        # Fetches value from hash node iff key is symbol and value is str
-        # Raises an exception if value is not str
-        # Returns nil if key is not found
-        def value_from_hash_node(node, key)
-          return unless node.type == :hash
-          pair = node.children.detect do |pair_node|
-            key_symbol_node = pair_node.children.first
-            key == key_symbol_node.children.first
-          end
-          if pair
-            value_node = pair.children.last
-            throw "Bad type. Expected (str), got (#{value_node.type})" unless value_node.type == :str
-            value_node.children.first
-          end
-        end
-
-      end
-
-    end
-  end
-end

data/lib/analyst/entity_parser/entities/empty.rb

@@ -1,13 +0,0 @@
-module Analyst
-
-  module EntityParser
-    module Entities
-      class Empty < Entity
-        def full_name
-          ""
-        end
-      end
-    end
-  end
-
-end

data/lib/analyst/entity_parser/entities/entity.rb

@@ -1,29 +0,0 @@
-module Analyst
-  module EntityParser
-    module Entities
-      class Entity
-
-        attr_reader :ast, :parent
-
-        def initialize(parent, ast)
-          @parent = parent
-          @ast = ast
-        end
-
-        def handle_send_node(node)
-          # raise "Subclass must implement handle_send_node"
-          # abstract method.  btw, this feels wrong -- send should be an entity too.  but for now, whatevs.
-        end
-
-        def full_name
-          throw "Subclass must implement #full_name"
-        end
-
-        def inspect
-          "\#<#{self.class}:#{object_id} full_name=#{full_name}>"
-        end
-
-      end
-    end
-  end
-end

data/lib/analyst/entity_parser/entities/method.rb

@@ -1,16 +0,0 @@
-module Analyst
-
-  module EntityParser
-    module Entities
-      class Method < Entity
-        def name
-          ast.children.first.to_s
-        end
-        def full_name
-          parent.full_name + '#' + name
-        end
-      end
-    end
-  end
-
-end

data/lib/analyst/entity_parser/entities/module.rb

@@ -1,31 +0,0 @@
-module Analyst
-
-  module EntityParser
-    module Entities
-      class Module < Entity
-        def name
-          const_node_array(ast.children.first).join('::')
-        end
-        def full_name
-          parent.full_name.empty? ? name : parent.full_name + '::' + name
-        end
-
-        private
-
-        # takes a (const) node and returns an array specifying the fully-qualified
-        # constant name that it represents.  ya know, so CoolModule::SubMod::SweetClass
-        # would be parsed to:
-        # (const
-        #   (const
-        #     (const nil :CoolModule) :SubMod) :SweetClass)
-        # and passing that node here would return [:CoolModule, :SubMod, :SweetClass]
-        def const_node_array(node)
-          return [] if node.nil?
-          raise "expected (const) node or nil, got (#{node.type})" unless node.type == :const
-          const_node_array(node.children.first) << node.children[1]
-        end
-      end
-    end
-  end
-
-end

data/lib/analyst/formatters/base.rb

@@ -1,33 +0,0 @@
-module Formatters
-
-  module Base
-
-    def self.included(klass)
-      klass.send(:attr_accessor, :file)
-      klass.send(:attr_accessor, :source)
-      klass.send(:attr_accessor, :output_directory)
-    end
-
-    def initialize(file, output_directory=nil, source="")
-      self.file = file
-      self.source = source
-      self.output_directory = output_directory
-    end
-
-    def filename
-      File.basename(self.file.path_to_file) + file_extension
-    end
-
-    def output_path
-      output_path = File.dirname(File.join(self.output_directory, self.file.path_to_file))
-      FileUtils.mkpath(output_path)
-      output_path
-    end
-
-    def path_to_results
-      File.join(output_path, filename)
-    end
-
-  end
-
-end

data/lib/analyst/formatters/csv.rb

@@ -1,43 +0,0 @@
-module Formatters
-
-  class Csv
-
-    include Formatters::Base
-
-    def self.has_index?
-      false
-    end
-
-    def self.writes_to_file_system?
-      true
-    end
-
-    def content
-      rows + "\r\n"
-    end
-
-    def export
-      begin
-        File.open(path_to_results, 'a') {|outfile| outfile.write(content)}
-      rescue Exception => e
-        puts "Unable to write output: #{e} #{e.backtrace}"
-      end
-    end
-
-    def file_extension
-      ".csv"
-    end
-
-    def path_to_results
-      File.join(output_directory, "results#{file_extension}")
-    end
-
-    def rows
-      file.methods.map do |method|
-        "#{file.path_to_file},#{file.class_name},#{method.name},#{method.complexity}"
-      end.join("\r\n")
-    end
-
-  end
-
-end

data/lib/analyst/formatters/html.rb

@@ -1,87 +0,0 @@
-require 'rouge'
-
-module Formatters
-
-  class Html
-
-    include Formatters::Base
-
-    def self.has_index?
-      true
-    end
-
-    def self.writes_to_file_system?
-      true
-    end
-
-    def self.index_class
-      Formatters::HtmlIndex
-    end
-
-    def columns
-      ["class", "method", "complexity"]
-    end
-
-    def content
-      Haml::Engine.new(output_template).render(
-        Object.new, {
-          header: header,
-          rows: rows,
-          source_lines: preprocessed,
-          class_name: file.class_name,
-          complexity: file.complexity,
-          path_to_file: file.path_to_file,
-          date: Time.now.strftime("%Y/%m/%d"),
-          time: Time.now.strftime("%l:%M %P")
-        }
-      )
-    end
-
-    def export
-      begin
-        File.open(path_to_results, 'w') {|outfile| outfile.write(content)}
-      rescue Exception => e
-        puts "Unable to write output: #{e} #{e.backtrace}"
-      end
-    end
-
-    def formatter
-      Rouge::Formatters::HTML.new(line_numbers: true)
-    end
-
-    def header
-      columns.map{|col| "<th>#{col.titleize}</th>"}.join("\r\n")
-    end
-
-    def lexer
-      lexer = Rouge::Lexers::Ruby.new
-    end
-
-    def output_template
-      File.read(File.dirname(__FILE__) + "/templates/output.html.haml")
-    end
-
-    def preprocessed
-      formatter.format(lexer.lex(source))
-    end
-
-    def rows
-      i = 0
-      file.methods.inject([]) do |a, method|
-        i += 1
-        a << "<tr class='#{i % 2 == 1 ? 'even' : 'odd'}'>"
-        a << "  <td>#{file.class_name}</td>"
-        a << "  <td>#{method.name}</td>"
-        a << "  <td>#{method.complexity}</td>"
-        a << "</tr>"
-        a
-      end.join("\r\n")
-    end
-
-    def file_extension
-      ".htm"
-    end
-
-  end
-
-end

data/lib/analyst/formatters/html_index.rb

@@ -1,47 +0,0 @@
-module Formatters
-
-  class HtmlIndex
-
-    include Formatters::Base
-
-    attr_reader :file_summary, :output_directory
-
-    def initialize(file_summary, output_directory=nil)
-      @file_summary = file_summary
-      @output_directory = output_directory
-    end
-
-    def content
-      Haml::Engine.new(output_template).render(
-        Object.new, {
-          file_summary: file_summary,
-          date: Time.now.strftime("%Y/%m/%d"),
-          time: Time.now.strftime("%l:%M %P")
-        }
-      )
-    end
-
-    def export
-      begin
-        File.open(path_to_results, 'w') {|outfile| outfile.write(content)}
-      rescue Exception => e
-        puts "Unable to write output: #{e} #{e.backtrace}"
-      end
-    end
-
-    def filename
-      "index.htm"
-    end
-
-    def output_path
-      FileUtils.mkpath(self.output_directory)
-      self.output_directory
-    end
-
-    def output_template
-      File.read(File.dirname(__FILE__) + "/templates/index.html.haml")
-    end
-
-  end
-
-end