gh-issues-stats 0.4.0

data/lib/github/issues/mixins/statistics.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Github
+  class Issues
+    ##
+    # Mixin for calculating issues statistics
+    module Statistics
+      private
+
+      ##
+      # Collects statistics about issues
+      #
+      # @param object [Hash] Hash containing :created, :closed, and :finished issue arrays
+      #
+      # @return [Hash] Hash containing calculated statistics
+      def stats_combined(object)
+        {
+          ratio: {
+            all: stats_closed_created_ratio(object[:closed], object[:created]),
+            finished: stats_closed_created_ratio(object[:finished], object[:created])
+          },
+          close_time: {
+            all: {
+              average: stats_average_closing_time(object[:closed]),
+              median: stats_median_closing_time(object[:closed])
+            },
+            finished: {
+              average: stats_average_closing_time(object[:finished]),
+              median: stats_median_closing_time(object[:finished])
+            }
+          }
+        }
+      end
+
+      ##
+      # Calculates the ratio of closed issues to created issues
+      #
+      # @param closed [Array<Hashie::Mash>] Array of closed issues
+      # @param created [Array<Hashie::Mash>] Array of created issues
+      #
+      # @return [Float] Ratio of closed to created issues
+      def stats_closed_created_ratio(closed, created)
+        return 0 if created.nil? || created.empty? || closed.nil? || closed.empty?
+
+        closed.size.to_f / created.size
+      end
+
+      ##
+      # Calculates the average closing time for a set of issues
+      #
+      # @param closed [Array<Hashie::Mash>] Array of closed issues
+      #
+      # @return [Float] Average closing time in seconds
+      def stats_average_closing_time(closed)
+        return 0 if closed.nil? || closed.empty?
+
+        total = closed.sum { |issue| issue.closed_at - issue.created_at }
+        total.to_f / closed.size
+      end
+
+      ##
+      # Calculates the median closing time for a set of issues
+      #
+      # @param closed [Array<Hashie::Mash>] Array of closed issues
+      #
+      # @return [Float] Median closing time in seconds
+      def stats_median_closing_time(closed)
+        return 0 if closed.nil? || closed.empty?
+
+        times = closed.map { |issue| issue.closed_at - issue.created_at }
+        times.sort!
+        size = times.size
+        (times[(size - 1) / 2] + times[size / 2]) / 2.0
+      end
+    end
+  end
+end

data/lib/github/issues/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Github
+  class Issues
+    VERSION = '0.4.0'
+  end
+end

data/lib/github/issues.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'hashie'
+
+module Github
+  ##
+  # Main class for analyzing GitHub issues
+  class Issues
+    include Statistics
+    include Fetch
+    include Group
+
+    CACHE_DIR = File.join(Dir.home, '.cache', 'gh-issues-stats').freeze
+    DATABASE_NAME = 'issues.db'
+
+    ##
+    # Repository to analyze (e.g., 'owner/repo')
+    attr_reader :repository
+
+    ## Cache path for storing database file
+    attr_reader :cache
+
+    ##
+    # Credentials for GitHub API access
+    attr_reader :credentials
+
+    ##
+    # Database instance for storing and retrieving issues
+    attr_reader :database
+
+    ##
+    # Refresh interval in seconds for updating the stored issues
+    attr_reader :refresh
+
+    ##
+    # Initialize the Issues analyzer
+    #
+    # @param repository [String] GitHub repository (e.g., 'owner/repo')
+    # @param cache [String] Path to cache directory
+    # @param credentials [Hash] Optional GitHub API credentials
+    # @param refresh [Integer] Refresh interval in seconds (default: 86400)
+    #
+    # @return [Github::Issues] The initialized issues analyzer
+    def initialize(repository, cache: CACHE_DIR, credentials: {}, refresh: 86_400)
+      @repository = repository
+      @credentials = credentials
+      @refresh = refresh
+
+      dir = File.join(cache, repository)
+      FileUtils.mkdir_p(dir)
+      @cache = dir
+
+      database_path = File.join(dir, DATABASE_NAME)
+      github_repository_exist!(credentials, repository) unless File.exist?(database_path)
+      @database = Database.new(database_path)
+
+      at_exit do
+        database.close
+      end
+    end
+
+    ##
+    # Get all unique labels from the issues
+    #
+    # @return [Array<String>] List of unique labels
+    def labels
+      ensure_issues_loaded(database, refresh, credentials, repository)
+      database.all_labels.sort.reverse
+    end
+
+    ##
+    # List all issues
+    #
+    # @return [Array<Hashie::Mash>] List of issues
+    def all
+      ensure_issues_loaded(database, refresh, credentials, repository)
+      fetch_issues_from_database(database)
+    end
+
+    ##
+    # List issues filtered by labels
+    #
+    # @param labels [Array<String>] List of labels to filter issues
+    #
+    # @return [Array<Hashie::Mash>] List of filtered issues
+    def filtered_by_labels(labels)
+      ensure_issues_loaded(database, refresh, credentials, repository)
+      fetch_issues_from_database(database, labels:)
+    end
+
+    ##
+    # Total average closing time of all issues
+    #
+    # @return [Float] Average closing time in seconds
+    def all_average_closing_time
+      average_closing_time_filtered_by_labels([])
+    end
+
+    ##
+    # Total average closing time of all issues filtered by labels
+    #
+    # @param labels [Array<String>] List of labels to filter issues
+    #
+    # @return [Float] average closing time in seconds
+    def average_closing_time_filtered_by_labels(labels)
+      ensure_issues_loaded(database, refresh, credentials, repository)
+      list = fetch_issues_from_database(database, labels:)
+      return 0 if list.empty?
+
+      closed = list.select { |issue| issue.state == 'closed' }
+      stats_average_closing_time(closed)
+    end
+
+    ##
+    # Total median closing time of all issues
+    #
+    # @return [Float] Median closing time in seconds
+    def all_median_closing_time
+      median_closing_time_filtered_by_labels([])
+    end
+
+    ##
+    # Total median closing time of all issues filtered by labels
+    #
+    # @param labels [Array<String>] List of labels to filter issues
+    #
+    # @return [Float] Median closing time in seconds
+    def median_closing_time_filtered_by_labels(labels)
+      ensure_issues_loaded(database, refresh, credentials, repository)
+      list = fetch_issues_from_database(database, labels:)
+      return 0 if list.empty?
+
+      closed = list.select { |issue| issue.state == 'closed' }
+      stats_median_closing_time(closed)
+    end
+
+    ##
+    # Issues grouped per year with optional statistics
+    #
+    # @param stats [Boolean] Whether to include statistics for each year
+    #
+    # @return [Hashie::Mash] Issues grouped by year with optional statistics
+    def per_year(stats: true)
+      per_year_filtered_by_labels([], stats:)
+    end
+
+    ##
+    # Issues grouped per year filtered by labels with optional statistics
+    #
+    # @param labels [Array<String>] List of labels to filter issues
+    # @param stats [Boolean] Whether to include statistics for each year
+    #
+    # @return [Hashie::Mash] Issues grouped by year with optional statistics
+    def per_year_filtered_by_labels(labels, stats: true)
+      ensure_issues_loaded(database, refresh, credentials, repository)
+      list = fetch_issues_from_database(database, labels:)
+      return if list.empty?
+
+      hash = group_by_period(list)
+      hash.each_key { |year| hash[year][:stats] = stats_combined(hash[year]) } if stats
+
+      Hashie::Mash.new(hash)
+    end
+
+    ##
+    # Issues grouped per month for a specific year with optional statistics
+    #
+    # @param year [Integer] Year to filter issues
+    # @param stats [Boolean] Whether to include statistics for each month
+    #
+    # @return [Hashie::Mash] Issues grouped by month with optional statistics
+    def per_month(year, stats: true)
+      per_month_filtered_by_labels(year, [], stats:)
+    end
+
+    ##
+    # Issues grouped per month for a specific year filtered by labels with
+    # optional statistics
+    #
+    # @param year [Integer] Year to filter issues
+    # @param labels [Array<String>] List of labels to filter issues
+    # @param stats [Boolean] Whether to include statistics for each month
+    #
+    # @return [Hashie::Mash] Issues grouped by month with optional statistics
+    def per_month_filtered_by_labels(year, labels, stats: true)
+      ensure_issues_loaded(database, refresh, credentials, repository)
+      list = fetch_issues_from_database(database, labels:)
+      return if list.empty?
+
+      list = list.select { |issue| issue.created_at.year == year }
+      return if list.empty?
+
+      hash = group_by_period(list, period: :month)
+      hash.each_key { |month| hash[month][:stats] = stats_combined(hash[month]) } if stats
+
+      Hashie::Mash.new(hash)
+    end
+  end
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: gh-issues-stats
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Tobias Schäfer
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: tty-pager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: unicode_plot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+description: 'Analyse Github repository issues lifecycle.
+
+  '
+email:
+- github@blackox.org
+executables:
+- gh-issues-stats
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/gh-issues-stats
+- lib/gh-issues-stats.rb
+- lib/github/issues.rb
+- lib/github/issues/app.rb
+- lib/github/issues/app/base.rb
+- lib/github/issues/app/labels.rb
+- lib/github/issues/app/mixins/chart.rb
+- lib/github/issues/app/mixins/exec.rb
+- lib/github/issues/app/mixins/legend.rb
+- lib/github/issues/app/mixins/options.rb
+- lib/github/issues/app/mixins/statistics.rb
+- lib/github/issues/app/mixins/table.rb
+- lib/github/issues/app/month.rb
+- lib/github/issues/app/year.rb
+- lib/github/issues/database.rb
+- lib/github/issues/mixins/database/marshal.rb
+- lib/github/issues/mixins/database/schema.rb
+- lib/github/issues/mixins/database/store.rb
+- lib/github/issues/mixins/fetch.rb
+- lib/github/issues/mixins/group.rb
+- lib/github/issues/mixins/statistics.rb
+- lib/github/issues/version.rb
+homepage: https://github.com/tschaefer/gh-issues-stats
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/tschaefer/gh-issues-stats
+  bug_tracker_uri: https://github.com/tschaefer/gh-issues-stats/issues
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.4
+specification_version: 4
+summary: Analyse Github repository issues lifecycle.
+test_files: []