appmap 0.25.2 → 0.28.1

data/lib/appmap/rspec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'appmap/util'
+
 module AppMap
   # Integration of AppMap with RSpec. When enabled with APPMAP=true, the AppMap tracer will
   # be activated around each scenario which has the metadata key `:appmap`.
@@ -8,10 +10,7 @@ module AppMap
     LOG = false
 
     def self.metadata
-      require 'appmap/command/record'
-      @metadata ||= AppMap::Command::Record.detect_metadata
-      @metadata.freeze
-      @metadata.dup
+      AppMap.detect_metadata
     end
 
     module FeatureAnnotations
@@ -107,7 +106,17 @@ module AppMap
 
       def parent
         # An example group always has a parent; but it might be 'self'...
-        example_group.parent != example_group ? ScopeExampleGroup.new(example_group.parent) : nil
+
+        # DEPRECATION WARNING: `Module#parent` has been renamed to `module_parent`. `parent` is deprecated and will be
+        # removed in Rails 6.1. (called from parent at /Users/kgilpin/source/appland/appmap-ruby/lib/appmap/rspec.rb:110)
+        example_group_parent = \
+          if example_group.respond_to?(:module_parent)
+            example_group.module_parent
+          else
+            example_group.parent
+          end
+
+        example_group_parent != example_group ? ScopeExampleGroup.new(example_group_parent) : nil
       end
     end
 
@@ -129,7 +138,7 @@ module AppMap
 
         AppMap::RSpec.add_event_methods @trace.event_methods
 
-        class_map = AppMap.class_map(AppMap::RSpec.config, @trace.event_methods)
+        class_map = AppMap.class_map(@trace.event_methods)
 
         description = []
         scope = ScopeExample.new(example)
@@ -180,7 +189,6 @@ module AppMap
     end
 
     @recordings_by_example = {}
-    @config = nil
     @event_methods = Set.new
 
     class << self
@@ -188,10 +196,6 @@ module AppMap
         warn 'Configuring AppMap recorder for RSpec'
 
         FileUtils.mkdir_p APPMAP_OUTPUT_DIR
-
-        require 'appmap/hook'
-        @config = AppMap.configure
-        AppMap::Hook.hook(@config)
       end
 
       def begin_spec(example)
@@ -214,9 +218,9 @@ module AppMap
       end
 
       def save(example_name, class_map, events: nil, feature_name: nil, feature_group_name: nil, labels: nil)
-        metadata = RSpec.metadata.dup.tap do |m|
+        metadata = RSpec.metadata.tap do |m|
           m[:name] = example_name
-          m[:app] = @config.name
+          m[:app] = AppMap.configuration.name
           m[:feature] = feature_name if feature_name
           m[:feature_group] = feature_group_name if feature_group_name
           m[:labels] = labels if labels
@@ -236,13 +240,13 @@ module AppMap
           classMap: class_map,
           events: events
         }.compact
-        fname = sanitize_filename(example_name)
+        fname = AppMap::Util.scenario_filename(example_name)
 
-        File.write(File.join(APPMAP_OUTPUT_DIR, "#{fname}.appmap.json"), JSON.generate(appmap))
+        File.write(File.join(APPMAP_OUTPUT_DIR, fname), JSON.generate(appmap))
       end
 
       def print_inventory
-        class_map = AppMap.class_map(@config, @event_methods)
+        class_map = AppMap.class_map(@event_methods)
         save 'Inventory', class_map, labels: %w[inventory]
       end
 
@@ -256,28 +260,6 @@ module AppMap
           print_inventory
         end
       end
-
-      private
-
-      # Cribbed from v5 version of ActiveSupport:Inflector#parameterize:
-      # https://github.com/rails/rails/blob/v5.2.4/activesupport/lib/active_support/inflector/transliterate.rb#L92
-      def sanitize_filename(fname, separator: '_')
-        # Replace accented chars with their ASCII equivalents.
-        fname = fname.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
-
-        # Turn unwanted chars into the separator.
-        fname.gsub!(/[^a-z0-9\-_]+/i, separator)
-
-        re_sep = Regexp.escape(separator)
-        re_duplicate_separator        = /#{re_sep}{2,}/
-        re_leading_trailing_separator = /^#{re_sep}|#{re_sep}$/i
-
-        # No more than one of the separator in a row.
-        fname.gsub!(re_duplicate_separator, separator)
-
-        # Finally, Remove leading/trailing separator.
-        fname.gsub(re_leading_trailing_separator, '')
-      end
     end
   end
 end

data/lib/appmap/trace.rb

@@ -2,38 +2,38 @@
 
 module AppMap
   module Trace
-    ScopedMethod = Struct.new(:defined_class, :method)
+    ScopedMethod = Struct.new(:defined_class, :method, :static)
 
