inq 26.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at me@duckie.co. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# How to contribute
+
+Want to contribute to Inq? This document has the information you need
+to make sure the process goes smoothly.
+
+By contributing to this project, you agree to follow our
+[Code of Conduct](https://github.com/duckinator/inq/blob/master/CODE_OF_CONDUCT.md).
+
+## Guidelines
+
+2. New features should be paired with tests.
+3. Ensure your code follows our general code style.
+   * Run `bundle exec rubocop` to check for any violations.
+4. Don't modify the CHANGELOG or version number.
+5. If you need feedback or assistance, feel free to join us on Slack
+   (http://slack.bundler.io/) or open an issue on GitHub
+   (https://github.com/duckinator/inq).
+
+## Getting started
+
+```
+$ bundle install
+$ bundle exec rake test
+```
+
+Then, to run inq commands, simply run `bundle exec inq <args>`.
+
+## Issues
+
+Inq uses the GitHub issue tracker for tracking bugs and feature
+requests.
+
+For more details, including information on the various labels we use, see
+[ISSUES.md](https://github.com/duckinator/inq/blob/master/ISSUES.md).

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Inq only supports Ruby versions under "normal maintenance".
+# This number should be updated when a Ruby version goes into security
+# maintenance.
+#
+# Ruby maintenance info: https://www.ruby-lang.org/en/downloads/branches/
+#
+# NOTE: Update inq.gemspec when this is updated!
+ruby "~> 2.4"
+
+# Specify your gem's dependencies in inq.gemspec
+gemspec

data/ISSUES.md

@@ -0,0 +1,62 @@
+# Issue Management
+
+This document explains what labels on a given issue mean, or to help you
+choose labels for new/updated issues.
+
+We use an issue tracker to organize and prioritize work by allowing users
+to report bugs, request features or documentation, and start discussions.
+
+---
+
+## high priority
+
+An issue that should be resolved as soon as possible.
+
+## in progress
+
+An issue which is currently being worked on. This should be added when
+someone begins work on an issue.
+
+## ready
+
+An issue which is ready to be worked on. This should be removed when
+someone begins work on an issue.
+
+## size: large
+
+An issue which is expected to take a large amount of effort to resolve.
+
+## size: small
+
+An issue which is expected to be relatively simple to resolve.
+
+## type: bug report
+
+A bug report.
+
+## type: documentation
+
+A request for additional or updated documentation.
+
+## type: feature request
+
+A request for a new feature to be added.
+
+## type: question/discussion
+
+A question or discussion. Issues with this label are likely to not have
+any immediately-actionable tasks.
+
+When any tasks do arise from an issue with this label, more specific
+issues will likely be opened to replace it.
+
+## type: refactoring
+
+A request for a particular section of code to be refactored.
+
+Including concrete suggestions for smaller areas will likely get these
+issues resolved more quickly.
+
+## type: tests
+
+A request for new or improved tests addressing specific situations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2019 Ellen Marie Dash and Inq contributors
+
+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,91 @@
+[![Travis](https://img.shields.io/travis/duckinator/inq.svg)](https://travis-ci.org/duckinator/inq)
+[![Code Climate](https://img.shields.io/codeclimate/github/duckinator/inq.svg)](https://codeclimate.com/github/duckinator/inq)
+[![Gem](https://img.shields.io/gem/v/inq.svg)](https://rubygems.org/gems/inq)
+[Documentation](https://how-is.github.io)
+
+# Inq
+
+Inq is tool for generating summaries of the health of a codebase hosted on GitHub. It uses information available from issues and pull requests to provide an overview of a repository and highlight problem areas of the codebase.
+
+Reports can be generated retroactively.
+
+If you want to contribute or discuss inq, you can [join Bundler's slack](http://slack.bundler.io/) and join the #how_is channel.
+
+## Installation
+
+    $ gem install inq
+
+## Configuration
+
+To avoid errors due to hitting rate limits, Inq requires a Personal
+Access Token for GitHub.
+
+### Acquiring A Personal Access Token
+
+To acquire a personal access token:
+
+1. Go to: https://github.com/settings/tokens/new
+2. For `Token description`, enter `inq CLI client`.
+3. Scroll to the bottom of the page.
+4. Click `Generate token`. This will take you to a new page.
+5. Save the token somewhere. **You can't access it again.**
+
+**NOTE:** Inq _only_ needs read access.
+
+#### Using The Token
+
+Create a file in `~/.config/inq/config.yml`:
+
+```
+sources/github:
+  username: <USERNAME>
+  token:    <TOKEN>
+```
+
+Make sure to replace `<TOKEN>` with the actual token, and `<USERNAME>`
+with your GitHub username.
+
+## Usage
+
+### Command Line
+
+    $ inq --repository REPOSITORY --date DATE [--output OUTPUT_FILENAME]
+    # OUTPUT_FILENAME defaults to ./report.html.
+
+or
+
+    $ inq --date DATE --config CONFIG_FILENAME
+
+#### Example \#1
+
+    $ inq rubygems/rubygems 2016-12-01 --output report-2016-12-01.html
+
+The above command creates a HTML file containing the report for the state of
+the rubygems/rubygems repository, for November 01 2016 to
+December 01 2016, and saves it as `./report-2016-12-01.html`.
+
+#### Example \#2
+
+    $ inq --date 2016-12-01 --config some-config.yml
+
+This generates the report(s) specified in the config file, for the period
+from November 01 2016 to December 01 2016, and saves them in the
+locations specified in the config file.
+
+#### Screenshot
+
+![image](https://user-images.githubusercontent.com/211/55504154-89284180-5650-11e9-9a13-e03e9b83c749.png)
+
+## 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. Run `bundle exec inq` to use the gem in this directory, ignoring other installed copies of this gem.
+
+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 pull requests are welcome on GitHub at https://github.com/duckinator/inq. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "timecop"
+require "inq"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  # Warning.warn() was added in Ruby 2.4.0, so don't use -w on older versions.
+  t.ruby_opts = "-w -r./spec/capture_warnings.rb" if RUBY_VERSION >= "2.4.0"
+end
+
+task :default => :spec
+
+task :generate_changelog do
+  sh "github_changelog_generator"
+end
+
+task :future_changelog do
+  sh "github_changelog_generator --future-release v#{Inq::VERSION}"
+end
+
+# Helper functions used later in the Rakefile.
+class HelperFunctions
+  def self.freeze_time(&_block)
+    date = DateTime.parse("2016-11-01").new_offset(0)
+    Timecop.freeze(date) do
+      yield
+    end
+  end
+
+  def self.generate_report(repository, format)
+    require "./spec/vcr_helper.rb"
+
+    freeze_time do
+      report = nil
+
+      options = {
+        repository: repository,
+        format: format,
+      }
+
+      cassette = repository.tr("/", "-")
+      VCR.use_cassette(cassette) do
+        report = Inq.generate_report(**options)
+      end
+
+      filename = "#{cassette}-report.#{format}"
+      path = File.expand_path("spec/data/#{filename}", __dir__)
+      File.open(path, "w") do |f|
+        f.puts report
+        # HACK: Trailing newline is missing, otherwise.
+        f.puts if format == "html"
+      end
+    end
+  end
+end
+
+namespace :generate_reports do
+  desc "Generate example HTML reports."
+  task :html do
+    [
+      "how-is/example-repository",
+      "how-is/example-empty-repository",
+    ].each do |repo|
+      HelperFunctions.generate_report(repo, "html")
+    end
+  end
+
+  desc "Generate example JSON reports."
+  task :json do
+    HelperFunctions.generate_report("how-is/example-repository", "json")
+  end
+
+  task :all => [:html, :json]
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "inq"
+
+# 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

data/bin/prerelease-generate-changelog

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# This script is a fucking tragedy.
+
+PROJECT="inq"
+
+SCRIPT_DIR="$(dirname $(readlink -f $0))" # Directory this script is in.
+cd "$SCRIPT_DIR/.."
+
+LAST_RELEASE="$(git tag --list | cut -d 'v' -f 2 | sort -n | tail -n 1)"
+NEXT_RELEASE=$(cat lib/$PROJECT/version.rb | grep '^\s*VERSION\s*=\s*' | cut -d '"' -f 2)
+
+if [ -z "$LAST_RELEASE" ]; then
+  echo "error: Could not find latest release using \`git tag --list\`"
+  exit 1
+fi
+
+if [ -z "$NEXT_RELEASE" ]; then
+  echo "error: No version number found in $(pwd)lib/$PROEJCT/version.rb."
+  exit 1
+fi
+
+if [ "$LAST_RELEASE" == "$NEXT_RELEASE" ]; then
+  echo "error: last release (\"$LAST_RELEASE\") and next release (\"$NEXT_RELEASE\") are equivalent."
+  exit 1
+fi
+
+bundle exec github_changelog_generator --future-release "v$NEXT_RELEASE"

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/bors.toml

@@ -0,0 +1,17 @@
+status = [
+  "FreeBSD",
+  "Lint",
+  "Linux container:ruby:2.4-alpine",
+  "Linux container:ruby:2.5-alpine",
+  "Linux container:ruby:2.6-alpine",
+  "Windows RUBY_VERSION:2.5.3.101",
+  "Windows RUBY_VERSION:2.6.3.1",
+  "macOS RUBY_VERSION:2.5",
+  "macOS RUBY_VERSION:2.6",
+  #"continuous-integration/travis-ci/push",
+  #"continuous-integration/appveyor/branch"
+]
+
+# Uncomment this to use a two hour timeout.
+# The default is one hour.
+#timeout_sec = 7200

data/build-debug.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup" # to avoid having to do `bundle exec ...`
+require "inq/sources/ci/travis"
+require "inq/sources/ci/appveyor"
+require "pp"
+
+travis = Inq::Sources::CI::Travis.new("rubygems/rubygems", "2018-12-01", "2019-02-01")
+builds = travis.builds
+puts "Number of builds: #{builds.length}"
+puts "First build:      #{builds.first['html_url']} (#{builds.first['started_at'].rfc3339})"
+puts "Last build:       #{builds.last['html_url']} (#{builds.last['started_at'].rfc3339})"
+
+appveyor = Inq::Sources::CI::Appveyor.new("rubygems/rubygems", "2018-12-01", "2019-02-01")
+builds = appveyor.builds
+puts "Number of builds: #{builds.length}"
+puts "First build:      #{builds.first['html_url']} (#{builds.first['started_at'].rfc3339})"
+puts "Last build:       #{builds.last['html_url']} (#{builds.last['started_at'].rfc3339})"