gem-miner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4acfe8bf3640a218566752d209c0ec69dbf0665d
+  data.tar.gz: 6fe3c2965609073a8777875ecca05dde2cb61c9f
+SHA512:
+  metadata.gz: c50059c70f09a70cbee8d212d22f9e34610a723100a5132fbac7fad70816b7761532c3c82a78556f228bfca5d6575dc10a9c820ff4aa5e98f6bd40c7b2d31b56
+  data.tar.gz: 2aa3365629d0780671ad8c4f6743230107e4f03a7ede10c376debb915b517636f7d822975bfc68946896b9eab9aa4563e8a9858bfa8ff90a8614503a38de7eae

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gem-miner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Reevoo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# GemMiner
+
+[![Build Status](https://travis-ci.org/reevoo/gem-miner.svg?branch=master)](https://travis-ci.org/reevoo/gem-miner)
+
+[![Code Climate](https://codeclimate.com/github/reevoo/gem-miner/badges/gpa.svg)](https://codeclimate.com/github/reevoo/gem-miner)
+
+
+
+At [Reevoo](http://reevoo.github.io), we want to get rid of some of our old repositories - they don't do anything and they're confusing new starters. However, we want to make sure that these repositories aren't used by others.
+
+GemMiner looks through all of the repositories of a GitHub user and shows where a gem is being used by extracting information from Gemfiles and Gemspecs.
+
+This tool is being actively developed; please feel free to contribute or fork for your own purposes!
+
+## Installation
+
+This is a tool, so it makes sense to install it globally.
+
+```bash
+gem install 'gem-miner'
+```
+
+## Usage
+
+Execute `gem-miner help` in your favourite shell for information on the wonderful things this application can do.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/reevoo/gem-miner.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gem-miner"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/gem-miner

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'gem-miner/cli'
+
+GemMiner::CLI.start(ARGV)

data/gem-miner.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gem-miner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gem-miner'
+  spec.version       = GemMiner::VERSION
+  spec.authors       = ['Reevoo']
+  spec.email         = ['developers@reevoo.com']
+
+  spec.summary       = %q{Collect Gemfiles and Gemspecs from multiple repositories.}
+  spec.homepage      = 'https://github.com/reevoo/gem-miner'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # GitHub API Client
+  spec.add_dependency 'octokit', '~> 4'
+
+  # CLI helper. Not at v1 yet...
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'pry-byebug'
+end

data/lib/gem-miner.rb

@@ -0,0 +1,4 @@
+require 'gem-miner/version'
+require 'gem-miner/miner'
+# 'gem-miner/cli' is deliberately not included here;
+# cli includes gem-miner, not the other way round.

data/lib/gem-miner/cli.rb

@@ -0,0 +1,53 @@
+require 'gem-miner'
+require 'thor'
+require 'yaml'
+
+module GemMiner
+  class CLI < Thor
+
+    option :token,
+      aliases: [:t],
+      desc: 'The Github access token to use when querying Github.',
+      type: :string
+
+    option :output,
+      aliases: [:o],
+      desc: 'The filename to output results to (leave blank for console).',
+      type: :string
+
+    desc 'gems QUERY', 'Collects all gems for projects given by the Github query.'
+    long_desc <<-LD
+      Collects all gems for projects given by the Github query.
+      This is useful for auditing which gems you use across all projects,
+      to check whether you can delete any!
+
+      The following command gets all gems for the organisation 'reevoo':
+
+      > $ gem-miner gems user:reevoo
+
+      You probably want to supply an access token to ensure you are not rate-limited
+      by Github.
+
+      This action returns the gems as a hash in YAML format with the gem description as the key
+      and the repositories that use the gem as an array of values.
+    LD
+    def gems(github_search_query)
+      output GemMiner::Miner.gems_for(github_search_query, options[:token]).to_yaml
+    end
+
+    private
+
+    # Output the result of a command to either the terminal or a file,
+    # depending on the options given.
+    def output(result)
+      if options[:output]
+        File.write(options[:output], result)
+      else
+        puts result
+      end
+
+      result
+    end
+
+  end
+end

data/lib/gem-miner/github_client.rb

@@ -0,0 +1,38 @@
+require 'base64'
+require 'octokit'
+
+module GemMiner
+  # A Github client with GemMiner-specific extensions.
+  class GithubClient
+
+    def initialize(github_access_token = nil)
+      @internal_client = Octokit::Client.new(
+        auto_paginate: true,
+        access_token: github_access_token
+      )
+    end
+
+    # Gets the files from a code search.
+    def files(query)
+      @internal_client.search_code(query)['items']
+        .map do |item|
+          {
+            name: name_of(item),
+            content: raw_content(item),
+          }
+        end
+    end
+
+    private
+
+    def name_of(item)
+      item[:repository][:full_name]
+    end
+
+    def raw_content(item)
+      content_request = @internal_client.contents(name_of(item), path: item[:path])
+      Base64.decode64 content_request[:content]
+    end
+
+  end
+end

data/lib/gem-miner/logger.rb

@@ -0,0 +1,15 @@
+module GemMiner
+
+  module Logger
+    @@logger = STDOUT
+
+    def self.logger=(logger)
+      @@logger = logger
+    end
+
+    def log(message)
+      @@logger.print message if @@logger
+    end
+  end
+
+end

data/lib/gem-miner/miner.rb

@@ -0,0 +1,121 @@
+require 'base64'
+require 'octokit'
+
+require 'gem-miner/github_client'
+require 'gem-miner/logger'
+
+module GemMiner
+  class Miner
+    include Logger
+
+    def self.gems_for(*args)
+      new(*args).gems
+    end
+
+    def initialize(github_search_query, github_client = GithubClient.new)
+      @github_search_query = github_search_query
+      @github_client = github_client
+    end
+
+    # A hash of gems and the repositories they are used in:
+    #
+    # {
+    #   "pry '~> 1'" => ['reevoo/flakes', 'reevoo/gem-miner'],
+    #   ...
+    # }
+    def gems
+      @gems ||= collect_gems!
+    end
+
+    private
+
+    # Collects gem specifications from Gemfiles and Gemspecs.
+    # Returns a hash of gems and the repositories they are used in:
+    #
+    # {
+    #   "pry '~> 1'" => ['reevoo/flakes', 'reevoo/gem-miner'],
+    #   ...
+    # }
+    def collect_gems!
+      gemfiles = parse_gemfiles
+      gemspecs = parse_gemspecs
+
+      gems = merge_hashes(gemfiles, gemspecs)
+
+      # Invert the PROJECT => [GEMS] hash to a GEM => [PROJECTS] hash
+      gems = invert_hash_of_arrays(gems)
+
+      # Sort it
+      gems = gems.sort.to_h
+    end
+
+    # Collects all of the gemfiles for all Reevoo repositories.
+    # Returns a dictionary with the gem as the key and an array of repositories as
+    # values.
+    def parse_gemfiles
+      results = search("filename:Gemfile #{@github_search_query}")
+
+      log "Parsing #{results.count} gemfiles"
+      gemfiles = results.reduce({}) do |memo, result|
+        # We might have more than one Gemfile in a repository...
+        memo[name_of(result)] ||= []
+        memo[name_of(result)] += extract_gemfile(result[:content])
+        log '.'
+        memo
+      end
+      log "done!\n"
+      gemfiles
+    end
+
+    GEM_REGEX = /gem[\s]+([^\n\;]+)/
+    def extract_gemfile(gemfile)
+      gemfile.gsub(/\"/, '\'').scan(GEM_REGEX).flatten
+    end
+
+    def parse_gemspecs
+      results = search("filename:gemspec #{@github_search_query}")
+      log "Parsing #{results.count} gemspecs"
+      gemspecs = results.reduce({}) do |memo, result|
+        # We might have more than one Gemfile in a repository...
+        memo[name_of(result)] ||= []
+        memo[name_of(result)] += extract_gemspec(result[:content])
+        log '.'
+        memo
+      end
+      log "done!\n"
+      gemspecs
+    end
+
+    GEMSPEC_REGEX = /dependency[\s]+([^\n\;]+)/
+    def extract_gemspec(gemspec)
+      gemspec.gsub(/\"/, '\'').scan(GEMSPEC_REGEX).flatten
+    end
+
+    def search(query)
+      @github_client.files(query)
+    end
+
+    # Merge two hashes of lists
+    #
+    # h1 = { a: [1, 2, 3], b: [2, 4] }
+    # h2 = { b: [1, 3], c: [1, 2, 3] }
+    # merge_hashes(h1, h2) # => { a: [1, 2, 3], b: [1, 2, 3, 4], c: [1, 2, 3] }
+    #
+    # From http://stackoverflow.com/questions/11171834/merging-ruby-hash-with-array-of-values-into-another-hash-with-array-of-values
+    def merge_hashes(hash1, hash2)
+      hash1.merge(hash2) { |key, oldval, newval| (oldval | newval) }
+    end
+
+    # Converts a hash of the form A => [Bs] to B => [As]
+    def invert_hash_of_arrays(hash)
+      hash.reduce({}) do |memo, (key, values)|
+        values.each do |v|
+          memo[v] ||= []
+          memo[v] << key
+        end
+
+        memo
+      end
+    end
+  end
+end

data/lib/gem-miner/version.rb

@@ -0,0 +1,3 @@
+module GemMiner
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: gem-miner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Reevoo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- developers@reevoo.com
+executables:
+- gem-miner
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gem-miner
+- gem-miner.gemspec
+- lib/gem-miner.rb
+- lib/gem-miner/cli.rb
+- lib/gem-miner/github_client.rb
+- lib/gem-miner/logger.rb
+- lib/gem-miner/miner.rb
+- lib/gem-miner/version.rb
+homepage: https://github.com/reevoo/gem-miner
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Collect Gemfiles and Gemspecs from multiple repositories.
+test_files: []