flutter 0.1.0.pre.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdffa233de57141c16bbbd41684ca85b04208b32edeec97625662383f4e3e753
-  data.tar.gz: be3eb7f6bb1d0ffd8123ad4b8c2293ecdaf4c3979c75be8471542a2c26e1d771
+  metadata.gz: cbd8d330334676bcfcb2d328466c569bd561ed05a7fd3a45e880cace5670af56
+  data.tar.gz: 5b4fcd28bb14fa1a6fd5b9c834abbd5bf368c56e7496b574864f2f443d7effb5
 SHA512:
-  metadata.gz: e301754a8492f5eaae1ba2388fe39c4d1fe2250b61bb7b792025d646e96719bd1df76a1ed8f669a821107e4e12f54b89c070671f5b86c29d24eae7bf2a3de3d7
-  data.tar.gz: 4e69808a87b89d50f3d7fcf964ae3a2d5ccc176294e7f610e00d5ffb712131384ff24bb64e630e1ef1f5df1afac7f2175c986d031b4ada8dba9af37df00c930d
+  metadata.gz: e6720c70a784f3b6862d7bc07749465fbf5834fb1c6b7fe19b76caa7c0fd52bec2e0b79fc9100385dcc878881ec77199f7e8ff34e0105f5d272b806eeb12ef06
+  data.tar.gz: 4cd2b8a88705a44a6b1f28159e01bc8f0e2aed6f54caf287617d81a2ebd823ddcc02ec0867110f7d38da4c5b3541d491cb366e82fd9d94bad319ca7588c74d6d

data/CHANGELOG.md

@@ -4,17 +4,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
-## [0.1.0.pre.3]
+## Unreleased
+## Fixed
+- Corrected integration examples for guard in README
+## 0.2.1
+## 0.2.0
 ### Added
-  - Improved documentation for Tracker
-  - Improved documentation for Persistance classes
+- CI Recipe in README
+- CI integration for incremental tests in branches/pull requests
+- Release workflow tasks & github actions integration
+
+### Fixed
+- Ensure all methods (including inherited ones) are considered when calculating signatures for a class or module.
+- Fix calculation of total / filtered examples for rspec integration
+
+## 0.1.0.pre.3
+### Added
+- Improved documentation for Persistence classes
+- Improved documentation for Tracker
 
 ### Changed
-  - Pinned dependencies to known working minimum versions
+- Pinned dependencies to known working minimum versions
 
-## [0.1.0.pre.2]
+## 0.1.0.pre.2
 ### Added
-  - Minitest integration
-  - RSpec integration
+- Minitest integration
+- RSpec integration
 

data/Gemfile

@@ -11,6 +11,7 @@ group :test, :development do
   gem "overcommit", "~> 0.59.1"
   gem "gem-release", "~> 2.2"
   gem "guard", "~> 2.18"
+  gem "keepachangelog", "~> 0.6.1"
   gem "rubocop", "~> 1.21"
   gem "rubocop-shopify", require: false
   gem "rubocop-minitest", "~> 0.22.1"

data/Guardfile

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 guard :minitest, test_folders: ["test"] do
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { "test" }
+  watch(%r{^(test|lib)/(.*/)?([^/]+)\.rb$}) { "test" }
 end
 
-guard :rspec, cmd: "rspec" do
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { "spec" }
+guard :rspec, cmd: "rspec", all_on_start: true do
+  watch(%r{^(spec|lib)/(.*/)?([^/]+)\.rb$}) { "spec" }
 end

data/README.md

