test-prof 0.2.1 → 0.3.0

data/lib/test_prof/rspec_stamp/rspec.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require "test_prof/ext/string_strip_heredoc"
+
 module TestProf
   module RSpecStamp
     class RSpecListener # :nodoc:
       include Logging
+      using StringStripHeredoc
 
       NOTIFICATIONS = %i[
         example_failed
@@ -27,54 +30,27 @@ module TestProf
       end
 
       def stamp!
+        stamper = Stamper.new
+
         @examples.each do |file, lines|
-          stamp_file(file, lines.uniq)
+          stamper.stamp_file(file, lines.uniq)
         end
 
         msgs = []
 
         msgs <<
-          <<~MSG
+          <<-MSG.strip_heredoc
             RSpec Stamp results
 
-            Total patches: #{@total}
+            Total patches: #{stamper.total}
             Total files: #{@examples.keys.size}
 
-            Failed patches: #{@failed}
-            Ignored files: #{@ignored}
+            Failed patches: #{stamper.failed}
+            Ignored files: #{stamper.ignored}
           MSG
 
         log :info, msgs.join
       end
-
-      private
-
-      def stamp_file(file, lines)
-        @total += lines.size
-        return if ignored?(file)
-
-        log :info, "(dry-run) Patching #{file}" if dry_run?
-
-        code = File.readlines(file)
-
-        @failed += RSpecStamp.apply_tags(code, lines, RSpecStamp.config.tags)
-
-        File.write(file, code.join) unless dry_run?
-      end
-
-      def ignored?(file)
-        ignored = RSpecStamp.config.ignore_files.find do |pattern|
-          file =~ pattern
-        end
-
-        return unless ignored
-        log :warn, "Ignore stamping file: #{file}"
-        @ignored += 1
-      end
-
-      def dry_run?
-        RSpecStamp.config.dry_run?
-      end
     end
   end
 end

data/lib/test_prof/rspec_stamp.rb

@@ -10,7 +10,8 @@ module TestProf
 
     # RSpecStamp configuration
     class Configuration
-      attr_accessor :ignore_files, :dry_run, :tags
+      attr_reader :tags
+      attr_accessor :ignore_files, :dry_run
 
       def initialize
         @ignore_files = [%r{spec/support}]
@@ -44,6 +45,49 @@ module TestProf
       end
     end
 
+    # Stamper collects statistics about applying tags
+    # to examples.
+    class Stamper
+      include TestProf::Logging
+
+      attr_reader :total, :failed, :ignored
+
+      def initialize
+        @total = 0
+        @failed = 0
+        @ignored = 0
+      end
+
+      def stamp_file(file, lines)
+        @total += lines.size
+        return if ignored?(file)
+
+        log :info, "(dry-run) Patching #{file}" if dry_run?
+
+        code = File.readlines(file)
+
+        @failed += RSpecStamp.apply_tags(code, lines, RSpecStamp.config.tags)
+
+        File.write(file, code.join) unless dry_run?
+      end
+
+      private
+
+      def ignored?(file)
+        ignored = RSpecStamp.config.ignore_files.find do |pattern|
+          file =~ pattern
+        end
+
+        return unless ignored
+        log :warn, "Ignore stamping file: #{file}"
+        @ignored += 1
+      end
+
+      def dry_run?
+        RSpecStamp.config.dry_run?
+      end
+    end
+
     class << self
       include TestProf::Logging
 
@@ -84,12 +128,16 @@ module TestProf
         parsed = Parser.parse(code)
         return false unless parsed
 
-        parsed.desc ||= 'works'
+        desc = parsed.desc_const || quote(parsed.desc || 'works')
 
         tags.each do |t|
           if t.is_a?(Hash)
-            t.keys.each { |k| parsed.add_htag(k, t[k]) }
+            t.each_key do |k|
+              parsed.remove_tag(k)
+              parsed.add_htag(k, t[k])
+            end
           else
+            parsed.remove_tag(t)
             parsed.add_tag(t)
           end
         end
@@ -97,9 +145,9 @@ module TestProf
         need_parens = block == "{"
 
         tags_str = parsed.tags.map { |t| t.is_a?(Symbol) ? ":#{t}" : t }.join(", ") unless
-          parsed.tags.nil?
+          parsed.tags.nil? || parsed.tags.empty?
 
-        unless parsed.htags.nil?
+        unless parsed.htags.nil? || parsed.htags.empty?
           htags_str = parsed.htags.map do |(k, v)|
             vstr = v.is_a?(Symbol) ? ":#{v}" : quote(v)
 
@@ -108,7 +156,7 @@ module TestProf
         end
 
         replacement = "\\1#{parsed.fname}#{need_parens ? '(' : ' '}"\
-                      "#{[quote(parsed.desc), tags_str, htags_str].compact.join(', ')}"\
+                      "#{[desc, tags_str, htags_str].compact.join(', ')}"\
                       "#{need_parens ? ') ' : ' '}\\3"
 
         if config.dry_run?
@@ -122,6 +170,7 @@ module TestProf
       # rubocop: enable Metrics/PerceivedComplexity
 
       def quote(str)
+        return str unless str.is_a?(String)
         if str.include?("'")
           "\"#{str}\""
         else

data/lib/test_prof/ruby_prof.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "test_prof/ext/string_strip_heredoc"
+
 module TestProf
   # RubyProf wrapper.
   #
@@ -48,7 +50,8 @@ module TestProf
                     :include_threads, :eliminate_methods
 
       def initialize
-        @printer = ENV.fetch('TEST_RUBY_PROF_PRINTER', :call_stack).to_sym
+        @printer = ENV['TEST_RUBY_PROF'].to_sym if PRINTERS.key?(ENV['TEST_RUBY_PROF'])
+        @printer ||= ENV.fetch('TEST_RUBY_PROF_PRINTER', :flat).to_sym
         @mode = ENV.fetch('TEST_RUBY_PROF_MODE', :wall).to_sym
         @min_percent = 1
         @include_threads = false
@@ -119,6 +122,7 @@ module TestProf
 
     class << self
       include Logging
+      using StringStripHeredoc
 
       def config
         @config ||= Configuration.new
@@ -172,12 +176,23 @@ module TestProf
         ENV["RUBY_PROF_MEASURE_MODE"] = config.mode.to_s
         @initialized = TestProf.require(
           'ruby-prof',
-          <<~MSG
+          <<-MSG.strip_heredoc
             Please, install 'ruby-prof' first:
                # Gemfile
-              gem 'ruby-prof', require: false
+              gem 'ruby-prof', '>= 0.16.0', require: false
           MSG
-        )
+        ) { check_ruby_prof_version }
+      end
+
+      def check_ruby_prof_version
+        if Utils.verify_gem_version('ruby-prof', at_least: '0.16.0')
+          true
+        else
+          log :error, <<-MGS.strip_heredoc
+            Please, upgrade 'ruby-prof' to version >= 0.16.0.
+          MGS
+          false
+        end
       end
     end
   end

