appmap 0.18.1

data/spec/fixtures/rails4_users_app/spec/controllers/users_controller_api_spec.rb

@@ -0,0 +1,49 @@
+require 'rails_helper'
+require 'rack/test'
+
+RSpec.describe Api::UsersController, feature_group: 'Users', type: :controller, appmap: true do
+
+  describe 'POST /api/users', feature: 'Create a user' do
+    describe 'with required parameters' do
+      it 'creates a user' do
+        post :create, { login: 'alice', password: 'foobar' }
+        expect(response.status).to eq(201)
+      end
+    end
+    describe 'with a missing parameter' do
+      it 'reports error 422' do
+        post :create, {}
+        expect(response.status).to eq(422)
+      end
+    end
+  end
+  describe 'GET /api/users', feature: 'List users' do
+    before do
+      post :create, { login: 'alice', password: 'secret' }
+    end
+    it 'lists the users' do
+      post :index, {}
+      users = JSON.parse(response.body)
+      expect(users.map { |r| r['login'] }).to include('alice')
+    end
+  end
+
+  context 'when parameterizing a string' do
+    context 'using the inflector' do
+      it 'uses the default separator' do
+        expect(ActiveSupport::Inflector.parameterize('foo bar baz')).to eq('foo-bar-baz')
+      end
+      it 'uses a specified separator' do
+        expect(ActiveSupport::Inflector.parameterize('foo bar baz', '+')).to eq('foo+bar+baz')
+      end
+    end
+    context 'with #parameterize' do
+      it 'uses the default separator' do
+        expect('foo bar baz'.parameterize).to eq('foo-bar-baz')
+      end
+      it 'uses a specified separator' do
+        expect('foo bar baz'.parameterize('+')).to eq('foo+bar+baz')
+      end
+    end
+  end
+end

data/spec/fixtures/rails4_users_app/spec/rails_helper.rb

@@ -0,0 +1,95 @@
+STDERR.puts "rails4_users_app rails_helper"
+# 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', __dir__)
+
+# 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!
+
+# The issue this hack works around is discussed here
+# https://github.com/rails/rails/issues/34790, with the comment that
+# it won't be fixed here:
+# https://github.com/rails/rails/issues/34790#issuecomment-450036849
+if RUBY_VERSION >= '2.6.0'
+  class ActionController::TestResponse < ActionDispatch::TestResponse
+    def recycle!
+      # hack to avoid MonitorMixin double-initialize error:
+      @mon_mutex_owner_object_id = nil
+      @mon_mutex = nil
+      initialize
+    end
+  end
+end
+
+
+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 }
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # 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")
+
+  
+  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/rails4_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/rails4_users_app/test/fixtures/users.yml

@@ -0,0 +1,9 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+one:
+  login: MyString
+  password: MyString
+
+two:
+  login: MyString
+  password: MyString

data/spec/fixtures/rails_users_app/.dockerignore

@@ -0,0 +1 @@
+Gemfile.lock

data/spec/fixtures/rails_users_app/.gitignore

@@ -0,0 +1,39 @@
+# 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
+vendor
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+
+/node_modules
+/yarn-error.log
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+# Other
+.DS_Store
+.appmap
+appmap.json
+appmap-recording-*.json
+capybara-*.html
+
+# appmap gem is pre-installed, don't lock to a version
+Gemfile.lock
+

data/spec/fixtures/rails_users_app/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/spec/fixtures/rails_users_app/.ruby-version

@@ -0,0 +1 @@
+2.5.5

data/spec/fixtures/rails_users_app/Dockerfile

@@ -0,0 +1,29 @@
+ARG GEM_VERSION
+ARG RUBY_VERSION
+
+FROM appmap:${GEM_VERSION} as appmap
+
+FROM ruby:${RUBY_VERSION}
+RUN apt-get update && apt-get install -y vim less
+RUN apt-get install -y postgresql-client
+
+RUN mkdir /app
+WORKDIR /app
+
+RUN gem install -N bundler
+
+COPY Gemfile .
+
+RUN bundle
+RUN bundle binstubs bundler rspec-core --force
+
+COPY . .
+
+COPY --from=appmap /pkg/appmap.gem /tmp/
+RUN gem install /tmp/appmap.gem && \
+    bundle update --local appmap && \
+    bundle binstubs appmap --force
+
+EXPOSE 3000
+
+HEALTHCHECK --interval=1s --retries=10 CMD curl --fail http://localhost:3000/health || exit 1

data/spec/fixtures/rails_users_app/Dockerfile.pg

@@ -0,0 +1,3 @@
+FROM postgres:10
+
+HEALTHCHECK --interval=1s --retries=10 CMD psql -U postgres -c "select 1" || exit 1

data/spec/fixtures/rails_users_app/Gemfile