-    class Tracers
+    class Tracing
       def initialize
-        @tracers = []
+        @Tracing = []
       end
 
       def empty?
-        @tracers.empty?
+        @Tracing.empty?
       end
 
       def trace(enable: true)
         Tracer.new.tap do |tracer|
-          @tracers << tracer
+          @Tracing << tracer
           tracer.enable if enable
         end
-      end 
+      end
 
       def enabled?
-        @tracers.any?(&:enabled?)
+        @Tracing.any?(&:enabled?)
       end
 
       def record_event(event, defined_class: nil, method: nil)
-        @tracers.each do |tracer|
+        @Tracing.each do |tracer|
           tracer.record_event(event, defined_class: defined_class, method: method)
         end
       end
 
       def delete(tracer)
-        return unless @tracers.member?(tracer)
+        return unless @Tracing.member?(tracer)
 
-        @tracers.delete(tracer)
+        @Tracing.delete(tracer)
         tracer.disable
       end
     end
@@ -67,7 +67,7 @@ module AppMap
       return unless @enabled
 
       @events << event
-      @methods << Trace::ScopedMethod.new(defined_class, method) if defined_class && method
+      @methods << Trace::ScopedMethod.new(defined_class, method, event.static) if (defined_class && method && event.event == :call)
     end
 
     # Gets a unique list of the methods that were invoked by the program.

data/lib/appmap/util.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module AppMap
+  module Util
+    class << self
+      # scenario_filename builds a suitable file name from a scenario name.
+      # Special characters are removed, and the file name is truncated to fit within
+      # shell limitations.
+      def scenario_filename(name, max_length: 255, separator: '_', extension: '.appmap.json')
+        # Cribbed from v5 version of ActiveSupport:Inflector#parameterize:
+        # https://github.com/rails/rails/blob/v5.2.4/activesupport/lib/active_support/inflector/transliterate.rb#L92
+        # Replace accented chars with their ASCII equivalents.
+
+        fname = name.encode('utf-8', invalid: :replace, undef: :replace, replace: '_')
+
+        # Turn unwanted chars into the separator.
+        fname.gsub!(/[^a-z0-9\-_]+/i, separator)
+
+        re_sep = Regexp.escape(separator)
+        re_duplicate_separator        = /#{re_sep}{2,}/
+        re_leading_trailing_separator = /^#{re_sep}|#{re_sep}$/i
+
+        # No more than one of the separator in a row.
+        fname.gsub!(re_duplicate_separator, separator)
+
+        # Finally, Remove leading/trailing separator.
+        fname.gsub!(re_leading_trailing_separator, '')
+
+        if (fname.length + extension.length) > max_length
+          require 'base64'
+          require 'digest'
+          fname_digest = Base64.urlsafe_encode64 Digest::MD5.digest(fname), padding: false
+          fname[max_length - fname_digest.length - extension.length - 1..-1] = [ '-', fname_digest ].join
+        end
+
+        [ fname, extension ].join
+      end
+    end
+  end
+end

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.25.2'
+  VERSION = '0.28.1'
 
   APPMAP_FORMAT_VERSION = '1.2'
 end

data/package-lock.json

