flutter 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ca2f5eb98359bf0cbac8abbdedcbe6ca27ec7bf205625f44cf0c4150313eeb4
-  data.tar.gz: 6620320c3c54d63117ddc95550c0d4223411bfe9b6b469336fe9f60ffcddcfe3
+  metadata.gz: d3929d7a4586b20232226e254f271162bba4ee4a8212bd65a59b1a06c371d9f3
+  data.tar.gz: ed09b644a323dd8fc4dccb380a6212d272fb283708e9edbdc42487cd82728513
 SHA512:
-  metadata.gz: 6f97e5720ea6fd890e4c6283a1193750eea3c1ffa64de2de550793cecb14f8636a205774a08811a3f4aea35ed5a764023603fa91a33bd0b4d00496925f4ab35c
-  data.tar.gz: 7f890be9219df6f89fde38e9bc34479a65c9a3d8d910ec1495732a2a32ac65d33291c507b8e7b6950facca0d02b6a47c726c864ae2abde9a4416ae983096b29c
+  metadata.gz: d696e398b4e0130b48ffa9f36b5fc7371ab62b9b37670a652e736f56c202df95ca0bef74c934cc8d2c802818b10d90e80b99c902e04b3ebdcf12601d14c0a752
+  data.tar.gz: fc2e7556e864e626b9670344ef44c5d12c62321b63a48be5637082fc1213422184ee54d53ad42c9f0f7852420f1ce923d58bf2fdbfebeac6104a2307b7668f93

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider redcarpet
+--markup markdown

data/CHANGELOG.md

@@ -5,6 +5,18 @@ 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.2.2 - 2022-10-03
+### Added
+- Document configuration options in README
+
+### Changed
+- Delay requiring source files explicitely and only in the case where
+- Ensure the previous test->coverage mapping is merged with current
+
+## 0.2.1
+### Fixed
+- Corrected integration examples for guard in README
+
 ## 0.2.0
 ### Added
 - CI Recipe in README

data/Gemfile

@@ -6,6 +6,11 @@ gemspec
 
 gem "rake", "~> 13.0"
 
+group :development do
+  gem "yard", "~> 0.9.28"
+  gem "redcarpet", "~> 3.5"
+end
+
 group :test, :development do
   gem "pry", "~> 0.14.1"
   gem "overcommit", "~> 0.59.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)](https://flutter.indydevs.org)
 
 ```
  __   __
@@ -22,7 +23,7 @@ or in continuous integration environments to only run the subset of tests affect
 ## How?
 Flutter tracks each method call within the context of each test case in your test suite and persists this mapping along with
 a signature for all the methods that were exercised. On subsequent runs Flutter intercepts test enumeration and skips any test if
-all the following conditions are true:
+**ALL** the following conditions are true:
 
 - The test was seen before
 - The source of the test has not changed
@@ -42,30 +43,26 @@ all the following conditions are true:
   ```ruby
   require 'flutter'
   ```
-- Enable & configure it in your `test_helper.rb`:
+- Enable & configure it in your `test_helper.rb` (See [Configuration options](#configuration-options) for available options):
 
   ```ruby
   Flutter.configure do |config|
     config.enabled = true
-    # Paths to consider when tracking test -> source mappings. Default: Dir.pwd/*
-    config.sources = ["./app/*", "./test/*"]
-    # Paths to ignore for tracking test -> source. Default: ./vendor
-    config.exclusions = ["./vendor/*"]
-    # Storage type. Default: Flutter::Persistence::Marshal
-    config.storage_class = Flutter::Persistence::Marshal
-    # Where to store the state. Default: ./.flutter
-    config.storage_options = {path: "./.flutter"}
-    # Whether to reset the stored state before the test run. Default: false
-    config.reset_storage = false
   end
   ```
+- Run your test suite the way you normally would (for example: `bundle exec rake test`). The first run will run all
+  tests. After the test run has completed the mapping of test cases to exercised code will be persisted in the `./.flutter`
+  folder.
+- Now make changes and run the test suite again. Only the relevant tests will be executed.
 
 #### 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
 ```
 
