appmap 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbd73ea1339788825987a09e80097ad54fcaf6297ae5a7bbe01aa39b5462a8bb
-  data.tar.gz: 6338cbb3203543ce4db169fef9cfcf31acfd6ea44da94220bca5c00638368520
+  metadata.gz: e7b445cafb60cb09ec8ac53a47ce2a18983679f4c0b12d57d3296b95ad18e99b
+  data.tar.gz: 32bd5984db62f59553902802e6d21627470f664b049c7b4501e3522ce7ac3c73
 SHA512:
-  metadata.gz: 6d0b9d851b266a230a40ac85e9991d183919c67b1c09e155009ffb3cd2de660e40521e6253534ae6a3e06867238810d6f5def1c9b10f094f81ed2498e79ee4ea
-  data.tar.gz: 4a6f75650e36876086782f778eb1fbb90f7d15a9e35eb28f245ce942285b3cfd95c76c16e5d01a5c90867455668609e974a41dfd829a6e7a91487833ebee49c9
+  metadata.gz: 0a910eaf05acbcdc0d0c39ce1aacd992efc4ea85f725325557edcfb1b61df32dbcdec4f2ee614296a0c7d97248dca067259adf059b4e6a7390b4b64561247474
+  data.tar.gz: 6d5d2766f9b1b558349b25926c3dd23b6489e6991c3fa6cde6bd865de7db9d99470c1c1fe606abe1366d77f8995f4cde440626bce417baa2f2d512114dd835d0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v0.20.0
+
+Updated to [AppMap file format](https://github.com/applandinc/appmap) version 1.2.
+
+* **Event `message`** is now an array of parameter objects.
+* The value of each `appmap:` tags in an RSpec is recorded as a `label` in the AppMap file metadata.
+* `layout` is removed from AppMap file metadata.
+
 # v0.19.0
 
 * **RSpec** feature and feature group names can be inferred from example group and example names.

data/README.md

@@ -78,16 +78,15 @@ Each entry in the `packages` list is a YAML object which has the following keys:
 
 ## RSpec
 
-To instrument RSpec tests, follow these steps:
+To instrument RSpec tests, follow these additional steps:
 
-1) Include the `appmap` gem in your Gemfile.
-2) Require `appmap/rspec` in your `spec_helper.rb`.
-3) Add `appmap: true` to the tests you want to instrument.
-4) Export the environment variable `APPMAP=true`.
-5) *Optional* Add `feature: '<feature name>'` and `feature_group: '<feature group name>'` annotations to your 
-   examples. 
+1) Require `appmap/rspec` in your `spec_helper.rb`.
+
+```ruby
+require 'appmap/rspec'
+```
 
-Here's an example of an appmap-enabled RSpec test:
+2) Add `appmap: true` to the tests you want to instrument.
 
 ```ruby
 describe Hello, appmap: true do
@@ -99,7 +98,10 @@ describe Hello, appmap: true do
 end
 ```
 
-Run the tests like this:
+3) *Optional* Add `feature: '<feature name>'` and `feature_group: '<feature group name>'` annotations to your 
+   examples. 
+
+4) Run the tests with the environment variable `APPMAP=true`:
 
 ```sh-session
 $ APPMAP=true bundle exec rspec -t appmap

data/exe/appmap

@@ -77,7 +77,8 @@ module AppMap
 
         require 'appmap/command/record'
         AppMap::Command::Record.new(@config, program).perform do |features, events|
-          @output_file.write JSON.generate(classMap: features,
+          @output_file.write JSON.generate(version: AppMap::APPMAP_FORMAT_VERSION,
+                                           classMap: features,
                                            metadata: AppMap::Command::Record.detect_metadata,
                                            events: events)
         end

data/lib/appmap/command/record.rb

@@ -19,7 +19,6 @@ module AppMap
                 name: 'rails',
                 version: ::Rails.version
               }
-              m[:layout] = 'rails'
             end
             m[:git] = git_metadata if git_available
           end

data/lib/appmap/command/upload.rb

@@ -51,7 +51,7 @@ module AppMap
           appmap[:events] = events
         else
           class_map = prune(data)
-          appmap = { "classMap": class_map, "events": [] }
+          appmap = { "version": AppMap::APPMAP_FORMAT_VERSION, "classMap": class_map, "events": [] }
         end
 
         upload_file = { user: user, org: org, data: appmap }.compact

data/lib/appmap/middleware/remote_recording.rb

@@ -70,7 +70,7 @@ module AppMap
         require 'appmap/command/record'
         metadata = AppMap::Command::Record.detect_metadata
 
-        response = JSON.generate(classMap: @features, metadata: metadata, events: @events)
+        response = JSON.generate(version: AppMap::APPMAP_FORMAT_VERSION, classMap: @features, metadata: metadata, events: @events)
 
         [ true, response ]
       end

data/lib/appmap/rails/action_handler.rb

@@ -27,7 +27,17 @@ module AppMap
                 request_method: payload[:method],
                 path_info: payload[:path]
               }
-              h[:message] = payload[:params]
+
+              params = payload[:params]
+              h[:message] = params.keys.map do |key|
+                val = params[key]
+                {
+                  name: key,
+                  class: val.class.name,
+                  value: self.class.display_string(val),
+                  object_id: val.__id__
+                }
+              end
             end
           end
         end

data/lib/appmap/rspec.rb

@@ -45,7 +45,7 @@ module AppMap
         end
 
         appmap = {
-          version: '1.1',
+          version: AppMap::APPMAP_FORMAT_VERSION,
           classMap: features,
           metadata: metadata,
           events: events

data/lib/appmap/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module AppMap
-  VERSION = '0.19.0'
+  VERSION = '0.20.0'
+
+  APPMAP_FORMAT_VERSION = '1.2'
 end

data/spec/abstract_controller4_base_spec.rb

@@ -23,8 +23,17 @@ describe 'AbstractControllerBase' do
 
       expect(appmap).to include(<<-MESSAGE.strip)
   message:
-    login: alice
-    password: "[FILTERED]"
+  - name: login
+    class: String
+    value: alice
+    object_id:
+      MESSAGE
+
+      expect(appmap).to include(<<-MESSAGE.strip)
+  - name: password
+    class: String
+    value: "[FILTERED]"
+    object_id:
       MESSAGE
 
       expect(appmap).to include(<<-SERVER_REQUEST.strip)

data/spec/abstract_controller_base_spec.rb

@@ -23,8 +23,17 @@ describe 'AbstractControllerBase' do
 
       expect(appmap).to include(<<-MESSAGE.strip)
   message:
-    login: alice
-    password: "[FILTERED]"
+  - name: login
+    class: String
+    value: alice
+    object_id:
+      MESSAGE
+
+      expect(appmap).to include(<<-MESSAGE.strip)
+  - name: password
+    class: String
+    value: "[FILTERED]"
+    object_id:
       MESSAGE
 
       expect(appmap).to include(<<-SERVER_REQUEST.strip)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2019-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport