dev_metrics 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9932a3bb8544a01ac52f90c4a5217161e5ec4152741302f27e073d551c7c70b
-  data.tar.gz: de933ff7150d18fbdc896ae51783bfd1955b4cdd0f2fd3b4caed1b4ca3d5c108
+  metadata.gz: 34f8fdcb4bcfa8353303ddc44a30dc227df6ecbf92d87b1f967c927d56ba2480
+  data.tar.gz: e77b9e47b4bd91487c0a4deea93df599cd1b31f778d4bcba32b8de8448d18b9b
 SHA512:
-  metadata.gz: 235b658af21204f6c748e14049b4d65016dba87e72f798c799a58f51b225eba9c31fb0b228504bd40f3c88e13a220e0ebaf0d600d3775bdfec0b79de90c39b65
-  data.tar.gz: f0cd5727a59f0b3259527539a8b22f196434941a2a65807ae3b1b3af8559c98b9c514f77283ca1e4c1698886a58a79569cea6a0b149ddfee07a4df62446ccb16
+  metadata.gz: 2b3cb0b8caec22116264a81ef34b3d62ca1c616852dc45eece9cfeead345f71901be7f91d3b87cc1d69cf66b30118fe37e90b4c82f9c6d95baf8128375fc1f9d
+  data.tar.gz: 0b0f53174f2f572538cac10c90c607c65fbdb421a1bac95ebf5839541ef31f218a0a955ccee0788a5e35cc7eb47755ff79ef4bbaa789b7b78f31d2649b591f63

data/bin/dev_metrics

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# filepath: bin/dev_metrics
+
+require_relative "../lib/dev_metrics"
+
+DevMetrics.run

data/lib/dev_metrics/client.rb

@@ -7,22 +7,23 @@ require_relative 'query_builder'
 require_relative 'metrics_calc'
 require_relative 'pull_request_wrapper'
 
+
 module DevMetrics
   class Client
     GITHUB_GRAPHQL_API = 'https://api.github.com/graphql'.freeze
-    ACCESS_TOKEN = ENV.fetch('GITHUB_ACCESS_TOKEN', nil)
 
     def initialize(config)
       @repo_name = config.repo_name
-      @access_token = config.access_token || ENV.fetch('GITHUB_ACCESS_TOKEN', nil)
-      @bot_accounts = config.bot_accounts || []
-      @fix_branch_names = config.fix_branch_names || %w(hotfix fix rollback)
+      @access_token = config.access_token
+      @excluded_accounts = config.excluded_accounts || []
+      @rollback_branch_prefixes = config.rollback_branch_prefixes || %w(hotfix fix rollback)
     end
 
     def fetch(period: Date.today)
       uri = URI.parse(GITHUB_GRAPHQL_API)
       builder = DevMetrics::QueryBuilder.new(@repo_name)
 
+
       token = @access_token
 
       auth_request = build_request(uri, builder.access_auth_check, token)
@@ -38,8 +39,8 @@ module DevMetrics
       DevMetrics::MetricsCalc.new(
         parsed_pr_data,
         period,
-        bot_accounts: @bot_accounts,
-        fix_branch_names: @fix_branch_names
+        excluded_accounts: @excluded_accounts,
+        rollback_branch_prefixes: @rollback_branch_prefixes
       )
     end
 

data/lib/dev_metrics/csv.rb

@@ -0,0 +1,27 @@
+require_relative 'format_base'
+
+module DevMetrics
+  class Csv < FormatBase
+
+    def call
+      write
+    end
+
+    def file_name
+      "dev_metrics.csv"
+    end
+
+    def format
+      columns.map { |col| col['label'] || col }.join(',') + "\n" +
+        build_row.join(',')
+    end
+
+    def write
+      File.open(file_name, 'a') do |f|  # ← append mode
+        f.puts columns.map { |col| col['label'] || col }.join(',') if File.size(file_name).zero?
+        f.puts build_row.join(',')
+      end
+      puts "CSV data written to #{file_name}"
+    end
+  end
+end

data/lib/dev_metrics/format_base.rb

@@ -1,25 +1,35 @@
+require 'yaml'
+
 module DevMetrics
   class FormatBase
 
     attr_reader :metrics_calc
 
-    def initialize(metrics_calc)
+    def initialize(metrics_calc, config_path = "dev_metrics_config.yml")
       @metrics_calc = metrics_calc
-      write
+      @format_config = YAML.load_file(config_path)
     end
 
     private
 
-    def data_format
-      raise NotImplementedError, "You must implement the data_format method in a subclass"
-    end
+    def write; end
+
+    def file_name; end
 
-    def output_filename
-      raise NotImplementedError, "You must implement the output_filename method in a subclass"
+    def columns
+      @format_config['columns'] || []
     end
 
-    def write
-     raise NotImplementedError, "You must implement the write method in a subclass"
+    def build_row
+      columns.map do |column|
+        key = column['key'] || column
+        begin
+          value = @metrics_calc.send(key)
+        rescue NoMethodError
+          value = "No defined for #{key}"
+        end
+        value
+      end
     end
   end
 end

data/lib/dev_metrics/json.rb

@@ -0,0 +1,28 @@
+require 'json'
+require_relative 'format_base'
+
+module DevMetrics
+  class Json < FormatBase
+
+    def call
+      write
+    end
+
+    private
+
+    def write
+      data = {}
+      columns.each_with_index do |col, idx|
+        key = col['label'] || col['key'] || col
+        data[key] = build_row[idx]
+      end
+      File.open(file_name, "w") do |file|
+        file.puts JSON.pretty_generate(data)
+      end
+    end
+
+    def file_name
+      "output.json"
+    end
+  end
+end

data/lib/dev_metrics/markdown.rb

@@ -1,34 +1,27 @@
-require_relative 'format_base'
-
-module DevMetrics
-  class Markdown < FormatBase
-
-    private
-
-    def data_format
-      output = ""
-
-      output << "| #{metrics_calc.period} |"
-      output << " #{metrics_calc.prs_length} |"
-      output << " #{metrics_calc.rollback_prs_length} |"
-      output << " #{metrics_calc.failure_rate}% |"
-      output << " #{metrics_calc.lead_time} |"
-      output << " #{metrics_calc.average_changed_line_size} |"
-      output << " #{metrics_calc.average_changed_file} |"
-      output << " [PRs for #{metrics_calc.period}](https://github.com/#{@repo_name}/pulls?q=is%3Apr+merged%3A#{metrics_calc.period}) |\n"
-      output
-    end
-
-    def write
-      formatted_data = data_format
-      File.open(output_filename, 'a') do |file|
-        file.write(formatted_data)
-      end
-    end
-
-
-    def output_filename
-      "metrics_report.md"
-    end
-  end
-end
+require_relative 'format_base'
+
+module DevMetrics
+  class Markdown < FormatBase
+
+    def call
+      write
+    end
+
+    private
+
+    def write
+      is_new_file = !File.exist?(file_name) || File.size(file_name).zero?
+      File.open(file_name, "a") do |file|
+        if is_new_file
+          file.puts "| " + columns.map { |col| col['label'] || col }.join(' | ') + " |"
+          file.puts "| " + (["---"] * columns.size).join(' | ') + " |"
+        end
+        file.puts "| " + build_row.join(' | ') + " |"
+      end
+    end
+
+    def file_name
+      "dev_metrics.md"
+    end
+  end
+end

data/lib/dev_metrics/metrics_calc.rb

@@ -1,26 +1,30 @@
+require 'pry'
+
 module DevMetrics
   class MetricsCalc
     attr_reader :period
 
-    def initialize(prs, period, bot_accounts:, fix_branch_names:)
+    def initialize(prs, period, excluded_accounts:, rollback_branch_prefixes:)
       @prs = prs
       @period = period
-      @bot_accounts = bot_accounts || []
-      @fix_branch_names = fix_branch_names
+      @excluded_accounts = excluded_accounts || []
+      @rollback_branch_prefixes = rollback_branch_prefixes
     end
 
     # Returns the number of PRs excluding those created by bot accounts.
     #
     # @return [Integer] Number of PRs excluding bots.
     def prs_length
-      count_prs_with_excluded_account(@prs, @bot_accounts).length
+      count_prs_with_excluded_account(@prs, @excluded_accounts).length
     end
 
     # Returns the number of rollback PRs (branch name matches fix patterns).
     #
     # @return [Integer] Number of rollback PRs.
     def rollback_prs_length
-      @prs.count { |pr| pr.head_ref_name&.match?(/^#{@fix_branch_names.join('|')}/) }
+      return 0 if @rollback_branch_prefixes.nil? || @rollback_branch_prefixes.empty?
+      regex = /^#{@rollback_branch_prefixes.join('|')}/
+      @prs.count { |pr| pr.head_ref_name&.match?(regex) }
     end
 
     # Returns the average lead time for PRs (from creation to merge) as a formatted string.
@@ -200,9 +204,9 @@ module DevMetrics
 
     private
 
-    def count_prs_with_excluded_account(prs, bot_accounts)
-      return prs if bot_accounts.empty?
-      prs.reject { |pr| bot_accounts.include?(pr.author) }
+    def count_prs_with_excluded_account(prs, excluded_accounts)
+      return prs if excluded_accounts.empty?
+      prs.reject { |pr| excluded_accounts.include?(pr.author) }
     end
 
     def format_time(seconds)

data/lib/dev_metrics/query_builder.rb

@@ -4,6 +4,7 @@ module DevMetrics
     def initialize(repo)
       @repo = repo
     end
+
     def access_auth_check
       to_body <<~GRAPHQL
       {
@@ -11,7 +12,7 @@ module DevMetrics
           id
         }
       }
-    GRAPHQL
+      GRAPHQL
     end
 
     def pull_requests_for(period)
@@ -22,20 +23,35 @@ module DevMetrics
             node {
               ... on PullRequest {
                 url
+                number
                 title
-                author { login }
+                body
+                state
+                createdAt
+                updatedAt
+                closedAt
                 mergedAt
+                author { login }
+                assignees(first: 10) { nodes { login } }
+                labels(first: 10) { nodes { name } }
                 headRefName
-                publishedAt
+                baseRefName
                 additions
                 deletions
                 changedFiles
+                commits { totalCount }
+                reviews { totalCount }
+                reviewRequests { totalCount }
+                mergedBy { login }
+                milestone { title }
+                isDraft
+                mergeable
               }
             }
           }
         }
       }
-    GRAPHQL
+      GRAPHQL
     end
 
     private

data/lib/dev_metrics/version.rb

@@ -1,3 +1,3 @@
 module DevMetrics
-  VERSION = "0.2.0"
+  VERSION = "0.2.5"
 end

data/lib/dev_metrics.rb

@@ -1,17 +1,40 @@
+require 'optparse'
+require 'yaml'
 require_relative 'dev_metrics/markdown'
 require_relative 'dev_metrics/version'
 require_relative 'dev_metrics/client'
 require_relative 'dev_metrics/metrics_calc'
+require_relative 'dev_metrics/csv'
+require_relative 'dev_metrics/json'
+
 
 module DevMetrics
   class Config
-    attr_accessor :access_token, :repo_name, :bot_accounts, :fix_branch_names
+    attr_accessor :access_token, :repo_name, :excluded_accounts, :rollback_branch_prefixes
 
     def initialize
       @access_token = nil
       @repo_name = nil
-      @bot_accounts = nil
-      @fix_branch_names = nil
+      @excluded_accounts = []
+      @rollback_branch_prefixes = []
+    end
+
+    def load_from_yaml(path = "dev_metrics_config.yml")
+      unless File.exist?(path)
+        warn "Config file '#{path}' not found. Please create it before running this tool."
+        exit 1
+      end
+
+      config = YAML.load_file(path)
+      if config["access_token"].nil? || config["repo_name"].nil?
+        warn "Config file must include 'access_token' and 'repo_name'."
+        exit 1
+      end
+
+      @access_token = config["access_token"]
+      @repo_name = config["repo_name"]
+      @excluded_accounts = config["excluded_accounts"] || []
+      @rollback_branch_prefixes = config["rollback_branch_prefixes"] || []
     end
   end
 
@@ -21,15 +44,57 @@ module DevMetrics
     @configuration
   end
 
-  def self.configure
-    yield(configuration)
+  def self.option_parse(argv)
+    options = {
+      period: (Date.today << 1).strftime("%Y-%m"),
+      format: "csv",
+      config: "dev_metrics_config.yml"
+    }
+    OptionParser.new do |opts|
+      opts.banner = "Usage: dev_metrics [options]"
+
+      opts.on("-c", "--config FILE", "Specify config YAML file (default: dev_metrics_config.yml)") do |file|
+        options[:config] = file
+      end
+
+      opts.on("-p", "--period PERIOD", "Specify the period for metrics (e.g., '2025-05' or '2025-05-01..2025-05-31')") do |period|
+        options[:period] = period
+      end
+
+      opts.on("-f", "--format FORMAT", "Specify the output format (e.g., 'csv', 'json', 'markdown')") do |format|
+        options[:format] = format
+      end
+
+      opts.on("-h", "--help", "Display this help message") do
+        puts opts
+        exit
+      end
+    end.parse!(argv)
+    options
   end
 
-  # Run: fetch PRs, calculate metrics, and pass to formatter
-  def self.run(period:, format:)
+  def self.run(argv: nil)
+    argv ||= ARGV
+    options = option_parse(argv)
+    config_file = options[:config] || "dev_metrics_config.yml"
+    @configuration.load_from_yaml(config_file)
+    period = options[:period]
+    format = options[:format]
+
     client = DevMetrics::Client.new(@configuration)
     prs = client.fetch(period: period)
 
-    format.new(prs)
+    case format
+    when "csv"
+      DevMetrics::Csv.new(prs).call
+    when "markdown"
+      DevMetrics::Markdown.new(prs).call
+    when "json"
+      DevMetrics::Json.new(prs).call
+    else
+      warn "Unknown format: #{format}"
+      warn "Available formats: csv, markdown, json"
+      exit 1
+    end
   end
 end

