appmap 0.18.1

data/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "appmap-ruby-lore",
+  "version": "1.0.0",
+  "description": "Lore for the AppMap Rubygem",
+  "scripts": {
+    "start": "./node_modules/applore/bin/lore serve"
+  },
+  "directories": {
+    "example": "examples",
+    "lib": "lib",
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/applandinc/appmap-ruby.git"
+  },
+  "bugs": {
+    "url": "https://github.com/applandinc/appmap-ruby/issues"
+  },
+  "homepage": "https://github.com/applandinc/appmap-ruby#readme",
+  "dependencies": {
+    "applore": "^0.3.0"
+  }
+}

data/spec/abstract_controller4_base_spec.rb

@@ -0,0 +1,58 @@
+require 'rails_spec_helper'
+
+describe 'AbstractControllerBase' do
+  before(:all) { @fixture_dir = 'spec/fixtures/rails4_users_app' }
+  include_examples 'Rails app pg database'
+  
+  around(:each) do |example|
+    FileUtils.rm_rf tmpdir
+    FileUtils.mkdir_p tmpdir
+    cmd = "docker-compose run --rm -e APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
+    system cmd, chdir: @fixture_dir or raise 'Failed to run rails_users_app container'
+
+    example.run
+  end
+
+  let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
+  let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+
+  describe 'testing with rspec' do
+    it 'Message fields are recorded in the appmap' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+
+      expect(appmap).to include(<<-MESSAGE.strip)
+  message:
+    login: alice
+    password: "[FILTERED]"
+      MESSAGE
+
+      expect(appmap).to include(<<-SERVER_REQUEST.strip)
+  http_server_request:
+    request_method: POST
+    path_info: "/api/users?login=alice&password=foobar
+      SERVER_REQUEST
+    end
+    it 'Properly captures method parameters in the appmap' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+
+      expect(appmap).to match(<<-CREATE_CALL.strip)
+  event: call
+  defined_class: Api::UsersController
+  method_id: create_user
+  path: app/controllers/api/users_controller.rb
+  lineno: 23
+  static: false
+  thread_id: .*
+  parameters:
+  - name: params
+    class: Hash
+    object_id: .*
+    value: '{"login"=>"alice"}'
+    kind: req
+  receiver:
+      CREATE_CALL
+    end
+  end
+end

data/spec/abstract_controller_base_spec.rb

