appmap 0.31.0

data/spec/fixtures/rails_users_app/config/environments/test.rb

@@ -0,0 +1,36 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => "public, max-age=#{1.hour.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/fixtures/rails_users_app/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# ActiveSupport::Reloader.to_prepare do
+#   ApplicationController.renderer.defaults.merge!(
+#     http_host: 'example.org',
+#     https: false
+#   )
+# end

data/spec/fixtures/rails_users_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/fixtures/rails_users_app/config/initializers/cors.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Avoid CORS issues when API is called from the frontend app.
+# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.
+
+# Read more: https://github.com/cyu/rack-cors
+
+# Rails.application.config.middleware.insert_before 0, Rack::Cors do
+#   allow do
+#     origins 'example.com'
+#
+#     resource '*',
+#       headers: :any,
+#       methods: [:get, :post, :put, :patch, :delete, :options, :head]
+#   end
+# end

data/spec/fixtures/rails_users_app/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/fixtures/rails_users_app/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/fixtures/rails_users_app/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/spec/fixtures/rails_users_app/config/initializers/record_button.rb

@@ -0,0 +1,3 @@
+require 'appmap/middleware/remote_recording'
+Rails.application.config.middleware.insert_after Rails::Rack::Logger, AppMap::Middleware::RemoteRecording \
+  unless Rails.env.test?

data/spec/fixtures/rails_users_app/config/initializers/wrap_parameters.rb

@@ -0,0 +1,9 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end

data/spec/fixtures/rails_users_app/config/locales/en.yml

@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   'true': 'foo'
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/spec/fixtures/rails_users_app/config/routes.rb

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+  namespace :api do
+    resources :users, only: %i[index create]
+  end
+
+  resources :users, only: %i[index]
+
+  get 'health', to: 'health#show'
+
+  root 'users#index'
+end

data/spec/fixtures/rails_users_app/create_app

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+set -e
+
+# Just checking for a healthy container isn't enough, apparently. If
+# we don't wait here, sometimes the database is inaccessible.
+for i in {1..10}; do
+  psql -h pg -U postgres postgres -c 'select 1' >/dev/null 2>&1 && break
+  printf ' .'
+  sleep 1
+done
+echo
+out="$(psql -h pg -U postgres postgres -c 'select 1' 2>&1)"
+if [[ $? != 0 ]]; then
+   echo "Postgres didn't start in time:"
+   echo "$out"
+   exit 1
+fi
+
+psql -h pg -U postgres -c "create database app_development"
+psql -h pg -U postgres -c "create database app_test"
+
+set -e
+
+RAILS_ENV=development ./bin/rake db:migrate
+RAILS_ENV=test ./bin/rake db:migrate
+
+echo "INSERT INTO users ( login ) VALUES ( 'admin' )  " | psql -h pg -U postgres app_development

data/spec/fixtures/rails_users_app/db/migrate/20190728211408_create_users.rb

@@ -0,0 +1,9 @@
+Sequel.migration do
+  change do
+    create_table :users do
+      primary_key :id
+      text :login, null: false, unique: true
+      column :password_digest, :bytea
+    end
+  end
+end

data/spec/fixtures/rails_users_app/db/schema.rb

@@ -0,0 +1,23 @@
+Sequel.migration do
+  change do
+    create_table(:schema_migrations) do
+      column :filename, "text", :null=>false
+      
+      primary_key [:filename]
+    end
+    
+    create_table(:users) do
+      primary_key :id
+      column :login, "text", :null=>false
+      column :password_digest, "bytea"
+      
+      index [:login], :name=>:users_login_key, :unique=>true
+    end
+  end
+end
+Sequel.migration do
+  change do
+    self << "SET search_path TO \"$user\", public"
+    self << "INSERT INTO \"schema_migrations\" (\"filename\") VALUES ('20190728211408_create_users.rb')"
+  end
+end

data/spec/fixtures/rails_users_app/docker-compose.yml

@@ -0,0 +1,28 @@
+version: "3"
+services:
+  pg:
+    build:
+      context: .
+      dockerfile: Dockerfile.pg
+    ports:
+      - "5432"
+    environment:
+      POSTGRES_HOST_AUTH_METHOD: trust
+
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    image: rails-app:${RUBY_VERSION}
+    command:
+      [ "./bin/rails", "server", "-b", "0.0.0.0", "webrick" ]
+    environment:
+      RAILS_ENV:
+      ORM_MODULE:
+      APPMAP:
+    volumes:
+    - .:/src/app
+    ports:
+    - "3000"
+    links:
+    - pg:pg

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/fixtures/rails_users_app/public/robots.txt

@@ -0,0 +1 @@
+# See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

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

@@ -0,0 +1,29 @@
+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, params: { 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, params: {}
+        expect(response.status).to eq(422)
+      end
+    end
+  end
+  describe 'GET /api/users', feature: 'List users' do
+    before do
+      post :create, params: { login: 'alice' }
+    end
+    it 'lists the users' do
+      post :index, params: {}
+      users = JSON.parse(response.body)
+      expect(users.map { |r| r['login'] }).to include('alice')
+    end
+  end
+end

data/spec/fixtures/rails_users_app/spec/models/user_spec.rb

@@ -0,0 +1,39 @@
+require 'rails_helper'
+
+describe User, feature_group: 'User', appmap: true do
+  # TODO: appmap/rspec doesn't handle shared_examples_for 100% correctly yet.
+  # In my tests, only one of these two tests will be emitted as an appmap.
+  shared_examples_for 'creates the user' do |username|
+    let(:login) { username }
+    let(:user) { User.new(login: login) }
+    it "creates #{username.inspect}" do
+      expect(user.save(raise_on_failure: true)).to be_truthy
+    end
+  end
+
+  describe 'creation', feature: 'Create a user' do
+    context 'using shared_examples_for' do
+      # AppMap.
+#      context "with username 'alice'" do
+#        it_should_behave_like 'creates the user', 'alice'
+#      end
+#      context "with username 'bob'" do
+#        it_should_behave_like 'creates the user', 'bob'
+#      end
+    end
+
+    # So, instead of shared_examples_for, let's go with a simple method
+    # containing the assertions. The method can be called from within an example.
+    def save_and_verify
+      expect(user.save(raise_on_failure: true)).to be_truthy
+    end
+
+    context do
+      let(:login) { 'charles' }
+      let(:user) { User.new(login: login) }
+      it "creates 'charles'" do
+        save_and_verify
+      end
+    end
+  end
+end

data/spec/fixtures/rails_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