oss-stats 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9343ec72ca5f1412829f0cfd8f64ced3c725ab9a01198a228e2caa9d3540c7f6
-  data.tar.gz: c5ff104f234c412c7059fd3d914fda9c5f72466427ad00bc29bf1ad2e0a0b10e
+  metadata.gz: cf35db5f39b5f26e0ea59ca26d502137077aa46b18812dcfb2d3355c11fb8606
+  data.tar.gz: 37a81f53394b9ea8a6da952dbc17c47a8f74be94216829dc5826500c8fb2d762
 SHA512:
-  metadata.gz: 5c455dd20bf92a07a843ecb6549e43ca760d94d423868cdcb2833c012d43149660c7963e664bd24a8bbae5caf7fb558400bc1f06f01cb23b11190da6f51cfcde
-  data.tar.gz: f5912b0c5b8a1bf7c9f84da22562903f8ce6b79bc52efe6cefb1d5e1d3e01460184a382a4b8c6f32e56c7553d4b3f4e806e0ec9acba54ef6f6212c1a71b48281
+  metadata.gz: c06f182855176fa481653ea05574ba5c95eef1251a07cda209e4279dcbbdbc96f24de9792d5c680f0aa9995b512433ec533caef8a6fb43d754591bcb8a094eb6
+  data.tar.gz: 9edd71a6a6d5230e17cc42b8ccea40b6b385fb034ea65bbdd5255a2a8479a44c26f2a0a7c93a83eed42143d5983891c293b07b2b426a3b0f4fdb5c607ea0122a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # oss-stats Changelog
 
+## 0.0.2 (2025-07-10)
+
+* Setup now uses the gem instead of a separate checkout
+* Massive improvements to setup script
+* Add "convert" option to setup script to move to gem-based setup
+* Fix some ruby warnings
+* Fix bug in default config file
+
 ## 0.0.1 (2025-06-15)
 
 * Initial release!

data/Gemfile

@@ -3,8 +3,6 @@ source 'https://rubygems.org'
 gem 'oss-stats', path: '.'
 
 group(:development) do
-  # for cookstyle
-  gem 'base64'
   gem 'cookstyle'
   gem 'mdl'
   gem 'rspec'

data/README.md

@@ -7,7 +7,8 @@
 This is a collection of tools that aim to make it easier to track and report
 various metrics around health of an open source project.
 
