analyst 0.16.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25e03d345e3eee79249da960a221c1635de9ded7
-  data.tar.gz: 939e2a44f33bc42afed68a253be53e4110c0ea21
+  metadata.gz: cacc928955bbd8e72446dcf6b20a5cbebc5ec4fc
+  data.tar.gz: b4c9cad57b52ba7f6c48f04f9295935cbe918463
 SHA512:
-  metadata.gz: 385373476be049c30d9ebccb8ab096496587eae69a85678e420631cf7c1bfb9ce04336b3a316b78e36f0f293186c8967714e3d7fe6d77857e776dfcd60daaa07
-  data.tar.gz: 8423b501882aab60fac8dfea3b59272d539718731ac6a40e42152c0a512f339a68e8985c31717ecd6d3354d934fb3bd2eb9f4cd710ad53c794a99c91da7cff92
+  metadata.gz: 00085874da8ad41948eca83217e3d36e519518a65d197c8fb6b38bb2fbca0ae3fd6a25bb7f3f00337d5400f1d240987a630955a6eefde5419001db7655637360
+  data.tar.gz: 238d01df95d83893c687a2bf1e1e9b578dc12218f446137439a997127ec92f16fec87c38b1e1317c4f26a88a563907e5ad92755bdae8e79d96fc41dbb138b0ea

data/analyst.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "flog"
 
 end
 

data/lib/analyst/entities/constant_assignment.rb

@@ -10,11 +10,7 @@ module Analyst
       end
 
       def full_name
-        scope.nil? ? name : scope.full_name + '::' + name
-      end
-
-      def scope
-        @scope ||= process_node(ast.children.first)
+        parent.nil? ? name : parent.full_name + '::' + name
       end
 
       private

data/lib/analyst/entities/entity.rb

@@ -24,6 +24,10 @@ module Analyst
         end
       end
 
+      def strings
+        @strings ||= contents_of_type(Entities::String)
+      end
+
       def modules
         @modules ||= begin
           nested_modules = top_level_modules.map(&:modules).flatten
@@ -70,6 +74,10 @@ module Analyst
         @conditionals ||= contents_of_type(Entities::Conditional)
       end
 
+      def hashes
+        @hashes ||= contents_of_type(Entities::Hash)
+      end
+
       def location
         "#{file_path}:#{line_number}"
       end

data/lib/analyst/entities/hash.rb

@@ -25,6 +25,12 @@ module Analyst
           hash
         end
       end
+
+      private
+
+      def contents
+        pairs
+      end
     end
   end
 end

data/lib/analyst/entities/method_call.rb

@@ -19,18 +19,10 @@ module Analyst
         end
       end
 
-      def constants
-        if target.is_a? Analyst::Entities::Constant
-          super << target
-        else
-          super
-        end
-      end
-
       private
 
       def contents
-        arguments
+        (arguments + [target]).compact
       end
 
       def target_node
@@ -38,7 +30,7 @@ module Analyst
       end
 
       def target
-        process_node(target_node)
+        @target ||= process_node(target_node)
       end
 
       def name_node

data/lib/analyst/entities/pair.rb

@@ -6,11 +6,17 @@ module Analyst
       handles_node :pair
 
       def key
-        process_node(ast.children[0])
+        @key ||= process_node(ast.children[0])
       end
 
       def value
-        process_node(ast.children[1])
+        @value ||= process_node(ast.children[1])
+      end
+
+      private
+
+      def contents
+        [key, value]
       end
     end
   end

data/lib/analyst/parser.rb

@@ -7,7 +7,7 @@ module Analyst
     extend Forwardable
 
     def_delegators :root, :classes, :top_level_classes, :constants,
-                          :methods
+                          :methods, :method_calls, :hashes
 
     def self.for_files(*path_to_files)
       file_paths = path_to_files.map do |path|

data/lib/analyst/version.rb

@@ -1,3 +1,3 @@
 module Analyst
-  VERSION = "0.16.1"
+  VERSION = "1.0.0"
 end

data/spec/entities/class_method_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Analyst::Entities::ClassMethod do
+
+  let(:code) {<<-CODE
+      class DefaultCarrier
+        def self.register(carrier)
+          CarrierRegistry.add(carrier)
+        end
+      end
+    CODE
+  }
+  let(:parser) { Analyst.for_source(code) }
+  let(:klass)  { parser.classes.first }
+  let(:method) { klass.cmethods.first }
+
+  describe "#name" do
+    it "returns its short name" do
+      expect(method.name).to eq("register")
+    end
+  end
+
+  describe "#fulL_name" do
+    it "returns its fully qualified name" do
+      expect(method.full_name).to eq("DefaultCarrier::register")
+    end
+  end
+
+end

data/spec/{class_spec.rb → entities/class_spec.rb}

@@ -5,6 +5,7 @@ describe Analyst::Entities::Class do
   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" } }