@@ -551,9 +551,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A=="
+      "version": "4.17.19",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.19.tgz",
+      "integrity": "sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ=="
     },
     "longest": {
       "version": "1.0.1",

data/spec/abstract_controller4_base_spec.rb

@@ -52,8 +52,8 @@ describe 'AbstractControllerBase' do
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
-  static: false
   thread_id: .*
+  static: false
   parameters:
   - name: params
     class: Hash

data/spec/abstract_controller_base_spec.rb

@@ -57,8 +57,8 @@ describe 'AbstractControllerBase' do
   method_id: build_user
   path: app/controllers/api/users_controller.rb
   lineno: 23
-  static: false
   thread_id: .*
+  static: false
   parameters:
   - name: params
     class: ActiveSupport::HashWithIndifferentAccess

data/spec/fixtures/hook/singleton_method.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class SingletonMethod
+  class << self
+    def say_default
+      'default'
+    end
+  end
+
+  def SingletonMethod.say_class_defined
+    'defined with explicit class scope'
+  end
+
+  def self.say_self_defined
+    'defined with self class scope'
+  end
+
+  # When called, do_include calls +include+ to bring in the module
+  # AddMethod. AddMethod defines a new instance method, which gets
+  # added to the singleton class of SingletonMethod.
+  def do_include
+    class << self
+      SingletonMethod.include(AddMethod)
+    end
+    self
+  end
+  
+  def self.new_with_instance_method
+    SingletonMethod.new.tap do |m|
+      def m.say_instance_defined
+        'defined for an instance'
+      end
+    end
+  end
+  
+  def to_s
+    'Singleton Method fixture'
+  end
+end
+
+module AddMethod
+  def self.included(base)
+    base.module_eval do
+      define_method "added_method" do
+        _added_method
+      end
+    end
+  end
+  
+  def _added_method
+    'defined by including a module'
+  end
+end
+

data/spec/fixtures/rails_users_app/Gemfile

@@ -39,6 +39,7 @@ appmap_options = \
 gem 'appmap', appmap_options
 
 group :development, :test do
+  gem 'cucumber-rails', require: false
   gem 'rspec-rails'
   # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support
   # isn't activated.

data/spec/fixtures/rails_users_app/features/api_users.feature

@@ -0,0 +1,13 @@
+Feature: /api/users
+
+  @appmap-disable
+  Scenario: A user can be created
+    When I create a user
+    Then the response status should be 201
+
+  Scenario: When a user is created, it should be in the user list
+    Given I create a user
+    And the response status should be 201
+    When I list the users
+    Then the response status should be 200
+    And the response should include the user

data/spec/fixtures/rails_users_app/features/support/env.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'cucumber/rails'
+require 'appmap/cucumber'

data/spec/fixtures/rails_users_app/features/support/hooks.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+if AppMap::Cucumber.enabled?
+  Around('not @appmap-disable') do |scenario, block|
+    appmap = AppMap.record do
+      block.call
+    end
+
+    AppMap::Cucumber.write_scenario(scenario, appmap)
+  end
+end

data/spec/fixtures/rails_users_app/features/support/steps.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+When 'I create a user' do
+  @response = post '/api/users', login: 'alice'
+end
+
+Then(/the response status should be (\d+)/) do |status|
+  expect(@response.status).to eq(status.to_i)
+end
+
+When 'I list the users' do
+  @response = get '/api/users'
+  @users = JSON.parse(@response.body)
+end
+
+Then 'the response should include the user' do
+  expect(@users.map { |u| u['login'] }).to include('alice')
+end

data/spec/hook_spec.rb

@@ -5,6 +5,16 @@ require 'appmap/hook'
 require 'appmap/event'
 require 'diffy'
 
+# Show nulls as the literal +null+, rather than just leaving the field
+# empty. This make some of the expected YAML below easier to
+# understand.
+module ShowYamlNulls
+  def visit_NilClass(o)
+    @emitter.scalar('null', nil, 'tag:yaml.org,2002:null', true, false, Psych::Nodes::Scalar::ANY)
+  end
+end
+Psych::Visitors::YAMLTree.prepend(ShowYamlNulls)
+
 describe 'AppMap class Hooking' do
   def collect_events(tracer)
     [].tap do |events|
@@ -30,24 +40,28 @@ describe 'AppMap class Hooking' do
     end.to_yaml
   end
 
-  def invoke_test_file(file, &block)
+  def invoke_test_file(file, setup: nil, &block)
+    AppMap.configuration = nil
     package = AppMap::Hook::Package.new(file, [])
     config = AppMap::Hook::Config.new('hook_spec', [ package ])
+    AppMap.configuration = config
     AppMap::Hook.hook(config)
+    
+    setup_result = setup.call if setup
 
     tracer = AppMap.tracing.trace
     AppMap::Event.reset_id_counter
     begin
       load file
-      yield
+      yield setup_result
     ensure
       AppMap.tracing.delete(tracer)
     end
     [ config, tracer ]
   end
 
-  def test_hook_behavior(file, events_yaml, &block)
-    config, tracer = invoke_test_file(file, &block)
+  def test_hook_behavior(file, events_yaml, setup: nil, &block)
+    config, tracer = invoke_test_file(file, setup: setup, &block)
 
     events = collect_events(tracer)
     expect(Diffy::Diff.new(events, events_yaml).to_s).to eq('')
@@ -55,6 +69,10 @@ describe 'AppMap class Hooking' do
     [ config, tracer ]
   end
 
+  after do
+    AppMap.configuration = nil
+  end
+
   it 'hooks an instance method that takes no arguments' do
     events_yaml = <<~YAML
     ---
@@ -90,10 +108,10 @@ describe 'AppMap class Hooking' do
   end
 
   it 'builds a class map of invoked methods' do
-    config, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' do
+    _, tracer = invoke_test_file 'spec/fixtures/hook/instance_method.rb' do
       InstanceMethod.new.say_default
     end
-    class_map = AppMap.class_map(config, tracer.event_methods).to_yaml
+    class_map = AppMap.class_map(tracer.event_methods).to_yaml
     expect(Diffy::Diff.new(class_map, <<~YAML).to_s).to eq('')
     ---
     - :name: spec/fixtures/hook/instance_method.rb
@@ -202,7 +220,7 @@ describe 'AppMap class Hooking' do
       :parameters:
       - :name: :kw
         :class: NilClass
-        :value: 
+        :value: null
         :kind: :key
       :receiver:
         :class: InstanceMethod
@@ -232,7 +250,7 @@ describe 'AppMap class Hooking' do
       :parameters:
       - :name: :block
         :class: NilClass
-        :value: 
+        :value: null
         :kind: :block
       :receiver:
         :class: InstanceMethod
@@ -254,15 +272,15 @@ describe 'AppMap class Hooking' do
     ---
     - :id: 1
       :event: :call
-      :defined_class: ClassMethod
+      :defined_class: SingletonMethod
       :method_id: say_default
-      :path: spec/fixtures/hook/class_method.rb
+      :path: spec/fixtures/hook/singleton_method.rb
       :lineno: 5
       :static: true
       :parameters: []
       :receiver:
         :class: Class
-        :value: ClassMethod
+        :value: SingletonMethod
     - :id: 2
       :event: :return
       :parent_id: 1
@@ -270,8 +288,8 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: default
     YAML
-    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
-      expect(ClassMethod.say_default).to eq('default')
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_default).to eq('default')
     end
   end
 
