appmap 0.37.0 → 0.37.2

data/spec/fixtures/rails6_users_app/spec/rails_helper.rb

@@ -0,0 +1,66 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'spec_helper'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+require 'appmap/rspec'
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+
+
+  DatabaseCleaner.allow_remote_database_url = true
+  
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around :each do |example|
+    # Enable the use of 'return' from a guard
+    -> {
+      return example.run unless %i[model controller].member?(example.metadata[:type])
+
+      DatabaseCleaner.cleaning do
+        example.run
+      end
+    }.call
+  end
+end

data/spec/fixtures/rails6_users_app/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/fixtures/rails6_users_app/users_app/.gitignore

@@ -0,0 +1,20 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/spec/hook_spec.rb

@@ -181,8 +181,8 @@ describe 'AppMap class Hooking', docker: false do
       :static: false
       :parameters:
       - :name: :kw
-        :class: Hash
-        :value: '{:kw=>"kw"}'
+        :class: String
+        :value: kw
         :kind: :key
       :receiver:
         :class: InstanceMethod
@@ -229,6 +229,48 @@ describe 'AppMap class Hooking', docker: false do
     end
   end
 
+  it 'hooks an instance method that takes keyword arguments' do
+    events_yaml = <<~YAML
+    ---
+    - :id: 1
+      :event: :call
+      :defined_class: InstanceMethod
+      :method_id: say_kws
+      :path: spec/fixtures/hook/instance_method.rb
+      :lineno: 20
+      :static: false
+      :parameters:
+      - :name: :args
+        :class: Array
+        :value: "[4, 5]"
+        :kind: :rest
+      - :name: :kw1
+        :class: String
+        :value: one
+        :kind: :keyreq
+      - :name: :kw2
+        :class: Integer
+        :value: '2'
+        :kind: :key
+      - :name: :kws
+        :class: Hash
+        :value: "{:kw3=>:three}"
+        :kind: :keyrest
+      :receiver:
+        :class: InstanceMethod
+        :value: Instance Method fixture
+    - :id: 2
+      :event: :return
+      :parent_id: 1
+      :return_value:
+        :class: String
+        :value: one2{:kw3=>:three}45
+    YAML
+    test_hook_behavior 'spec/fixtures/hook/instance_method.rb', events_yaml do
+      expect(InstanceMethod.new.say_kws(4, 5, kw1: 'one', kw2: 2, kw3: :three)).to eq('one2{:kw3=>:three}45')
+    end
+  end
+
   it 'hooks an instance method that takes a block argument' do
     events_yaml = <<~YAML
     ---
@@ -237,7 +279,7 @@ describe 'AppMap class Hooking', docker: false do
       :defined_class: InstanceMethod
       :method_id: say_block
       :path: spec/fixtures/hook/instance_method.rb
-      :lineno: 20
+      :lineno: 24
       :static: false
       :parameters:
       - :name: :block
@@ -405,7 +447,7 @@ describe 'AppMap class Hooking', docker: false do
 
       # Verify the native extension works as expected
       expect(AppMap::Hook.singleton_method_owner_name(say_instance_defined)).to eq('SingletonMethod')
-      
+
       expect(s.say_instance_defined).to eq('defined for an instance')
     end
   end
@@ -436,7 +478,7 @@ describe 'AppMap class Hooking', docker: false do
       expect(SingletonMethod::STRUCT_TEST.say_struct_singleton).to eq('singleton for a struct')
     end
   end
-  
+
   it 'Reports exceptions' do
     events_yaml = <<~YAML
     ---
@@ -483,8 +525,8 @@ describe 'AppMap class Hooking', docker: false do
         :static: false
         :parameters:
         - :name: :args
-          :class: Symbol
-          :value: to_s
+          :class: Array
+          :value: "[:to_s]"
           :kind: :rest
         :receiver:
           :class: Class
@@ -531,8 +573,8 @@ describe 'AppMap class Hooking', docker: false do
         :static: false
         :parameters:
         - :name: :args
-          :class: Symbol
-          :value: to_s
+          :class: Array
+          :value: "[:to_s]"
           :kind: :rest
         :receiver:
           :class: Class
@@ -653,8 +695,8 @@ describe 'AppMap class Hooking', docker: false do
         :static: false
         :parameters:
         - :name: arg