@@ -0,0 +1,59 @@
+require 'rails_spec_helper'
+
+describe 'AbstractControllerBase' do
+  before(:all) { @fixture_dir = 'spec/fixtures/rails_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 APPMAP=true -v #{File.absolute_path tmpdir}:/app/tmp app ./bin/rspec spec/controllers/users_controller_api_spec.rb:8"
+    system cmd, chdir: @fixture_dir or raise 'Failed to run rails_users_app container'
+
+    example.run
+  end
+
+  let(:tmpdir) { 'tmp/spec/AbstractControllerBase' }
+  let(:appmap_json) { File.join(tmpdir, 'appmap/rspec/Api_UsersController_POST_api_users_with_required_parameters_creates_a_user.appmap.json') }
+
+  describe 'testing with rspec' do
+    it 'Message fields are recorded in the appmap' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+
+      expect(appmap).to include(<<-MESSAGE.strip)
+  message:
+    login: alice
+    password: "[FILTERED]"
+      MESSAGE
+
+      expect(appmap).to include(<<-SERVER_REQUEST.strip)
+  http_server_request:
+    request_method: POST
+    path_info: "/api/users"
+      SERVER_REQUEST
+    end
+
+    it 'Properly captures method parameters in the appmap' do
+      expect(File).to exist(appmap_json)
+      appmap = JSON.parse(File.read(appmap_json)).to_yaml
+
+      expect(appmap).to match(<<-CREATE_CALL.strip)
+  event: call
+  defined_class: Api::UsersController
+  method_id: create_user
+  path: app/controllers/api/users_controller.rb
+  lineno: 23
+  static: false
+  thread_id: .*
+  parameters:
+  - name: params
+    class: ActiveSupport::HashWithIndifferentAccess
+    object_id: .*
+    value: '{"login"=>"alice"}'
+    kind: req
+  receiver:
+      CREATE_CALL
+    end
+  end
+end

data/spec/fixtures/rack_users_app/.dockerignore

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

data/spec/fixtures/rack_users_app/.gitignore

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

data/spec/fixtures/rack_users_app/Dockerfile

@@ -0,0 +1,32 @@
+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 mkdir /app
+WORKDIR /app
+
+RUN gem install -N bundler
+
+COPY Gemfile .
+
+RUN bundle
+RUN bundle binstubs rack
+
+COPY . .
+
+COPY --from=appmap /pkg/appmap.gem /tmp/
+RUN gem install /tmp/appmap.gem && \
+    bundle update --local appmap && \
+    bundle binstubs appmap --force
+
+EXPOSE 9292
+
+ENV GLI_DEBUG=true
+
+ENTRYPOINT [ "./bin/appmap", "record", "-o", "tmp/appmap.json" ]
+
+HEALTHCHECK --interval=1s --retries=10 CMD curl --fail http://localhost:9292/health || exit 1

data/spec/fixtures/rack_users_app/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'rack'
+gem 'rack-app'
+gem 'rspec'
+gem 'pry-byebug'
+
+appmap_gem_opts = {}
+appmap_gem_opts[:path] = '../../..' if File.exist?('../../../appmap.gemspec')
+gem 'appmap', appmap_gem_opts

data/spec/fixtures/rack_users_app/appmap.yml

@@ -0,0 +1,3 @@
+name: rack_users_app
+packages:
+  - path: lib

data/spec/fixtures/rack_users_app/config.ru

@@ -0,0 +1,2 @@
+require './lib/app.rb'
+run App

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

@@ -0,0 +1,9 @@
+version: "3"
+services:
+  app:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    image: rack-users-app:${RUBY_VERSION}
+    ports:
+      - "9292"

data/spec/fixtures/rack_users_app/lib/app.rb

@@ -0,0 +1,36 @@
+require 'rack/app'
+require 'json'
+
+class App < Rack::App
+  USERS = Hash.new
+
+  class CodedError < StandardError
+    attr_reader :code
+
+    def initialize(code)
+      @code = code
+    end
+  end
+
+  get '/health' do
+    response.status = 204
+  end
+
+  post '/users' do
+    params = JSON.parse(request.body.read)
+    user_id = params['login']
+    password = params['password']
+    halt 422 unless user_id && password
+    USERS[user_id] = params
+    response.headers['location'] = "/users/#{user_id}"
+    response.status = 201
+  end
+
+  def halt(code)
+    raise CodedError, code
+  end
+
+  error CodedError do |ex|
+    response.status = ex.code
+  end
+end

data/spec/fixtures/rails4_users_app/.gitignore

@@ -0,0 +1,13 @@
+# 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/*
+!/log/.keep
+/tmp

data/spec/fixtures/rails4_users_app/.rbenv-gemsets

@@ -0,0 +1,2 @@
+rails4_users_app
+

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

@@ -0,0 +1 @@
+2.5.1

data/spec/fixtures/rails4_users_app/Dockerfile

@@ -0,0 +1,30 @@
+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 -v '~> 1.17' -N bundler
+ 
+COPY Gemfile .
+
+RUN bundle
+RUN bundle binstubs --force \
+    bundler rake rspec-core
+
+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/rails4_users_app/Dockerfile.pg

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

data/spec/fixtures/rails4_users_app/Gemfile

@@ -0,0 +1,77 @@
+source 'https://rubygems.org'
+git_source(:github) { |name| "https://github.com/#{name}.git" }
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.2.11'
+gem 'haml-rails'
+
+# Use postgresql as the database for Active Record
+gem 'pg', '~> 0.15'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+# gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .coffee assets and views
+# gem 'coffee-rails', '~> 4.1.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+# gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0', group: :doc
+
+# Use ActiveModel has_secure_password
+gem 'bcrypt', '~> 3.1.7'
+
+# Use Unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+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'
+  gem 'database_cleaner'
+  
+  gem 'pry-byebug'
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> in views
+  gem 'web-console', '~> 2.0'
+
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+end
+

data/spec/fixtures/rails4_users_app/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/fixtures/rails4_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 File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/fixtures/rails4_users_app/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/spec/fixtures/rails4_users_app/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,27 @@
+module Api
+  class UsersController < ApplicationController
+    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/rails4_users_app/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

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

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

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

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

data/spec/fixtures/rails4_users_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/fixtures/rails4_users_app/app/models/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/rails4_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/rails4_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/rails4_users_app/appmap.yml

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

data/spec/fixtures/rails4_users_app/bin/rails

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path('../spring', __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/fixtures/rails4_users_app/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/fixtures/rails4_users_app/bin/spring

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# This file loads Spring without using Bundler, in order to be fast.
+# It gets overwritten when you run the `spring binstub` command.
+
+unless defined?(Spring)
+  require 'rubygems'
+  require 'bundler'
+
+  lockfile = Bundler::LockfileParser.new(Bundler.default_lockfile.read)
+  spring = lockfile.specs.detect { |spec| spec.name == 'spring' }
+  if spring
+    Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
+    gem 'spring', spring.version
+    require 'spring/binstub'
+  end
+end

data/spec/fixtures/rails4_users_app/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Users
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end

data/spec/fixtures/rails4_users_app/config/boot.rb

@@ -0,0 +1,3 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.