glyptodont 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ad92f48b0fac0e3a90a61d375ccb01f187c79a79070bb801cac3d30f13585e3
+  data.tar.gz: eec6a97e7ab90f1bbd557f5e8fbfc4e6f5809f7aa21f030a1b1f5eae124f1288
+SHA512:
+  metadata.gz: b1daa8bc22b0345c15c8c6f19b394f236e9169007f402b934c94a55b5076ac4ce0c21e9b1c5a49300a5276490b2366df4e68ebc731ece3a89d4b1e12f4eb7c2a
+  data.tar.gz: d1238f2ffbde7b028bc65405ffe0e9b1573f4f8fc86450a2fd1a5cd1ceece15ef4b3bd8e6d7662c0418c7861311d1084c39f0b5dd9931c35b99a3a81b9369e33

data/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0']
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run the default task
+      run: |
+        gem install bundler
+        sudo apt install cmake
+        bundle install
+        ./script/cibuild

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.rspec_status
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/

data/.glyptodont.yaml

@@ -0,0 +1,10 @@
+---
+ignore:
+  - README.md:10
+  - README.md:15
+  - lib/glyptodont/checkers/counter.rb:28
+  - lib/glyptodont/checkers/counter.rb:30
+  - lib/glyptodont/todo_researcher.rb:32
+  - lib/glyptodont/todo_researcher.rb:33
+  - lib/glyptodont/todo_researcher.rb:34
+  - lib/glyptodont/todo_researcher.rb:35

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.4.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.0