data/lib/test_prof/stack_prof.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "test_prof/ext/string_strip_heredoc"
+
 module TestProf
   # StackProf wrapper.
   #
@@ -26,12 +28,13 @@ module TestProf
 
       def initialize
         @mode = ENV.fetch('TEST_STACK_PROF_MODE', :wall).to_sym
-        @raw = ENV['TEST_STACK_PROF_RAW'] == '1'
+        @raw = ENV['TEST_STACK_PROF'] == 'raw' || ENV['TEST_STACK_PROF_RAW'] == 1
       end
     end
 
     class << self
       include Logging
+      using StringStripHeredoc
 
       def config
         @config ||= Configuration.new
@@ -88,7 +91,7 @@ module TestProf
 
         html_path = path.gsub(/\.dump$/, '.html')
 
-        log :info, <<~MSG
+        log :info, <<-MSG.strip_heredoc
           Run the following command to generate a flame graph report:
 
           stackprof --flamegraph #{path} > #{html_path} && stackprof --flamegraph-viewer=#{html_path}
@@ -111,12 +114,23 @@ module TestProf
         return @initialized if instance_variable_defined?(:@initialized)
         @initialized = TestProf.require(
           'stackprof',
-          <<~MSG
+          <<-MSG.strip_heredoc
             Please, install 'stackprof' first:
                # Gemfile
-              gem 'stackprof', require: false
+              gem 'stackprof', '>= 0.2.9', require: false
           MSG
-        )
+        ) { check_stack_prof_version }
+      end
+
+      def check_stack_prof_version
+        if Utils.verify_gem_version('stackprof', at_least: '0.2.9')
+          true
+        else
+          log :error, <<-MSG.strip_heredoc
+            Please, upgrade 'stackprof' to version >= 0.2.9.
+          MSG
+          false
+        end
       end
     end
   end