+  let(:amp)    { parser.classes.detect { |klass| klass.full_name == "Performances::Equipment::Amp" }}
 
   describe "#method_calls" do
     it "lists all method invocations within a class definition" do
@@ -27,4 +28,11 @@ describe Analyst::Entities::Class do
     end
   end
 
+  describe "#constants" do
+    it "returns a list of constants" do
+      constants = amp.constants.map(&:name)
+      expect(constants).to match_array ["Interfaces::Basic", "Performances::Equipment::Microphone", "Performances::Equipment::MicStand"]
+    end
+  end
+
 end

data/spec/entities/constant_assignment_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Analyst::Entities::ConstantAssignment do
+
+  let(:code) {<<-CODE
+      class Carrier
+        OBSTACLES = [:rain, :sleet, :snow]
+        def deliver(mail)
+          delivery = Delivery.new(mail)
+          delivery.deliver!
+        end
+      end
+    CODE
+  }
+  let(:parser)  { Analyst.for_source(code) }
+  let(:klass)   { parser.classes.first }
+  let(:constant_assignment) { klass.constant_assignments.first }
+
+  describe "#name" do
+    it "returns the short name of a constant" do
+      expect(constant_assignment.name).to eq("OBSTACLES")
+    end
+  end
+
+  describe "#full_name" do
+    it "returns the full name of a constant" do
+      expect(constant_assignment.full_name).to eq("Carrier::OBSTACLES")
+    end
+  end
+
+end

data/spec/{entity_spec.rb → entities/entity_spec.rb}

@@ -46,6 +46,12 @@ describe Analyst::Entities::Entity do
       found = Analyst.for_source(code).constants.map(&:full_name)
       expect(found).to match_array %w[A B C]
     end
+
+    it "finds constants inside of interpolated strings" do
+      code = 'str = "Today, scientists classify Pluto as a #{Pluto.wtfru?}"'
+      found = Analyst.for_source(code).constants.map(&:name)
+      expect(found).to match_array %w[Pluto]
+    end
   end
 
   describe "#conditionals" do
@@ -115,4 +121,20 @@ end
     end
   end
 
+  describe "#method_calls" do
+    it "detects method calls" do
+      code = 'do_that_thang'
+      found = Analyst.for_source(code).method_calls.map(&:name)
+      expect(found).to match_array %w[do_that_thang]
+    end
+
+    it "detects calls inside calls" do
+      code = 'do_that_thang(with_this_stuff)'
+      do_that_thang = Analyst.for_source(code).method_calls.first
+      found = do_that_thang.method_calls.map(&:name)
+      expect(found).to match_array %w[with_this_stuff]
+    end
+
+  end
+
 end

data/spec/entities/hash_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Analyst::Entities::Hash do
+
+  let(:code) {<<-CODE
+      class Postmark
+        attr_accessor :date, :origin_city
+        def to_hash
+          {
+            date: self.date,
+            sent_from: self.origin_city
+          }
+        end
+      end
+    CODE
+  }
+  let(:parser)  { Analyst.for_source(code) }
+  let(:klass)   { parser.classes.first }
+  let(:methods) { klass.imethods }
+
+  describe "#pairs" do
+    let(:pairs) { methods.map(&:hashes).flatten.first.pairs }
+
+    it "extracts key/value pairs" do
+      expect(pairs.map(&:class)).to eq(
+        [Analyst::Entities::Pair, Analyst::Entities::Pair]
+      )
+    end
+  end
+
+  describe "#to_hash" do
+    let(:hash_entity) { methods.map(&:hashes).flatten.first }
+    it "returns a hash with appropriate keys" do
+      expect(hash_entity.to_hash.keys).to eq(
+        [:date, :sent_from]
+      )
+    end
+    it "returns a hash with appropriate values" do
+      expect(hash_entity.to_hash.values.map(&:class)).to eq(
+        [Analyst::Entities::MethodCall, Analyst::Entities::MethodCall]
+      )
+    end
+  end
+
+end

data/spec/entities/instance_method_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Analyst::Entities::InstanceMethod do
+
+  let(:code) {<<-CODE
+      class DefaultCarrier
+        def initialize
+          @foo = "bar"
+        end
+      end
+    CODE
+  }
+  let(:parser) { Analyst.for_source(code) }
+  let(:klass)  { parser.classes.first }
+  let(:method) { klass.imethods.first }
+
+  describe "#name" do
+    it "returns its short name" do
+      expect(method.name).to eq("initialize")
+    end
+  end
+
+  describe "#fulL_name" do
+    it "returns its fully qualified name" do
+      expect(method.full_name).to eq("DefaultCarrier#initialize")
+    end
+  end
+
+end

