gem-home 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 665486b62cff1fd7cb2bf5b07a53d010061ff940
+  data.tar.gz: a268b8d2c0d1ff8f815ac6760d2d6b781db0e571
+SHA512:
+  metadata.gz: d160b81688a73cb441cd70814a626d087d3d2a266d207b244d2dfdb6bf03d76ab610bba7749d202485dabac6ed2898429fe5ab3f7cfcf1e3c2b1af53c9f5c0d7
+  data.tar.gz: c8e75b1f44b7215bbfcd63129d85f9a2b83415f872119b2b97ce9f0d46f313915cf297b9be84278dab8778ea769448542b4413108d53868b7459d2d9a1962172

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ryan
+
+MIT License
+
+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,23 @@
+# Gem::Home
+
+Ads some useful extensions to the default `gem` command
+
+## Installation
+
+    $ gem install gem-home
+
+## Usage
+
+```bash
+gem home gem-name
+gem issues gem-name
+gem docs gem-name
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gem-home/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/gem-home.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "gem-home"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Ryan"]
+  spec.email         = ["ryan@mazondo.com"]
+  spec.summary       = "Adds convenience methods to the gem command"
+  spec.description   = "gem home `gem-name`, gem docs `gem-name`, gem issues `gem-name`"
+  spec.homepage      = "https://github.com/mazondo/gem-home"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock", "~> 1.20.4"
+end

data/lib/rubygems/commands/docs_command.rb

@@ -0,0 +1,15 @@
+class Gem::Commands::DocsCommand < Gem::Command
+
+  def initialize
+    super 'docs', "Open a gem's documentation"
+  end
+
+  def execute
+    require "rubygems/home/spec_loader"
+    require "rubygems/home/browser"
+
+    name = get_one_gem_name
+    link = ::Gem::Home::SpecLoader.get_docs_url(name)
+    ::Gem::Home::Browser.open_link(link)
+  end
+end

data/lib/rubygems/commands/home_command.rb

@@ -0,0 +1,15 @@
+class Gem::Commands::HomeCommand < Gem::Command
+
+  def initialize
+    super 'home', "Open a gem's homepage"
+  end
+
+  def execute
+    require "rubygems/home/spec_loader"
+    require "rubygems/home/browser"
+
+    name = get_one_gem_name
+    link = ::Gem::Home::SpecLoader.get_home_url(name)
+    ::Gem::Home::Browser.open_link(link)
+  end
+end

data/lib/rubygems/commands/issues_command.rb

@@ -0,0 +1,15 @@
+class Gem::Commands::IssuesCommand < Gem::Command
+
+  def initialize
+    super 'issues', "Open a gem's issue tracker"
+  end
+
+  def execute
+    require "rubygems/home/spec_loader"
+    require "rubygems/home/browser"
+
+    name = get_one_gem_name
+    link = ::Gem::Home::SpecLoader.get_issues_url(name)
+    ::Gem::Home::Browser.open_link(link)
+  end
+end

data/lib/rubygems/home/browser.rb

@@ -0,0 +1,17 @@
+module Gem
+  module Home
+    module Browser
+
+      # open_url takes in a url, and attempts
+      # to open it in a browser using `git web--browse {{link}}`
+      def self.open_link(url)
+        unless system("git", "web--browse", url)
+          puts "Couldn't start Browser"
+          puts "But, you can do it yourself!"
+          puts link
+          exit 1
+        end
+      end
+    end
+  end
+end

data/lib/rubygems/home/spec_loader.rb

@@ -0,0 +1,69 @@
+require "open-uri"
+require "json"
+require "uri"
+module Gem
+  module Home
+    module SpecLoader
+      def self.get_issues_url(gem)
+        data = pull_gemspec(gem)
+        link = data["bug_tracker_uri"]
+        return link if link && valid_url?(link)
+        # looks like nobody gave us an issue tracker
+        # are we working with a github link?
+        github_link = github_repo(data)
+        return [github_link, "issues"].join("/") if github_link
+        return false
+      end
+
+      def self.get_home_url(gem)
+        data = pull_gemspec(gem)
+        link = data["homepage_uri"]
+        return link if link && valid_url?(link)
+        # looks like nobody gave us a homepage
+        # are we working with a github link?
+        github_link = github_repo(data)
+        return github_link if github_link
+
+        # jeeze, not even a github repo.
+        # They don't deserve it, but we'll fall back to rubydocs
+        return "http://www.rubydoc.info/gems/#{gem}"
+      end
+
+      def self.get_docs_url(gem)
+        data = pull_gemspec(gem)
+        link = data["documentation_uri"]
+        return link if link && valid_url?(link)
+        # looks like nobody gave us a documentation url
+        # let's send them to rubydocs
+        return "http://www.rubydoc.info/gems/#{gem}"
+      end
+
+      def self.pull_gemspec(gem)
+        begin
+          result = open("http://rubygems.org/api/v1/gems/#{gem}.json").read
+          return JSON.parse(result)
+        rescue => e
+          puts "Error loading #{gem} gem's spec from rubygems.org"
+          puts e.message
+          exit 1
+        end
+      end
+
+      def self.valid_url?(url)
+        url =~ URI::regexp
+      end
+
+      def self.github_repo(data)
+        possible = ["homepage_uri", "wiki_uri", "documentation_uri", "source_code_uri", "bug_tracker_uri"]
+        possible.each do |p|
+          link = data[p]
+          if link && link =~ /^(https{0,1}:\/\/)?(www\.)?github\.com/i
+            matches = link.match(/^(https{0,1}:\/\/)?(www\.)?github\.com\/([a-zA-Z]+)\/([a-zA-Z]+)/i)
+            return ["https://github.com", matches[3], matches[4]].join("/") if matches[3] && matches[4]
+          end
+        end
+        return false
+      end
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,5 @@
+require 'rubygems/command_manager'
+
+Gem::CommandManager.instance.register_command :home
+Gem::CommandManager.instance.register_command :issues
+Gem::CommandManager.instance.register_command :docs

data/test/stubs/full_data.json

@@ -0,0 +1 @@
+{"name":"harpoon","downloads":650,"version":"0.0.4","version_downloads":309,"platform":"ruby","authors":"Ryan Quinn","info":"Deploy small server-less webapps to amazon s3, including buckets, dns and permissions","licenses":["MIT"],"project_uri":"http://rubygems.org/gems/harpoon","gem_uri":"http://rubygems.org/gems/harpoon-0.0.4.gem","homepage_uri":"http://www.getharpoon.com","wiki_uri":"","documentation_uri":"http://docs.getharpoon.com","mailing_list_uri":"","source_code_uri":"https://github.com/mazondo/harpoon","bug_tracker_uri":"https://getharpoon.com/issues","dependencies":{"development":[],"runtime":[{"name":"activesupport","requirements":"~\u003e 4.1.5"},{"name":"aws-sdk","requirements":"~\u003e 1.51.0"},{"name":"colorize","requirements":"~\u003e 0.7.3"},{"name":"netrc","requirements":"~\u003e 0.7.7"},{"name":"public_suffix","requirements":"~\u003e 1.4.5"},{"name":"thor","requirements":"~\u003e 0.19.1"}]}}

data/test/stubs/github_home.json

@@ -0,0 +1,6 @@
+{
+  "name": "harpoon",
+  "project_uri": "http://rubygems.org/gems/harpoon",
+  "gem_uri": "http://rubygems.org/gems/harpoon-0.0.4.gem",
+  "homepage_uri": "http://github.com/mazondo/harpoon"
+}

data/test/stubs/github_issues.json

@@ -0,0 +1,6 @@
+{
+  "name": "harpoon",
+  "project_uri": "http://rubygems.org/gems/harpoon",
+  "gem_uri": "http://rubygems.org/gems/harpoon-0.0.4.gem",
+  "bug_tracker_uri": "http://github.com/mazondo/harpoon/issues"
+}

data/test/stubs/no_data.json

@@ -0,0 +1,3 @@
+{
+  "name": "harpoon"
+}

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "cgi" unless defined? CGI
+require_relative "../lib/rubygems/home/browser"
+require_relative "../lib/rubygems/home/spec_loader"
+require "minitest/autorun"
+require 'webmock/minitest'

data/test/test_spec_loader.rb

@@ -0,0 +1,57 @@
+require "test_helper"
+
+describe "Spec Loader" do
+  let(:spec) {::Gem::Home::SpecLoader}
+
+  before do
+    stub_request(:get, "http://rubygems.org/api/v1/gems/full-json.json").
+      to_return(:status => 200, :body => IO.read("test/stubs/full_data.json").strip)
+    stub_request(:get, "http://rubygems.org/api/v1/gems/github-homepage-json.json").
+      to_return(:status => 200, :body => IO.read("test/stubs/github_home.json").strip)
+    stub_request(:get, "http://rubygems.org/api/v1/gems/github-issues-json.json").
+      to_return(:status => 200, :body => IO.read("test/stubs/github_issues.json").strip)
+    stub_request(:get, "http://rubygems.org/api/v1/gems/no-data-json.json").
+      to_return(:status => 200, :body => IO.read("test/stubs/no_data.json").strip)
+  end
+
+  describe "issues" do
+    it "Should use gemspec issues path if present" do
+      link = spec.get_issues_url("full-json")
+      assert_equal "https://getharpoon.com/issues", link
+    end
+
+    it "Should fallback to github if possible" do
+      link = spec.get_issues_url("github-homepage-json")
+      assert_equal "https://github.com/mazondo/harpoon/issues", link
+    end
+  end
+
+  describe "docs" do
+    it "Should use gemspec docs path if present" do
+      link = spec.get_docs_url("full-json")
+      assert_equal "http://docs.getharpoon.com", link
+    end
+
+    it "Should fallback to rubydocs if nothing else" do
+      link = spec.get_docs_url("github-homepage-json")
+      assert_equal "http://www.rubydoc.info/gems/github-homepage-json", link
+    end
+  end
+
+  describe "home" do
+    it "Should use gemspec home path if present" do
+      link = spec.get_home_url("full-json")
+      assert_equal "http://www.getharpoon.com", link
+    end
+
+    it "Should fallback to github if possible" do
+      link = spec.get_home_url("github-issues-json")
+      assert_equal "https://github.com/mazondo/harpoon", link
+    end
+
+    it "Should fallback to rubydoc if nothing else" do
+      link = spec.get_docs_url("no-data-json")
+      assert_equal "http://www.rubydoc.info/gems/no-data-json", link
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: gem-home
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.20.4
+description: gem home `gem-name`, gem docs `gem-name`, gem issues `gem-name`
+email:
+- ryan@mazondo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gem-home.gemspec
+- lib/rubygems/commands/docs_command.rb
+- lib/rubygems/commands/home_command.rb
+- lib/rubygems/commands/issues_command.rb
+- lib/rubygems/home/browser.rb
+- lib/rubygems/home/spec_loader.rb
+- lib/rubygems_plugin.rb
+- test/stubs/full_data.json
+- test/stubs/github_home.json
+- test/stubs/github_issues.json
+- test/stubs/no_data.json
+- test/test_helper.rb
+- test/test_spec_loader.rb
+homepage: https://github.com/mazondo/gem-home
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Adds convenience methods to the gem command
+test_files:
+- test/stubs/full_data.json
+- test/stubs/github_home.json
+- test/stubs/github_issues.json
+- test/stubs/no_data.json
+- test/test_helper.rb
+- test/test_spec_loader.rb