appmap 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7b445cafb60cb09ec8ac53a47ce2a18983679f4c0b12d57d3296b95ad18e99b
-  data.tar.gz: 32bd5984db62f59553902802e6d21627470f664b049c7b4501e3522ce7ac3c73
+  metadata.gz: 2f6f185625c62dee8266aaca7dc13d15994bf1ebe947569e134da574a0a557a0
+  data.tar.gz: 46c6c133477606f5ba908b710fa69fd44063b91b4e966e8d1d36fb5eb8b4aa6b
 SHA512:
-  metadata.gz: 0a910eaf05acbcdc0d0c39ce1aacd992efc4ea85f725325557edcfb1b61df32dbcdec4f2ee614296a0c7d97248dca067259adf059b4e6a7390b4b64561247474
-  data.tar.gz: 6d5d2766f9b1b558349b25926c3dd23b6489e6991c3fa6cde6bd865de7db9d99470c1c1fe606abe1366d77f8995f4cde440626bce417baa2f2d512114dd835d0
+  metadata.gz: 82ed069dbe728941c732d1b9c9e5681a6d31544df703a859e4e3a8c75fe0fde906036bfaaabebac5ad2f2cab5df1176e2233f16e975ab39f2eca1bac592fd3f0
+  data.tar.gz: 77d93bb43e7efdc5cd81570422af35aac203e84438eea375eb18f07d5ed3e0a76ad7383ba808daa1cc8ac0e7f5a1a224c3857131aef7fbe5a64c323fefacdab7

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.21.0
+
+* Scenario data includes `recorder` and `client` info, describing how the data was recorded.
+
 # v0.20.0
 
 Updated to [AppMap file format](https://github.com/applandinc/appmap) version 1.2.

data/README.md

@@ -145,17 +145,19 @@ unless Rails.env.test?
 end
 ```
 
-2. Start your Rails application server. For example:
+2. Download and unpack the [AppLand browser extension](https://github.com/applandinc/appland-browser-extension). Install into Chrome using `chrome://extensions/`. Turn on "Developer Mode" and then load the extension using the "Load unpacked" button.
+
+3. Start your Rails application server. For example:
 
 ```sh-session
 $ bundle exec rails server
 ```
 
-3. Open the AppApp browser extension and push `Start`.
+4. Open the AppApp browser extension and push `Start`.
 
-4. Use your app. For example, perform a login flow, or run through a manual UI test.
+5. Use your app. For example, perform a login flow, or run through a manual UI test.
 
-5. Open the AppApp browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
+6. Open the AppApp browser extension and push `Stop`. The recording will be transferred to the AppLand website and opened in your browser.
 
 # Uploading AppMaps
 

data/appmap.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -9,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Kevin Gilpin']
   spec.email         = ['kgilpin@gmail.com']
 
-  spec.summary       = %q{Inspect and trace your Ruby code, generating a JSON data file.}
-  spec.homepage      = 'https://github.com/kgilpin/appmap-ruby'
+  spec.summary       = %q{Record the operation of a Ruby program, using the AppLand 'AppMap' format.}
+  spec.homepage      = AppMap::URL
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.

data/lib/appmap/command/record.rb

@@ -11,6 +11,11 @@ module AppMap
               name: 'ruby',
               engine: RUBY_ENGINE,
               version: RUBY_VERSION
+            },
+            client: {
+              name: 'appmap',
+              url: AppMap::URL,
+              version: AppMap::VERSION
             }
           }.tap do |m|
             if defined?(::Rails)

data/lib/appmap/middleware/remote_recording.rb

@@ -69,6 +69,9 @@ module AppMap
 
         require 'appmap/command/record'
         metadata = AppMap::Command::Record.detect_metadata
+        metadata[:recorder] = {
+          name: 'remote_recording'
+        }
 
         response = JSON.generate(version: AppMap::APPMAP_FORMAT_VERSION, classMap: @features, metadata: metadata, events: @events)
 

data/lib/appmap/rspec.rb

@@ -42,6 +42,9 @@ module AppMap
             name: 'rspec',
             version: Gem.loaded_specs['rspec-core']&.version&.to_s
           }