@@ -0,0 +1,51 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 5.2.3'
+
+gem 'haml-rails'
+
+gem 'activerecord', require: false
+gem 'pg'
+gem 'sequel', '= 5.20.0', require: false
+gem 'sequel-rails', require: false
+gem 'sequel_secure_password', require: false
+
+appmap_path = \
+  # Support debugging inside the container with volume-mounted source
+  if File.directory?('/src/appmap-ruby')
+    '/src/appmap-ruby'
+  elsif File.exist?('../../../appmap.gemspec')
+    '../../..'
+  end
+
+if appmap_path
+  # Set the branch parameter, so that 'bundle config local.appmap' will work
+  appmap_branch = Dir.chdir appmap_path do
+    `git rev-parse --abbrev-ref HEAD`.strip
+  end
+end
+
+appmap_options = \
+  if appmap_path && appmap_branch
+    { git: appmap_path, branch: appmap_branch }
+  elsif appmap_path
+    { path: appmap_path }
+  else
+    {}
+  end.merge(require: %w[appmap appmap/railtie])
+
+gem 'appmap', appmap_options
+
+group :development, :test do
+  gem 'rspec-rails'
+  # Required for Sequel, since without ActiveRecord, the Rails transactional fixture support
+  # isn't activated.
+  gem 'database_cleaner'
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'pry-byebug'
+end
+
+group :development do
+end

data/spec/fixtures/rails_users_app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/fixtures/rails_users_app/app/controllers/api/users_controller.rb

@@ -0,0 +1,27 @@
+module Api
+  class UsersController < ActionController::API
+    def index
+      @users = User.all
+      render json: @users
+    end
+
+    def create
+      @user = create_user(params.slice(:login).to_unsafe_h)
+      unless @user.valid?
+        error = {
+          code: 'invalid',
+          target: 'User',
+          message: @user.errors.full_messages.join(', '),
+          details: @user.errors.map { |k, v| { code: 'invalid', target: k, message: Array(v).join(', ') } }
+        }
+        return render json: error, status: :unprocessable_entity
+      end
+      @user.save
+      render json: @user, status: :created
+    end
+
+    def create_user(params)
+      User.new(params)
+    end
+  end
+end

data/spec/fixtures/rails_users_app/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/fixtures/rails_users_app/app/controllers/health_controller.rb

@@ -0,0 +1,5 @@
+class HealthController < ActionController::API
+  def show
+    render nothing: true, status: 204
+  end
+end

data/spec/fixtures/rails_users_app/app/controllers/users_controller.rb

@@ -0,0 +1,5 @@
+class UsersController < ApplicationController
+  def index
+    @users = User.all
+  end
+end

data/spec/fixtures/rails_users_app/app/models/activerecord/user.rb

@@ -0,0 +1,18 @@
+class User < ActiveRecord::Base
+  has_secure_password validations: false
+  validates_presence_of :login
+  validates_confirmation_of :password, if: -> { password_provided? }
+
+  def authenticate(unencrypted)
+    # Just be extra sure that empty passwords aren't accepted
+    return false if unencrypted.blank? || password.blank?
+
+    super
+  end
+
+  protected
+
+  def password_provided?
+    !(password.blank? && password_confirmation.blank?)
+  end
+end

data/spec/fixtures/rails_users_app/app/models/sequel/user.rb

@@ -0,0 +1,25 @@
+class User < Sequel::Model(:users)
+  plugin :secure_password, cost: 12, include_validations: false
+  plugin :validation_helpers
+
+  def authenticate(unencrypted)
+    # Just be extra sure that empty passwords aren't accepted
+    return false if unencrypted.blank? || password.blank?
+
+    super
+  end
+
+  def validate
+    super
+
+    errors.add :password, 'doesn\'t match confirmation' if password_provided? && password != password_confirmation
+
+    validates_presence %i[login]
+  end
+
+  protected
+
+  def password_provided?
+    !(password.blank? && password_confirmation.blank?)
+  end
+end

data/spec/fixtures/rails_users_app/app/views/layouts/application.html.haml

@@ -0,0 +1,7 @@
+!!!
+%html
+  %head
+    %meta{:content => "text/html; charset=UTF-8", "http-equiv" => "Content-Type"}/
+    %title Rails Users App
+  %body
+    = yield

data/spec/fixtures/rails_users_app/app/views/users/index.html.haml

@@ -0,0 +1,7 @@
+%h1{style: 'margin-top: 2em'}
+  = pluralize @users.size, 'user'
+
+%ul
+  - for user in @users
+    %li
+      = user.login

data/spec/fixtures/rails_users_app/appmap.yml

@@ -0,0 +1,3 @@
+name: rails_users_app
+packages:
+  - path: app

data/spec/fixtures/rails_users_app/bin/_appmap-record-self

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_appmap-record-self' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("appmap", "_appmap-record-self")

data/spec/fixtures/rails_users_app/bin/appmap

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'appmap' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("appmap", "appmap")

data/spec/fixtures/rails_users_app/bin/byebug

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'byebug' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("byebug", "byebug")

data/spec/fixtures/rails_users_app/bin/gli

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'gli' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("gli", "gli")

data/spec/fixtures/rails_users_app/bin/htmldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")