appsignal 2.8.4.beta.1 → 2.9.18.beta.1

data/README.md

@@ -6,6 +6,7 @@ issues.
 
 - [AppSignal.com website][appsignal]
 - [Documentation][docs]
+- [Ruby code documentation][ruby-doc]
 - [Support][contact]
 
 [![Build Status](https://travis-ci.org/appsignal/appsignal-ruby.png?branch=master)](https://travis-ci.org/appsignal/appsignal-ruby)
@@ -172,6 +173,29 @@ bundle exec rake install
 bundle exec rake extension:install
 ```
 
+#### Git source for Bundler
+
+When specifying a git source for the AppSignal gem in Bundler we do not support
+JRuby. This is because our gemspec defaults to the Ruby implementation for
+installing the AppSignal C-extension.
+
+```ruby
+# Gemfile
+gem "appsignal",
+  :git => "https://github.com/appsignal/appsignal-ruby.git",
+  :branch => "master"
+```
+
+When you need to use a git source of the gem in your JRuby install, you'll need
+to run the following to install the C-extension on JRuby. Note that this
+post-install step is not possible on platforms such as Heroku where the app is
+sent through a deploy pipeline and the app is started immediately after.
+
+```bash
+bundle install
+(cd $(bundle show appsignal)/ext && rake)
+```
+
 ### Testing
 
 ```bash
@@ -207,9 +231,9 @@ BUNDLE_GEMFILE=gemfiles/sinatra.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/webmachine.gemfile bundle exec rspec
 ```
 
-If you have either [RVM][rvm] or [rbenv][rbenv] installed you can also use
-`rake generate_bundle_and_spec_all` to generate a script that runs specs for
-all Ruby versions and gem combinations we support.
+If you have either [RVM][rvm], [rbenv][rbenv] or [chruby][chruby] installed you
+can also use `rake build_matrix:local:generate` to generate a script that runs
+specs for all Ruby versions and gem combinations we support.
 
 We run the suite against all of the Gemfiles mentioned above and on
 a number of different Ruby versions.
@@ -244,12 +268,15 @@ we send a package to so far on our [Stroopwafles page][waffles-page].
 AppSignal. They will help you get set up, tweak your code and make sure you get
 the most out of using AppSignal.
 
+Also see our [SUPPORT.md file](SUPPORT.md).
+
 [appsignal]: https://appsignal.com
 [appsignal-sign-up]: https://appsignal.com/users/sign_up
 [contact]: mailto:support@appsignal.com
 [coc]: https://docs.appsignal.com/appsignal/code-of-conduct.html
 [waffles-page]: https://appsignal.com/waffles
 [docs]: http://docs.appsignal.com
+[ruby-doc]: https://www.rubydoc.info/gems/appsignal
 [contributing-guide]: http://docs.appsignal.com/appsignal/contributing.html
 [supported-systems]: http://docs.appsignal.com/support/operating-systems.html
 [integrations]: http://docs.appsignal.com/ruby/integrations/index.html
@@ -263,3 +290,4 @@ the most out of using AppSignal.
 [semver]: http://semver.org/
 [rvm]: http://rvm.io/
 [rbenv]: https://github.com/rbenv/rbenv
+[chruby]: https://github.com/postmodern/chruby/

data/Rakefile

@@ -2,120 +2,157 @@ require "bundler"
 require "rubygems/package_task"
 require "fileutils"
 
-GEMFILES = %w[
-  capistrano2
-  capistrano3
-  grape
-  no_dependencies
-  padrino
-  rails-3.2
-  rails-4.0
-  rails-4.1
-  rails-4.2
-  rails-5.0
-  resque
-  sequel
-  sequel-435
-  sinatra
-  grape
-  webmachine
-  que
-].freeze
-
-RUBY_VERSIONS = %w[
-  2.0.0-p648
-  2.1.8
-  2.2.4
-  2.3.0
-  2.4.0
-].freeze
-
-EXCLUSIONS = {
-  "rails-5.0" => %w[2.0.0 2.1.8]
-}.freeze
-
 VERSION_MANAGERS = {
-  :rbenv => ->(version) { "rbenv local #{version}" },
-  :rvm => ->(version) { "rvm use --default #{version.split("-").first}" }
+  :chruby => {
+    :env => "#!/bin/bash\nsource /usr/local/opt/chruby/share/chruby/chruby.sh",
+    :switch_command => lambda { |version| "chruby #{version}" }
+  },
+  :rbenv => {
+    :env => "#!/bin/bash",
+    :switch_command => lambda { |version| "rbenv local #{version}" }
+  },
+  :rvm => {
+    :env => "#!/bin/bash --login",
+    :switch_command => lambda { |version| "rvm use --default #{version}" }
+  }
 }.freeze
 
-namespace :travis do
-  task :generate do
-    yaml = YAML.load_file("build_matrix.yml")
-    matrix = yaml["matrix"]
-    defaults = matrix["defaults"]
-    gems = matrix["gems"]
+namespace :build_matrix do
+  namespace :travis do
+    task :generate do
+      yaml = YAML.load_file("build_matrix.yml")
+      matrix = yaml["matrix"]
+      defaults = matrix["defaults"]
+
+      builds = []
+      matrix["ruby"].each do |ruby|
+        ruby_version = ruby["ruby"]
+        gemset_for_ruby(ruby, matrix).each do |gem|
+          next if excluded_for_ruby?(gem, ruby)
+
+          env = ""
+          rubygems = gem["rubygems"] || ruby["rubygems"] || defaults["rubygems"]
+          env = "_RUBYGEMS_VERSION=#{rubygems}" if rubygems
+          bundler = gem["bundler"] || ruby["bundler"] || defaults["bundler"]
+          env += " _BUNDLER_VERSION=#{bundler}" if bundler
+
+          builds << {
+            "rvm" => ruby_version,
+            "gemfile" => "gemfiles/#{gem["gem"]}.gemfile",
+            "env" => env
+          }
+        end
+      end
+      travis = yaml["travis"]
+      travis["matrix"]["include"] = travis["matrix"]["include"] + builds
+
+      header = "# DO NOT EDIT\n" \
+        "# This is a generated file by the `rake build_matrix:travis:generate` task.\n" \
+        "# See `build_matrix.yml` for the build matrix.\n" \
+        "# Generate this file with `rake build_matrix:travis:generate`.\n"
+      generated_yaml = header + YAML.dump(travis)
+      File.write(".travis.yml", generated_yaml)
+      puts "Generated `.travis.yml`"
+      puts "Build count: #{builds.length}"
+    end
 
-    builds = []
-    matrix["ruby"].each do |ruby|
-      ruby_version = ruby["ruby"]
-      gemset =
-        if ruby["gems"]
-          # Only a specific gemset for this Ruby
-          selected_gems = matrix["gemsets"].fetch(ruby["gems"])
-          gems.select { |g| selected_gems.include?(g["gem"]) }
-        else
-          # All gems for this Ruby
-          gems
+    task :validate => :generate do
+      `git status | grep .travis.yml 2>&1`
+      if $?.exitstatus.zero? # rubocop:disable Style/SpecialGlobalVars
+        puts "The `.travis.yml` is modified. The changes were not committed."
+        puts "Please run `rake build_matrix:travis:generate` and commit the changes."
+        exit 1
+      end
+    end
+  end
+
+  namespace :local do
+    task :generate do
+      yaml = YAML.load_file("build_matrix.yml")
+      matrix = yaml["matrix"]
+      defaults = matrix["defaults"]
+
+      VERSION_MANAGERS.each do |version_manager, config|
+        out = []
+        out << config[:env]
+        out << "rm -f .ruby-version"
+        out << "echo 'Using #{version_manager}'"
+        matrix["ruby"].each do |ruby|
+          ruby_version = ruby["ruby"]
+          out << "echo 'Switching to #{ruby_version}'"
+          out << "#{config[:switch_command].call(ruby_version)} || { echo 'Switching Ruby failed'; exit 1; }"
+          out << "ruby -v"
+          out << "echo 'Compiling extension'"
+          out << "./support/bundler_wrapper exec rake extension:install"
+          out << "rm -f gemfiles/*.gemfile.lock"
+          gemset_for_ruby(ruby, matrix).each do |gem|
+            next if excluded_for_ruby?(gem, ruby)
+            gemfile = gem["gem"]
+            out << "echo 'Bundling #{gemfile} in #{ruby_version}'"
+            rubygems = gem["rubygems"] || ruby["rubygems"] || defaults["rubygems"]
+            rubygems_version = "env _RUBYGEMS_VERSION=#{rubygems_version}" if rubygems
+            bundler = gem["bundler"] || ruby["bundler"] || defaults["bundler"]
+            bundler_version = "env _BUNDLER_VERSION=#{bundler}" if bundler
+            gemfile_env = "env BUNDLE_GEMFILE=gemfiles/#{gemfile}.gemfile"
+            out << "#{bundler_version} #{rubygems_version} ./support/install_deps"
+            out << "#{bundler_version} #{gemfile_env} ./support/bundler_wrapper install --quiet || { echo 'Bundling failed'; exit 1; }"
+            out << "echo 'Running #{gemfile} in #{ruby_version}'"
+            out << "#{bundler_version} #{gemfile_env} ./support/bundler_wrapper exec rspec || { echo 'Running specs failed'; exit 1; }"
+          end
+          out << ""
+        end
+        out << "rm -f .ruby-version"
+        out << "echo 'Successfully ran specs for all environments'"
+
+        script = "bundle_and_spec_all_#{version_manager}"
+        FileUtils.rm_f(script)
+        File.open(script, "w") do |file|
+          file.write out.join("\n")
         end
-      gemset.each do |gem|
-        # Don't add build if ignored for this combination of Ruby and gem
-        next if (gem.dig("exclude", "ruby") || []).include?(ruby_version)
-
-        env = ""
-        rubygems = gem["rubygems"] || ruby["rubygems"] || defaults["rubygems"]
-        env = "_RUBYGEMS_VERSION=#{rubygems}" if rubygems
-        bundler = gem["bundler"] || ruby["bundler"] || defaults["bundler"]
-        env += " _BUNDLER_VERSION=#{bundler}" if bundler
-
-        builds << {
-          "rvm" => ruby_version,
-          "gemfile" => "gemfiles/#{gem["gem"]}.gemfile",
-          "env" => env
-        }
+        File.chmod(0o775, script)
+        puts "Generated #{script}"
       end
     end
-    travis = yaml["travis"]
-    travis["matrix"]["include"] = travis["matrix"]["include"] + builds
-
-    header = "# DO NOT EDIT\n" \
-      "# This is a generated file by the `rake travis:generate` task.\n" \
-      "# See `build_matrix.yml` for the build matrix.\n" \
-      "# Generate this file with `rake travis:generate`.\n"
-    generated_yaml = header + YAML.dump(travis)
-    File.write(".travis.yml", generated_yaml)
-    puts "Generated `.travis.yml`"
-    puts "Build count: #{builds.length}"
   end
 
-  task :validate => :generate do
-    `git status | grep .travis.yml 2>&1`
-    if $?.exitstatus.zero? # rubocop:disable Style/SpecialGlobalVars
-      puts "The `.travis.yml` is modified. The changes were not committed."
-      puts "Please run `rake travis:generate` and commit the changes."
-      exit 1
+  def gemset_for_ruby(ruby, matrix)
+    gems = matrix["gems"]
+    if ruby["gems"]
+      # Only a specific gemset for this Ruby
+      selected_gems = matrix["gemsets"].fetch(ruby["gems"])
+      gems.select { |g| selected_gems.include?(g["gem"]) }
+    else
+      # All gems for this Ruby
+      gems
     end
   end
+
+  def excluded_for_ruby?(gem, ruby)
+    (gem.dig("exclude", "ruby") || []).include?(ruby["ruby"])
+  end
 end
 
 namespace :build do
+  def base_gemspec
+    eval(File.read("appsignal.gemspec")) # rubocop:disable Security/Eval
+  end
+
   def modify_base_gemspec
-    eval(File.read("appsignal.gemspec")).tap do |s| # rubocop:disable Security/Eval
+    base_gemspec.tap do |s|
       yield s
     end
   end
 
   namespace :ruby do
-    spec = modify_base_gemspec do |s|
-      s.extensions = %w[ext/extconf.rb]
-    end
-
-    Gem::PackageTask.new(spec) { |_pkg| }
+    # Extension default set in `appsignal.gemspec`
+    Gem::PackageTask.new(base_gemspec) { |_pkg| }
   end
 
   namespace :jruby do
     spec = modify_base_gemspec do |s|
       s.platform = "java"
+      # Override extensions config with JRuby extension installer
+      # Default set in `appsignal.gemspec`
       s.extensions = %w[ext/Rakefile]
       s.add_dependency "ffi"
     end
@@ -177,7 +214,7 @@ namespace :publish do
     Dir.chdir("#{File.dirname(__FILE__)}/pkg") do
       Dir["*.gem"].each do |gem_package|
         puts "## Publishing gem package: #{gem_package}"
-        puts `gem push #{gem_package}`
+        system "gem push #{gem_package}"
       end
     end
   end
@@ -231,44 +268,6 @@ task :spec_all_gemfiles do
   end
 end
 
-task :generate_bundle_and_spec_all do
-  VERSION_MANAGERS.each do |version_manager, switch_command|
-    out = []
-    out << if version_manager == :rvm
-             "#!/bin/bash --login"
-           else
-             "#!/bin/sh"
-           end
-    out << "rm -f .ruby-version"
-    out << "echo 'Using #{version_manager}'"
-    RUBY_VERSIONS.each do |version|
-      short_version = version.split("-").first
-      out << "echo 'Switching to #{short_version}'"
-      out << "#{switch_command.call(version)} || { echo 'Switching Ruby failed'; exit 1; }"
-      out << "ruby -v"
-      out << "echo 'Compiling extension'"
-      out << "cd ext && rm -f appsignal-agent appsignal_extension.bundle appsignal.h libappsignal.a Makefile && ruby extconf.rb && make && cd .."
-      GEMFILES.each do |gemfile|
-        next if EXCLUSIONS[gemfile] && EXCLUSIONS[gemfile].include?(short_version)
-        out << "echo 'Bundling #{gemfile} in #{short_version}'"
-        out << "bundle --quiet --gemfile gemfiles/#{gemfile}.gemfile || { echo 'Bundling failed'; exit 1; }"
-        out << "echo 'Running #{gemfile} in #{short_version}'"
-        out << "env BUNDLE_GEMFILE=gemfiles/#{gemfile}.gemfile bundle exec rspec || { echo 'Running specs failed'; exit 1; }"
-      end
-    end
-    out << "rm -f .ruby-version"
-    out << "echo 'Successfully ran specs for all environments'"
-
-    script = "bundle_and_spec_all_#{version_manager}"
-    FileUtils.rm_f(script)
-    File.open(script, "w") do |file|
-      file.write out.join("\n")
-    end
-    File.chmod(0o775, script)
-    puts "Generated #{script}"
-  end
-end
-
 task :console do
   require "irb"
   require "irb/completion"
@@ -300,7 +299,7 @@ namespace :extension do
           appsignal_extension.o \
           appsignal_extension.so \
           appsignal_extension.bundle \
-          install.log \
+          install.report \
           libappsignal.* \
           appsignal.version \
           Makefile \

data/SUPPORT.md

@@ -0,0 +1,16 @@
+# Support
+
+[Contact us][contact] and speak directly with the engineers working on
+AppSignal. They will help you get set up, tweak your code and make sure you get
+the most out of using AppSignal. You can also find our documentation at
+[docs.appsignal.com](https://docs.appsignal.com/).
+
+We do not recommend creating an issue on the Ruby gem's GitHub project if it
+concerns your private app data. During the support process we'll need the
+AppSignal logs and other resources that contain your app's private data,
+something for which the public GitHub issue tracker is not suited.
+
+Please contact us on our website [appsignal.com](https://appsignal.com/) or via
+email at [support@appsignal.com][contact].
+
+[contact]: mailto:support@appsignal.com

data/appsignal.gemspec

@@ -2,10 +2,11 @@
 
 require File.expand_path("../lib/appsignal/version", __FILE__)
 
-Gem::Specification.new do |gem|
+Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.authors = [
     "Robert Beekman",
-    "Thijs Cadier"
+    "Thijs Cadier",
+    "Tom de Bruijn"
   ]
   gem.email                 = ["support@appsignal.com"]
   gem.description           = "The official appsignal.com gem"
@@ -21,14 +22,26 @@ Gem::Specification.new do |gem|
   gem.require_paths         = %w[lib ext]
   gem.version               = Appsignal::VERSION
   gem.required_ruby_version = ">= 1.9"
+  # Default extension installer. Overridden by JRuby gemspec as defined in
+  # `Rakefile`.
+  gem.extensions            = %w[ext/extconf.rb]
+
+  gem.metadata = {
+    "bug_tracker_uri"   => "https://github.com/appsignal/appsignal-ruby/issues",
+    "changelog_uri"     =>
+      "https://github.com/appsignal/appsignal-ruby/blob/master/CHANGELOG.md",
+    "documentation_uri" => "https://docs.appsignal.com/ruby/",
+    "homepage_uri"      => "https://docs.appsignal.com/ruby/",
+    "source_code_uri"   => "https://github.com/appsignal/appsignal-ruby"
+  }
 
   gem.add_dependency "rack"
 
   gem.add_development_dependency "rake", "~> 11"
-  gem.add_development_dependency "rspec", "~> 3.7"
+  gem.add_development_dependency "rspec", "~> 3.8"
   gem.add_development_dependency "pry"
   gem.add_development_dependency "timecop"
   gem.add_development_dependency "webmock"
   gem.add_development_dependency "rubocop", "0.50.0"
-  gem.add_development_dependency "yard"
+  gem.add_development_dependency "yard", ">= 0.9.20"
 end

data/build_matrix.yml

@@ -9,32 +9,33 @@ travis: # Default `.travis.yml` contents
   language: ruby
   cache:
     directories:
-      - vendor/bundle
+      - "$TRAVIS_BUILD_DIR/vendor/cache"
 
   env:
     global:
+      - "BUNDLE_PATH=$TRAVIS_BUILD_DIR/vendor/cache"
       - "RUNNING_IN_CI=true"
       - "RAILS_ENV=test"
       - "JRUBY_OPTS=''" # Workaround https://github.com/travis-ci/travis-ci/issues/6471
 
   before_install:
     - "./support/install_deps"
-  install: "./support/bundler_wrapper install --jobs=3 --retry=3"
+  install: "./support/bundler_wrapper install --jobs=3 --retry=3 --path=${BUNDLE_PATH:-$TRAVIS_BUILD_DIR/vendor/cache}"
   before_script:
     - "./support/bundler_wrapper exec rake extension:install"
   script: "./support/bundler_wrapper exec rake test"
   after_failure:
-    - "find ./ext -name install.log -exec cat {} \\;"
+    - "find ./ext -name install.report -exec cat {} \\;"
     - "find ./ext -name mkmf.log -exec cat {} \\;"
 
   matrix:
     fast_finish: true
     include: # Builds based on the matrix below are added to this list
-      - rvm: "2.6.0"
+      - rvm: "2.6.4"
         gemfile: "gemfiles/no_dependencies.gemfile"
         before_script: "" # Unset default: No need to install the extension
         script:
-          - "./support/bundler_wrapper exec rake travis:validate"
+          - "./support/bundler_wrapper exec rake build_matrix:travis:validate"
           - "./support/bundler_wrapper exec rubocop"
 
 matrix:
@@ -47,7 +48,6 @@ matrix:
       - "no_dependencies"
     minimal:
       - "no_dependencies"
-      - "rails-4.2"
       - "rails-5.2"
 
   ruby:
@@ -65,7 +65,7 @@ matrix:
       gems: "none"
     - ruby: "2.5.3"
       gems: "minimal"
-    - ruby: "2.6.0"
+    - ruby: "2.6.4"
     - ruby: "jruby-19mode"
       gems: "minimal"
   gems:
@@ -76,16 +76,20 @@ matrix:
     - gem: "padrino"
       bundler: "1.17.3"
     - gem: "que"
+    - gem: "que_beta"
+      exclude:
+        ruby:
+          - "2.0.0"
     - gem: "rails-3.2"
       bundler: "1.17.3"
       exclude:
         ruby:
-          - "2.6.0"
+          - "2.6.4"
     - gem: "rails-4.2"
       bundler: "1.17.3"
       exclude:
         ruby:
-          - "2.6.0"
+          - "2.6.4"
     - gem: "rails-5.0"
       exclude:
         ruby:
@@ -98,6 +102,14 @@ matrix:
       exclude:
         ruby:
           - "2.0.0"
+    - gem: "rails-6.0"
+      exclude:
+        ruby:
+          - "2.0.0"
+          - "2.1.8"
+          - "2.2.4"
+          - "2.3.8"
+          - "2.4.5"
     - gem: "resque"
       bundler: "1.17.3"
     - gem: "sequel"