flutter 0.1.0.pre.2

data/lib/flutter/persistence.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "set"
+module Flutter
+  module Persistence
+    class AbstractStorage
+      def initialize
+        load!
+      end
+
+      # :nocov:
+      def test_mapping
+        raise NotImplementedError
+      end
+
+      def source_mapping
+        raise NotImplementedError
+      end
+
+      def update_test_mapping!(mapping)
+        raise NotImplementedError
+      end
+
+      def update_source_mapping!(mapping)
+        raise NotImplementedError
+      end
+
+      def persist!(updates)
+        raise NotImplementedError
+      end
+
+      def to_s
+        raise NotImplementedError
+      end
+
+      def clear!
+        raise NotImplementedError
+      end
+
+      def load!
+        raise NotImplementedError
+      end
+      # :nocov:
+    end
+
+    class Yaml < AbstractStorage
+      require "yaml"
+      # ruby >= 3.1 requires this
+      YAML_LOAD_OPTS = RUBY_VERSION > "3.1" ? { permitted_classes: [Hash, Set, Symbol] } : {}
+      def initialize(path:)
+        @path = File.absolute_path(path)
+        @full_path = File.join(@path, "state.yml")
+        @state = { test_mapping: {}, source_mapping: {} }
+        super()
+      end
+
+      def load!
+        if File.exist?(@full_path)
+          persisted = YAML.load(File.read(@full_path), **YAML_LOAD_OPTS)
+          @state.update(persisted) if persisted
+        end
+      end
+
+      def test_mapping
+        @state.fetch(:test_mapping) { @state[:test_mapping] = {} }
+      end
+
+      def source_mapping
+        @state.fetch(:source_mapping) { @state[:source_mapping] = {} }
+      end
+
+      def update_test_mapping!(mapping)
+        test_mapping.merge!(mapping)
+      end
+
+      def update_source_mapping!(mapping)
+        source_mapping.merge!(mapping)
+      end
+
+      def clear!
+        FileUtils.rm(@full_path) if File.exist?(@full_path)
+        @state.clear
+      end
+
+      def persist!
+        FileUtils.mkdir_p(@path) unless File.exist?(@path)
+        File.open(@full_path, "w") { |file| file.write(@state.to_yaml) }
+      end
+
+      def to_s
+        "state: #{@full_path}"
+      end
+    end
+
+    class Marshal < AbstractStorage
+      require "pstore"
+      def initialize(path:)
+        @path = File.absolute_path(path)
+        FileUtils.mkdir_p(@path) unless File.exist?(@path)
+        @full_path = File.join(@path, "state.pstore")
+        @state = nil
+        super()
+      end
+
+      def load!
+        @state = PStore.new(@full_path)
+        @state.transaction do
+          @state[:test_mapping] ||= {}
+          @state[:source_mapping] ||= {}
+        end
+      end
+
+      def test_mapping
+        @state.transaction do
+          return @state[:test_mapping]
+        end
+      end
+
+      def source_mapping
+        @state.transaction do
+          return @state[:source_mapping]
+        end
+      end
+
+      def update_test_mapping!(mapping)
+        @state.transaction do
+          @state[:test_mapping] ||= {}
+          @state[:test_mapping].merge!(mapping)
+        end
+      end
+
+      def update_source_mapping!(mapping)
+        @state.transaction do
+          @state[:source_mapping] ||= {}
+          @state[:source_mapping].merge!(mapping)
+        end
+      end
+
+      def clear!
+        FileUtils.rm(@full_path) if File.exist?(@full_path)
+      end
+
+      def persist!
+      end
+
+      def to_s
+        "state: #{@full_path}"
+      end
+    end
+  end
+end

