test_file_finder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b01e368369d161afd0766f1ea95a296b16dc8cb5e3f20d5c8e7abf7910e8da0b
+  data.tar.gz: 442c058ea7d0ad184d5fe31d697cb9f0f3058b1fe09e03717cf8d12bbadaa5cc
+SHA512:
+  metadata.gz: 70f2284e0d24b68b4a426acd9d42c02a4886c64e258282339459ae4df8ae5da73484916f78b3ca774b8619d88666dc40041f6820f306def6fc5f10d70a143033
+  data.tar.gz: ccfc5613ed9250411a4e2623ddcf650d2a982e7631d0d3bdb12b820278bfa07c7c0f3595424f925bfc78324c54ba1106dd2180e9bf802756c2dc0037172672dc

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.byebug_history
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+rspec:
+  script: bundle; bundle exec rspec
+  rules:
+    - if: $CI
+
+check-executable:
+  script: bash tff_test.sh
+  rules:
+    - if: $CI

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in test_file_finder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    test_file_finder (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  test_file_finder!
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -0,0 +1,53 @@
+# TestFileFinder
+
+A Ruby gem for deteting test files associated with input files.
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'test_file_finder', git: 'https://gitlab.com/gitlab-org/ci-cd/test_file_finder.git'
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+## Usage
+
+### Ruby
+
+The FileFinder class has exactly one method (`#test_files`) that returns existing test files likely to be associated with the files you passed into `#initialize`:
+
+```ruby
+TestFileFinder::FileFinder.new(paths: file_paths).test_files
+```
+
+### Command Line
+
+TestFileFinder is packed up into the `tff` executable, which can be used from the command line:
+
+```bash
+$ file_paths="app/models/widget.rb"
+$ tff $file_paths
+spec/models/widget_spec.rb
+```
+
+You can use it in a script, for example:
+
+```bash
+$ rspec $(tff $(git diff --name-only master..head))
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and merge requests are welcome in GitLab at <https://gitlab.com/gitlab-org/ci-cd/test_file_finder>.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'test_file_finder'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/tff

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'test_file_finder'
+
+puts TestFileFinder::FileFinder.new(paths: ARGV).test_files

data/lib/test_file_finder.rb

@@ -0,0 +1,6 @@
+require 'test_file_finder/version'
+require 'test_file_finder/file_finder'
+
+module TestFileFinder
+  class Error < StandardError; end
+end

data/lib/test_file_finder/file_finder.rb

@@ -0,0 +1,47 @@
+class TestFileFinder::FileFinder
+
+  def initialize(paths: [])
+    @paths = [paths].flatten
+  end
+
+  def test_files
+    search
+  end
+
+  private
+
+  attr_reader :paths
+
+  def search
+    file_path_guesses.select { |path| File.exist?(path) }
+  end
+
+  def file_path_guesses
+    paths.map do |path|
+      guess_test_files_for(path)
+    end.compact.uniq
+  end
+
+  def context
+    {
+      app:      %r{^app/(.+)\.rb$},
+      lib:      %r{^lib/(.+)\.rb$},
+      spec:     %r{^spec/(.+)_spec.rb$},
+      spec_dir: 'spec',
+    }
+  end
+
+  def guess_test_files_for(path)
+    if (match = context[:app]&.match(path))
+      return "#{context[:spec_dir]}/#{match[1]}_spec.rb"
+    end
+
+    if (match = context[:lib]&.match(path))
+      return "#{context[:spec_dir]}/lib/#{match[1]}_spec.rb"
+    end
+
+    if context[:spec]&.match(path)
+      return path
+    end
+  end
+end

data/lib/test_file_finder/version.rb

@@ -0,0 +1,3 @@
+module TestFileFinder
+  VERSION = '0.0.1'
+end

data/test_file_finder.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'test_file_finder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'test_file_finder'
+  spec.version       = TestFileFinder::VERSION
+  spec.authors       = ['drew cimino']
+  spec.email         = ['dscimino@gmail.com']
+
+  spec.summary       = %q{Guesses spec file paths given input file paths.}
+  spec.description   = %q{A command-line tool for guessing which spec files are relavant to a passed-in set of file paths.}
+  spec.homepage      = 'https://gitlab.com/gitlab-org/ci-cd/test-file-finder'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://gitlab.com/gitlab-org/ci-cd/test-file-finder/-/tree/master'
+    spec.metadata['changelog_uri'] = 'https://gitlab.com/gitlab-org/ci-cd/test-file-finder/-/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'byebug'
+end

data/tff_test.sh

@@ -0,0 +1,16 @@
+
+expected="spec/models/test_file_finder_gem_executable_widget_spec.rb"
+mkdir -p "spec/models"
+echo "existing specs" >> $expected
+
+actual=$( ruby -Ilib exe/tff app/models/test_file_finder_gem_executable_widget.rb)
+rm $expected
+
+if [[ -n $actual && $expected = $actual ]]
+then
+	echo "Executable verified"
+	exit 0
+else
+	echo "Could not verify executable"
+	exit 1
+fi

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: test_file_finder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- drew cimino
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: 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'
+description: A command-line tool for guessing which spec files are relavant to a passed-in
+  set of file paths.
+email:
+- dscimino@gmail.com
+executables:
+- tff
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tff
+- lib/test_file_finder.rb
+- lib/test_file_finder/file_finder.rb
+- lib/test_file_finder/version.rb
+- test_file_finder.gemspec
+- tff_test.sh
+homepage: https://gitlab.com/gitlab-org/ci-cd/test-file-finder
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://gitlab.com/gitlab-org/ci-cd/test-file-finder
+  source_code_uri: https://gitlab.com/gitlab-org/ci-cd/test-file-finder/-/tree/master
+  changelog_uri: https://gitlab.com/gitlab-org/ci-cd/test-file-finder/-/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Guesses spec file paths given input file paths.
+test_files: []