@@ -81,31 +78,43 @@ end
   ```ruby
   require 'flutter'
   ```
-- Enable & configure it in your `spec_helper.rb`:
+- Enable & configure it in your `spec_helper.rb` (See [Configuration options](#configuration-options) for available options):
 
   ```ruby
   Flutter.configure do |config|
     config.enabled = true
-    # Paths to consider when tracking test -> source mappings. Default: Dir.pwd/*
-    config.sources = ["./app/*", "./test/*"]
-    # Paths to ignore for tracking test -> source. Default: ./vendor
-    config.exclusions = ["./vendor/*"]
-    # Storage type. Default: Flutter::Persistence::Marshal
-    config.storage_class = Flutter::Persistence::Marshal
-    # Where to store the state. Default: ./.flutter
-    config.storage_options = {path: "./.flutter"}
-    # Whether to reset the stored state before the test run. Default: false
-    config.reset_storage = false
   end
   ```
+- Run your specs the way you normally would (for example: `bundle exec rspec`). The first run will run all
+  tests. After the test run has completed the mapping of test cases to exercised code will be persisted in the `./.flutter`
+  folder.
+- Now make changes and run rspec again. Only the relevant examples will be executed.
+
 #### 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
 ```
+
+### Configuration options
+|      option       | Description                                                    |                  Type                   |             Default             |
+|:-----------------:|:---------------------------------------------------------------|:---------------------------------------:|:-------------------------------:|
+|     `enabled`     | Whether flutter is enabled                                     |         `TrueClass, FalseClass`         |             `true`              |
+|     `sources`     | List of glob style expressions to select source files to track |                  `Set`                  |       `["#{Dir.pwd}/*"]`        |
+|   `exclusions`    | List of glob style expressions to exclude sources files        |                  `Set`                  |   `["#{Dir.pwd}/vendor}/*"]`    |
+|  `storage_class`  | The storage class to use for persisting the state              | `Flutter::Persistence::AbstractStorage` | `Flutter::Persistence::Marshal` |
+| `storage_options` | Additional options to pass to the storage class                |                 `Hash`                  |     `{path: './.flutter'}`      |
+|  `reset_storage`  | Whether to clear the persisted state on initialization         |         `TrueClass, FalseClass`         |             `false`             |
+
+
+
+
+
 ## Configuring flutter in continuous integration
 
 Flutter can be used in continuous integration environments to speed up the turn
@@ -174,9 +183,9 @@ To install this gem onto your local machine, run `bundle exec rake install`.
   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"]`
+  - Patch release `bundle exec rake release["patch"]`
+  - Minor release `bundle exec rake release["minor"]`
+  - Major release `bundle exec rake release["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.

data/Rakefile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "date"
 require "rake/testtask"
 require "keepachangelog"
 
@@ -27,11 +28,11 @@ 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, _|
+  sh("gem bump --pretend -v #{args[:version]}") do |ok, _|
     if ok
-      new_version = %x(gem bump --no-commit #{args[:version]} | awk '{print $4}' | uniq).chomp
+      new_version = %x(gem bump --no-commit -v #{args[:version]} | awk '{print $4}' | uniq).chomp
       parser.parsed_content["versions"]["Unreleased"] = { "url" => nil, "date" => nil, "changes" => {} }
-      parser.parsed_content["versions"][new_version] = log
+      parser.parsed_content["versions"]["#{new_version} - #{Date.today}"] = log
       File.open("CHANGELOG.md", "w") do |file|
         file.write(parser.to_md)
       end
@@ -49,10 +50,8 @@ task :release_notes, [:version] do |_t, args|
   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 }
+  parser.parsed_content["versions"] = parser.parsed_content["versions"].select { |k, _v| k.start_with?(version) }
   lines = parser.to_md.split("\n")
-  chunk = ["## #{version}"] + (
-    lines.slice_after { |line| line.include?("## #{version}") }.to_a[1] || []
-  )
+  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/lib/flutter/minitest.rb

@@ -62,7 +62,7 @@ module Flutter
       end
 
       def before_teardown
-        Minitest.flutter_tracker&.stop if ::Flutter.enabled
+        Minitest.flutter_tracker&.stop(location, failures.empty?) if ::Flutter.enabled
         super
       end
     end

data/lib/flutter/parser.rb

@@ -51,9 +51,14 @@ module Flutter
     end
 
     def build_signatures
-      require_relative @file
       @targets.each do |container|
-        instance = Kernel.const_get(container)
+        begin
+          instance = Kernel.const_get(container)
+        rescue NameError
+          require_relative @file
+          instance = Kernel.const_get(container)
+        end
+
         class_methods = instance.methods + instance.private_methods
         instance_methods = instance.instance_methods + instance.private_instance_methods
 
@@ -65,11 +70,12 @@ module Flutter
           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}"
+      rescue
+        warn("Failed to parse #{@file}")
+        break
       end
     rescue LoadError
-      $stderr.puts "failed to inspect #{@file}"
+      warn("Failed to inspect #{@file}")
     end
 
     def source_hash(callable)

data/lib/flutter/rspec.rb

@@ -52,7 +52,8 @@ if defined?(RSpec.configure)
     config.around(:each) do |example|
       Flutter::RSpec.tracker.start(example.full_description) if Flutter.enabled
       example.run
-      Flutter::RSpec.tracker.stop if Flutter.enabled
+      Flutter::RSpec.tracker.stop(example.full_description,
+        example.execution_result.exception.nil?) if Flutter.enabled
     end
 
     config.after(:suite) do

data/lib/flutter/tracker.rb

@@ -26,6 +26,7 @@ module Flutter
       @exclusions = exclusions.map { |s| File.absolute_path(s) }
       @storage = storage_class.new(**storage_options)
       @test_mapping = @storage.test_mapping
+      @previous_test_mapping = {}
       @test_source_mapping = {}
       @source_mapping = @storage.source_mapping
       @current_source_mapping = {}
@@ -39,7 +40,7 @@ module Flutter
     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)
+      @previous_test_mapping[test] = @test_mapping.delete(test)
       @current_tracepoint = TracePoint.new(:call) do |tp|
         hit!(test, tp)
       end
@@ -47,8 +48,11 @@ module Flutter
     end
 
     # End tracking (should be called after a call to {#start})
-    def stop
+    # @param [String] test A unique identifier for the test
+    # @param [TrueClass, FalseClass] success Whether the test succeeded
+    def stop(test, success)
       @current_tracepoint&.disable
+      @test_mapping[test].merge!(@previous_test_mapping.delete(test) || {}) { |_, old, new| old + new } unless success
     end
 
     ##

data/lib/flutter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flutter
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/flutter.rb

@@ -7,6 +7,5 @@ require_relative "flutter/rspec"
 require_relative "flutter/persistence"
 
 module Flutter
-  class Error < StandardError; end
   include Flutter::Config
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flutter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Ali-Akber Saifee
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-01 00:00:00.000000000 Z
+date: 2022-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -65,6 +65,7 @@ extra_rdoc_files: []
 files:
 - ".overcommit.yml"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -84,13 +85,15 @@ files:
 - lib/flutter/version.rb
 - lib/minitest/flutter_plugin.rb
 - sig/flutter.rbs
-homepage: https://github.com/indydevs/flutter
+homepage: https://flutter.indydevs.org
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/indydevs/flutter
+  homepage_uri: https://flutter.indydevs.org
   source_code_uri: https://github.com/indydevs/flutter
+  bug_tracker_uri: https://github.com/indydevs/flutter/issues
   changelog_uri: https://github.com/indydevs/flutter/blob/master/CHANGELOG.md
+  ducmentation_uri: https://flutter.indydevs.org
 post_install_message: 
 rdoc_options: []
 require_paths: