analyst 0.14.2 → 0.15.0

data/lib/analyst/entities/symbol.rb

@@ -1,12 +1,25 @@
 module Analyst
 
   module Entities
-    module Symbol
+    class Symbol < Entity
 
-      def self.new(node, parent)
+      handles_node :sym
+
+      def value
         ast.children.first
       end
 
+      def name
+      end
+
+      def full_name
+      end
+
+     private
+
+      def content_node
+      end
+
     end
   end
 end

data/lib/analyst/entities/{empty.rb → unhandled.rb}

@@ -1,7 +1,9 @@
+require_relative 'entity'
+
 module Analyst
 
   module Entities
-    class Empty < Entity
+    class Unhandled < Entity
       def full_name
         ""
       end

data/lib/analyst/parser.rb

@@ -1,5 +1,4 @@
 require 'fileutils'
-require 'pry'
 
 module Analyst
 
@@ -7,45 +6,49 @@ module Analyst
 
     extend Forwardable
 
-    attr_reader :start_path
-
-    def_delegators :root, :classes, :top_level_classes
-
-    # TODO: Empty -> Unhandled (or something like that)
-    PROCESSORS = Hash.new(Entities::Empty).merge!(
-      :root => Entities::Root,
-      :class => Entities::Class,
-      :def => Entities::InstanceMethod,
-      :defs => Entities::SingletonMethod,
-      :begin => Entities::Begin,
-      :module => Entities::Module,
-      :send => Entities::MethodCall,
-      :sclass => Entities::SingletonClass,
-      :dstr => Entities::InterpolatedString
-    # :def => :method_node_parser,
-    # :send => :send_node_parser
-    # TODO: make a method parser, which pushes the the context_stack so that things inside method bodies
-    # are treated differently than those inside class or module bodies.  same with Block (right?)
-    )
-
-    def self.process_node(node, parent)
-      return if node.nil? # TODO: maybe a Entities:Nil would be appropriate? maybe?
-      PROCESSORS[node.type].new(node, parent)
+    def_delegators :root, :classes, :top_level_classes, :constants,
+                          :methods
+
+    def self.for_files(path_to_files)
+      file_paths = if File.directory?(path_to_files)
+        Dir.glob(File.join(path_to_files, "**", "*.rb"))
+      else
+        [path_to_files]
+      end
+
+      wrapped_asts = file_paths.map do |path|
+        ast = ::Parser::CurrentRuby.parse(File.open(path, 'r').read)
+        ::Parser::AST::Node.new(:analyst_file, [ast])
+      end
+
+      root_node = ::Parser::AST::Node.new(:analyst_root, wrapped_asts)
+      root = Entities::Root.new(root_node, file_paths)
+      new(root)
+    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)
     end
 
-    def initialize(ast)
-      @ast = ast
+    def initialize(root)
+      @root = root
     end
 
     def inspect
       "\#<#{self.class}:#{object_id}>"
     end
 
+    def top_level_entities
+      root.contents
+    end
+
     private
 
-    def root
-      @root ||= self.class.process_node(@ast, nil)
-    end
+    attr_reader :root
 
   end
 

data/lib/analyst/processor.rb

@@ -0,0 +1,25 @@
+require_relative 'entities/unhandled'
+
+module Analyst
+
+  module Processor
+
+    PROCESSORS = Hash.new(Analyst::Entities::Unhandled)
+
+    def self.register_processor(type, processor)
+      if PROCESSORS.key? type
+        raise "(#{type}) nodes already registered by #{PROCESSORS[type]}"
+      end
+      PROCESSORS[type] = processor
+    end
+
+    def self.process_node(node, parent)
+      return if node.nil?
+      return unless node.respond_to?(:type)
+      PROCESSORS[node.type].new(node, parent)
+    end
+
+  end
+
+end
+

data/lib/analyst/version.rb

@@ -1,3 +1,3 @@
 module Analyst
-  VERSION = "0.14.2"
+  VERSION = "0.15.0"
 end

data/lib/analyst.rb

@@ -1,56 +1,45 @@
-require 'ephemeral'
-require 'poro_plus'
 require 'fileutils'
 require 'haml'
+require 'parser/current'
 
-require_relative "analyst/analyzer"
+require_relative "analyst/parser"
+require_relative "analyst/processor"
+require_relative "analyst/version"
 require_relative "analyst/entities/entity"
-require_relative "analyst/entities/empty"
 require_relative "analyst/entities/root"
-require_relative "analyst/entities/begin"
+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"
 require_relative "analyst/entities/interpolated_string"
+require_relative "analyst/entities/constant"
+require_relative "analyst/entities/conditional"
 require_relative "analyst/entities/method"
 require_relative "analyst/entities/method_call"
 require_relative "analyst/entities/singleton_class"
+require_relative "analyst/entities/array"
 require_relative "analyst/entities/hash"
 require_relative "analyst/entities/pair"
 require_relative "analyst/entities/symbol"
 require_relative "analyst/entities/string"
-require_relative "analyst/parser"
-require_relative "analyst/version"
 
 module Analyst
-  def self.new(path_to_files)
-    Analyst::Parser.new(FileProcessor.new(path_to_files).ast)
-  end
-
-  class FileProcessor
 
-    attr_reader :path_to_files
+  module ClassMethods
 
-    def initialize(path_to_files)
-      @path_to_files = path_to_files
+    def for_files(path_to_files)
+      Analyst::Parser.for_files(path_to_files)
     end
 
-    def source_files
-      if File.directory?(path_to_files)
-        return Dir.glob(File.join(path_to_files, "**", "*.rb"))
-      else
-        return [path_to_files]
-      end
-    end
+    alias :for_file :for_files
 
-    def ast
-      ::Parser::AST::Node.new(
-        :root, source_files.map do |file|
-          content = File.open(file, "r").read
-          ::Parser::CurrentRuby.parse(content)
-        end
-      )
+    def for_source(source)
+      Analyst::Parser.for_source(source)
     end
 
   end
 
+  extend ClassMethods
+
 end

data/spec/class_spec.rb

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

data/spec/constant_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Analyst::Entities::Constant do
+
+  describe "#name" do
+    context "with top-level scoping" do
+      let(:source) { "::Food::Pizza::Hawaiian" }
+
+      it "correctly reports the name" do
+        analyzer = Analyst.for_source(source)
+        expect(analyzer.constants.first.name).to eq source
+      end
+    end
+
+    context "without a scope" do
+      let(:source) { "Body::Organs::Pancreas" }
+
+      it "correctly reports the name" do
+        analyzer = Analyst.for_source(source)
+        expect(analyzer.constants.first.name).to eq source
+      end
+
+    end
+  end
+
+end

data/spec/entity_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe Analyst::Entities::Entity do
+
+  let(:parser) { Analyst.for_file("./spec/fixtures/music.rb") }
+  let(:singer) { parser.classes.detect{ |klass| klass.name == "Singer" }}
+
+  describe "#constants" do
+    it "lists all constants from recursive search" do
+      constants = singer.constants.map(&:full_name)
+      expected = %w[SUPER_ATTRS HIPSTER_THRESHOLD HIPSTER_THRESHOLD Song Performance::Equipment::Microphone]
+      # TODO: once (casgn) is done, expected should contain one more
+      # SUPER_ATTRS and one more HIPSTER_THRESHOLD
+
+      expect(constants).to match_array expected
+    end
+
+    it "finds constants inside of Arrays" do
+      code = <<-CODE
+        class Mail
+          def things
+            [Stamp, Envelope, Postcard]
+          end
+        end
+      CODE
+
+      found = Analyst.for_source(code).constants.map(&:full_name)
+      expect(found).to match_array %w[Stamp Envelope Postcard]
+    end
+
+    it "finds constants inside of method calls" do
+      code = <<-CODE
+        class Mail
+          def deliver
+            ship_to(PostOffice.nearest_to(recipient))
+          end
+        end
+      CODE
+
+      found = Analyst.for_source(code).constants.map(&:full_name)
+      expect(found).to match_array %w[PostOffice]
+    end
+
+    it "finds constants inside of parenthetical expressions" do
+      code = "def fn; A + (B || C); end"
+      found = Analyst.for_source(code).constants.map(&:full_name)
+      expect(found).to match_array %w[A B C]
+    end
+  end
+
+  describe "#conditionals" do
+    it "lists all conditionals from recursive search" do
+      # TODO: test recursive search frd -- i.e. conditionals inside of conditionals
+      conditionals = singer.imethods.map(&:conditionals).flatten
+      expect(conditionals.count).to eq(1)
+    end
+  end
+
+  describe "(private) #source_range" do
+    let(:code) do <<-CODE
+class Foo
+  attr_accessor :bar
+end
+
+class Baz
+  def initialize
+    puts "Fresh Baz!"
+  end
+end
+    CODE
+    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
+    end
+  end
+
+  describe "#file_path" do
+    let(:parser) { Analyst.for_files("./spec/fixtures") }
+    let(:singer) { parser.classes.detect { |klass| klass.name == "Singer" } }
+
+    it "reports the path of the source file" do
+      expect(singer.file_path).to eq "./spec/fixtures/music.rb"
+    end
+  end
+
+  describe "#location" do
+    let(:parser) { Analyst.for_files("./spec/fixtures") }
+    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"
+    end
+  end
+
+  describe "#source" do
+    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"
+
+      expect(test_method.source).to eq(method_text)
+    end
+  end
+
+end

