organization_gem_dependencies 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb5e5a02cbf5ed813e8420830752b6f2f1341f61
-  data.tar.gz: ee3ad55b7be9f1d8f2db3263e20c8cb37e4768a0
+  metadata.gz: 4417535dea7895998e8e89f8c4c1bce3c00a98ad
+  data.tar.gz: d0acb5e478eef3f405cb2e155eb3240534f54b24
 SHA512:
-  metadata.gz: 71ab9c48f521b57b7fa7e2c1c0803126d613b99c641999aeb8951dcef3aa72b369b2a550f216bcfa931088dcd266e97aae98192e5458e49e894806d2d3dfe9a0
-  data.tar.gz: b97283bde770583c62b9dec9a306a02c62b9f6baa241b72b152c7e35de95adbc2314ec93486f84c9b020630bffb8511609551944bf53e91fc559d79b833a978b
+  metadata.gz: 712b8fb611a5a7beb8f96fe6916953eb5a0c8027188497e4a0836b0e008671b9f626135b01af2e76f8461b19759beaab133bb2f42b6ddbc4cc9278a927c5b390
+  data.tar.gz: 64c6a76d8c24f9e2c9134c65ef2278e3ca257d58407c36dd8c4a42ae0053b48416ee85cc331180fb3cef1848e5688d541587113ae83f0db4bb1106f2c384e8fe

data/README.md

@@ -1 +1,99 @@
 # organization_gem_dependencies
+
+This gem installs a command line utility `organization_gem_dependencies`, that
+outputs a json file with a reverse dependency tree.
+
+
+## Installation
+
+```sh
+gem install organization_gem_dependencies
+```
+
+## Usage
+
+```sh
+organization_gem_dependencies [--direct] GITHUB_ORGANIZATION
+```
+
+For example, running `organization_gem_dependencies -d rails` produces output
+like the following:
+
+```json
+{
+  ...,
+  "rails": {
+    "4.0.0.beta": [
+      "routing_concerns/Gemfile.lock"
+    ],
+    "4.2.10": [
+      "rails-docs-server/test/fixtures/releases/v4.2.10/Gemfile.lock"
+    ],
+    "5.1.1": [
+      "actioncable-examples/Gemfile.lock"
+    ],
+    "5.2.0": [
+      "rails-contributors/Gemfile.lock",
+      "webpacker/Gemfile.lock"
+    ],
+    "6.0.0.alpha": [
+      "rails/Gemfile.lock"
+    ]
+  },
+  "rails-controller-testing": {
+    "1.0.2": [
+      "rails-contributors/Gemfile.lock"
+    ]
+  },
+  "rails-dom-testing": {
+    "2.0.2": [
+      "rails-dom-testing/Gemfile.lock"
+    ]
+  },
+  "rails-perftest": {
+    "0.0.7": [
+      "rails-perftest/Gemfile.lock"
+    ]
+  },
+  "railties": {
+    "4.2.1": [
+      "rails-perftest/Gemfile.lock"
+    ],
+    "5.1.4": [
+      "globalid/Gemfile.lock"
+    ]
+  },
+  "rake": {
+    "0.9.2.2": [
+      "commands/Gemfile.lock",
+      "etagger/Gemfile.lock",
+      "routing_concerns/Gemfile.lock"
+    ],
+    "10.0.3": [
+      "strong_parameters/Gemfile.lock"
+    ],
+    "10.0.4": [
+      "cache_digests/Gemfile.lock"
+    ],
+    "10.3.2": [
+      "activemodel-globalid/Gemfile.lock"
+    ],
+    "10.4.2": [
+      "jquery-ujs/Gemfile.lock",
+      "record_tag_helper/Gemfile.lock"
+    ],
+    "12.0.0": [
+      "rails-docs-server/test/fixtures/releases/v4.2.10/Gemfile.lock",
+      "rails-dom-testing/Gemfile.lock"
+    ],
+    "12.1.0": [
+      "globalid/Gemfile.lock"
+    ],
+    "12.3.1": [
+      "rails/Gemfile.lock",
+      "webpacker/Gemfile.lock"
+    ]
+  },
+  ...
+}
+```

data/lib/organization_gem_dependencies.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require 'organization_gem_dependencies/cli'
+require 'organization_gem_dependencies/version'

data/lib/organization_gem_dependencies/cli.rb

@@ -10,17 +10,25 @@ require 'octokit'
 module OrganizationGemDependencies
   # Define the command line interface.
   class Cli
-    SEARCH_TERM = 'org:appfolio filename:Gemfile.lock'
+    SEARCH_TERM = 'org:%s filename:Gemfile.lock'
+    USAGE = <<~USAGE
+      Usage: organization_gem_dependencies [options] GITHUB_ORGANIZATION
+    USAGE
 
     def run
       parse_options
+      if ARGV.size != 1
+        STDERR.puts USAGE
+        return 1
+      end
+      github_organization = ARGV[0]
 
       access_token = ENV['GITHUB_ACCESS_TOKEN'] || \
                      STDIN.getpass('GitHub Personal Access Token: ')
       github = Octokit::Client.new(access_token: access_token)
 
       gems = {}
-      gemfiles(github) do |gemfile|
+      gemfiles(github, github_organization) do |gemfile|
         STDERR.puts "Processing #{gemfile.repository.name}/#{gemfile.path}"
         content = nil
         sleep_time = 0
@@ -45,8 +53,8 @@ module OrganizationGemDependencies
 
     private
 
-    def gemfiles(github)
-      github.search_code(SEARCH_TERM, per_page: 1000)
+    def gemfiles(github, organization)
+      github.search_code(SEARCH_TERM % organization, per_page: 1000)
       last_response = github.last_response
 
       matches = last_response.data.items
@@ -91,9 +99,7 @@ module OrganizationGemDependencies
     def parse_options
       @options = { direct: false }
       OptionParser.new do |config|
-        config.banner = <<~USAGE
-          Usage: organization_gem_dependencies [options]
-        USAGE
+        config.banner = USAGE
         config.on('-d', '--direct',
                   'Consider only direct dependencies.') do |direct|
           @options[:direct] = direct

data/lib/organization_gem_dependencies/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OrganizationGemDependencies
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: organization_gem_dependencies
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bryce Boe
@@ -92,5 +92,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Discover all ruby gem depedencies for a github organization.
+summary: Discover all ruby gem dependencies for a github organization.
 test_files: []