-* [How to use this repo](#how-to-use-this-repo)
+* [Installation](#installation)
+   * [Converting from pre-gem verions](#converting-from-pre-gem-versions)
 * [Tools in this repo](#tools-in-this-repo)
    * [Repo Stats](#repo-stats)
    * [Pipeline Visibility Stats](#pipeline-visibility-stats)
@@ -15,34 +16,86 @@ various metrics around health of an open source project.
    * [Promises](#promises)
 * [Authentication](#authentication)
 
-## How to use this repo
+## Installation
 
-You'll want to create your own repository to keep the data and results that
-these scripts use and generate about your project.
+You'll want to create your own directory or git repository to keep the data and
+results that these scripts use and generate about your project. Whether or not
+your directory is actually a git repo doesn't matter, but we recommend making
+it one.
 
-Currently docs and tools are all setup for you to keep your repo and this repo
-checked out at the same level and use `oss-stats` directly from git. Once we
-get a release out the door, we'll update this with alternative options.
+In your fresh directory, run this command to set everything up:
 
-This repo has a script that'll do all the required initial work. On your new
-repo, do:
+```bash
+\curl -sSL https://raw.githubusercontent.com/jaymzh/oss-stats/refs/heads/main/bin/initialize_repo.sh | bash -s
+```
+
+You can pass in some options like:
 
-```shell
-<path_to_this_repo>/scripts/intialize_repo.sh
+```bash
+\curl -sSL https://raw.githubusercontent.com/jaymzh/oss-stats/refs/heads/main/bin/initialize_repo.sh | bash -s -- <options>
 ```
 
-This will:
+You can find valid options with `-h`.
 
-* Generate basic config skeleton files for the various scripts
-* Create necessary directories
-* Setup a GitHub Actions workflow for you
+This will create a Gemfile that depends on the `git` version of the `oss-stats`
+gem, install the bundle, setup the binstubs in `./bin`, create same config
+files for you, and even setup GitHub Workflows!
 
 You can run it with `-n` (dryrun) to see what it will do without actually
 doing anything.
 
+It'll look like:
+
+```text
+Welcome to oss-stats!
+
+We'll go ahead and setup this directory to be ready to track your open source
+stats!
+
+➤ Initializing Gemfile to depend on oss-stats
+➤ Installing gem bundle
+➤ Making necessary directories
+➤ Copying basic skeleton files
+➤ Creating initial config files
+➤ Setting up GH Workflows
+
+OK, this directory is setup.
+
+NEXT STEPS:
+
+1. Edit `repo_stats_config.rb` in this directory to add repository to specify
+   what repositories you care about, and change anything else you may be
+   interested in.
+2. Run a sample report with: `./bin/repo_stats.rb`
+
+We recommend running it regularly (e.g. weekly) and storing the output in the
+repo_reports directory we've created, ala:
+
+  date=$(date '+%Y-%m-%d')
+  out="repo_reports/${date}.md"
+  for repo in $repos; do
+    ./bin/repo_stats.rb >> $out
+  done
+
+Then you can also check `promise_stats`, `pipeline_visibility_stats`, and
+`meeting_stats`.
+```
+
 You can see an example of a downstream repo at
 [chef-oss-stats](https://github.com/jaymzh/chef-oss-stats/).
 
+### Converting from pre-gem versions
+
+If you ran the setup script before it used the gem (and required `../oss-stats`
+to exist), you can convert to the new setup. Make sure your `oss-stats` checkout
+is updated, and then run:
+
+```bash
+../oss-stats/bin/initialize_repo.sh -c
+```
+
+Once you've done that, your `oss-stats` checkout is no longer necessary.
+
 ## Tools in this repo
 
 ### Repo Stats

data/bin/initialize_repo.sh

@@ -0,0 +1,326 @@
+#!/bin/bash
+
+CONVERT=0
+DRYRUN=0
+DEBUG=0
+FORCE=0
+BRANCH=""
+NOGIT=0
+VERSION=""
+DIRS=(
+    scripts
+    data
+    repo_reports
+    pipeline_visibility_reports
+    promises
+    images
+    .github/workflows
+)
+OSS_STATS_PATH=""
+
+step() {
+    echo "➤ $*"
+}
+
+warn() {
+    echo "WARNING: $*" >&2
+}
+
+err() {
+    echo "ERROR: $*" >&2
+}
+
+die() {
+    err "$@"
+    exit 1
+}
+
+debug() {
+    [[ "$DEBUG" -eq 0 ]] && return
+
+    echo "DEBUG: $*" >&2
+}
+
+run() {
+    if [[ "$DRYRUN" -ne 0 ]]; then
+        echo "DRYRUN: $*"
+        return 0
+    fi
+    "$@"
+}
+
+usage() {
+    cat <<EOF
+$0 <options>
+
+This script will initialize a new repo that utilizes oss-stats. It should
+be run in an empty directory, or new git clone.
+
+Options:
+    -b <branch>
+            Install oss-stats gem from a specific branch. You probably do
+            not want this.
+
+    -c
+            Convert Mode. If you setup oss-stats back when it required
+            a checkout of your downstream repo and oss-stats next to each
+            other, you can use this option to convert your repo to use the
+            gem instead.
+
+    -d
+            Enable debug output.
+
+    -f
+            Force. Copy over files, even if the directory is not empty. Not
+            recommended.
+
+    -G
+            When installing oss-stats, don't use git, instead use wahtever
+            is latest. Not recommended. See also '-V'.
+
+    -h
+            Print this help message.
+
+    -n
+            Dryrun. Don't do any work, just say what you would do.
+
+    -V <version_constraint>
+            When installing oss-stats, don't use git, and specifically use
+            this version of the gem. Must be in gem-constraint format.
+
+EOF
+}
+
+do_gem() {
+    step "Initializing Gemfile to depend on oss-stats"
+    if [ "$CONVERT" -eq 1 ]; then
+        run rm Gemfile Gemfile.lock
+    fi
+    gemfile_line="gem 'oss-stats'"
+    if [[ -n "$VERSION" ]]; then
+        gemfile_line="$gemfile_line, $VERSION"
+    elif [[ "$NOGIT" -eq 0 ]]; then
+        gemfile_line="$gemfile_line,\n  git: 'https://github.com/jaymzh/oss-stats.git'"
+        if [[ -n "$BRANCH" ]]; then
+            gemfile_line="$gemfile_line,\n  branch: '$BRANCH'"
+        fi
+    fi
+
+    if [ -e Gemfile ] && [ "$CONVERT" -eq 0 ]; then
+        if grep -q 'oss-stats' Gemfile; then
+            warn "Gemfile already populated with oss-stats, skipping"
+        else
+            warn "Gemfile already exists, adding oss-stats"
+            if [ "$DRYRUN" -eq 0 ]; then
+                echo -e "$gemfile_line" >> Gemfile
+            fi
+        fi
+    else
+        cat >Gemfile <<EOF
+source 'https://rubygems.org'
+
+$(echo -e "$gemfile_line")
+
+group(:development) do
+  gem 'cookstyle'
+  gem 'mdl'
+  gem 'rspec'
+end
+EOF
+    fi
+
+    step 'Installing gem bundle'
+    if ! out=$(run bundle install); then
+        die "Failed to install bundle. Output: \n$out"
+    fi
+    if ! out=$(run bundle update oss-stats); then
+        die "Failed to install latest oss-stats. Output: \n$out"
+    fi
+    run bundle binstubs oss-stats
+    OSS_STATS_PATH=$(bundle show oss-stats)
+}
+
+do_directories() {
+    step 'Making necessary directories'
+    run mkdir -p "${DIRS[@]}"
+}
+
+gen_file() {
+    local file="$1"
+    local content="$2"
+
+    if [ -e "$file" ]; then
+        warn "$file exists, skipping"
+        return
+    fi
+
+    if [ "$DRYRUN" -eq 0 ]; then
+        echo -e "$content" > "$file"
+    else
+        echo "DRYRUN: echo \"$content\" > $file"
+    fi
+}
+
+do_files() {
+    local dst
+    local file
+    step 'Copying basic skeleton files'
+
+    # top level files
+    mapfile -t files < <(
+        find "$OSS_STATS_PATH/initialization_data/" -maxdepth 1 -type f
+    )
+    debug "Copying files: ${files[*]}"
+    for file in "${files[@]}"; do
+        dst=$(basename "$file")
+        run cp "$file" "$dst"
+    done
+
+    # scripts
+    mapfile -t files< <(
+        find "$OSS_STATS_PATH/initialization_data/scripts" -maxdepth 1 -type f
+    )
+    debug "Copying scripts: ${files[*]}"
+    for file in "${files[@]}"; do
+        dst=$(basename "$file")
+        run cp "$file" "scripts/$dst"
+        chmod +x "scripts/$dst"
+    done
+}
+
+do_config_files() {
+    step 'Creating initial config files'
+    for file in "$OSS_STATS_PATH/examples/"*_config.rb; do
+        f=$(basename "$file")
+        # even if we're in force/convert, skip config files that exist
+        if [ -e "$f" ]; then
+            warn "Config file $f already exists, skipping"
+        else
+            run cp "$file" .
+        fi
+    done
+}
+
+do_gh_workflows() {
+    step 'Setting up GH Workflows'
+    for file in "$OSS_STATS_PATH/initialization_data/github_workflows/"*; do
+        f=".github/workflows/$(basename "$file")"
+        run cp "$file" "$f"
+    done
+}
+
+do_instructions() {
+    if [ "$CONVERT" -eq 1 ]; then
+        do_convert_instructions
+    else
+        do_install_instructions
+    fi
+}
+
+do_install_instructions() {
+    cat <<'EOF'
+OK, this directory is setup.
+
+NEXT STEPS:
+
+1. Edit `repo_stats_config.rb` in this directory to add repository to specify
+   what repositories you care about, and change anything else you may be
+   interested in.
+2. Run a sample report with: `./bin/repo_stats.rb`
+
+We recommend running it regularly (e.g. weekly) and storing the output in the
+repo_reports directory we've created, ala:
+
+  date=$(date '+%Y-%m-%d')
+  out="repo_reports/${date}.md"
+  for repo in $repos; do
+    ./bin/repo_stats.rb >> $out
+  done
+
+Then you can also check `promise_stats`, `pipeline_visibility_stats`, and
+`meeting_stats` - these are all in `./bin`
+EOF
+}
+
+do_convert_instructions() {
+    cat <<'EOF'
+We've done our best to convert your repo. Some things to check for:
+
+* You probably will want to revert to your README if you've made changes,
+  so run `git diff README.md`, and optionally `git checkout README.md`
+* If you have your own CI stuff, be sure to checkout the changes to the
+  github workflow files
+* New stuff is in bin/ and scripts/ - be sure to git add them
+* Finally, do a pass on `git diff` and `git status`, to make sure you like
+  what you see.
+
+From now on, run script with `./bin/<script>` instead of
+`../oss-stats/bin/<script>` and other than that, it should be the same!
+EOF
+}
+
+while getopts b:cdfGhnV: opt; do
+    case "$opt" in
+        b)
+            BRANCH="$OPTARG"
+            ;;
+        c)
+            debug "Activating CONVERT mode"
+            CONVERT=1
+            ;;
+        d)
+            debug "Activating DEBUG mode"
+            DEBUG=1
+            ;;
+        f)
+            debug "Activating FORCE mode"
+            FORCE=1
+            ;;
+        G)
+            NOGIT=1
+            ;;
+        h)
+            usage
+            exit
+            ;;
+        n)
+            DRYRUN=1
+            ;;
+        V)
+            VERSION="$OPTARG"
+            ;;
+        ?)
+            exit 1
+            ;;
+    esac
+done
+
+# shellcheck disable=SC2012
+num=$(ls | wc -l)
+if [[ "$num" -ne 0 ]]; then
+    if [[ "$FORCE" -eq 1 ]]; then
+        warn "Directory not empty, but force is on"
+    elif [[ "$CONVERT" -eq 1 ]]; then
+        warn "Directory not empty, but convert is on"
+    else
+        die "Script should be run in an empty directory"
+    fi
+fi
+
+cat <<'EOF'
+Welcome to oss-stats!
+
+We'll go ahead and setup this directory to be ready to track your open source
+stats!
+
+EOF
+
+do_gem
+debug "OSS_STATS_PATH is $OSS_STATS_PATH"
+do_directories
+do_files
+do_config_files
+do_gh_workflows
+do_instructions
+
+

data/bin/meeting_stats

@@ -257,13 +257,13 @@ def summary(db_file)
   db.close
 
   # TODO: de-dupe this with generate_plots
-  dates = data.map { |row| row[0] }.uniq.reverse
+  dates = data.map(&:first).uniq.reverse
   dates[0..2].each do |date|
-    total_teams = data.count { |row| row[0] == date }
-    present_teams = data.count { |row| row[0] == date && row[2] == 'Y' }
+    total_teams = data.count { |row| row.first == date }
+    present_teams = data.count { |row| row.first == date && row[2] == 'Y' }
     present_pct = ((present_teams / total_teams) * 100).round(2)
     reporting_builds = data.count do |row|
-      row[0] == date && row[3] != 'N' && !row[3].strip.empty?
+      row.first == date && row[3] != 'N' && !row[3].strip.empty?
     end
     reporting_builds_pct =
       ((reporting_builds.to_f / total_teams) * 100).round(2)
@@ -284,15 +284,15 @@ def generate_plots(db_file, img_dir)
   )
   db.close
 
-  dates = data.map { |row| row[0] }.uniq
+  dates = data.map(&:first).uniq
   attendance_percentages = []
   build_status_percentages = []
 
   dates.each do |date|
-    total_teams = data.count { |row| row[0] == date }
-    present_teams = data.count { |row| row[0] == date && row[2] == 'Y' }
+    total_teams = data.count { |row| row.first == date }
+    present_teams = data.count { |row| row.first == date && row[2] == 'Y' }
     reporting_builds = data.count do |row|
-      row[0] == date && row[3] != 'N' && !row[3].strip.empty?
+      row.first == date && row[3] != 'N' && !row[3].strip.empty?
     end
 
     attendance_percentages <<
@@ -307,7 +307,7 @@ def generate_plots(db_file, img_dir)
   }
 
   sizes.each do |name, size|
-    g = Gruff::Line.new(size[0], size[1])
+    g = Gruff::Line.new(size.first, size[1])
     g.maximum_value = 100
     g.minimum_value = 0
     g.title = 'Percentage of Teams Present Over Time'
@@ -315,7 +315,7 @@ def generate_plots(db_file, img_dir)
     g.labels = dates.each_with_index.to_h
     g.write(::File.join(img_dir, "attendance-#{name}.png"))
 
-    g2 = Gruff::Line.new(size[0], size[1])
+    g2 = Gruff::Line.new(size.first, size[1])
     g2.maximum_value = 100
     g2.minimum_value = 0
     g2.title = 'Percentage of Teams Reporting Build Status Over Time'

data/bin/pipeline_visibility_stats

@@ -6,7 +6,6 @@ require 'json'
 require 'mixlib/shellout'
 require 'net/http'
 require 'optparse'
-require 'set'
 require 'uri'
 require 'yaml'
 
@@ -254,11 +253,10 @@ def process_buildkite_pipelines(
     total_pipeline_count += 1
     next if visibility.casecmp('public').zero?
 
-    if reported_slugs.add?(report_key)
-      log.debug("Pipeline #{report_key} is #{visibility} (direct)")
-      repo_missing_public << slug
-      private_pipeline_count += 1
-    end
+    next unless reported_slugs.add?(report_key)
+    log.debug("Pipeline #{report_key} is #{visibility} (direct)")
+    repo_missing_public << slug
+    private_pipeline_count += 1
   end
 
   # However, more likely, we don't have access to see the pipeline or

data/bin/promise_stats

@@ -68,7 +68,7 @@ def update_promise_status(config, date, new_status)
 
   print 'Enter ID to update: '
   chosen_id = gets.strip.to_i
-  if rows.any? { |r| r[0] == chosen_id }
+  if rows.any? { |r| r.first == chosen_id }
     if new_status == 'resolved'
       db.execute(
         "UPDATE promises SET resolved_on = ?, status = 'resolved' " +
@@ -107,7 +107,7 @@ def edit_promise(config)
 
   print 'Enter ID to edit: '
   chosen_id = gets.strip.to_i
-  entry = rows.find { |r| r[0] == chosen_id }
+  entry = rows.find { |r| r.first == chosen_id }
 
   unless entry
     puts 'Invalid ID.'
@@ -197,7 +197,7 @@ def prompt(txt, default = nil)
 end
 
 def main
-  if ARGV.empty? || %w{--help -h}.include?(ARGV[0])
+  if ARGV.empty? || %w{--help -h}.include?(ARGV.first)
     puts <<~HELP
       Usage: #{$PROGRAM_NAME} [subcommand] [options]
 

data/bin/repo_stats

@@ -110,4 +110,4 @@ def main
   end
 end
 
-main if __FILE__ == $PROGRAM_NAME
+main

data/examples/promise_stats_config.rb

@@ -8,7 +8,7 @@ db_file DEFAULT_DB_FILE = File.expand_path(
   __dir__,
 )
 header <<~EOF
-    # Promises Report #{Date.today.to_s}
+    # Promises Report #{Date.today}
 EOF
 
 # Uncomment this and set it to a string to have the output

data/examples/repo_stats_config.rb

@@ -18,32 +18,60 @@ include_list false
 # is the organizations block. It allows you to specify
 # all of the repos that will be processed and how
 # they should be processed
-organizations({
-  'someorg' => {
-    # if this org uses different branches (can further override under the repo)
-    'branches' => ['trunk'],
-    # if you want a different number of days by for repos in this org (can
-    # further override under the repo)
-    'days' => 7,
-    'repositories' => {
-      'repo1' => {},
-      'repo2' => {
-        # crazy repo, only do 2 days
-        'days' => 2,
-        'branches' => ['main'],
+organizations(
+  {
+    'someorg' => {
+      # if this org uses different branches
+      # (can further override under the repo)
+      'branches' => ['trunk'],
+      # if you want a different number of days by for repos in this org (can
+      # further override under the repo)
+      'days' => 7,
+      'repositories' => {
+        'repo1' => {},
+        'repo2' => {
+          # crazy repo, only do 2 days
+          'days' => 2,
+          'branches' => ['main'],
+        },
+        'repo3' => {
+          'days' => 30,
+          'branches' => ['main'],
+        },
+      },
+    },
+    'anotherorg' => {
+      'days' => 45,
+      'branches' => %w{main oldstuff},
+      'repositories' => {
+        'repo1' => {},
+        'repo2' => {},
+        'repo3' => {},
       },
-      'repo3' => {
-        'days' => 30,
-        'branches' => ['main'],
-      }
-  },
-  'anotherorg' => {
-    'days' => 45,
-    'branches' => %w{main oldstuff},
-    'repositories' => {
-      'repo1' => {},
-      'repo2' => {},
-      'repo3' => {},
     },
   },
-})
+)
+
+# limit output to only repos in the top-N trouble-makers along various
+# axes
+#
+# All of these except "N" or "N%" (3 repos, or 3% or repos, for example)
+
+# top_n_stale 3
+#  OR
+# top_n_stale_pr 3
+# top_n_stale_issue 3
+#
+# top_n_oldest 3
+#  OR
+# top_n_oldest_pr 3
+# top_n_oldest_issue 3
+#
+# top_n_time_to_close 3
+#  OR
+# top_n_time_to_close_pr 3
+# top_n_time_to_close_issue 3
+#
+# top_n_most_broken_ci_days 3
+#
+# top_n_most_broken_ci_jobs 3

data/initialization_data/README.md

@@ -1,7 +1,7 @@
-# OSS Stats for <Project>
+# OSS Stats for YOUR_PROJECT_HERE
 
-This repo aims to track stats that affect how <project>'s open source community
-interacts with the project and repositories.
+This repo aims to track stats that affect how YOUR_PROJECT_HERE's open source
+community interacts with the project and repositories.
 
 It leverages [oss-stats](https://github.com/jaymzh/oss-stats) to track those
 stats. It assumes oss-stats and this repo are checked out next to each other
@@ -9,10 +9,10 @@ on the filesystem.
 
 ## tl;dr
 
-* See **Issue, PR, and CI stats** in [ci_reports](ci_reports)
+* See **Issue, PR, and CI stats** in [ci_reports](repo_reports)
 * See **weekly meeting stats** in [Slack Status Tracking](team_slack_reports.md)
 * See **pipeline visiblity stats** in [pipeline_visibility_reports](pipeline_visibility_reports)
-* See **promises** in [promises][promises]
+* See **promises** in [promises_reports][promises_reports]
 
 ## Usage
 

data/lib/oss_stats/github_token.rb

@@ -1,13 +1,24 @@
+require_relative 'log'
+
 # looks for :github_token in `options`, falling back to
 # $GITHUB_TOKEN, and then gh's auth.
 def get_github_token(options)
-  return options[:github_token] if options[:github_token]
-  return ENV['GITHUB_TOKEN'] if ENV['GITHUB_TOKEN']
+  if options[:github_token]
+    log.debug('Using GH token from CLI')
+    return options[:github_token]
+  elsif ENV['GITHUB_TOKEN']
+    log.debug('Using GH token from env')
+    return ENV['GITHUB_TOKEN']
+  end
 
   config_path = File.expand_path('~/.config/gh/hosts.yml')
   if File.exist?(config_path)
     config = YAML.load_file(config_path)
-    return config.dig('github.com', 'oauth_token')
+    token = config.dig('github.com', 'oauth_token')
+    if token
+      log.debug('Using GH token from gh cli config')
+      return token
+    end
   end
   nil
 end

data/lib/oss_stats/repo_stats.rb

@@ -3,7 +3,6 @@ require 'date'
 require 'deep_merge'
 require 'octokit'
 require 'optparse'
-require 'set'
 require 'yaml'
 
 require_relative 'buildkite_client'
@@ -149,7 +148,7 @@ module OssStats
       buildkite_badge_regex =
         %r{\)\]\((https://buildkite\.com\/([^\/]+)\/([^\/\)]+))\)}
       matches = readme.scan(buildkite_badge_regex)
-      if matches.length.zero?
+      if matches.empty?
         log.debug('no BK pipelines found in readme')
         return pipelines
       end
@@ -209,7 +208,7 @@ module OssStats
           api_builds = bk_client.get_pipeline_builds(
             pl[:org], pl[:pipeline], from_date, today, branch
           )
-          if api_builds.length.zero?
+          if api_builds.empty?
             log.debug("No builds for #{pl} on #{branch}")
             next
           end
@@ -314,7 +313,7 @@ module OssStats
             log.debug("  Acquiring page #{page}")
             runs = gh_client.workflow_runs(
               repo, workflow.id, branch:, status: 'completed', per_page: 100,
-              page:
+                                 page:
             )
             rate_limited_sleep
 
@@ -499,7 +498,7 @@ module OssStats
       end
       log.info(
         "    * Stale #{type} (>30 days without comment): " +
-        stats[:stale_count],
+        stats[:stale_count].to_s,
       )
       avg_time = stats[:avg_time_to_close_hours]
       avg_time_str =

data/lib/oss_stats/version.rb

@@ -1,3 +1,3 @@
 module OssStats
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

data/oss-stats.gemspec

@@ -25,9 +25,19 @@ Gem::Specification.new do |spec|
     Dir.glob('bin/*') +
     Dir.glob('extras/*') +
     Dir.glob('spec/*') +
+    Dir.glob('scripts/*') +
     Dir.glob('initialization_data/*') +
     Dir.glob('initialization_data/github_workflow/s*')
-  %w{sqlite3 octokit mixlib-log mixlib-config gruff deep_merge}.each do |dep|
+  %w{
+    base64
+    deep_merge
+    faraday-retry
+    gruff
+    mixlib-config
+    mixlib-log
+    octokit
+    sqlite3
+  }.each do |dep|
     spec.add_dependency dep
   end
   spec.metadata = {

data/scripts/run_cookstyle.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+exec bundle exec cookstyle "$@"

data/scripts/run_markdownlint.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+exec bundle exec mdl "$@"

data/scripts/run_shellcheck.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+if [ -z "$1" ]; then
+    mapfile -t files < <(find . -type f -name \*.sh)
+    exec shellcheck "${files[@]}"
+fi
+
+exec shellcheck "${@}"

data/scripts/run_specs.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+exec bundle exec rspec -f doc "$@"

data/spec/repo_stats_spec.rb

@@ -108,8 +108,8 @@ RSpec.describe 'repo_stats' do
                                        .and_return(double(content: ''))
       allow(client).to receive(:workflows).and_return(
         double(workflows: [
-          double(id: 1, name: 'Test Workflow', html_url: 'testurl'),
-        ]),
+                 double(id: 1, name: 'Test Workflow', html_url: 'testurl'),
+               ]),
       )
       allow(client).to receive(:workflow_runs).with(
         'test_org/test_repo',
@@ -127,8 +127,8 @@ RSpec.describe 'repo_stats' do
       ).and_return(double(workflow_runs: []))
       allow(client).to receive(:workflow_run_jobs).and_return(
         double(jobs: [
-            double(name: 'Test Job', conclusion: 'failure'),
-        ]),
+                 double(name: 'Test Job', conclusion: 'failure'),
+               ]),
       )
 
       failed_tests = get_failed_tests_from_ci(client, nil, options, {})
@@ -205,15 +205,15 @@ RSpec.describe 'repo_stats' do
           expect(mock_buildkite_client).to receive(:get_pipeline)
             .with('test-buildkite-org', 'actual-pipeline-name')
             .and_return({
-              url: 'testurl',
-              slug: 'actual-pipeline-name',
-            })
+                          url: 'testurl',
+                          slug: 'actual-pipeline-name',
+                        })
           expect(mock_buildkite_client).to receive(:get_pipeline)
             .with('other-org', 'other-pipeline')
             .and_return({
-              url: 'testurl',
-              slug: 'other-pipeline',
-            })
+                          url: 'testurl',
+                          slug: 'other-pipeline',
+                        })
           expect(mock_buildkite_client).to receive(:get_pipeline_builds)
             .with(
               'test-buildkite-org',
@@ -222,13 +222,15 @@ RSpec.describe 'repo_stats' do
               Date.today,
               'main',
             )
-            .and_return([
-              {
-                'node' => {
-                  'createdAt' => (Date.today - 1).to_s, 'state' => 'FAILED'
+            .and_return(
+              [
+                {
+                  'node' => {
+                    'createdAt' => (Date.today - 1).to_s, 'state' => 'FAILED'
+                  },
                 },
-              },
-            ])
+              ],
+            )
           expect(mock_buildkite_client).to receive(:get_pipeline_builds)
             .with(
               'other-org',
@@ -237,13 +239,15 @@ RSpec.describe 'repo_stats' do
               Date.today,
               'main',
             )
-            .and_return([
-              {
-                'node' => {
-                  'createdAt' => (Date.today - 1).to_s, 'state' => 'PASSED'
+            .and_return(
+              [
+                {
+                  'node' => {
+                    'createdAt' => (Date.today - 1).to_s, 'state' => 'PASSED'
+                  },
                 },
-              },
-            ])
+              ],
+            )
           failed_tests = get_failed_tests_from_ci(
             client, mock_buildkite_client, settings_with_buildkite_token, {}
           )
@@ -256,9 +260,9 @@ RSpec.describe 'repo_stats' do
           expect(mock_buildkite_client).to receive(:get_pipeline)
             .with('test-buildkite-org', 'another-actual-pipeline')
             .and_return({
-              url: 'testurl',
-              slug: 'another-actual-pipelinename',
-            })
+                          url: 'testurl',
+                          slug: 'another-actual-pipelinename',
+                        })
           allow(client).to receive(:readme)
             .with(repo_full_name)
             .and_return(
@@ -282,24 +286,24 @@ RSpec.describe 'repo_stats' do
           expect(mock_buildkite_client).to receive(:get_pipeline)
             .with('test-buildkite-org', 'actual-pipeline-name')
             .and_return({
-              url: 'testurl',
-              slug: 'actual-pipeline-name',
-            })
+                          url: 'testurl',
+                          slug: 'actual-pipeline-name',
+                        })
           expect(mock_buildkite_client).to receive(:get_pipeline)
             .with('other-org', 'other-pipeline')
             .and_return({
-              url: 'testurl',
-              slug: 'other-pipeline',
-            })
+                          url: 'testurl',
+                          slug: 'other-pipeline',
+                        })
           allow(mock_buildkite_client).to receive(:get_pipeline_builds)
             .and_return([
-              {
-                'node' => {
-                  'createdAt' => (Date.today - 1).to_s,
-                  'state' => 'PASSED',
-                },
-              },
-            ])
+                          {
+                            'node' => {
+                              'createdAt' => (Date.today - 1).to_s,
+                              'state' => 'PASSED',
+                            },
+                          },
+                        ])
           failed_tests = get_failed_tests_from_ci(
             client, mock_buildkite_client, settings_with_buildkite_token, {}
           )
@@ -340,15 +344,15 @@ RSpec.describe 'repo_stats' do
             expect(mock_buildkite_client).to receive(:get_pipeline)
               .with('test-buildkite-org', 'actual-pipeline-name')
               .and_return({
-                url: 'testurl',
-                slug: 'actual-pipeline-name',
-              })
+                            url: 'testurl',
+                            slug: 'actual-pipeline-name',
+                          })
             expect(mock_buildkite_client).to receive(:get_pipeline)
               .with('other-org', 'other-pipeline')
               .and_return({
-                url: 'testurl',
-                slug: 'other-pipeline',
-              })
+                            url: 'testurl',
+                            slug: 'other-pipeline',
+                          })
             allow(mock_buildkite_client).to receive(:get_pipeline_builds)
               .with(
                 org_name, pipeline_name, today - days_to_check, today, 'main'
@@ -359,15 +363,17 @@ RSpec.describe 'repo_stats' do
               client, mock_buildkite_client, options_for_ongoing, {}
             )
 
-            expected_job_dates = Set.new([
-              today - days_to_check + 1,
-              today - days_to_check + 2,
-              # no 3, it passed that day
-              today - days_to_check + 4,
-              # add today (days_to_check = 5), becuase we fill in
-              # all days through today if the last check is failing
-              today,
-            ])
+            expected_job_dates = Set.new(
+              [
+                today - days_to_check + 1,
+                today - days_to_check + 2,
+                # no 3, it passed that day
+                today - days_to_check + 4,
+                # add today (days_to_check = 5), becuase we fill in
+                # all days through today if the last check is failing
+                today,
+              ],
+            )
             expect(failed_tests['main'][job_key][:dates])
               .to eq(expected_job_dates)
             expect(failed_tests['main'][job_key][:dates].size)
@@ -417,9 +423,9 @@ RSpec.describe 'repo_stats' do
           allow(mock_buildkite_client)
             .to receive(:get_pipeline)
             .and_return({
-              url: 'testurl',
-              slug: 'actual-pipeline-name',
-            })
+                          url: 'testurl',
+                          slug: 'actual-pipeline-name',
+                        })
         end
 
         it 'handles the error gracefully and logs it' do
@@ -593,26 +599,28 @@ RSpec.describe 'repo_stats' do
 
   describe '#determine_orgs_to_process' do
     before(:each) do
-      OssStats::Config::RepoStats.organizations({
-        'org1' => {
-          'days' => 2,
-          'repositories' => {
-            'repo1' => {},
-            'repo2' => {
-              'days' => 3,
+      OssStats::Config::RepoStats.organizations(
+        {
+          'org1' => {
+            'days' => 2,
+            'repositories' => {
+              'repo1' => {},
+              'repo2' => {
+                'days' => 3,
+              },
             },
           },
-        },
-        'org2' => {
-          'days' => 7,
-          'repositories' => {
-            'repoA' => {
-              'days' => 30,
+          'org2' => {
+            'days' => 7,
+            'repositories' => {
+              'repoA' => {
+                'days' => 30,
+              },
+              'repoB' => {},
             },
-            'repoB' => {},
           },
         },
-      })
+      )
     end
     let(:config) { OssStats::Config::RepoStats }
 
@@ -1007,7 +1015,7 @@ ci_broken_days_map: { 'main_job' => 100 }),
           ),
           mock_repo_data(
             'repo_issue_slow', avg_close_pr_hours: 10,
-            avg_close_issue_hours: 100
+                               avg_close_issue_hours: 100
           ),
           mock_repo_data(
             'repo_both_fast', avg_close_pr_hours: 5, avg_close_issue_hours: 5

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: oss-stats
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Phil Dibowitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-16 00:00:00.000000000 Z
+date: 2025-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: octokit
+  name: deep_merge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mixlib-log
+  name: faraday-retry
+  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: gruff
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: gruff
+  name: mixlib-log
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: deep_merge
+  name: octokit
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,6 +126,7 @@ description:
 email:
 - phil@ipom.com
 executables:
+- initialize_repo.sh
 - meeting_stats
 - pipeline_visibility_stats
 - promise_stats
@@ -123,6 +152,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- bin/initialize_repo.sh
 - bin/meeting_stats
 - bin/pipeline_visibility_stats
 - bin/promise_stats
@@ -134,9 +164,7 @@ files:
 - examples/meeting_stats_config.rb
 - examples/promise_stats_config.rb
 - examples/repo_stats_config.rb
-- initialization_data/Gemfile
 - initialization_data/README.md
-- initialization_data/rubocop.yml
 - lib/oss_stats/buildkite_client.rb
 - lib/oss_stats/buildkite_token.rb
 - lib/oss_stats/config/meeting_stats.rb
@@ -149,6 +177,10 @@ files:
 - lib/oss_stats/repo_stats.rb
 - lib/oss_stats/version.rb
 - oss-stats.gemspec
+- scripts/run_cookstyle.sh
+- scripts/run_markdownlint.sh
+- scripts/run_shellcheck.sh
+- scripts/run_specs.sh
 - spec/buildkite_client_spec.rb
 - spec/repo_stats_spec.rb
 homepage: https://github.com/jaymzh/oss-stats

data/initialization_data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-eval_gemfile('../oss-stats/Gemfile')

data/initialization_data/rubocop.yml

@@ -1,2 +0,0 @@
-inherit_from:
-  - ../oss-stats/.rubocop.yml