metadata

@@ -1,31 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: dev_metrics
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - sean2121
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-06-16 00:00:00.000000000 Z
+date: 2025-06-19 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
-executables: []
+executables:
+- dev_metrics
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/dev_metrics
 - lib/dev_metrics.rb
 - lib/dev_metrics/client.rb
+- lib/dev_metrics/csv.rb
 - lib/dev_metrics/format_base.rb
+- lib/dev_metrics/json.rb
 - lib/dev_metrics/markdown.rb
 - lib/dev_metrics/metrics_calc.rb
 - lib/dev_metrics/pull_request_wrapper.rb
 - lib/dev_metrics/query_builder.rb
 - lib/dev_metrics/version.rb
-- lib/spec/dev_metrics/metrics_calc_spec.rb
-- lib/spec/spec_helper.rb
 homepage: 
 licenses:
 - MIT
@@ -45,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: A RubyGem for tracking and analyzing development metrics from various repositories.

data/lib/spec/dev_metrics/metrics_calc_spec.rb

@@ -1,107 +0,0 @@
-require_relative '../spec_helper'
-require 'dev_metrics/metrics_calc'
-require 'time'
-
-RSpec.describe DevMetrics::MetricsCalc do
-  let(:period) { "2025-04" }
-  let(:config) { { bot_accounts: [], fix_branch_names: %w(hotfix fix rollback) } }
-
-  let(:pr1) do
-    double(
-      additions: 10,
-      deletions: 2,
-      changed_files: 1,
-      commits_count: 3,
-      reviews_count: 2,
-      review_requests_count: 1,
-      draft?: false,
-      labels: ["bug"],
-      assignees: ["alice"],
-      milestone: "v1.0",
-      created_at: Time.parse("2025-04-01T10:00:00Z"),
-      closed_at: Time.parse("2025-04-02T10:00:00Z"),
-      merged_at: Time.parse("2025-04-02T10:00:00Z"),
-      head_ref_name: "feature/abc",
-      author: "alice"
-    )
-  end
-
-  let(:pr2) do
-    double(
-      additions: 5,
-      deletions: 5,
-      changed_files: 2,
-      commits_count: 2,
-      reviews_count: 1,
-      review_requests_count: 0,
-      draft?: true,
-      labels: ["enhancement"],
-      assignees: ["bob"],
-      milestone: "v1.0",
-      created_at: Time.parse("2025-04-03T10:00:00Z"),
-      closed_at: Time.parse("2025-04-04T10:00:00Z"),
-      merged_at: nil,
-      head_ref_name: "fix/xyz",
-      author: "bob"
-    )
-  end
-
-  let(:prs) { [pr1, pr2] }
-
-  subject do
-    described_class.new(
-      prs,
-      period,
-      bot_accounts: config[:bot_accounts],
-      fix_branch_names: config[:fix_branch_names]
-    )
-  end
-
-  it "calculates prs_length" do
-    expect(subject.prs_length).to eq 2
-  end
-
-  it "calculates rollback_prs_length" do
-    expect(subject.rollback_prs_length).to eq 1
-  end
-
-  it "calculates average_changed_line_size" do
-    expect(subject.average_changed_line_size).to eq 11.0
-  end
-
-  it "calculates average_commits_count" do
-    expect(subject.average_commits_count).to eq 2.5
-  end
-
-  it "calculates draft_pr_rate" do
-    expect(subject.draft_pr_rate).to eq 50.0
-  end
-
-  it "calculates label_counts" do
-    expect(subject.label_counts).to eq({ "bug" => 1, "enhancement" => 1 })
-  end
-
-  it "calculates assignee_counts" do
-    expect(subject.assignee_counts).to eq({ "alice" => 1, "bob" => 1 })
-  end
-
-  it "calculates milestone_counts" do
-    expect(subject.milestone_counts).to eq({ "v1.0" => 2 })
-  end
-
-  it "calculates average_pr_age" do
-    expect(subject.average_pr_age).to be_a(Float)
-  end
-
-  it "calculates draft_pr_count" do
-    expect(subject.draft_pr_count).to eq 1
-  end
-
-  it "calculates merged_pr_count" do
-    expect(subject.merged_pr_count).to eq 1
-  end
-
-  it "calculates closed_unmerged_pr_count" do
-    expect(subject.closed_unmerged_pr_count).to eq 1
-  end
-end

data/lib/spec/spec_helper.rb

@@ -1,3 +0,0 @@
-require 'rspec'
-
-$LOAD_PATH.unshift File.expand_path('../../lib', __dir__)