cerebro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 300c56ecf7b5ccc38151ec5383dcf467a7f7c260
+  data.tar.gz: 2269ee2bb942a2cedcd6bad1d5db275c5fb2eb15
+SHA512:
+  metadata.gz: fcb68614992bba5d6c69343878a36bba36bb01ab06a1129fbbc3c0c2f3474f1bb7d566d3f0ea0f6b4f2a0cb23dabc1450be99c6a2a7b1541c09fff258dd8fe95
+  data.tar.gz: 273930a5f25475a54dd43de1e219cb3f00579ac4ed700630620fc81e2d882016f88d646df1867cedf70b83817257377574ee3d433f9efd5caf02d6cd109963b5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 cortelyou
+
+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,91 @@
+# Cerebro
+
+Search through github forks of a repo for search terms!
+Great for maintainers that want to know what downstream forks are doing.
+
+## Installation
+
+Install it with:
+
+```bash
+$ gem install cerebro
+```
+
+## Details
+
+Cerebro currently works by using the Github API to identify all the forks of the
+repo if interest. It then will clone all the repos down into a specifically named
+repo under the `$HOME/.cerebro` directory. It will then use grep searching to
+determine if your search term is present in each/which of the forks.
+
+## Usage
+
+- Cloning down of the repos will be shallow by default. If you want deep clones, use `cerebro search --deep`.
+
+####Searching:
+
+- To clean up all repos that Cerebro has cloned onto your local file system:
+
+```bash
+$ GITHUB_TOKEN=<github_api_token> cerebro search <repo_owner> <repo_name> <search_term>
+```
+
+For example, if I'm looking to determine how many forks of the [Cloud Foundry python buildpack](https://github.com/cloudfoundry/python-buildpack)
+have been forked to add or use `graphviz`, I might run:
+
+```
+GITHUB_TOKEN=<github_token> cerebro search cloudfoundry python-buildpack graphviz
+Found 85 forks of cloudfoundry/python-buildpack
+All forks will be stored in /Users/user/.cerebro/python-buildpack-forks
+Cloning or updating all local fork repos...
+<...>
+Searching through these forks now...
+
+----------------Search Results---------------------
+Found graphviz in kdunn-pivotal-python-buildpack
+Found graphviz in ssssam-python-buildpack
+
+Found "graphviz" in 2 forks out of total 85 forks of cloudfoundry/python-buildpack
+
+Clones of forked repos are located in /Users/user/.cerebro/python-buildpack-forks
+```
+
+####Cleaning Up:
+
+- To clean up all repos that Cerebro has cloned onto your local file system:
+
+```bash
+$ cerebro clean --all
+```
+
+- To clean up only the repos that are forks for a specific repo:
+
+```bash
+$ cerebro clean <repo-name>
+```
+
+## Dependencies
+
+- This gem relies on `git` for cloning down forks of repos.
+- This gem currently relies on $HOME being set on your machine for figuring out where to store cloned repos.
+- This gem's searching for forks relies on the user providing a valid Github API token via
+  `GITHUB_TOKEN` env vars. This token is not persisted or stored at all.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RochesterinNYC/cerebro or in https://cloudfoundry.slack.com/messages/buildpacks/.
+
+## Later Work
+
+- Make dirnames specific to owner and repo name instead of just repo name
+- Command for cleaning up stored repos
+- Specify where to store cloned repos
+- Option for auto-clean up afterwards
+- Better UX for specifying github auth
+- Remove dependency on octokit
+- Threading for parallel cloning
+- Search caching?
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cerebro"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cerebro.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cerebro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cerebro"
+  spec.version       = Cerebro::VERSION
+  spec.authors       = ["James Wen"]
+  spec.email         = ["jrw2175@columbia.edu"]
+
+  spec.summary       = "A tool for searching through forks of github repos for information."
+  spec.description   = "Description"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = ["cerebro"]
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'claide', '>= 1.0.0', '< 2.0'
+  spec.add_runtime_dependency 'octokit', '>= 4.0.0', '< 5.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/exe/cerebro

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'cerebro'
+
+Cerebro::Command.run(ARGV)

data/lib/cerebro.rb

@@ -0,0 +1,11 @@
+require "cerebro/version"
+
+module Cerebro
+  autoload :Command,  'cerebro/command'
+  autoload :Searcher, 'cerebro/searcher'
+
+  def self.storage_directory
+    home_dir = ENV.fetch('HOME', nil)
+    home_dir.empty? ? nil : File.join(home_dir, ".cerebro")
+  end
+end

data/lib/cerebro/command.rb

@@ -0,0 +1,24 @@
+require 'claide'
+
+module Cerebro
+  class Command < CLAide::Command
+    require 'cerebro/command/search'
+    require 'cerebro/command/clean'
+
+    def self.run(argv)
+      super(argv)
+    end
+
+    def validate!
+	    super
+
+      if !Cerebro.storage_directory
+        puts <<-HELP
+You don't have $HOME set.
+Cerebro currently relies on storing cloned fork repos in your home directory.
+        HELP
+        exit 1
+      end
+    end
+  end
+end

data/lib/cerebro/command/clean.rb