@@ -3,6 +3,7 @@
 [![CI](https://github.com/indydevs/flutter/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/indydevs/flutter/actions/workflows/main.yml)
 [![codecov](https://codecov.io/github/indydevs/flutter/branch/main/graph/badge.svg?token=XANF37D9C1)](https://codecov.io/github/indydevs/flutter)
 [![Gem](https://img.shields.io/gem/v/flutter)](https://rubygems.org/gems/flutter)
+[![Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/flutter)
 
 ```
  __   __
@@ -61,11 +62,13 @@ all the following conditions are true:
   ```
 
 #### With guard
-Add the following to your `Guardfile`:
+Using the same configuration as above (and assuming that the application
+sources are in the `./lib` folder while the tests are in the `./test` folder)
+add the following to your `Guardfile`:
 
 ```ruby
 guard :minitest, test_folders: ["test"] do
-  watch(%r{^{test,lib}/(.*/)?([^/]+)\.rb$}) { "test" }
+  watch(%r{^(test|lib)/(.*/)?([^/]+)\.rb$}) { "test" }
 end
 ```
 
@@ -87,7 +90,7 @@ end
   Flutter.configure do |config|
     config.enabled = true
     # Paths to consider when tracking test -> source mappings. Default: Dir.pwd/*
-    config.sources = ["./app/*", "./test/*"]
+    config.sources = ["./app/*", "./lib/*", "./spec/*"]
     # Paths to ignore for tracking test -> source. Default: ./vendor
     config.exclusions = ["./vendor/*"]
     # Storage type. Default: Flutter::Persistence::Marshal
@@ -99,15 +102,65 @@ end
   end
   ```
 #### With guard
-Using the same configuration as above add the following to your `Guardfile`:
+Using the same configuration as above (and assuming that the application
+sources are in the `./app` & `./lib` folders while the specs are in the `./spec` folder)
+add the following to your `Guardfile`:
 
 ```ruby
 guard :rspec, cmd: "rspec" do
-  watch(%r{^{spec,lib}/(.*/)?([^/]+)\.rb$}) { "spec" }
+  watch(%r{^(spec|app|lib)/(.*/)?([^/]+)\.rb$}) { "spec" }
 end
 ```
 ## Configuring flutter in continuous integration
-**TODO**
+
+Flutter can be used in continuous integration environments to speed up the turn
+around time from running tests by only running tests affected by the changes
+in a pull request.
+
+### Github Actions
+The following example workflow with github actions does the following:
+- Always run all tests on the `main` branch
+- Only run tests affected by the "current" commit for CI workflows triggered by a `push` event on other branches
+- If the CI workflow is triggered due to a `pull_request` event, run all tests affected by all commits in the branch
+  (by comparing against the branch point of the pull request)
+
+```yaml
+    # Get the commit where this branch diverges from origin/main
+    - name: Retrieve branch point
+      if: github.event_name == 'pull_request'
+      run: |
+        echo "::set-output name=KEY::$(diff -u <(git rev-list --first-parent origin/main) <(git rev-list --first-parent HEAD) | sed -ne 's/^ //p' | head -1)"
+      id: cache_keys
+    # Use the always-upload-cache action to:
+    #  - Restore the flutter state from cache from either the branch point (if it was set in the previous step)
+    #    or the last run in the current branch
+    #  - After the run cache the flutter state using the current commit hash as the hash key
+    - name: Setup flutter state
+      id: flutter-state
+      uses: pat-s/always-upload-cache@v2.1.5
+      env:
+        cache-name: cache-flutter-state
+      with:
+        path: .flutter
+        key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ matrix.ruby-version }}-${{ github.sha }}
+        restore-keys: |
+          ${{ runner.os }}-build-${{ env.cache-name }}-${{ matrix.ruby-version }}-${{ steps.cache_keys.outputs.KEY }}
+    # If this is a push event on the main branch, clear the flutter state
+    # so that all tests are run and a full state is cached on the main branch
+    - name: Clear flutter state
+      if: github.event_name == 'push' && startsWith(github.ref, 'refs/heads/main')
+      run: rm -rf .flutter
+```
+> **Note**
+> The exact CI configuration would ofcourse depend on your workflow and confidence in selectively
+> running tests for pull requests.
+
+> **Warning**
+> Selectively running tests in a pull request would show a drop in coverage if you are collecting
+> and/or using code coverage as a "Check". One way to make Flutter work hand in hand with code
+> coverage checks is to only validate that the diff in the pull request has a 100% coverage. For
+> example with [codecov](https://docs.codecov.com/docs/commit-status#section-project-status) this can be
+> achieved by only enabling the `project` status for the main branch and `patch` status otherwise.
 
 ## Related work
 
@@ -119,9 +172,19 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 This project uses [overcommit](https://github.com/sds/overcommit) to enforce standards. Enable the precommit hooks in your local checkout by running: `overcommit --sign`
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number by running `gem bump`,
-then move the `Unreleased` entries in the [CHANGELOG](./CHANGELOG.md) to the new version and commit that.
-Finally tag and release the gem with `gem tag` and `gem release`
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Releasing a new version
+- Ensure that the [Unreleased](./CHANGELOG.md#Unreleased) section of the changelog is up to date
+  and contains useful details.
+- Create a new release using the `release` rake task as follows (for more details about specifying the version change
+  run `gem bump --help` which is the command used by the task):
+  - Patch release `bundle exec rake release["-v patch"]`
+  - Minor release `bundle exec rake release["-v minor"]`
+  - Major release `bundle exec rake release["-v major"]`
+  > **Note**
+  > The `release` rake task automates updating the changelog & version, committing the changes & creating a new tag
+- Push the tag. The CI workflow for tag pushes will take care of publishing the gem & creating a github release.
 
 ## Contributing
 

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
 require "rake/testtask"
+require "keepachangelog"
 
 Rake::TestTask.new(:unit) do |t|
   t.libs << "test"
@@ -22,3 +22,35 @@ RSpec::Core::RakeTask.new(:spec)
 
 task test: [:unit, :spec]
 task default: [:test, :spec, "rubocop:autocorrect_all"]
+
+desc "Increment the version, update changelog and create a tag for the release"
+task :release, [:version] do |_t, args|
+  parser = Keepachangelog::MarkdownParser.load("CHANGELOG.md")
+  log = parser.parsed_content["versions"].delete("Unreleased")
+  sh("gem bump --pretend #{args[:version]}") do |ok, _|
+    if ok
+      new_version = %x(gem bump --no-commit #{args[:version]} | awk '{print $4}' | uniq).chomp
+      parser.parsed_content["versions"]["Unreleased"] = { "url" => nil, "date" => nil, "changes" => {} }
+      parser.parsed_content["versions"][new_version] = log
+      File.open("CHANGELOG.md", "w") do |file|
+        file.write(parser.to_md)
+      end
+      %x(git add CHANGELOG.md lib/flutter/version.rb)
+      %x(git commit -m "Bump flutter to #{new_version}")
+      %x(gem tag -s)
+      Rake::Task["release_notes"].execute({ version: new_version })
+    end
+  end
+end
+
+desc "Get release notes for the current or specific version"
+task :release_notes, [:version] do |_t, args|
+  version = (args[:version] || Flutter::VERSION)
+  parser = Keepachangelog::MarkdownParser.load("CHANGELOG.md")
+  parser.parsed_content.delete("intro")
+  parser.parsed_content.delete("title")
+  parser.parsed_content["versions"] = parser.parsed_content["versions"].select { |k, _v| k == version }
+  lines = parser.to_md.split("\n")
+  chunk = lines.slice_after { |line| line.include?("## #{version}") }.to_a[1] || []
+  puts chunk.join("\n")
+end

data/TODO.md

@@ -8,7 +8,7 @@
 
 ## Code quality
 - [ ] Separate public/private API
-- [ ] Add rdoc / yard documentation
+- [x] Add rdoc / yard documentation
 
 ## Testing
 - [x] Improve test coverage
@@ -26,5 +26,5 @@
 ## Usability
 - [x] Quick start guide
 - [x] Recipes for guard
-- [ ] Recipes for CI
+- [x] Recipes for CI
 

data/codecov.yml

@@ -0,0 +1,13 @@
+coverage:
+  status:
+    project:
+      default:
+        paths:
+          - "lib"
+        branches:
+          - main
+    patch:
+      default:
+        paths:
+          - "lib"
+        informational: false

data/lib/flutter/minitest.rb

@@ -10,7 +10,7 @@ end
 module Flutter
   module Minitest
     class << self
-      attr_accessor :filtered
+      attr_accessor :filtered, :total
 
       def flutter_tracker
         @tracker ||= Flutter::Tracker.new(
@@ -31,7 +31,7 @@ module Flutter
           return unless ::Flutter.enabled
 
           Flutter::Minitest.flutter_tracker.persist!
-          $stdout.puts "Flutter filtered out #{Flutter::Minitest.filtered} tests"
+          $stdout.puts "Flutter filtered #{Flutter::Minitest.filtered} / #{Flutter::Minitest.total} tests"
           if @verbose
             $stdout.puts "Persisted flutter #{Flutter::Minitest.flutter_tracker}"
           end
@@ -43,17 +43,15 @@ module Flutter
       module ClassMethods
         def runnable_methods
           Flutter::Minitest.filtered ||= 0
+          Flutter::Minitest.total ||= 0
           default = super()
+          Flutter::Minitest.total += default.length
           default.select do |test|
-            skip = Minitest.flutter_tracker.skip?(
+            !Minitest.flutter_tracker.skip?(
               "#{name}##{test}",
               File.absolute_path(instance_method(test).source_location[0]),
               instance_method(test).source,
-            )
-            if skip
-              Flutter::Minitest.filtered += 1
-            end
-            !skip
+            ).tap { |skip| Flutter::Minitest.filtered += 1 if skip }
           end
         end
       end

data/lib/flutter/parser.rb

@@ -8,6 +8,11 @@ module Flutter
   class Parser
     attr_reader :signatures
 
+    @method_cache = {}
+    class << self
+      attr_reader :method_cache
+    end
+
     def initialize(file)
       @signatures = {}
       @targets = Set.new
@@ -49,23 +54,17 @@ module Flutter
       require_relative @file
       @targets.each do |container|
         instance = Kernel.const_get(container)
-        class_methods = (
-          instance.methods - Object.methods
-        ) + (
-          instance.private_methods - Object.private_methods
-        )
-        instance_methods = (
-          instance.instance_methods - Object.instance_methods
-        ) + (
-          instance.private_instance_methods - Object.private_instance_methods
-        )
+        class_methods = instance.methods + instance.private_methods
+        instance_methods = instance.instance_methods + instance.private_instance_methods
 
         @signatures.merge!(class_methods.map do |method|
-          ["#{container}::#{method}", source_hash(instance.method(method))]
-        end.to_h)
+          hash = source_hash(instance.method(method))
+          ["#{container}::#{method}", hash] if hash
+        end.compact.to_h)
         @signatures.merge!(instance_methods.map do |method|
-          ["#{container}:#{method}", source_hash(instance.instance_method(method))]
-        end.to_h)
+          hash = source_hash(instance.instance_method(method))
+          ["#{container}:#{method}", hash] if hash
+        end.compact.to_h)
       rescue NameError
         $stderr.puts "failed to load #{container} in #{@file}"
       end
@@ -74,9 +73,12 @@ module Flutter
     end
 
     def source_hash(callable)
-      Digest::SHA1.hexdigest(callable.source)
+      return unless callable.source_location
+
+      sep = callable.is_a?(UnboundMethod) ? ":" : "::"
+      Parser.method_cache["#{callable.owner}#{sep}#{callable.name}"] ||= Digest::SHA1.hexdigest(callable.source)
     rescue MethodSource::SourceNotFoundError
-      "<no-source>"
+      nil
     end
   end
 end

data/lib/flutter/rspec.rb

@@ -5,7 +5,7 @@ require_relative "tracker"
 module Flutter
   module RSpec
     class << self
-      attr_accessor :filtered
+      attr_accessor :filtered, :total
 
       def tracker
         @tracker ||= Flutter::Tracker.new(
@@ -17,20 +17,20 @@ module Flutter
 
     module ClassMethods
       def filtered_examples
-        Flutter::RSpec.filtered ||= 0
+        Flutter::RSpec.filtered ||= Set.new
+        Flutter::RSpec.total ||= Set.new
         Flutter::RSpec.tracker.reset! if Flutter.enabled && Flutter.config.reset_storage
 
         original = super
+        Flutter::RSpec.total.merge(original)
         return original unless Flutter.enabled
 
         original.select do |example|
-          skip = example.metadata[:block] && Flutter::RSpec.tracker.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
+          ).tap { |skip| Flutter::RSpec.filtered << example if skip })
         end
       end
     end
@@ -58,7 +58,7 @@ if defined?(RSpec.configure)
     config.after(:suite) do
       if Flutter.enabled
         $stdout.puts
-        $stdout.puts "Flutter filtered out #{Flutter::RSpec.filtered} examples"
+        $stdout.puts "Flutter filtered #{Flutter::RSpec.filtered.length} / #{Flutter::RSpec.total.length} examples"
         Flutter::RSpec.tracker.persist!
       end
     end

data/lib/flutter/tracker.rb

@@ -98,6 +98,7 @@ module Flutter
     # that it was configured with
     # @return [void]
     def reset!
+      $stdout.puts "Resetting flutter: #{@storage}"
       @storage.clear!
       @source_mapping.clear
       @test_mapping.clear

data/lib/flutter/version.rb

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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: flutter
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Ali-Akber Saifee
 - Ankita Gupta
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-30 00:00:00.000000000 Z
+date: 2022-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -73,6 +73,7 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- codecov.yml
 - lib/flutter.rb
 - lib/flutter/config.rb
 - lib/flutter/minitest.rb
@@ -90,7 +91,7 @@ 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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -101,12 +102,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Intelligent test selection based on incremental code changes
 test_files: []