-          :class: String
-          :value: string
+          :class: Array
+          :value: '["string"]'
           :kind: :rest
         :receiver:
           :class: Digest::SHA256
@@ -673,8 +715,8 @@ describe 'AppMap class Hooking', docker: false do
         :static: false
         :parameters:
         - :name: arg
-          :class: String
-          :value: string
+          :class: Array
+          :value: '["string"]'
           :kind: :rest
         :receiver:
           :class: Digest::SHA256
@@ -785,7 +827,7 @@ describe 'AppMap class Hooking', docker: false do
       :defined_class: InstanceMethod
       :method_id: say_the_time
       :path: spec/fixtures/hook/instance_method.rb
-      :lineno: 24
+      :lineno: 28
       :static: false
       :parameters: []
       :receiver:

data/spec/rails_spec_helper.rb

@@ -29,10 +29,10 @@ def run_cmd(*cmd, &failed)
   raise 'Command failed'
 end
 
-shared_context 'Rails app pg database' do
-  before(:all) do
-    raise 'you must set @fixure_dir' unless @fixture_dir
+shared_context 'Rails app pg database' do |fixture_dir|
+  let(:fixture_dir) { fixture_dir }
 
+  before(:all) do
     print_pg_logs = lambda do
       logs, = run_cmd 'docker-compose logs pg'
       puts "docker-compose logs for pg:"
@@ -40,7 +40,7 @@ shared_context 'Rails app pg database' do
       puts logs
     end
 
-    Dir.chdir @fixture_dir do 
+    Dir.chdir fixture_dir do 
       run_cmd 'docker-compose down -v'
       cmd = 'docker-compose up -d pg'
       run_cmd cmd
@@ -54,7 +54,7 @@ shared_context 'Rails app pg database' do
   after(:all) do
     if ENV['NOKILL'] != 'true'
       cmd = 'docker-compose down -v'
-      run_cmd cmd, chdir: @fixture_dir
+      run_cmd cmd, chdir: fixture_dir
     end
   end
 end

data/spec/railtie_spec.rb

@@ -1,43 +1,42 @@
 require 'rails_spec_helper'
 
 describe 'AppMap tracer via Railtie' do
-  before(:all) { @fixture_dir = 'spec/fixtures/rails_users_app' }
-  include_context 'Rails app pg database'
-  
-  let(:env) { {} }
+  include_context 'Rails app pg database', 'spec/fixtures/rails5_users_app' do 
+    let(:env) { {} }
 
-  let(:cmd) { %(docker-compose run --rm -e RAILS_ENV -e APPMAP app ./bin/rails r "puts Rails.configuration.appmap.enabled.inspect") }
-  let(:command_capture2) do
-    require 'open3'
-    Open3.capture3(env, cmd, chdir: @fixture_dir).tap do |result|
-      unless result[2] == 0
-        $stderr.puts <<~END
-          Failed to run rails_users_app container
-          <<< Output:
-          #{result[0]}
-          #{result[1]}
-          >>> End of output
-        END
-        raise 'Failed to run rails_users_app container'
+    let(:cmd) { %(docker-compose run --rm -e RAILS_ENV -e APPMAP app ./bin/rails r "puts Rails.configuration.appmap.enabled.inspect") }
+    let(:command_capture2) do
+      require 'open3'
+      Open3.capture3(env, cmd, chdir: fixture_dir).tap do |result|
+        unless result[2] == 0
+          warn <<~STDERR
+            Failed to run rails5_users_app container
+            <<< Output:
+            #{result[0]}
+            #{result[1]}
+            >>> End of output
+          STDERR
+          raise 'Failed to run rails5_users_app container'
+        end
       end
     end
-  end
-  let(:command_output) { command_capture2[0].strip }
-  let(:command_result) { command_capture2[2] }
-
-  it 'is disabled by default' do
-    expect(command_output).to eq('nil')
-  end
+    let(:command_output) { command_capture2[0].strip }
+    let(:command_result) { command_capture2[2] }
 
-  describe 'with APPMAP=true' do
-    let(:env) { { 'APPMAP' => 'true' } }
-    it 'is enabled' do
-      expect(command_output.split("\n")).to include('true')
+    it 'is disabled by default' do
+      expect(command_output).to eq('nil')
     end
