fcom 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a9b5f97f93fe24acc44065291ffb501679421adbbe099a944f4c04288d599e1
+  data.tar.gz: 5cf9ee105891ae2a84fd6c46bac5cfe368f7ec1b896c9cdd49ef618c8498c1f7
+SHA512:
+  metadata.gz: d764a10321efa1264e4d5b9b9a9d51b1e2964789f36a4660017e1c0c0d04edb6859c266649dc922e3374a65f28590ca36d3396eabd1f67ce4dfd125bf7bf4297
+  data.tar.gz: 0ed2904a35496b5a8d848f3dfc8adfdcf7af1b3af7bb019df8373ad34930fc142cae5def0af3dae9e43d86c94c36b52e5dde66171a9f0511240e3fe58011c9b3

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "03:52"
+    timezone: America/Chicago

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Run Rspec Tests
+
+on:
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - name: Run Rubocop
+      run: bin/rubocop --format clang
+    - name: Run RSpec tests
+      run: bin/rspec --format progress
+    - name: Ensure alpha version
+      run: grep alpha $(find . -type f -name version.rb)
+    - name: Ensure no git diff
+      run: git diff --exit-code && git diff-index --quiet --cached HEAD

data/.gitignore

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

data/.release_assistant.yml

@@ -0,0 +1,3 @@
+---
+git: true
+rubygems: true

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  runger_style:
+    - rulesets/default.yml # gem 'rubocop'
+    - rulesets/performance.yml # gem 'rubocop-performance'
+    - rulesets/rake.yml # gem 'rubocop-rake'
+    - rulesets/rspec.yml # gem 'rubocop-rspec'

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -0,0 +1,125 @@
+## v0.4.1 (2023-05-04)
+[no unreleased changes yet]
+
+## v0.4.0 (2022-09-29)
+[no unreleased changes yet]
+
+## v0.3.4 (2021-01-26)
+### Dependencies
+- Bump `release_assistant` to `0.1.1.alpha`
+
+## v0.3.3 (2021-01-26)
+### Internal
+- Source Rubocop rules/config from `runger_style` gem
+- Use `release_assistant` to manage releases
+- Ensure in PR CI runs that the current version contains "alpha" & that there's no git diff (e.g.
+  due to failing to run `bundle` after updating the version)
+
+## 0.3.2 - 2020-06-13
+### Tests
+- Extract RSpec performance summary reporting to a gem
+  ([rspec_performance_summary](https://github.com/davidrunger/rspec_performance_summary/))
+
+## 0.3.1 - 2020-06-06
+### Docs
+- Add note to README.md about `--init` option
+
+## 0.3.0 - 2020-06-06
+### Added
+- Add `--init` flag to automatically create an `.fcom.yml` file
+
+## 0.2.19 - 2020-06-05
+### Docs
+- Add badges to README.md (CI status, dependabot status, tag/version)
+
+## 0.2.18 - 2020-06-05
+### Tests
+- Stub `ConfigFileOptions#config_file_exists?` to return `false` in tests
+
+## 0.2.17 - 2020-06-05
+### Fixed
+- Print warning about missing `.fcom.yml` config file before executing querier
+
+## 0.2.16 - 2020-06-05
+### Tests
+- Don't print debug statement(s) when executing tests
+
+## 0.2.15 - 2020-06-05
+### Fixed
+- Don't print empty spaces before the first matching commit
+
+## 0.2.14 - 2020-06-05
+### Added
+- Print warning if `.fcom.yml` config file does not exist (or it does not specify a `repo` option)
+
+## 0.2.13 - 2020-06-05
+### Added
+- Add support for an `.fcom.yml` config file (supporting only a `repo` option at this time)
+
+## 0.2.12 - 2020-06-05
+### Docs
+- Update the illustrated `--help` output in `README.md` to reflect the `-i`/`--ignore-case` and
+  `--debug` options.
+
+## 0.2.11 - 2020-06-05
+### Tests
+- Added logging of how long each example takes to execute
+- Stubbed `Fcom::GitHelpers#repo` in tests to improve spec performance
+
+## 0.2.10 - 2020-06-05
+### Changed
+- Set `Fcom.logger.level` for both querier and parser
+
+## 0.2.9 - 2020-06-05
+### Changed
+- Specify dependency versions
+
+## 0.2.8 - 2020-06-05
+## Added
+- Add `--debug` option and only print the command(s) being executed if that option is used
+
+## Fixed
+- Added `activesupport` as a dependency of the `fcom` gem in the gemspec
+
+## Changed
+- Removed version locks for dependencies in gemspec
+
+## 0.2.7 - 2020-06-05
+### Maintenance
+- Added release script
+
+## 0.2.6 - 2020-06-05
+### Added
+- Allow searching case-insensitively via `-i`/`--ignore-case` option
+
+## 0.2.5 - 2020-06-05
+### Added
+- Allow filtering results to a specific path (directory or file) via `-p`/`--path` option
+
+### Tests
+- Don't send email notifications about Travis build results
+
+## 0.2.4 - 2019-12-31
+### Tests
+- Added tests
+
+## 0.2.3 - 2019-12-29
+### Added
+- Determine default repo name from git origin remote, if possible
+
+## 0.2.2 - 2019-12-28
+### Changed
+- Improved documentation
+
+## 0.2.1 - 2019-12-28
+### Added
+- Add `--repo` option, which is used in the GitHub links that are printed for matching commits
+
+## 0.2.0 - 2019-12-28
+### Breaking changes
+- Change how options should be provided to the `fcom` command
+- Parse command argument/options with `slop` gem
+
+## 0.1.0 - 2019-12-28
+### Added
+- Initial release

data/Gemfile

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+ruby '3.2.2'
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fcom.gemspec
+gemspec
+
+group :development, :test do
+  gem 'bundler', require: false
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'rake', require: false
+  gem 'rspec', require: false
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'runger_style', github: 'davidrunger/runger_style', require: false
+end
+
+group :development do
+  gem 'release_assistant', require: false, github: 'davidrunger/release_assistant'
+end

data/Gemfile.lock

@@ -0,0 +1,122 @@
+GIT
+  remote: https://github.com/davidrunger/release_assistant
+  revision: 969b3a90264da6ce73275a7240cc7e54ff5a6370
+  specs:
+    release_assistant (0.3.3.alpha)
+      activesupport (>= 6, < 8)
+      colorize (~> 0.8)
+      memoist (~> 0.16)
+      slop (~> 4.8)
+
+GIT
+  remote: https://github.com/davidrunger/runger_style
+  revision: 3d9d3a91cfd39a037ef4b0dbb547d4b652f7bc4e
+  specs:
+    runger_style (0.2.22.alpha)
+      rubocop (>= 1.38.0, < 2)
+
+PATH
+  remote: .
+  specs:
+    fcom (0.4.1)
+      activesupport (>= 6, < 8)
+      colorize (~> 0.8)
+      memoist (~> 0.16)
+      slop (~> 4.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    memoist (0.16.2)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.20.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    slop (4.10.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  fcom!
+  pry
+  pry-byebug
+  rake
+  release_assistant!
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  runger_style!
+
+RUBY VERSION
+   ruby 3.2.2p53
+
+BUNDLED WITH
+   2.4.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 David Runger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+[![Build Status](https://travis-ci.org/davidrunger/fcom.svg?branch=master)](https://travis-ci.org/davidrunger/fcom)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=davidrunger/fcom)](https://dependabot.com)
+![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/davidrunger/fcom?include_prereleases)
+
+# `fcom` ("find commit(s)")
+
+This is a CLI tool that I use to parse the git history of a repo.
+
+For example, if I use `fcom` to search this repo with `fcom "line.(green|red)" --regex --repo
+davidrunger/fcom`, I get this output:
+
+![](https://s3.amazonaws.com/screens.davidrunger.com/2019-12-28-20-50-09-oect2(1).png)
+
+## Installation
+
+```
+gem install fcom
+```
+
+## Dependencies
+
+This gem assumes that you have `git` and [`rg` (ripgrep)][ripgrep] installed.
+
+[ripgrep]: https://github.com/BurntSushi/ripgrep
+
+## Basic usage
+
+```
+$ fcom <search string> [options]
+```
+
+#### Available options and examples
+
+After installing, execute `fcom --help` to see usage examples and available options.
+
+```
+$ fcom --help
+
+Usage: fcom <search string> [options]
+
+Examples:
+  fcom update
+  fcom 'def update'
+  fcom "def update" --days 60
+  fcom "[Uu]ser.*slug" -d 365 --regex
+  fcom options --path spec/
+  fcom "line.(green|red)" -d 365 --regex --repo davidrunger/fcom -a "David Runger"
+
+    --repo             GitHub repo (in form `username/repo`)
+    -d, --days         number of days to search back
+    -r, --regex        interpret search string as a regular expression
+    -i, --ignore-case  search case-insensitively
+    -p, --path         path (directory or file) used to filter results
+    -a, --author       author
+    --rg-options       additional options passed directly to `rg` (e.g. `--rg-options "--max-columns 1000"`)
+    --debug            print debugging info
+    --init             create an `.fcom.yml` config file
+    -v, --version      print the version
+    -h, --help         print this help information
+```
+
+## `.fcom.yml` config file
+We highly recommend that you create an `.fcom.yml` file in any repository that you plan to search
+with `fcom`.
+
+**This file can be created automatically by executing `fcom --init`** in the relevant
+repo/directory.
+
+(You might (or might not) want to add `.fcom.yml` to your `~/.gitignore_global` file, so that this
+file is not tracked by `git`.)
+
+#### Example `.fcom.yml` config file
+```yaml
+repo: githubusername/reponame
+```
+
+The advantage of creating an `.fcom.yml` config file is that it will make the `fcom` command execute
+more quickly, because time will not be wasted parsing the output of `git remote [...]` in order to
+determine the URL of the repo's remote repository (which is used to construct links to matching
+commits).
+
+## 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 (in this repository's root directory):
+
+```
+$ rm -f pkg/*.gem && rake build && gem install --local pkg/fcom-*.gem
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/davidrunger/fcom.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/RELEASING.md

@@ -0,0 +1,7 @@
+To release a new version, run `bin/release` with an appropriate `--type` option, e.g.:
+
+```
+bin/release --type minor
+```
+
+(This uses the `release_assistant` gem.)

data/Rakefile

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

data/bin/_guard-core

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', '_guard-core')

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'fcom'
+
+# 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/guard

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/release

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'release' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('release_assistant', 'release')

data/bin/rspec

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

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/fcom

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'slop'
+require_relative '../lib/fcom.rb'
+
+opts =
+  Slop.parse do |o|
+    o.banner = <<~BANNER
+
+      Usage: fcom <search string> [options]
+
+      Examples:
+        fcom update
+        fcom 'def update'
+        fcom "def update" --days 60
+        fcom "[Uu]ser.*slug" -d 365 --regex
+        fcom options --path spec/
+        fcom "line.(green|red)" -d 365 --regex --repo davidrunger/fcom -a "David Runger"
+    BANNER
+
+    Fcom.define_slop_options(o)
+
+    o.on('--init', 'create an `.fcom.yml` config file') do
+      File.write('.fcom.yml', "repo: #{Fcom::GitHelpers.new.repo}\n")
+      puts('Created `.fcom.yml` file!'.green.bold)
+      exit
+    end
+    o.on('-v', '--version', 'print the version') do
+      puts(Fcom::VERSION)
+      exit
+    end
+    o.on('-h', '--help', 'print this help information') do
+      puts(o)
+      exit
+    end
+  end
+
+# Note: mutating the globally accessible `Fcom.logger` constant like this is not thread-safe
+Fcom.logger.level = Logger::DEBUG if opts.debug?
+
+if opts.parse_mode?
+  Fcom::Parser.new(opts).parse
+elsif !opts.arguments.empty?
+  Fcom.warn_if_config_file_repo_option_missing
+  Fcom::Querier.new(opts).query
+else
+  puts(opts.options)
+end

data/fcom.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'lib/fcom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fcom'
+  spec.version       = Fcom::VERSION
+  spec.authors       = ['David Runger']
+  spec.email         = ['davidjrunger@gmail.com']
+
+  spec.summary       = 'CLI tool for parsing git history'
+  spec.homepage      = 'https://github.com/davidrunger/fcom'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['rubygems_mfa_required'] = 'true'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/davidrunger/fcom'
+    spec.metadata['changelog_uri'] = 'https://github.com/davidrunger/fcom/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(__dir__)) 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_dependency('activesupport', '>= 6', '< 8')
+  spec.add_dependency('colorize', '~> 0.8')
+  spec.add_dependency('memoist', '~> 0.16')
+  spec.add_dependency('slop', '~> 4.8')
+
+  spec.required_ruby_version = '>= 3.2'
+end

data/lib/fcom/config_file_options.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Fcom::ConfigFileOptions
+  extend Memoist
+
+  def initialize
+    @options =
+      if config_file_exists?
+        YAML.load_file(config_file_path)
+      else
+        {}
+      end
+  end
+
+  def repo
+    @options['repo']
+  end
+
+  private
+
+  memoize \
+  def config_file_path
+    "#{ENV.fetch('PWD')}/.fcom.yml"
+  end
+
+  def config_file_exists?
+    File.exist?(config_file_path)
+  end
+end

data/lib/fcom/git_helpers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# This class contains helpers that extract information from `git`.
+class Fcom::GitHelpers
+  def repo
+    # Examples:
+    # git@github.com:davidrunger/fcom.git
+    # https://github.com/davidrunger/fcom.git
+    # https://github.com/davidrunger/fcom
+    origin_fetch_url.delete_suffix('/').match(%r{github\.com[:/](((?!\.git).)*)})[1]
+  end
+
+  private
+
+  def origin_fetch_url
+    origin_remote_info = `git remote -v`
+    origin_remote_info.match(/origin\s+(.*)\s+\(fetch\)$/)[1]
+  end
+end

data/lib/fcom/options_helpers.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# This module contains convenience methods that expose more directly the command options provided.
+module Fcom::OptionsHelpers
+  private
+
+  def author
+    @options[:author]
+  end
+
+  def days
+    @options[:days]
+  end
+
+  def ignore_case?
+    @options.ignore_case?
+  end
+
+  def path
+    @options[:path]
+  end
+
+  def regex_mode?
+    @options.regex?
+  end
+
+  def debug?
+    @options.debug?
+  end
+
+  def development?
+    @options.development?
+  end
+
+  def repo
+    @options[:repo]
+  end
+
+  def search_string
+    @options.arguments.first
+  end
+end

data/lib/fcom/parser.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# This class parses (and then reprints some of) STDIN according to the options passed to `fcom`.
+class Fcom::Parser
+  include ::Fcom::OptionsHelpers
+
+  def initialize(options)
+    @options = options
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  # rubocop:disable Metrics/MethodLength
+  def parse
+    expression_to_match = search_string
+    expression_to_match = Regexp.escape(expression_to_match).gsub('\\ ', ' ') unless regex_mode?
+    regex =
+      Regexp.new(
+        "((\\+|-)\\s?.*#{expression_to_match}.*|Omitted long (matching )?line)",
+        ignore_case? ? Regexp::IGNORECASE : nil,
+      )
+
+    previous_commit = nil
+    a_commit_has_matched = false
+    filename = nil
+    $stdin.each do |line|
+      line.chomp!
+      if (match = line.match(/^commit (.*)/)&.[](1))
+        previous_commit = match
+      elsif line.match?(/^diff /)
+        old_filename = line.match(%r{ a/(\S+)})&.[](1) || '[weird filename]'
+        new_filename = line.match(%r{ b/(\S+)})&.[](1) || '[weird filename]'
+        filename =
+          case
+          when old_filename == new_filename then old_filename
+          else "#{old_filename} --> #{new_filename}"
+          end
+      elsif line.match?(regex) && (filename.blank? || path_match?(filename))
+        if previous_commit
+          title, sha, author, date = previous_commit.split('|')
+          sha_with_url = "#{sha[0, 7]} ( https://github.com/#{repo}/commit/#{sha[0, 7]} )"
+
+          puts("\n\n") if a_commit_has_matched # print commit separator, if needed
+          puts([title, sha_with_url, author, date])
+          puts('==============================================')
+
+          previous_commit = nil
+          a_commit_has_matched = true
+        end
+
+        if filename
+          puts(filename)
+          filename = nil
+        end
+
+        if line.start_with?('+')
+          puts(line.green)
+        elsif line.start_with?('-')
+          puts(line.red)
+        else
+          puts(line)
+        end
+      end
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+  private
+
+  def path_match?(filename)
+    return true if path == Fcom::ROOT_PATH
+
+    filename.include?(path.delete_prefix('./'))
+  end
+end

data/lib/fcom/querier.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative './options_helpers.rb'
+
+# This class executes a system command to retrieve the git history, which is passed through `rg`
+# (ripgrep), and then ultimately is fed back to `fcom` for parsing.
+class Fcom::Querier
+  include ::Fcom::OptionsHelpers
+
+  def initialize(options)
+    @options = options
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/PerceivedComplexity
+  def query
+    expression_to_match = search_string
+    expression_to_match = Regexp.escape(expression_to_match).gsub('\\ ', ' ') unless regex_mode?
+
+    if expression_to_match.nil? || expression_to_match.empty?
+      puts('provide expression to match as first argument')
+      exit
+    end
+
+    quote = expression_to_match.include?('"') ? "'" : '"'
+
+    command = <<~COMMAND.squish
+      git log
+        #{%(--author="#{author}") if author}
+        #{"--since=#{days}.day" unless days.nil?}
+        --full-diff
+        --no-textconv
+        --format="commit %s|%H|%an|%cr (%ci)"
+        --source
+        -p #{path}
+        |
+
+      rg #{quote}(#{expression_to_match})|(^commit )|(^diff )#{quote}
+        --color never
+        #{'--ignore-case' if ignore_case?}
+        #{@options[:rg_options]}
+        |
+
+      #{'exe/' if development?}fcom #{quote}#{search_string}#{quote}
+        #{"--days #{days}" if days}
+        #{'--regex' if regex_mode?}
+        #{'--debug' if debug?}
+        #{'--ignore-case' if ignore_case?}
+        --path #{path}
+        --parse-mode
+        --repo #{repo}
+    COMMAND
+
+    Fcom.logger.debug("Executing command: #{command}")
+    system(command)
+  end
+  # rubocop:enable Metrics/PerceivedComplexity
+  # rubocop:enable Metrics/CyclomaticComplexity
+end

data/lib/fcom/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/StaticClass
+class Fcom
+  VERSION = '0.4.1'
+end
+# rubocop:enable Style/StaticClass

data/lib/fcom.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'colorize'
+require 'memoist'
+require 'slop'
+require 'yaml'
+
+# This `Fcom` class is the namespace within which most of the gem's code is written.
+# We need to define the class before requiring the modules.
+# rubocop:disable Lint/EmptyClass
+class Fcom
+end
+# rubocop:enable Lint/EmptyClass
+
+Dir["#{File.dirname(__FILE__)}/fcom/*.rb"].each { |file| require file }
+
+class Fcom
+  ROOT_PATH = '.'
+
+  class << self
+    extend Memoist
+
+    memoize \
+    def logger
+      Logger.new($stdout).tap do |logger|
+        logger.formatter = ->(_severity, _datetime, _progname, msg) { "#{msg}\n" }
+        # default the log level to WARN, but this can be set to `DEBUG` via the `--debug` CLI option
+        logger.level = Logger::WARN
+      end
+    end
+
+    memoize \
+    def config_file_options
+      Fcom::ConfigFileOptions.new
+    end
+
+    def warn_if_config_file_repo_option_missing
+      if config_file_options.repo.blank?
+        puts(<<~WARNING.rstrip.yellow)
+          Warning: you have not specified a `repo` option in an `.fcom.yml` file.
+          This will cause `fcom` to execute more slowly than necessary.
+        WARNING
+        puts('Execute `fcom --init` to create an `.fcom.yml` file.'.blue.bold)
+        puts("See https://github.com/davidrunger/fcom/#readme for more info.\n\n")
+      end
+    end
+
+    def define_slop_options(options)
+      git_helpers = Fcom::GitHelpers.new
+      default_repo = config_file_options.repo || git_helpers.repo || 'username/repo'
+
+      options.string('--repo', 'GitHub repo (in form `username/repo`)', default: default_repo)
+      options.integer('-d', '--days', 'number of days to search back')
+      options.bool(
+        '-r',
+        '--regex',
+        'interpret search string as a regular expression',
+        default: false,
+      )
+      options.bool('-i', '--ignore-case', 'search case-insensitively', default: false)
+      options.string(
+        '-p',
+        '--path',
+        'path (directory or file) used to filter results',
+        default: Fcom::ROOT_PATH,
+      )
+      options.string(
+        '-a',
+        '--author',
+        'author',
+      )
+      options.string(
+        '--rg-options',
+        'additional options passed directly to `rg` (e.g. `--rg-options "--max-columns 1000"`)',
+        default: '',
+      )
+      options.bool('--debug', 'print debugging info', default: false)
+      options.bool('--parse-mode', 'whether we are in parse mode', default: false, help: false)
+      options.bool('--development', 'use local `fcom` executable', default: false, help: false)
+    end
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: fcom
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- David Runger
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+description:
+email:
+- davidjrunger@gmail.com
+executables:
+- fcom
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".release_assistant.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- RELEASING.md
+- Rakefile
+- bin/_guard-core
+- bin/console
+- bin/guard
+- bin/release
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- exe/fcom
+- fcom.gemspec
+- lib/fcom.rb
+- lib/fcom/config_file_options.rb
+- lib/fcom/git_helpers.rb
+- lib/fcom/options_helpers.rb
+- lib/fcom/parser.rb
+- lib/fcom/querier.rb
+- lib/fcom/version.rb
+homepage: https://github.com/davidrunger/fcom
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/davidrunger/fcom
+  source_code_uri: https://github.com/davidrunger/fcom
+  changelog_uri: https://github.com/davidrunger/fcom/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: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: CLI tool for parsing git history
+test_files: []