appmap 0.32.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6becd9530caf01e14b8a7db69e74b40297d41e4724f25315cd7b44ea6ad3e02
-  data.tar.gz: 2863e714f0651d73fc9f2f87d0ea2c5f9fb7f9f553d1f109d9d8f10fff35f5be
+  metadata.gz: ae23c62b9a3f01cc3b7680706746d2f51c94c3a776978a8ee2d4e0e8501fca01
+  data.tar.gz: 4aa33af19ed0c31b826f8cffa75e147e2781fe93ed39353ace29cede8a7882b9
 SHA512:
-  metadata.gz: a5574478fee68b2531449df2b9ec135a60110950cdcd518cf5b85d10e6d0d756b3e22740a4ce0905d7fccb2e6e7d684ee38ac61fd11ad6fdfcff4355a7ae7b36
-  data.tar.gz: d15827a809ffde6b6ff98bfb62057f759cdc03e7e24452c1a8273801f94e37d61bab265ddb863ce8f60d83c639875fcf2d247f27abe9b27164817f0739b7c699
+  metadata.gz: 04a3c1bee70c02c96c1b71d5153a6ed44d668d6fc69d6da77cd6201364ede609bee93604f4ace391ddb38f8259841d6b334fdbe9051f1667d41cf3383281fe58
+  data.tar.gz: c60d868b2c1fa9c1e8742856dd7f946f5bf1284cab01a4478708c1582add5ca8fd16002e150d8a2cd897819edb661a9082cb01ec3e9879686d85d49b341d4ba8

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.33.0
+
+* Added command `AppMap.open` to open an AppMap in the browser.
+
 # v0.32.0
 
 * Removes un-necessary fields from `return` events.

data/appmap.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday'
   spec.add_dependency 'gli'
   spec.add_dependency 'parser'
+  spec.add_dependency 'rack'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'

data/lib/appmap.rb

@@ -14,19 +14,20 @@ require 'appmap/trace'
 require 'appmap/class_map'
 require 'appmap/metadata'
 require 'appmap/util'
+require 'appmap/open'
 
 module AppMap
   class << self
     @configuration = nil
     @configuration_file_path = nil
 
-    # configuration gets the configuration. If there is no configuration, the default
+    # Gets the configuration. If there is no configuration, the default
     # configuration is initialized.
     def configuration
-      @configuration ||= configure
+      @configuration ||= initialize
     end
 
-    # configuration= sets the configuration. This is only expected to happen once per
+    # Sets the configuration. This is only expected to happen once per
     # Ruby process.
     def configuration=(config)
       warn 'AppMap is already configured' if @configuration && config
@@ -34,22 +35,24 @@ module AppMap
       @configuration = config
     end
 
-    # initialize configures AppMap for recording. Default behavior is to configure from "appmap.yml".
+    # Configures AppMap for recording. Default behavior is to configure from "appmap.yml".
     # This method also activates the code hooks which record function calls as trace events.
     # Call this function before the program code is loaded by the Ruby VM, otherwise
     # the load events won't be seen and the hooks won't activate.
     def initialize(config_file_path = 'appmap.yml')
       warn "Configuring AppMap from path #{config_file_path}"
-      self.configuration = Config.load_from_file(config_file_path)
-      Hook.new(configuration).enable
+      Config.load_from_file(config_file_path).tap do |configuration|
+        self.configuration = configuration
+        Hook.new(configuration).enable
+      end
     end
 
-    # tracing can be used to start tracing, stop tracing, and record events.
+    # Used to start tracing, stop tracing, and record events.
     def tracing
       @tracing ||= Trace::Tracing.new
     end
 
-    # record records the events which occur while processing a block,
+    # Records the events which occur while processing a block,
     # and returns an AppMap as a Hash.
     def record
       tracer = tracing.trace
@@ -70,12 +73,18 @@ module AppMap
       }
     end
 
-    # class_map builds a class map from a config and a list of Ruby methods.
+    # Uploads an AppMap to the AppLand website and displays it.
+    def open(appmap = nil, &block)
+      appmap ||= AppMap.record(&block)
+      AppMap::Open.new(appmap).perform
+    end
+
+    # Builds a class map from a config and a list of Ruby methods.
     def class_map(methods)
       ClassMap.build_from_methods(configuration, methods)
     end
 
-    # detect_metadata returns default metadata detected from the Ruby system and from the
+    # Returns default metadata detected from the Ruby system and from the
     # filesystem.
     def detect_metadata
       @metadata ||= Metadata.detect.freeze

data/lib/appmap/open.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module AppMap
+  OpenStruct = Struct.new(:appmap)
+
+  class Open < OpenStruct
+    attr_reader :port
+
+    def perform
+      server = run_server
+      open_browser
+      server.kill
+    end
+
+    def page
+      require 'rack/utils'
+      <<~PAGE
+      <!DOCTYPE html>
+      <html>
+      <head>
+        <title>&hellip;</title>
+        <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+        <script type="text/javascript">
+        function dosubmit() { document.forms[0].submit(); }
+        </script>
+      </head>
+      <body onload="dosubmit();">
+        <form action="https://app.land/scenario_uploads" method="POST" accept-charset="utf-8">
+        <input type="hidden" name="data" value='#{Rack::Utils.escape_html appmap.to_json}'>
+        </form>
+      </body>
+      </html>
+      PAGE
+    end
+
+    def run_server
+      require 'rack'
+      Thread.new do
+        Rack::Handler::WEBrick.run(
+          lambda do |env|
+            return [200, { 'Content-Type' => 'text/html' }, [page]]
+          end,
+          :Port => 0
+        ) do |server|
+          @port = server.config[:Port]
+        end
+      end.tap do
+        sleep 1.0
+      end
+    end
+
+    def open_browser
+      system 'open', "http://localhost:#{@port}"
+      sleep 5.0
+    end
+  end
+end

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.32.0'
+  VERSION = '0.33.0'
 
   APPMAP_FORMAT_VERSION = '1.2'
 end

data/spec/open_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe AppMap::Open do
+  context 'a block of Ruby code' do
+    it 'opens in the browser' do
+      appmap = AppMap.record do
+        File.read __FILE__
+      end
+
+      open = AppMap::Open.new(appmap)
+      server = open.run_server
+      page = Net::HTTP.get URI.parse("http://localhost:#{open.port}")
+      expect(page).to include(%(name="data" value='{"version))
+      server.kill
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.33.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -277,6 +291,7 @@ files:
 - lib/appmap/metadata.rb
 - lib/appmap/middleware/remote_recording.rb
 - lib/appmap/minitest.rb
+- lib/appmap/open.rb
 - lib/appmap/rails/action_handler.rb
 - lib/appmap/rails/sql_handler.rb
 - lib/appmap/railtie.rb
@@ -457,6 +472,7 @@ files:
 - spec/fixtures/rails_users_app/spec/spec_helper.rb
 - spec/fixtures/rails_users_app/users_app/.gitignore
 - spec/hook_spec.rb
+- spec/open_spec.rb
 - spec/rails_spec_helper.rb
 - spec/railtie_spec.rb
 - spec/record_sql_rails4_pg_spec.rb