data/spec/fixtures/music.rb

@@ -16,22 +16,35 @@ end
 class Singer < Artist
 
   SUPER_ATTRS = { singing: 10, dancing: 10, looks: 10 }
+  HIPSTER_THRESHOLD = 10
 
   class << self
     def sellouts
-      where(:album_sales > 10)
+      where(:album_sales > HIPSTER_THRESHOLD)
     end
   end
 
   def self.superstar
     first = %w[Michael Beyonce Cee-lo Devin]
     last = %w[Jackson Knowles Green Townsend]
-
     new("#{first.sample} #{last.sample}", SUPER_ATTRS.dup)
   end
 
+  def status
+    if self.album_sales > HIPSTER_THRESHOLD
+      "sellout"
+    else
+      "cool"
+    end
+  end
+
+  def songs
+    Song.where(artist: self)
+  end
+
   def sing
-    "♬ Hang the DJ! ♬"
+    mic = Performance::Equipment::Microphone
+    mic.shout "♬ Hang the DJ! ♬"
   end
 end
 
@@ -65,6 +78,9 @@ module Performances
   module Equipment
     class Amp
     end
+
+    class Microphone
+    end
   end
 end
 

data/spec/parser_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "Parser" do
 
-  let(:parser) { Analyst.new("./spec/fixtures/music.rb") }
+  let(:parser) { Analyst.for_file("./spec/fixtures/music.rb") }
 
   describe "#top_level_classes" do
 
@@ -17,7 +17,8 @@ describe "Parser" do
     it "lists all classes from recursive search" do
       all_classes = %w[Artist Singer Song
                        Instruments::Stringed Instruments::Guitar
-                       Performances::Equipment::Amp]
+                       Performances::Equipment::Amp
+                       Performances::Equipment::Microphone]
 
       class_names = parser.classes.map(&:full_name)
 

data/spec/spec_helper.rb

@@ -6,3 +6,6 @@ require 'rubygems'
 require 'rspec'
 require 'analyst'
 require 'pry'
+require 'byebug'
+require 'awesome_print'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analyst
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.15.0
 platform: ruby
 authors:
 - Coraline Ada Ehmke
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ephemeral
+  name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: poro_plus
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,7 +40,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: haml
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: parser
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +68,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +82,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rouge
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,27 +96,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: terminal-table
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.6'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -124,21 +124,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -152,7 +152,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -166,7 +166,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -180,7 +180,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -210,12 +210,14 @@ files:
 - Rakefile
 - analyst.gemspec
 - lib/analyst.rb
-- lib/analyst/analyzer.rb
 - lib/analyst/association.rb
-- lib/analyst/entities/begin.rb
+- lib/analyst/entities/array.rb
 - lib/analyst/entities/class.rb
-- lib/analyst/entities/empty.rb
+- lib/analyst/entities/code_block.rb
+- lib/analyst/entities/conditional.rb
+- lib/analyst/entities/constant.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
@@ -224,11 +226,16 @@ 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
 - lib/analyst/parser.rb
+- lib/analyst/processor.rb
 - lib/analyst/version.rb
 - spec/class_spec.rb
+- spec/constant_spec.rb
+- spec/entity_spec.rb
 - spec/fixtures/music.rb
 - spec/method_spec.rb
 - spec/parser_spec.rb
@@ -259,6 +266,8 @@ specification_version: 4
 summary: A nice API for interacting with parsed Ruby source code.
 test_files:
 - spec/class_spec.rb
+- spec/constant_spec.rb
+- spec/entity_spec.rb
 - spec/fixtures/music.rb
 - spec/method_spec.rb
 - spec/parser_spec.rb