data/Brewfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+brew "asdf"
+brew "cmake"
+brew "git"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-03-13
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at paj+github@johnsy.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in glyptodont.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Pete Johns
+
+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,97 @@
+# Glyptodont
+
+Use this gem if you have ever deployed code to production without doing all of
+your to-dos.
+
+## Introduction
+
+All of the glyptodonts have fossilised. This is a tool to ensure that your TODOs
+are eradicated before this can happen to them.
+
+If you've ever been caught out because a TODO in production code has not been
+don, this gem is for ***you***!
+
+## Development status [![Ruby](https://github.com/johnsyweb/glyptodont/actions/workflows/main.yml/badge.svg)](https://github.com/johnsyweb/glyptodont/actions/workflows/main.yml)
+
+This was written after I was bitten by a TODO not being _done_ at work. I expect
+to build it into our CI pipeline and see what it catches.
+
+After checking out the project, run `script/setup` to install dependencies. Then,
+run `script/tests` to run the tests. You can also run `script/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 the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Getting started [![Gem version](https://img.shields.io/gem/v/glyptodont.svg?style=flat-square)](https://github.com/johnysweb/glyptodont) [![Gem downloads](https://img.shields.io/gem/dt/glyptodont.svg?style=flat-square)](https://rubygems.org/gems/glyptodont)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'glyptodont'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install glyptodont
+```
+
+## Usage
+
+```
+Usage: glyptodont [options]
+    -d, --directory DIRECTORY        Git repository to search for TODOs (default '.')
+    -t, --threshold TODOS            Maximum number of TODOs to allow (default 10)
+    -m, --max-age DAYS               Maximum number of days to allow TODOs to stay (default 14)
+        --version                    Show version
+```
+
+## Configuration
+
+glyptodont looks for an optional `.glyptodont.yaml` configuration file in the
+root of the directory being scanned, which contains an `ignore` list of
+`file_name:line_number` pairs to ignore when researching TODOs. This may be
+useful if you have, for example, Spanish language text in your project.
+
+### _Exempli gratiā_
+
+```yaml
+---
+ignore:
+  - lib/glyptodont/checkers/counter.rb:28
+  - lib/glyptodont/todo_researcher.rb:34
+```
+
+## Requirements
+
+- Ruby (tested against v2.4 and above)
+- Git
+- CMake
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+<https://github.com/johnsyweb/glyptodont>. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to adhere
+to the [code of
+conduct](https://github.com/johnsyweb/glyptodont/blob/master/CODE_OF_CONDUCT.md).
+
+## License [![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://github.com/johnsyweb/glyptodont/blob/HEAD/LICENSE.txt)
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Glyptodont project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/johnsyweb/glyptodont/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

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

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "glyptodont"
+
+exit(Glyptodont.check)

data/glyptodont.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/glyptodont/version"
+
+GITHUB_URL = "https://github.com/johnsyweb/glyptodont/"
+
+Gem::Specification.new do |spec|
+  spec.name          = "glyptodont"
+  spec.version       = Glyptodont::VERSION
+  spec.authors       = ["Pete Johns"]
+  spec.email         = ["paj+github@johnsy.com"]
+
+  spec.summary       = "A bit like `git grep 'T0D0'`, but better."  # .tr("0", "O")
+  spec.description   = "Use this gem if you have ever deployed code to production without doing all of your to-dos"
+  spec.homepage      = GITHUB_URL
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = GITHUB_URL
+  spec.metadata["changelog_uri"] = "#{GITHUB_URL}blob/HEAD/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  %w[git rugged].each { |gem| spec.add_dependency(gem) }
+end

data/lib/glyptodont.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "glyptodont/checkers/age"
+require_relative "glyptodont/checkers/counter"
+require_relative "glyptodont/configuration"
+require_relative "glyptodont/formatting"
+require_relative "glyptodont/options"
+require_relative "glyptodont/todo_researcher"
+
+require "forwardable"
+
+# This is where the magic happens
+module Glyptodont
+  class << self
+    def check
+      @options = Options.new
+      @configuration = Configuration.new(directory)
+
+      todos = TodoResearcher.new(directory, ignore).research
+
+      checks = [
+        Checkers::Counter.new(todos: todos, threshold: threshold),
+        Checkers::Age.new(todos: todos, threshold: max_age_in_days)
+      ].freeze
+
+      checks.each { |check| puts check.check }
+
+      checks.all?(&:passed?)
+    end
+
+    attr_reader :configuration, :options
+
+    extend Forwardable
+
+    def_delegator :@configuration, :ignore
+    def_delegators :@options, :directory, :threshold, :max_age_in_days
+  end
+end

data/lib/glyptodont/checkers/age.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Glyptodont
+  module Checkers
+    # Checks that the age of TODOs is below the specified threshold
+    class Age
+      def initialize(todos:, threshold:)
+        @todos = todos
+        @threshold = threshold
+      end
+
+      def check
+        @age, @reportable_todos = oldest_todos
+        message
+      end
+
+      def passed?
+        todos.empty? || age <= threshold
+      end
+
+      private
+
+      attr_reader :todos, :threshold, :age, :reportable_todos
+
+      def message
+        if todos.empty?
+          "Nothing left to do"
+        elsif passed?
+          "At #{Glyptodont.pluralize(age, "day")}, TODOs are fresh enough for now"
+        else
+          "Some TODOs are too stale at #{Glyptodont.pluralize(age, "day")} old:\n" +
+            reportable_todos.map { |t| Glyptodont.format_todo(t) }.join("\n")
+        end
+      end
+
+      def oldest_todos
+        todos.group_by { |todo| todo[:age] }
+             .max_by { |age, _group| age }
+      end
+    end
+  end
+end

data/lib/glyptodont/checkers/counter.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Glyptodont
+  module Checkers
+    # Checks that the number of TODOs is below the specified threshold
+    class Counter
+      def initialize(todos:, threshold:)
+        @threshold = threshold
+        @todos = todos
+      end
+
+      def check
+        @count = todos.size
+        @reportable_todos = passed? ? todos : []
+        message
+      end
+
+      def passed?
+        count <= threshold
+      end
+
+      private
+
+      def message
+        if count.zero?
+          "All done"
+        elsif passed?
+          "#{Glyptodont.pluralize(count, "TODO")}: This is tolerable"
+        else
+          "#{Glyptodont.pluralize(count, "TODO")}: There is work to be done:\n" +
+            todos.map { |t| Glyptodont.format_todo(t) }.join("\n")
+        end
+      end
+
+      attr_reader :todos, :threshold, :count
+    end
+  end
+end

data/lib/glyptodont/configuration.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "set"
+require "yaml"
+
+module Glyptodont
+  # Allow for configuring the tool
+  class Configuration
+    FILENAME = ".glyptodont.yaml"
+    def initialize(directory)
+      @config_filename = File.join(directory, FILENAME)
+    end
+
+    def ignore
+      @ignore ||= extract_ignore_set || []
+    end
+
+    private
+
+    attr_reader :config_filename
+
+    def config
+      @config ||= begin
+        YAML.load_file(config_filename)
+      rescue Errno::ENOENT
+        {}
+      end
+    end
+
+    def extract_ignore_set
+      config.fetch("ignore", []).map do |line|
+        parts = line.split(":", 2)
+        {
+          file: parts[0],
+          line: parts[1].to_i
+        }
+      end.to_set
+    end
+  end
+end

data/lib/glyptodont/formatting.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# String formatting methods
+module Glyptodont
+  class << self
+    def pluralize(items, text)
+      if items == 1
+        "1 #{text}"
+      else
+        "#{items} #{text}s"
+      end
+    end
+
+    def format_todo(todo)
+      format("%<file>s:%<line>s: %<text>s -- %<name>s @ %<time>s", todo)
+    end
+  end
+end

data/lib/glyptodont/options.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "version"
+
+require "optparse"
+
+module Glyptodont
+  # Command-line options for the tool
+  class Options
+    attr_reader :directory, :threshold, :max_age_in_days
+
+    def initialize
+      @directory = "."
+      @threshold = 10
+      @max_age_in_days = 14
+      parse
+    end
+
+    private
+
+    def parse
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{opts.program_name} [options]"
+
+        directory_option(opts)
+        threshold_option(opts)
+        max_age_in_days_option(opts)
+        version_option(opts)
+      end.parse!(ARGV)
+    end
+
+    def directory_option(opts)
+      opts.on("-d", "--directory DIRECTORY", String, "Git repository to search for TODOs (default '.')") do |d|
+        @directory = d
+      end
+    end
+
+    def threshold_option(opts)
+      opts.on("-t", "--threshold TODOS", Integer, "Maximum number of TODOs to allow (default 10)") do |t|
+        @threshold = t
+      end
+    end
+
+    def max_age_in_days_option(opts)
+      opts.on("-m", "--max-age DAYS", Integer, "Maximum number of days to allow TODOs to stay (default 14)") do |m|
+        @max_age_in_days = m
+      end
+    end
+
+    def version_option(opts)
+      opts.on_tail("--version", "Show version") do
+        puts VERSION
+        exit
+      end
+    end
+  end
+end

data/lib/glyptodont/todo_researcher.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "git"
+require "rugged"
+
+module Glyptodont
+  # Finds all the TODOs in a directory managed by Git, who last touched them and when.
+  class TodoResearcher
+    def initialize(directory, ignore)
+      @directory = directory
+      @ignore = ignore
+    end
+
+    def research
+      annotate(exclude_ignored(extract_details(git.grep(keyword_rexexp))))
+    end
+
+    private
+
+    attr_reader :directory, :ignore
+
+    def git
+      Git.open(directory)
+    end
+
+    def keyword_rexexp
+      "\\b\\(#{keywords.join('\|')}\\)\\b"
+    end
+
+    def keywords
+      %w[
+        FIXME
+        HACK
+        TODO
+        XXX
+      ]
+    end
+
+    def extract_details(todos)
+      todos.flat_map do |sha, matches|
+        file = sha.split(":", 2).last
+        matches.map do |match|
+          {
+            file: file,
+            line: match[0],
+            text: match[1].strip
+          }
+        end
+      end
+    end
+
+    def exclude_ignored(todos)
+      todos.reject { |todo| ignore.include?(todo.slice(:file, :line)) }
+    end
+
+    def annotate(todos)
+      todos.map do |todo|
+        annotation = annotate_line(file_path: todo[:file], line_number: todo[:line])
+        todo.merge(annotation).merge(age: days_since(annotation[:time]))
+      end
+    end
+
+    def annotate_line(file_path:, line_number:)
+      line_info(file_path: file_path, line_number: line_number)[:final_signature]
+    end
+
+    def line_info(file_path:, line_number:)
+      Rugged::Blame.new(repository, file_path).for_line(line_number)
+    end
+
+    def repository
+      @repository ||= Rugged::Repository.new(directory)
+    end
+
+    def days_since(timestamp)
+      (Time.now - timestamp).to_i / (24 * 60 * 60)
+    end
+  end
+end

data/lib/glyptodont/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Glyptodont
+  VERSION = "0.1.0"
+end

data/script/bootstrap

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+# script/bootstrap: Resolve all dependencies that the application requires to
+#                   run.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ]; then
+  brew bundle check >/dev/null 2>&1  || {
+    echo "==> Installing Homebrew dependencies…"
+    brew bundle
+  }
+fi
+
+if [ -f ".tool-versions" ]; then
+  echo "==> Installing Ruby…"
+  which bundle >/dev/null 2>&1  || {
+    gem install bundler
+    asdf reshim ruby
+  }
+fi
+
+if [ -f "Gemfile" ]; then
+  echo "==> Installing gem dependencies…"
+  bundle check --path vendor/gems >/dev/null 2>&1  || {
+    bundle install --path vendor/gems --quiet --without production
+  }
+fi

data/script/cibuild

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+# script/cibuild: Setup environment for CI to run tests. This is primarily
+#                 designed to run on the continuous integration server.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+echo "Tests started at…"
+date "+%H:%M:%S"
+
+# run tests
+echo "Running tests…"
+date "+%H:%M:%S"
+
+# run tests.
+script/test

data/script/console

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# script/console: Launch a console for the application. Optionally allow an
+#                 environment to be passed in to let the script handle the
+#                 specific requirements for connecting to a console for that
+#                 environment.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+# no argument provided, so just run the local console in the development
+# environment. Ensure the application is up to date first.
+script/update
+bin/console

data/script/setup

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+# script/setup: Set up application for the first time after cloning, or set it
+#               back to the initial first unused state.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+script/bootstrap
+
+echo "==> App is now ready to go!"

data/script/test

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+# script/test: Run test suite for application. Optionally pass in a path to an
+#              individual test file to run a single test.
+
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+[ -z "$DEBUG" ] || set -x
+
+echo "==> Running tests…"
+
+if [ -n "$1" ]; then
+  # pass arguments to test call. This is useful for calling a single test.
+  bundle exec rspec "$1"
+else
+  bundle exec rspec
+fi

data/script/update

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+# script/update: Update application to run for its current checkout.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+script/bootstrap

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: glyptodont
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pete Johns
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  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: rugged
+  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: Use this gem if you have ever deployed code to production without doing
+  all of your to-dos
+email:
+- paj+github@johnsy.com
+executables:
+- glyptodont
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".glyptodont.yaml"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- Brewfile
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- exe/glyptodont
+- glyptodont.gemspec
+- lib/glyptodont.rb
+- lib/glyptodont/checkers/age.rb
+- lib/glyptodont/checkers/counter.rb
+- lib/glyptodont/configuration.rb
+- lib/glyptodont/formatting.rb
+- lib/glyptodont/options.rb
+- lib/glyptodont/todo_researcher.rb
+- lib/glyptodont/version.rb
+- script/bootstrap
+- script/cibuild
+- script/console
+- script/setup
+- script/test
+- script/update
+homepage: https://github.com/johnsyweb/glyptodont/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/johnsyweb/glyptodont/
+  source_code_uri: https://github.com/johnsyweb/glyptodont/
+  changelog_uri: https://github.com/johnsyweb/glyptodont/blob/HEAD/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.11
+signing_key:
+specification_version: 4
+summary: A bit like `git grep 'T0D0'`, but better.
+test_files: []