data/lib/test_prof/tag_prof/rspec.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 require "test_prof/ext/float_duration"
+require "test_prof/ext/string_strip_heredoc"
 
 module TestProf
   module TagProf
     class RSpecListener # :nodoc:
       include Logging
       using FloatDuration
+      using StringStripHeredoc
 
       NOTIFICATIONS = %i[
         example_started
@@ -21,7 +23,7 @@ module TestProf
       end
 
       def example_started(_notification)
-        @ts = Time.now
+        @ts = TestProf.now
       end
 
       def example_finished(notification)
@@ -30,14 +32,14 @@ module TestProf
         tag = notification.example.metadata.fetch(@tag, :__unknown__)
 
         @tags[tag][:count] += 1
-        @tags[tag][:time] += (Time.now - @ts)
+        @tags[tag][:time] += (TestProf.now - @ts)
       end
 
       def print
         msgs = []
 
         msgs <<
-          <<~MSG
+          <<-MSG.strip_heredoc
             TagProf report for #{@tag}
           MSG
 

data/lib/test_prof/utils/sized_ordered_set.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module TestProf
+  module Utils
+    # Ordered set with capacity
+    class SizedOrderedSet
+      unless [].respond_to?(:bsearch_index)
+        require "test_prof/ext/array_bsearch_index"
+        using ArrayBSearchIndex
+      end
+
+      include Enumerable
+
+      def initialize(max_size, sort_by: nil)
+        @max_size = max_size
+        @comparator =
+          if block_given?
+            Proc.new
+          elsif !sort_by.nil?
+            ->(x, y) { x[sort_by] >= y[sort_by] }
+          else
+            ->(x, y) { x >= y }
+          end
+        @data = []
+      end
+
+      def <<(item)
+        return if data.size == max_size &&
+                  comparator.call(data.last, item)
+
+        # Find an index of a smaller element
+        index = data.bsearch_index { |x| !comparator.call(x, item) }
+
+        if index.nil?
+          data << item
+        else
+          data.insert(index, item)
+        end
+
+        data.pop if data.size > max_size
+        data.size
+      end
+
+      def each
+        if block_given?
+          data.each(&Proc.new)
+        else
+          data.each
+        end
+      end
+
+      def size
+        data.size
+      end
+
+      def to_a
+        data.dup
+      end
+
+      private
+
+      attr_reader :max_size, :data, :comparator
+    end
+  end
+end

data/lib/test_prof/utils.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TestProf
+  module Utils # :nodoc:
+    class << self
+      # Verify that loaded gem has correct version
+      def verify_gem_version(gem_name, at_least: nil, at_most: nil)
+        raise ArgumentError, "Please, provide `at_least` or `at_most` argument" if
+          at_least.nil? && at_most.nil?
+
+        version = Gem.loaded_specs[gem_name].version
+
+        (at_least.nil? || Gem::Version.new(at_least) <= version) &&
+          (at_most.nil? || Gem::Version.new(at_most) >= version)
+      end
+    end
+  end
+end

data/lib/test_prof/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TestProf
-  VERSION = "0.2.1"
+  VERSION = "0.3.0".freeze
 end

data/lib/test_prof.rb

@@ -3,6 +3,7 @@
 require "fileutils"
 require "test_prof/version"
 require "test_prof/logging"
+require "test_prof/utils"
 
 # Ruby applications tests profiling tools.
 #
@@ -33,11 +34,22 @@ module TestProf
       yield config
     end
 
+    # Avoid issues with wrong time due to monkey-patches (e.g. timecop)
+    # See https://github.com/rspec/rspec-core/blob/v3.6.0/lib/rspec/core.rb#L147
+    #
+    # We also want to handle Timecop specificaly
+    # See https://github.com/travisjeffery/timecop/blob/master/lib/timecop/time_extensions.rb#L11
+    if Time.respond_to?(:now_without_mock_time)
+      define_method(:now, &::Time.method(:now_without_mock_time))
+    else
+      define_method(:now, &::Time.method(:now))
+    end
+
     # Require gem and shows a custom
     # message if it fails to load
     def require(gem_name, msg)
       Kernel.require gem_name
-      true
+      block_given? ? yield : true
     rescue LoadError
       log :error, msg
       false
@@ -79,7 +91,7 @@ module TestProf
 
     def with_timestamps(path)
       return path unless config.timestamps?
-      timestamps = "-#{Time.now.to_i}"
+      timestamps = "-#{now.to_i}"
       "#{path.sub(/\.\w+$/, '')}#{timestamps}#{::File.extname(path)}"
     end
   end
@@ -115,3 +127,4 @@ require "test_prof/factory_doctor"
 require "test_prof/factory_prof"
 require "test_prof/rspec_stamp"
 require "test_prof/tag_prof"
+require "test_prof/rspec_dissect"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-prof
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2017-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,90 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.9'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: factory_girl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 4.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.49'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.49'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.50'
 description: "\n    Ruby applications tests profiling tools.\n\n    Contains tools
   to anylyze factories usage, integrate with Ruby profilers,\n    profile your examples
   using ActiveSupport notifications (if any) and\n    statically analyze your code
@@ -178,6 +108,8 @@ files:
 - guides/factory_default.md
 - guides/factory_doctor.md
 - guides/factory_prof.md
+- guides/let_it_be.md
+- guides/rspec_dissect.md
 - guides/rspec_stamp.md
 - guides/rubocop.md
 - guides/ruby_prof.md
@@ -196,7 +128,10 @@ files:
 - lib/test_prof/event_prof/instrumentations/active_support.rb
 - lib/test_prof/event_prof/minitest.rb
 - lib/test_prof/event_prof/rspec.rb
+- lib/test_prof/ext/array_bsearch_index.rb
 - lib/test_prof/ext/float_duration.rb
+- lib/test_prof/ext/string_strip_heredoc.rb
+- lib/test_prof/ext/string_truncate.rb
 - lib/test_prof/factory_default.rb
 - lib/test_prof/factory_default/factory_girl_patch.rb
 - lib/test_prof/factory_doctor.rb
@@ -212,7 +147,10 @@ files:
 - lib/test_prof/recipes/rspec/any_fixture.rb
 - lib/test_prof/recipes/rspec/before_all.rb
 - lib/test_prof/recipes/rspec/factory_default.rb
+- lib/test_prof/recipes/rspec/let_it_be.rb
 - lib/test_prof/recipes/rspec/sample.rb
+- lib/test_prof/rspec_dissect.rb
+- lib/test_prof/rspec_dissect/rspec.rb
 - lib/test_prof/rspec_stamp.rb
 - lib/test_prof/rspec_stamp/parser.rb
 - lib/test_prof/rspec_stamp/rspec.rb
@@ -223,6 +161,8 @@ files:
 - lib/test_prof/stack_prof/rspec.rb
 - lib/test_prof/tag_prof.rb
 - lib/test_prof/tag_prof/rspec.rb
+- lib/test_prof/utils.rb
+- lib/test_prof/utils/sized_ordered_set.rb
 - lib/test_prof/version.rb
 homepage: http://github.com/palkan/test-prof
 licenses:
@@ -236,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="