@@ -0,0 +1,48 @@
+require 'fileutils'
+
+module Cerebro
+  class Command
+    class Clean < Command
+      self.summary = 'Clean locally stored github repo forks'
+      self.description = <<-DESC
+	Clean up the repos that you've cloned down via searches
+      DESC
+
+      def initialize(argv)
+	@clean_specs = argv.arguments
+	@repo = argv.shift_argument
+	@clean_all = argv.flag?('all')
+	super
+      end
+
+      def self.options
+        [
+          ['--all', 'Clean all locally cloned repos used by Cerebro'],
+        ].concat(super).reject { |(name, _)| name == '--no-all' }
+      end
+
+      def validate!
+	super
+
+	if !@clean_all && @clean_specs.length != 1
+	  help = <<-HELP
+Usage: cerebro clean <repo_name>
+	  HELP
+	  help! help
+	end
+      end
+
+      def run
+	if @clean_all
+	  FileUtils.rm_rf("#{Cerebro.storage_directory}/.")
+	  puts "Cleaned up all local clones created by Cerebro"
+	else
+	  Dir.chdir(Cerebro.storage_directory) do
+	    FileUtils.rm_rf("#{@repo}-forks")
+	  end
+	  puts "Cleaned up all local clones of #{@repo} forks created by Cerebro"
+	end
+      end
+    end
+  end
+end

data/lib/cerebro/command/search.rb

@@ -0,0 +1,94 @@
+require 'octokit'
+require 'fileutils'
+require 'cerebro/searcher'
+
+module Cerebro
+  class Command
+    class Search < Command
+      self.summary = 'Search through github repo forks'
+      self.description = <<-DESC
+	Search through forks of the specified repo for a search term
+      DESC
+
+      def initialize(argv)
+	@search_specs = argv.arguments
+	@owner = argv.shift_argument
+	@repo = argv.shift_argument
+	@search_term = argv.shift_argument
+	@deep_clone = argv.flag?('deep')
+	@github_token = ENV.fetch('GITHUB_TOKEN', nil)
+	super
+      end
+
+      def self.options
+        [
+          ['--deep', 'Use full git cloning instead of shallow clones'],
+        ].concat(super).reject { |(name, _)| name == '--no-deep' }
+      end
+
+      def validate!
+	super
+
+	if @search_specs.length != 3
+	  help = <<-HELP
+  Usage: GITHUB_TOKEN=<github_token> cerebro search <repo_owner> <repo_name> <search_term>
+	  HELP
+	  help! help
+	end
+	if !@github_token
+	  puts <<-HELP
+  Please specify or pass in GITHUB_TOKEN as an environment variable.
+  Usage: GITHUB_TOKEN=<github_token> cerebro search <repo_owner> <repo_name> <search_term>
+	  HELP
+	  exit 1
+	end
+      end
+
+      def run
+	# Setup Github API
+	Octokit.auto_paginate = true
+	Octokit.configure do |c|
+	  c.access_token = @github_token
+	end
+
+	full_repo_name = "#{@owner}/#{@repo}"
+	forks_with_term = []
+
+	# Get all forks
+	forks = Octokit.forks(full_repo_name)
+	forks_directory = File.join(Cerebro.storage_directory, "#{@repo}-forks")
+	FileUtils.mkdir_p forks_directory
+
+	Dir.chdir(forks_directory) do
+	  puts "Found #{forks.count} forks of #{full_repo_name}"
+	  puts "All forks will be stored in #{forks_directory}"
+	  puts "Cloning or updating all local fork repos..."
+	  forks.each do |git_fork|
+	    forked_dir = File.join(forks_directory, "#{git_fork.owner.login}-#{git_fork.name}")
+	    if Dir.exists?(forked_dir)
+	      Dir.chdir(forked_dir) do
+		`git pull -r`
+	      end
+	    else
+	      shallow = @deep_clone ? "" : "--depth 1"
+	      `git clone #{shallow} #{git_fork.ssh_url} #{forked_dir}`
+	    end
+	  end
+	  puts "Searching through these forks now..."
+	  forks_with_term = Searcher.find(forks_directory, @search_term)
+	end
+	puts <<-RESULTS
+
+----------------Search Results---------------------
+	RESULTS
+	forks_with_term.each do |repo_identifier|
+	  puts "Found #{@search_term} in #{repo_identifier}"
+	end
+	puts
+	puts "Found \"#{@search_term}\" in #{forks_with_term.count} forks out of total #{forks.count} forks of #{full_repo_name}"
+	puts
+	puts "Clones of forked repos are located in #{forks_directory}"
+      end
+    end
+  end
+end

data/lib/cerebro/searcher.rb

@@ -0,0 +1,30 @@
+module Cerebro
+  class Searcher
+    attr_accessor :forks_dir
+    attr_accessor :search_term
+
+    def self.find(forks_dir, search_term)
+      new(forks_dir, search_term).matched_forks
+    end
+
+    def initialize(forks_dir, search_term)
+      @forks_dir = forks_dir
+      @search_term = search_term
+    end
+
+    def matched_forks
+      forks_with_term = []
+	    Dir.chdir(@forks_dir) do
+        Dir["*"].each do |fork_dir|
+          forks_with_term << fork_dir if search_in_fork(fork_dir)
+        end
+      end
+      forks_with_term
+    end
+
+    def search_in_fork(fork_dir)
+      `grep -IR '#{@search_term}' #{fork_dir}`
+      $?.success?
+    end
+  end
+end

data/lib/cerebro/version.rb

@@ -0,0 +1,3 @@
+module Cerebro
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: cerebro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Wen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: claide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Description
+email:
+- jrw2175@columbia.edu
+executables:
+- cerebro
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cerebro.gemspec
+- exe/cerebro
+- lib/cerebro.rb
+- lib/cerebro/command.rb
+- lib/cerebro/command/clean.rb
+- lib/cerebro/command/search.rb
+- lib/cerebro/searcher.rb
+- lib/cerebro/version.rb
+homepage: ''
+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.6.3
+signing_key: 
+specification_version: 4
+summary: A tool for searching through forks of github repos for information.
+test_files: []