data/spec/entities/method_call_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Analyst::Entities::MethodCall do
+
+  describe "#constants" do
+    let(:code) { "Universe.spawn(Star, into: Galaxy.named('Milky Way'))" }
+    let(:method_call) { Analyst.for_source(code).method_calls.first }
+
+    it "lists constant targets and arguments" do
+      found = method_call.constants.map(&:name)
+      expect(found).to match_array %w[Universe Star Galaxy]
+    end
+  end
+
+  describe "#arguments" do
+    it "lists arguments" do
+      code = "fn(:one, 'two', three)"
+      args = Analyst.for_source(code).method_calls.first.arguments
+
+      expect(args[0].value).to be :one
+      expect(args[1].value).to eq 'two'
+      expect(args[2].class).to eq Analyst::Entities::MethodCall
+      expect(args[2].name).to eq 'three'
+    end
+  end
+end

data/spec/entities/singleton_class_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Analyst::Entities::SingletonClass do
+
+  let(:code) {<<-CODE
+      class FriendlyStaff
+        class << self
+          def greet_customers
+            "Hello customers!"
+          end
+        end
+      end
+    CODE
+  }
+  let(:parser) { Analyst.for_source(code) }
+  let(:klass)  { parser.classes.first }
+  let(:singleton) { klass.singleton_class_blocks.first }
+
+  describe "#name" do
+    it "returns its short name" do
+      expect(singleton.name).to eq("FriendlyStaff!SINGLETON")
+    end
+  end
+
+  describe "#fulL_name" do
+    it "returns its fully qualified name" do
+      expect(singleton.full_name).to eq("FriendlyStaff!SINGLETON")
+    end
+  end
+
+  describe "#smethods" do
+    it "returns its singleton methods" do
+      expect(singleton.smethods.first.name).to eq("greet_customers")
+    end
+  end
+
+end

data/spec/entities/string_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Analyst::Entities::String do
+
+  let(:code) {<<-CODE
+      class DefaultCarrier
+        def initialize
+          "USPS"
+        end
+      end
+    CODE
+  }
+  let(:parser) { Analyst.for_source(code) }
+  let(:klass)  { parser.classes.first }
+  let(:string) { klass.imethods.first.strings.first }
+
+  describe "#value" do
+    it "returns the value of the string" do
+      expect(string.value).to eq("USPS")
+    end
+  end
+
+end

data/spec/fixtures/music.rb

@@ -49,7 +49,6 @@ class Singer < Artist
 end
 
 class Song
-
   def initialize(popularity)
     @popularity = popularity
   end
@@ -58,14 +57,12 @@ end
 module Instruments
 
   class Stringed
-
     def initialize(num_strings)
       @num_strings = num_strings
     end
   end
 
   class Guitar < Stringed
-
     def initialize(sound)
       super(6)
       @sound = sound
@@ -76,11 +73,22 @@ end
 
 module Performances
   module Equipment
+
     class Amp
+      include Interfaces::Basic
+      def self.companion_gear(type)
+        [
+          Performances::Equipment::Microphone.new("mic_1").on,
+          Performances::Equipment::MicStand.new("mic_1_stand")
+        ]
+      end
     end
 
     class Microphone
     end
+
+    class MicStand
+    end
+
   end
 end
-

data/spec/parser_spec.rb

@@ -18,7 +18,9 @@ describe "Parser" do
       all_classes = %w[Artist Singer Song
                        Instruments::Stringed Instruments::Guitar
                        Performances::Equipment::Amp
-                       Performances::Equipment::Microphone]
+                       Performances::Equipment::Microphone
+                       Performances::Equipment::MicStand
+                     ]
 
       class_names = parser.classes.map(&:full_name)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analyst
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Coraline Ada Ehmke
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2014-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -193,6 +193,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: flog
+  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
@@ -235,11 +249,17 @@ files:
 - 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/entities/class_method_spec.rb
+- spec/entities/class_spec.rb
+- spec/entities/constant_assignment_spec.rb
+- spec/entities/constant_spec.rb
+- spec/entities/entity_spec.rb
+- spec/entities/hash_spec.rb
+- spec/entities/instance_method_spec.rb
+- spec/entities/method_call_spec.rb
+- spec/entities/singleton_class_spec.rb
+- spec/entities/string_spec.rb
 - spec/fixtures/music.rb
-- spec/method_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -267,11 +287,17 @@ signing_key:
 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/entities/class_method_spec.rb
+- spec/entities/class_spec.rb
+- spec/entities/constant_assignment_spec.rb
+- spec/entities/constant_spec.rb
+- spec/entities/entity_spec.rb
+- spec/entities/hash_spec.rb
+- spec/entities/instance_method_spec.rb
+- spec/entities/method_call_spec.rb
+- spec/entities/singleton_class_spec.rb
+- spec/entities/string_spec.rb
 - spec/fixtures/music.rb
-- spec/method_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/spec/method_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-
-describe Analyst::Entities::InstanceMethod do
-
-  it "has specs" do
-    expect(false).to be_truthy
-  end
-
-end