project-report 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb2e40ca5b103334ae6bf30cb1d7d0adb72a9b5824c18e2480723d145ba27acf
+  data.tar.gz: 17f2bc41029fdddd6e0839400e38f9dd409d317f333e4e8e4e7d7aa67bc8175f
+SHA512:
+  metadata.gz: ee2a176a527dc6ab6aaea20fde66fb845d0b2308209548adb1a7f1f38497263d8fa43e0e74d885ecfcf49e6633cbbc4ef52e63064b3ef4c7d95f134365d027f4
+  data.tar.gz: cb0cc8c3c9959cb0209057ee2b3085081d76d904eaba7141c5c676c96ca745001a700fc13cab04af25b25fafec00bee245f972a0b16920b96e02b4c181988af3

data/bin/project-report

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+require 'rugged'
+require 'linguist'
+require 'optparse'
+require 'bibliothecary'
+
+def parse_options
+  ARGV.push('-h') if ARGV.empty?
+  options = { :name => "",
+              :business => "",
+  }
+  OptionParser.new do |opts|
+    opts.banner = "Generate statistics about project, such as used languages, row counts and dependencies.
+  Usage: project-report [options] -r<paths to git repository in local directory>
+
+  Example: ./project-report -r . -n\"Project Report\" --business=\"Open Source\"
+
+  Options:
+"
+
+    opts.on("-oFILE", "--output-file=FILE", "Write output to this file. Otherwise to STDOUT") do |o|
+      options[:output] = o
+    end
+    opts.on("-nNAME", "--project-name=NAME", "Project name, will be prompted if not set") do |name|
+      options[:name] = name
+    end
+    opts.on("-bBUSINESS", "--business=BUSINESS", "Project business area, will be prompted if not set") do |business|
+      options[:business] = business
+    end
+    opts.on("-h", "--help", "Show this message") do
+      puts opts
+      exit
+    end
+    opts.on("-rX,Y,Z --repos=X,Y,Z", Array, "Comma separated list of repository paths to scan. All repositories are assumed to be under the same project") do |list|
+      options[:repos] = list
+      options[:repos].each do |repo|
+        raise "#{repo} must be a git directory" unless File.directory?("#{repo}/.git")
+      end
+    end
+  end.parse!
+
+  mandatory = [:repos]
+  missing = mandatory.select { |param| options[param].nil? }
+  unless missing.empty?
+    raise OptionParser::MissingArgument.new(missing.join(', ')) #
+  end
+
+  options
+end
+
+def language_stats(path)
+  repo = Rugged::Repository.new(path)
+  Linguist::Repository.new(repo, repo.head.target_id)
+end
+
+# Scan Package manager data
+def scan_package_manager_data(root, paths)
+  manifests = Bibliothecary.identify_manifests(paths)
+  project_analyses = manifests.flat_map do |manifest|
+    Bibliothecary.analyse_file("#{root}/#{manifest}", File.open("#{root}/#{manifest}").read)
+  end
+  project_analyses.filter do |analysis|
+    # TODO flag for lockfile data? Drop them for now
+    analysis[:kind] != "lockfile"
+  end
+end
+
+def repo_stats(repo_path)
+  stats = language_stats(repo_path)
+  files = stats.repository.index.map { |h| h[:path] }
+  scans = scan_package_manager_data(repo_path, files)
+  {
+    "path" => repo_path,
+    "languages" => stats.languages,
+    "subprojects" => scans.map { |scan|
+      {
+        "platform" => scan[:platform],
+        "path" => scan[:path],
+        "dependencies" => scan[:dependencies].map { |dep|
+          {
+            "name" => dep[:name],
+            "type" => dep[:type].to_s,
+            "requirement" => dep[:requirement]
+          }
+        }
+      }
+    }
+  }
+end
+
+# Prompt missing fields
+options = parse_options
+if options[:name] == ""
+  print "Project name? "
+  options[:name] = STDIN.gets.strip
+end
+if options[:business] == ""
+  print "Project business area (e.g. ecommerce, banking, etc..)? "
+  options[:business] = STDIN.gets.strip
+end
+
+# Generate end result
+project = {
+  "project" => {
+    "name" => options[:name],
+    "business" => options[:business],
+    "repos" => options[:repos].map{ |repo| repo_stats(repo)}
+  }
+}
+if options[:output]
+  File.write(options[:output], project.to_yaml)
+else
+  puts(project.to_yaml(indentation: 10))
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: project-report
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tatu Lahtela
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: github-linguist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.16.0
+- !ruby/object:Gem::Dependency
+  name: bibliothecary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 7.0.2
+description: |-
+  Generate language statistics and dependency report for projects.
+  Shows used languages with row counts, used package managers and dependenccies.
+email: lahtela@iki.fi
+executables:
+- project-report
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/project-report
+homepage: https://github.com/ration/project-report
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Generate language statistics and dependency report for projects
+test_files: []