data/lib/flutter/rspec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "tracker"
+
+module Flutter
+  module RSpec
+    class << self
+      attr_accessor :filtered
+
+      def tracker
+        @tracker ||= Flutter::Tracker.new(
+          Flutter.config.sources, Flutter.config.exclusions,
+          Flutter.config.storage_class, Flutter.config.storage_options
+        )
+      end
+    end
+
+    module ClassMethods
+      def filtered_examples
+        Flutter::RSpec.filtered ||= 0
+        Flutter::RSpec.tracker.reset! if Flutter.enabled && Flutter.config.reset_storage
+
+        original = super
+        return original unless Flutter.enabled
+
+        original.select do |example|
+          skip = example.metadata[:block] && Flutter::RSpec.tracker.skip?(
+            example.full_description,
+            example.metadata[:absolute_file_path],
+            example.metadata[:block].source,
+          )
+          Flutter::RSpec.filtered += 1 if skip
+          !skip
+        end
+      end
+    end
+  end
+end
+
+module RSpec
+  module Core
+    class ExampleGroup
+      class << self
+        prepend Flutter::RSpec::ClassMethods
+      end
+    end
+  end
+end
+
+if defined?(RSpec.configure)
+  RSpec.configure do |config|
+    config.around(:each) do |example|
+      Flutter::RSpec.tracker.start(example.full_description) if Flutter.enabled
+      example.run
+      Flutter::RSpec.tracker.stop if Flutter.enabled
+    end
+
+    config.after(:suite) do
+      if Flutter.enabled
+        $stdout.puts
+        $stdout.puts "Flutter filtered out #{Flutter::RSpec.filtered} examples"
+        Flutter::RSpec.tracker.persist!
+      end
+    end
+  end
+end

