appmap 0.89.0 → 0.90.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d046b1cedf455ae967a663b200c05751c4c0659defa5e7dce0a7f760ba865b6
-  data.tar.gz: 790f5a9705b0d32b60467ecb8e51dc75e8fdbb2ac3af2022ee1c8a1a7c8cc8ca
+  metadata.gz: e8c53e191f43fe539ca2fd9381bf690597ec89b96ab1848680344b3d52a1b8f6
+  data.tar.gz: 1ee5593abdd95aefcc4b10a9ac717ea281e27885a4fd6a89fa0dc10ea5c2f66a
 SHA512:
-  metadata.gz: 7c999d39cb9385f3758746cf93d50f291a4a6f9ae1c8b33266897975bdd9aabf4c8a3f666a3b3650ee70a24978d574a5db0bfefe2539240b582f1a430eabe399
-  data.tar.gz: 731810f9c4afe0c0c9130ab81d71e0c20f85860bf57fef5d5736845aba4c4d240dff101bc5a46aef4c6ca9e08f5adfe90ac749bb059fc7ecacd08aec77926f4e
+  metadata.gz: c718347cfdb809cdfbdd46bee5399a98e6100d5afc3120e060f297d6f950227f1e263fab6baf5b705c4ec3573ef2f9aa1d1e96aff2053e120de1a2cc7dc4a55e
+  data.tar.gz: 89e90d35c06c1ae3db76bb58481dce70420081c92e386dc1b75922fbe53fcdac2609f157967fdacf476e3ed9c5f5c79bcfe83a88e56f84ab14aebaaab36fccfe

data/.rubocop.yml

@@ -18,7 +18,7 @@ Layout/LineLength:
   Max: 120
 
 Metrics/BlockLength:
-  ExcludedMethods:
+  AllowedMethods:
   - describe
   - it
   - context

data/.travis.yml

@@ -5,7 +5,6 @@ cache:
 - yarn
 
 rbenv:
-- 2.5
 - 2.6
 - 2.7
 - 3.0

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [0.90.1](https://github.com/applandinc/appmap-ruby/compare/v0.90.0...v0.90.1) (2022-09-19)
+
+
+### Bug Fixes
+
+* Faster comment extraction ([f6199a6](https://github.com/applandinc/appmap-ruby/commit/f6199a607fadd58500d9cdc9394b39413e6b2930))
+
+
+### Performance Improvements
+
+* Don't save comment and source in classmap. ([c3c8e75](https://github.com/applandinc/appmap-ruby/commit/c3c8e755677d169610bfa7e55c12f0d418120eb7))
+
+# [0.90.0](https://github.com/applandinc/appmap-ruby/compare/v0.89.0...v0.90.0) (2022-09-15)
+
+
+### Features
+
+* Include required_ruby_version in the gemspec ([a5d7c6b](https://github.com/applandinc/appmap-ruby/commit/a5d7c6b7b255f817f3ceec5924cd799d2565daa4))
+* Save default appmap.yml ([77a08d5](https://github.com/applandinc/appmap-ruby/commit/77a08d5ebbe2f49f19237242a62d05aadcc84228))
+
 # [0.89.0](https://github.com/applandinc/appmap-ruby/compare/v0.88.0...v0.89.0) (2022-09-07)
 
 

data/appmap.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Kevin Gilpin']
   spec.email         = ['kgilpin@gmail.com']
 
+  spec.required_ruby_version = '>= 2.6.0'
+
   spec.summary       = %q{Record the operation of a Ruby program, using the AppLand 'AppMap' format.}
   spec.homepage      = AppMap::URL
   spec.license       = 'MIT'

data/lib/appmap/class_map.rb

@@ -50,7 +50,7 @@ module AppMap
         end
       end
       Function = Struct.new(:name) do
-        attr_accessor :static, :location, :labels, :comment, :source
+        attr_accessor :static, :location, :labels
 
         def type
           'function'
@@ -63,8 +63,6 @@ module AppMap
             location: location,
             static: static,
             labels: labels,
-            comment: comment,
-            source: source
           }.delete_if { |_, v| v.nil? || v == [] }
         end
       end
@@ -126,7 +124,6 @@ module AppMap
           end
 
         comment = method.comment
-        function_info[:comment] = comment unless Util.blank?(comment)
 
         function_info[:labels] = parse_labels(comment) + (method.labels || [])
         object_infos << function_info

data/lib/appmap/config.rb

@@ -338,28 +338,34 @@ module AppMap
           AppMap uses this file to customize its behavior. For example, you can use
           the 'packages' setting to indicate which local file paths and dependency
           gems you want to include in the AppMap. Since you haven't provided specific
-          settings, the appmap gem will try and guess some reasonable defaults.
-          To suppress this message, create the file:
-          
-          #{Pathname.new(config_file_name).expand_path}
-          
-          Here are the default settings that will be used in the meantime. You can
-          copy and paste this example to start your appmap.yml.
+          settings, the appmap gem will use these default options:
           MISSING_FILE_MSG
           {}
         end
 
         load(config_data).tap do |config|
-          config_yaml = {
+          {
             'name' => config.name,
             'packages' => config.packages.select{|p| p.path}.map do |pkg|
               { 'path' => pkg.path }
             end,
             'exclude' => []
-          }.compact
-          unless config_present
-            warn Util.color(YAML.dump(config_yaml), :magenta)
-            warn logo.()
+          }.compact.tap do |config_yaml|
+            unless config_present
+              warn Util.color(YAML.dump(config_yaml), :magenta)
+              dirname = Pathname.new(config_file_name).dirname.expand_path
+              if Dir.exists?(dirname) && File.writable?(dirname)
+                warn Util.color(<<~CONFIG_FILE_MSG, :magenta)
+                This file will be saved to #{Pathname.new(config_file_name).expand_path},
+                where you can customize it.
+                CONFIG_FILE_MSG
+                File.write(config_file_name, YAML.dump(config_yaml))
+              end
+              warn Util.color(<<~CONFIG_FILE_MSG, :magenta)
+              For more information, see https://appmap.io/docs/reference/appmap-ruby.html#configuration
+              CONFIG_FILE_MSG
+              warn logo.()
+            end
           end
         end
       end

data/lib/appmap/trace.rb

@@ -21,8 +21,11 @@ module AppMap
       end
 
       def comment
-        @method.comment
-      rescue MethodSource::SourceNotFoundError, Errno::EINVAL
+        return nil if source_location.nil? || source_location.first.start_with?('<')
+
+        # Do not use method_source's comment method because it's slow
+        @comment ||= RubyMethod.last_comment *source_location
+      rescue Errno::EINVAL, Errno::ENOENT
         nil
       end
 
@@ -37,6 +40,21 @@ module AppMap
       def labels
         @package.labels
       end
+
+      private
+
+      # Read file and get last comment before line.
+      def self.last_comment(file, line_number)
+        File.open(file) do |f|
+          buffer = []
+          f.each_line.lazy.take(line_number - 1).reverse_each do |line|
+            break unless (line =~ /^\s*#/) || (line =~ /^\s*$/)
+
+            buffer << line.lstrip
+          end
+          buffer.reverse.join
+        end
+      end
     end
 
     class Tracing

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.89.0'
+  VERSION = '0.90.1'
 
   APPMAP_FORMAT_VERSION = '1.7.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.89.0
+  version: 0.90.1
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -446,7 +446,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="