forkreadme 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+source "https://rubygems.org"
+gemspec

data/bin/forkreadme

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "forkreadme"
+require "thor"
+
+module ForkReadme
+  class App < Thor
+
+    desc "generate [DIR]", "Generate a README for a GitHub fork repo"
+    method_option :path, :default=>"."
+    def generate path=""
+      begin
+        dir = File.expand_path path, Dir.pwd
+        puts Generator.new(dir).readme
+
+      rescue ForkReadme::Error => err
+        $stderr.puts err
+        exit false
+      end
+    end
+  end
+end
+
+ForkReadme::App.start

data/forkreadme.gemspec

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require File.expand_path("../lib/forkreadme/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "forkreadme"
+  gem.version       = ForkReadme::VERSION
+
+  gem.authors       = ["Adam Mckaig"]
+  gem.email         = ["adam.mckaig@gmail.com"]
+  gem.summary       = %q{Generate useful READMEs for GitHub forks}
+  gem.homepage      = "https://github.com/adammck/forkreadme"
+
+  gem.add_dependency "thor", "~> 0.14.6"
+  gem.add_dependency "octokit", "~> 1.0.2"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/forkreadme/errors.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+module ForkReadme
+  class Error < StandardError
+  end
+  
+  class NotRepo < Error
+  end
+  
+  class NotFork < Error
+  end
+end

data/lib/forkreadme/generator.rb

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+require "uri"
+require "octokit"
+
+module ForkReadme
+  class Generator
+    include URI::REGEXP::PATTERN
+
+    def initialize dir
+      @dir = dir
+    end
+
+    def readme
+      repo_name = github_repo_name @dir
+
+      if repo_name.empty?
+        raise NotRepo.new "Not a GitHub repo: #{@dir}"
+      end
+
+      repo = octokit.repo repo_name
+
+      unless repo.fork
+        raise NotFork.new "Not a GitHub fork: #{repo_name}"
+      end
+
+      parent_name = full_name repo.parent
+      parent = octokit.repo parent_name
+
+      s = []
+      s << "This is a fork of [#{parent.name}] (#{parent.html_url}), with pull requests:"
+      s << ""
+
+      logins = collaborator_logins repo
+      my_pulls = pull_requests(parent).select do |pull|
+        pull.user and logins.include?(pull.user.login)
+      end
+
+      my_pulls.each do |short_pull|
+        pull = pull_request(parent, short_pull.number)
+        if repo_name == full_name(pull.head.repo)
+          s << " * [#{pull.title}] (#{pull.html_url})"
+        end
+      end
+
+      s.join "\n"
+    end
+  
+  
+    private
+  
+    # Private: Returns an Array containing the logins of all collaborators for an
+    # Octokit repo.
+    def collaborator_logins repo
+      octokit.collabs(full_name repo).map do |user|
+        user.login
+      end
+    end
+  
+    # Private: Returns all pull request summaries (as returned by the "List pull
+    # requests" API, and wrapped by Octokit) for an Octokit repo.
+    def pull_requests repo
+      name = full_name repo
+  
+      %w[open closed].reduce([]) do |memo, state|
+        memo | octokit.pulls(name, state, :per_page=>100)
+      end
+    end
+  
+    # Private: Return full pull request (as returned by the "Get a single pull
+    # request" API, and wrapped by Octokit) to an Octokit repo and pull number.
+    def pull_request repo, number
+      octokit.pull full_name(repo), number
+    end
+  
+    # Private: Returns the full GitHub repo name of a Git working directory.
+    def github_repo_name path
+      clone_url = parse_url remote_url path
+      chop_extension clone_url.path
+    end
+  
+    # Private: Returns the full GitHub repo name of an Octokit repo.
+    def full_name repo
+      "#{repo.owner.login}/#{repo.name}"
+    end
+  
+    # Private: Returns a configured Octokit client.
+    def octokit
+      @ok ||= Octokit.new(:auto_traversal=>true)
+    end
+  
+    # Private: Returns the remote url of a Git working directory.
+    def remote_url path
+      %x{git config --file #{path}/.git/config --get remote.origin.url}
+    end
+  
+    # Private: Returns a parsed URL. Wraps `URI.parse` with support for Git's
+    # SCP-like syntax (look like: git@github.com:adammck/whatever.git).
+    def parse_url url
+      begin
+        URI.parse(url)
+  
+      rescue URI::InvalidURIError
+        if m = url.match("^(#{USERINFO})@(#{HOST}):(#{REL_PATH})$")
+          URI::Generic.new "ssh", m[1], m[2], 22, nil, m[3], nil, nil, nil
+  
+        else
+          raise
+        end
+      end
+    end
+  
+    # Private: Returns a filename with the extension removed.
+    def chop_extension filename
+      filename.sub /\.\w+$/, ""
+    end
+  end
+end

data/lib/forkreadme/version.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+module ForkReadme
+  VERSION = "0.0.1"
+end

data/lib/forkreadme.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# vim: et ts=2 sw=2
+
+module ForkReadme
+end
+
+require "forkreadme/errors"
+require "forkreadme/generator"
+require "forkreadme/version"

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: forkreadme
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Adam Mckaig
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70204084253700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *70204084253700
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: &70204084253100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70204084253100
+description: 
+email:
+- adam.mckaig@gmail.com
+executables:
+- forkreadme
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- bin/forkreadme
+- forkreadme.gemspec
+- lib/forkreadme.rb
+- lib/forkreadme/errors.rb
+- lib/forkreadme/generator.rb
+- lib/forkreadme/version.rb
+homepage: https://github.com/adammck/forkreadme
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Generate useful READMEs for GitHub forks
+test_files: []