-    context 'and RAILS_ENV=test' do
-      let(:env) { { 'APPMAP' => 'true', 'RAILS_ENV' => 'test' } }
-      it 'is disabled' do
-        expect(command_output).to eq('nil')
+
+    describe 'with APPMAP=true' do
+      let(:env) { { 'APPMAP' => 'true' } }
+      it 'is enabled' do
+        expect(command_output.split("\n")).to include('true')
+      end
+      context 'and RAILS_ENV=test' do
+        let(:env) { { 'APPMAP' => 'true', 'RAILS_ENV' => 'test' } }
+        it 'is disabled' do
+          expect(command_output).to eq('nil')
+        end
       end
     end
   end

data/spec/record_sql_rails4_pg_spec.rb

@@ -1,75 +1,74 @@
 require 'rails_spec_helper'
 
 describe 'Record SQL queries in a Rails4 app' do
-  before(:all) { @fixture_dir = 'spec/fixtures/rails4_users_app' }
-  include_context 'Rails app pg database'
-  
-  around(:each) do |example|
-    FileUtils.rm_rf tmpdir
-    FileUtils.mkdir_p tmpdir
-    cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
-    run_cmd cmd, chdir: @fixture_dir
+  include_context 'Rails app pg database', 'spec/fixtures/rails4_users_app' do
+    around(:each) do |example|
+      FileUtils.rm_rf tmpdir
+      FileUtils.mkdir_p tmpdir
+      cmd = "docker-compose run --rm -e ORM_MODULE=#{orm_module} -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:#{test_line_number}"
+      run_cmd cmd, chdir: fixture_dir
 
-    example.run
-  end
+      example.run
+    end
+
+    let(:tmpdir) { "tmp/spec/record_sql_rails_pg_spec" }
+    let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
 
-  let(:tmpdir) { "tmp/spec/record_sql_rails_pg_spec" }
-  let(:appmap) { JSON.parse(File.read(appmap_json)).to_yaml }
+    context 'when running specs' do
+      let(:test_line_number) { 31 }
+      let(:orm_module) { 'activerecord' }
 
-  context 'when running specs' do
-    let(:test_line_number) { 31 }
-    let(:orm_module) { 'activerecord' }
+      it { is_expected.to be }
+    end
 
-    it { is_expected.to be }
-  end
-  
-  context 'while creating a new record' do
-    let(:test_line_number) { 8 }
-    let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+    context 'while creating a new record' do
+      let(:test_line_number) { 8 }
+      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
 
-    xcontext 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql INSERT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      xcontext 'using Sequel ORM' do
+        let(:orm_module) { 'sequel' }
+        it 'detects the sql INSERT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: INSERT INTO "users" ("login") VALUES ('alice') RETURNING *
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
-    end
-    context 'using ActiveRecord ORM' do
-      let(:orm_module) { 'activerecord' }
-      it 'detects the sql INSERT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using ActiveRecord ORM' do
+        let(:orm_module) { 'activerecord' }
+        it 'detects the sql INSERT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: INSERT INTO "users" ("login", "created_at", "updated_at") VALUES ($1, $2,
       $3) RETURNING "id"
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
     end
-  end
 
-  context 'while listing records' do
-    let(:test_line_number) { 23 }
-    let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_GET_api_users_lists_the_users.appmap.json') }
+    context 'while listing records' do
+      let(:test_line_number) { 23 }
+      let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_GET_api_users_lists_the_users.appmap.json') }
 
-    xcontext 'using Sequel ORM' do
-      let(:orm_module) { 'sequel' }
-      it 'detects the sql SELECT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      xcontext 'using Sequel ORM' do
+        let(:orm_module) { 'sequel' }
+        it 'detects the sql SELECT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: SELECT * FROM "users"
-        SQL_QUERY
+          SQL_QUERY
 
-        expect(appmap).to include('sql:')
+          expect(appmap).to include('sql:')
+        end
       end
-    end
-    context 'using ActiveRecord ORM' do
-      let(:orm_module) { 'activerecord' }
-      it 'detects the sql SELECT' do
-        expect(appmap).to include(<<-SQL_QUERY.strip)
+      context 'using ActiveRecord ORM' do
+        let(:orm_module) { 'activerecord' }
+        it 'detects the sql SELECT' do
+          expect(appmap).to include(<<-SQL_QUERY.strip)
   sql_query:
     sql: SELECT "users".* FROM "users"
-        SQL_QUERY
+          SQL_QUERY
+        end
       end
     end
   end