@@ -280,15 +298,15 @@ describe 'AppMap class Hooking' do
     ---
     - :id: 1
       :event: :call
-      :defined_class: ClassMethod
+      :defined_class: SingletonMethod
       :method_id: say_class_defined
-      :path: spec/fixtures/hook/class_method.rb
+      :path: spec/fixtures/hook/singleton_method.rb
       :lineno: 10
       :static: true
       :parameters: []
       :receiver:
         :class: Class
-        :value: ClassMethod
+        :value: SingletonMethod
     - :id: 2
       :event: :return
       :parent_id: 1
@@ -296,8 +314,8 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: defined with explicit class scope
     YAML
-    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
-      expect(ClassMethod.say_class_defined).to eq('defined with explicit class scope')
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_class_defined).to eq('defined with explicit class scope')
     end
   end
 
@@ -306,15 +324,15 @@ describe 'AppMap class Hooking' do
     ---
     - :id: 1
       :event: :call
-      :defined_class: ClassMethod
+      :defined_class: SingletonMethod
       :method_id: say_self_defined
-      :path: spec/fixtures/hook/class_method.rb
+      :path: spec/fixtures/hook/singleton_method.rb
       :lineno: 14
       :static: true
       :parameters: []
       :receiver:
         :class: Class
-        :value: ClassMethod
+        :value: SingletonMethod
     - :id: 2
       :event: :return
       :parent_id: 1
@@ -322,11 +340,77 @@ describe 'AppMap class Hooking' do
         :class: String
         :value: defined with self class scope
     YAML
-    test_hook_behavior 'spec/fixtures/hook/class_method.rb', events_yaml do
-      expect(ClassMethod.say_self_defined).to eq('defined with self class scope')
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml do
+      expect(SingletonMethod.say_self_defined).to eq('defined with self class scope')
+    end
+  end
+
+
+  it 'hooks an included method' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: SingletonMethod
+      :method_id: added_method
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 44
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: SingletonMethod
+        :value: Singleton Method fixture
+    - :id: 2
+      :event: :call
+      :defined_class: AddMethod
+      :method_id: _added_method
+      :path: spec/fixtures/hook/singleton_method.rb
+      :lineno: 50
+      :static: false
+      :parameters: []
+      :receiver:
+        :class: SingletonMethod
+        :value: Singleton Method fixture
+    - :id: 3
+      :event: :return
+      :parent_id: 2
+      :return_value:
+        :class: String
+        :value: defined by including a module
+    - :id: 4
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: defined by including a module
+    YAML
+
+    load 'spec/fixtures/hook/singleton_method.rb'
+    setup = -> { SingletonMethod.new.do_include }
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml, setup: setup do |s|
+      expect(s.added_method).to eq('defined by including a module')
     end
   end
 
+  it "doesn't hook a singleton method defined for an instance" do
+    # Ideally, Ruby would fire a TracePoint event when a singleton
+    # class gets created by defining a method on an instance. It
+    # currently doesn't, though, so there's no way for us to hook such
+    # a method.
+    #
+    # This example will fail if Ruby's behavior changes at some point
+    # in the future.
+    events_yaml = <<~YAML
+    --- []
+    YAML
+    
+    load 'spec/fixtures/hook/singleton_method.rb'
+    setup = -> { SingletonMethod.new_with_instance_method }
+    test_hook_behavior 'spec/fixtures/hook/singleton_method.rb', events_yaml, setup: setup do |s|
+      expect(s.say_instance_defined).to eq('defined for an instance')
+    end
+  end
+  
   it 'Reports exceptions' do
     events_yaml = <<~YAML
     ---