data/lib/flutter/tracker.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require "deep_merge"
+require "set"
+require_relative "persistence"
+require_relative "parser"
+require "pry"
+
+module Flutter
+  class Tracker
+    attr_reader :test_mapping, :source_mapping
+
+    def initialize(sources, exclusions, storage_class, storage_options)
+      @sources = sources.map { |s| File.absolute_path(s) }
+      @exclusions = exclusions.map { |s| File.absolute_path(s) }
+      @storage = storage_class.new(**storage_options)
+      @test_mapping = @storage.test_mapping
+      @test_source_mapping = {}
+      @source_mapping = @storage.source_mapping
+      @current_source_mapping = {}
+      @path_mapping = {}
+      @method_prefixes = {}
+      @tracked_files = {}
+    end
+
+    # Resets the in-memory test_mapping for each test, and stores the methods that
+    # the test calls in the in-memory test_mapping
+    def start(test)
+      # Delete test from the in-memory mapping to allow each new test run
+      # to store all the functions that the test calls into
+      @test_mapping.delete(test)
+      @current_tracepoint = TracePoint.new(:call) do |tp|
+        hit!(test, tp)
+      end
+      @current_tracepoint&.enable
+    end
+
+    def stop
+      @current_tracepoint&.disable
+    end
+
+    def skip?(test, test_location, test_source)
+      test_location_rel = relative_path(test_location)
+      @test_source_mapping.fetch(test_location_rel) do
+        @test_source_mapping[test_location_rel] = {}
+      end[test] = Digest::SHA1.hexdigest(test_source)
+      return false unless
+        @test_mapping.key?(test) && @test_source_mapping[test_location_rel][test] == @source_mapping.dig(
+          test_location_rel, test
+        )
+
+      sources = @test_mapping[test]
+      sources.map do |file, methods|
+        @current_source_mapping[file] ||= Flutter::Parser.new(file).signatures
+        methods.map do |method|
+          @source_mapping.dig(file, method) == @current_source_mapping.dig(file, method)
+        end.all?
+      end.all?
+    end
+
+    def persist!
+      @storage.update_test_mapping!(@test_mapping)
+      @storage.update_source_mapping!(generate_source_mapping)
+      @storage.persist!
+    end
+
+    def reset!
+      @storage.clear!
+      @source_mapping.clear
+      @test_mapping.clear
+    end
+
+    def to_s
+      @storage.to_s
+    end
+
+    attr_reader :mapping
+
+    private
+
+    def hit!(test, tracepoint)
+      return unless File.exist?(tracepoint.path)
+
+      if tracked?(tracepoint.path, tracepoint.callee_id)
+        rel_path = relative_path(tracepoint.path)
+        prefix = method_prefix(tracepoint.defined_class)
+        @test_mapping.fetch(test) do
+          @test_mapping[test] = {}
+        end.fetch(rel_path) { @test_mapping[test][rel_path] = Set.new } << (
+          prefix ? "#{prefix}#{tracepoint.callee_id}" : tracepoint.callee_id
+        )
+      end
+    end
+
+    def relative_path(file)
+      @path_mapping[file] ||= Pathname.new(file).relative_path_from(Dir.pwd).to_s
+    end
+
+    ##
+    # Returns a prefix based on Tracepoint.defined_class
+    #
+    # @param [Class] tracepoint_class
+    # @return [String]
+    #
+    def method_prefix(tracepoint_class)
+      return unless tracepoint_class
+
+      @method_prefixes[tracepoint_class] ||= if tracepoint_class.to_s.start_with?("#<Class")
+        if tracepoint_class.superclass.name && tracepoint_class.to_s.include?(tracepoint_class.superclass.name)
+          "#{tracepoint_class.superclass.name}::"
+        else
+          tracepoint_class.to_s.sub(/#<Class:(.*?)(\(.*?\))?>/, '\1::')
+        end
+      else
+        "#{tracepoint_class.name}:"
+      end
+    end
+
+    def tracked?(file, _method)
+      @tracked_files.fetch(file) do
+        @sources.any?(->(source) { File.fnmatch?(source, file) }) && !@exclusions.any?(->(exclusion) {
+          File.fnmatch?(exclusion, file)
+        })
+      end
+    end
+
+    def generate_source_mapping
+      @test_mapping.map { |_k, v| v.keys }.flatten.uniq.map do |file|
+        [file, @current_source_mapping.fetch(file) { Flutter::Parser.new(file).signatures }]
+      end.to_h.deep_merge(@test_source_mapping)
+    end
+  end
+end

data/lib/flutter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Flutter
+  VERSION = "0.1.0.pre.2"
+end

data/lib/flutter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "flutter/version"
+require_relative "flutter/config"
+require_relative "flutter/minitest"
+require_relative "flutter/rspec"
+require_relative "flutter/persistence"
+
+module Flutter
+  class Error < StandardError; end
+  include Flutter::Config
+end

data/lib/minitest/flutter_plugin.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "flutter"
+require "flutter/tracker"
+require "flutter/minitest"
+
+module Minitest
+  class << self
+    def plugin_flutter_init(options)
+      if Flutter.enabled
+        Flutter::Minitest.flutter_tracker.reset! if Flutter.config.reset_storage
+        reporter << Flutter::Minitest::Reporter.new(options)
+      end
+    end
+  end
+end

data/sig/flutter.rbs

@@ -0,0 +1,4 @@
+module Flutter
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: flutter
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.2
+platform: ruby
+authors:
+- Ali-Akber Saifee
+- Ankita Gupta
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  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: dry-configurable
+  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: parser
+  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'
+description: "Flutter plugs in to your RSpec or Minitest test suites\n  and helps
+  you run only the tests that exercise the code you have changed since the last run\n
+  \ "
+email:
+- ali@indydevs.org
+- ankita@indydevs.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".overcommit.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- integration_tests/minitest/grape_app/.gitignore
+- integration_tests/minitest/grape_app/.ruby-version
+- integration_tests/minitest/grape_app/Gemfile
+- integration_tests/minitest/grape_app/Gemfile.lock
+- integration_tests/minitest/grape_app/README.md
+- integration_tests/minitest/grape_app/Rakefile
+- integration_tests/minitest/grape_app/api/api.rb
+- integration_tests/minitest/grape_app/api/routes/api_helpers.rb
+- integration_tests/minitest/grape_app/api/routes/change_request/api.rb
+- integration_tests/minitest/grape_app/api/routes/change_request/response_entity.rb
+- integration_tests/minitest/grape_app/api/routes/event/api.rb
+- integration_tests/minitest/grape_app/api/routes/event/response_entity.rb
+- integration_tests/minitest/grape_app/api/routes/project/api.rb
+- integration_tests/minitest/grape_app/api/routes/project/response_entity.rb
+- integration_tests/minitest/grape_app/api/routes/property/api.rb
+- integration_tests/minitest/grape_app/api/routes/property/response_entity.rb
+- integration_tests/minitest/grape_app/api/routes/trackable_object/api.rb
+- integration_tests/minitest/grape_app/api/routes/trackable_object/response_entity.rb
+- integration_tests/minitest/grape_app/api/routes/tracking_spec/api.rb
+- integration_tests/minitest/grape_app/api/routes/tracking_spec/response_entity.rb
+- integration_tests/minitest/grape_app/api/routes/tracking_spec/spec_response.rb
+- integration_tests/minitest/grape_app/api/routes/user/api.rb
+- integration_tests/minitest/grape_app/api/routes/user/response_entity.rb
+- integration_tests/minitest/grape_app/app/app.rb
+- integration_tests/minitest/grape_app/app/change_request/endpoint.rb
+- integration_tests/minitest/grape_app/app/change_request/generate_system_changes.rb
+- integration_tests/minitest/grape_app/app/change_request/service.rb
+- integration_tests/minitest/grape_app/app/event/endpoint.rb
+- integration_tests/minitest/grape_app/app/event/service.rb
+- integration_tests/minitest/grape_app/app/event/validator.rb
+- integration_tests/minitest/grape_app/app/project/endpoint.rb
+- integration_tests/minitest/grape_app/app/project/service.rb
+- integration_tests/minitest/grape_app/app/property/endpoint.rb
+- integration_tests/minitest/grape_app/app/property/service.rb
+- integration_tests/minitest/grape_app/app/trackable_object/endpoint.rb
+- integration_tests/minitest/grape_app/app/trackable_object/service.rb
+- integration_tests/minitest/grape_app/app/trackable_object/validator.rb
+- integration_tests/minitest/grape_app/app/tracking_spec/endpoint.rb
+- integration_tests/minitest/grape_app/app/tracking_spec/expand_tracking_spec_events.rb
+- integration_tests/minitest/grape_app/app/tracking_spec/service.rb
+- integration_tests/minitest/grape_app/app/tracking_spec/validator.rb
+- integration_tests/minitest/grape_app/app/utils/errors/api_exceptions.rb
+- integration_tests/minitest/grape_app/app/utils/errors/service_exceptions.rb
+- integration_tests/minitest/grape_app/app/versioned_entity/entity.rb
+- integration_tests/minitest/grape_app/app/versioned_entity/service.rb
+- integration_tests/minitest/grape_app/app/versioned_entity/validator.rb
+- integration_tests/minitest/grape_app/app/versioned_entity_snapshot/entity.rb
+- integration_tests/minitest/grape_app/config.ru
+- integration_tests/minitest/grape_app/config/boot.rb
+- integration_tests/minitest/grape_app/db/proto/change_request.rb
+- integration_tests/minitest/grape_app/db/proto/common/doc.rb
+- integration_tests/minitest/grape_app/db/proto/event.rb
+- integration_tests/minitest/grape_app/db/proto/event_snapshot.rb
+- integration_tests/minitest/grape_app/db/proto/project.rb
+- integration_tests/minitest/grape_app/db/proto/property.rb
+- integration_tests/minitest/grape_app/db/proto/property_snapshot.rb
+- integration_tests/minitest/grape_app/db/proto/trackable_object.rb
+- integration_tests/minitest/grape_app/db/proto/trackable_object_snapshot.rb
+- integration_tests/minitest/grape_app/db/proto/tracking_spec.rb
+- integration_tests/minitest/grape_app/test/api/functional/event_test.rb
+- integration_tests/minitest/grape_app/test/api/functional/property_test.rb
+- integration_tests/minitest/grape_app/test/api/functional/trackable_object_test.rb
+- integration_tests/minitest/grape_app/test/api/functional/tracking_spec_test.rb
+- integration_tests/minitest/grape_app/test/api/functional/user_test.rb
+- integration_tests/minitest/grape_app/test/api/functional/versioned_entity_helper.rb
+- integration_tests/minitest/grape_app/test/fixtures/change_requests.rb
+- integration_tests/minitest/grape_app/test/fixtures/event_snapshots.rb
+- integration_tests/minitest/grape_app/test/fixtures/events.rb
+- integration_tests/minitest/grape_app/test/fixtures/properties.rb
+- integration_tests/minitest/grape_app/test/fixtures/property_snapshots.rb
+- integration_tests/minitest/grape_app/test/fixtures/sample_tracking_spec.json
+- integration_tests/minitest/grape_app/test/fixtures/trackable_objects.rb
+- integration_tests/minitest/grape_app/test/fixtures/trackable_objects_snapshots.rb
+- integration_tests/minitest/grape_app/test/fixtures/tracking_specs.rb
+- integration_tests/minitest/grape_app/test/test_helper.rb
+- lib/flutter.rb
+- lib/flutter/config.rb
+- lib/flutter/minitest.rb
+- lib/flutter/parser.rb
+- lib/flutter/persistence.rb
+- lib/flutter/rspec.rb
+- lib/flutter/tracker.rb
+- lib/flutter/version.rb
+- lib/minitest/flutter_plugin.rb
+- sig/flutter.rbs
+homepage: https://github.com/indydevs/flutter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/indydevs/flutter
+  source_code_uri: https://github.com/indydevs/flutter
+  changelog_uri: https://github.com/indydevs/flutter/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Intelligent test selection based on incremental code changes
+test_files: []