+          m[:recorder] = {
+            name: 'rspec'
+          }
         end
 
         appmap = {
@@ -272,14 +275,17 @@ module AppMap
               description = []
               leaf = scope = ScopeExample.new(example)
               feature_group = feature = nil
-              labels = scope.labels.map(&:to_s).map(&:strip).reject(&:blank?).map(&:downcase).uniq
 
+              labels = []
               while scope
+                labels += scope.labels
                 description << scope.description
                 feature ||= scope.feature
                 feature_group ||= scope.feature_group
                 scope = scope.parent
               end
+
+              labels = labels.map(&:to_s).map(&:strip).reject(&:blank?).map(&:downcase).uniq
               description.reject!(&:nil?).reject(&:blank?)
               default_description = description.last
               description.reverse!

data/lib/appmap/trace/tracer.rb

@@ -135,7 +135,7 @@ module AppMap
         end
 
         def collect_parameters(tp)
-          tp.self.method(tp.method_id).parameters.collect do |pinfo|
+          -> { tp.self.method(tp.method_id).parameters rescue [] }.call.collect do |pinfo|
             kind, key = pinfo
             value = value_in_binding(tp, key)
             {

data/lib/appmap/version.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module AppMap
-  VERSION = '0.20.0'
+  URL = 'https://github.com/applandinc/appmap-ruby'
+
+  VERSION = '0.21.0'
 
   APPMAP_FORMAT_VERSION = '1.2'
 end

data/test/fixtures/rspec_recorder/spec/decorated_hello_spec.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'appmap/rspec'
+require 'hello'
+
+describe Hello, feature_group: 'Saying hello' do
+  it 'says hello', feature: 'Speak hello', appmap: true do
+    expect(Hello.new.say_hello).to eq('Hello!')
+  end
+end

data/test/fixtures/rspec_recorder/spec/{hello_spec.rb → labeled_hello_spec.rb}

@@ -2,8 +2,8 @@ require 'rspec'
 require 'appmap/rspec'
 require 'hello'
 
-describe Hello, feature_group: 'Hello' do
-  it 'says hello', feature: 'Say hello', appmap: true do
+describe Hello, appmap: 'hello' do
+  it 'says hello', appmap: 'speak' do
     expect(Hello.new.say_hello).to eq('Hello!')
   end
 end

data/test/fixtures/rspec_recorder/spec/plain_hello_spec.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'appmap/rspec'
+require 'hello'
+
+describe Hello, appmap: true do
+  it 'says hello' do
+    expect(Hello.new.say_hello).to eq('Hello!')
+  end
+end

data/test/rspec_test.rb

@@ -5,18 +5,58 @@ require 'test_helper'
 require 'English'
 
 class RSpecTest < Minitest::Test
-  def test_record_rspec
+  def perform_test(test_name)
     Bundler.with_clean_env do
       Dir.chdir 'test/fixtures/rspec_recorder' do
-        appmap_file = 'tmp/appmap/rspec/Hello_says_hello.json'
         FileUtils.rm_rf 'tmp'
         system 'bundle'
-        system({ 'APPMAP' => 'true' }, 'bundle exec rspec')
-        assert File.file?(appmap_file), 'appmap output file does not exist'
-        assert_includes File.read(appmap_file), %("class":"String","value":"Hello!")
-        assert_includes File.read(appmap_file), %("feature":"Say hello")
-        assert_includes File.read(appmap_file), %("feature_group":"Hello")
+        system({ 'APPMAP' => 'true' }, %(bundle exec rspec spec/#{test_name}.rb))
+
+        yield
       end
     end
   end
+
+  def test_record_decorated_rspec
+    perform_test 'decorated_hello_spec' do
+      appmap_file = 'tmp/appmap/rspec/Hello_says_hello.appmap.json'
+
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      appmap = JSON.parse(File.read(appmap_file))
+      assert_equal AppMap::APPMAP_FORMAT_VERSION, appmap['version']
+      assert_includes appmap.keys, 'metadata'
+      metadata = appmap['metadata']
+      assert_equal 'Saying hello', metadata['feature_group']
+      assert_equal 'Speak hello', metadata['feature']
+      assert_equal 'Hello says hello', metadata['name']
+      assert_includes metadata.keys, 'client'
+      assert_equal({ name: 'appmap', url: AppMap::URL, version: AppMap::VERSION }.stringify_keys, metadata['client'])
+      assert_includes metadata.keys, 'recorder'
+      assert_equal({ name: 'rspec' }.stringify_keys, metadata['recorder'])
+    end
+  end
+
+  def test_record_plain_rspec
+    perform_test 'plain_hello_spec' do
+      appmap_file = 'tmp/appmap/rspec/Hello_says_hello.appmap.json'
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      appmap = JSON.parse(File.read(appmap_file))
+      assert_includes appmap.keys, 'metadata'
+      metadata = appmap['metadata']
+      assert_equal 'Hello', metadata['feature_group']
+      assert_equal 'Hello', metadata['feature']
+      assert_equal 'Hello says hello', metadata['name']
+    end
+  end
+
+  def test_record_labeled_rspec
+    perform_test 'labeled_hello_spec' do
+      appmap_file = 'tmp/appmap/rspec/Hello_says_hello.appmap.json'
+      assert File.file?(appmap_file), 'appmap output file does not exist'
+      appmap = JSON.parse(File.read(appmap_file))
+      assert_includes appmap.keys, 'metadata'
+      metadata = appmap['metadata']
+      assert_equal %w[hello speak], metadata['labels'].sort
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-06 00:00:00.000000000 Z
+date: 2019-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -467,7 +467,9 @@ files:
 - test/fixtures/rspec_recorder/Gemfile
 - test/fixtures/rspec_recorder/appmap.yml
 - test/fixtures/rspec_recorder/lib/hello.rb
-- test/fixtures/rspec_recorder/spec/hello_spec.rb
+- test/fixtures/rspec_recorder/spec/decorated_hello_spec.rb
+- test/fixtures/rspec_recorder/spec/labeled_hello_spec.rb
+- test/fixtures/rspec_recorder/spec/plain_hello_spec.rb
 - test/fixtures/trace_test/trace_program_1.rb
 - test/implicit_inspect_test.rb
 - test/include_exclude_test.rb
@@ -475,7 +477,7 @@ files:
 - test/rspec_test.rb
 - test/test_helper.rb
 - test/trace_test.rb
-homepage: https://github.com/kgilpin/appmap-ruby
+homepage: https://github.com/applandinc/appmap-ruby
 licenses:
 - MIT
 metadata: {}
@@ -497,5 +499,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Inspect and trace your Ruby code, generating a JSON data file.
+summary: Record the operation of a Ruby program, using the AppLand 'AppMap' format.
 test_files: []