open_gemdocs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f80355f3c2bf3eb6fccbfae95a5bcf2306493d19680820f74c30ebc8d1fbe25
+  data.tar.gz: 3624db7fb13cb8784e5db06f2a6ebf0a21858cec666b79efafa4daa5b38104e0
+SHA512:
+  metadata.gz: 460e8b98333345f461e962e14c739d3f88b202b6a24e897d91050e05d2bc9f6f41ea746bb95a689c61577dafe2b3590cb68baaf83641755fa8ec3660972af10d
+  data.tar.gz: f13cffee516d76f47f7a1673fa68fee48e9308b286155cc3eb900d833692baa46a27ada5ecd9c48302bbad52f304de192085c105a04e1e343712d86294ced34a

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+FA��3�E���#b�GW�G�Q,}]G����!�	��)�Cm�K�=,��X�{���@"H��^���;RA՛e�F8G����1f���t�:�A9�;��]�m\p���5|�K�
+��dʶb�I��Rg��l�>�K�����<襇�R���=>N��O���}�\�@���ҘgE�o�M:/ɲ��D�V0
+j���(f!�}�j����ڮ�uKD(>��Ec�x[��NU�Z7�`�/X�hʳU��–Ꮊ^,K%��5���B�9�=�͑�N:����N'p;����PhA�Ǧ��=yx���C�8�mX܋[��y	`_d<��V�Ӎ�f�/��7RV3���J�����1/�������R�o�YC

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-25
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sean McCleary
+
+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,45 @@
+# OpenGemdocs
+
+This is a simple command line tool that helps open gem documentation on https://gemdocs.org.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add open_gemdocs
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install open_gemdocs
+```
+
+## Usage
+
+Currently, this only works on Macs because of the `open` command. It opens the documentation for a gem in your default web browser.
+
+For terminal use:
+
+```bash
+open_gemdocs --help
+```
+
+To see the available options.
+
+If you pass in the name of a gem from a directory that contains a Gemfile.lock file, it will determine what version of the gem you are using when it opens the online documentation.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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/mrinterweb/open_gemdocs.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/certs/mrinterweb.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQsFADA+MRAwDgYDVQQDDAdzZWFu
+bWNjMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNjb20w
+HhcNMjUwNDI2MDY1OTA3WhcNMjYwNDI2MDY1OTA3WjA+MRAwDgYDVQQDDAdzZWFu
+bWNjMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNjb20w
+ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQClsGKKD8z8vSV2l7CZdcsn
+H7tJqy2gPOziPh8Ah9wCbSFoI/4CzVk5YwYUZsKsFUSUtY6aF+CIEDi7iPqoDT6Y
+Qsj4P4jAL/TLy3qHFe8fE2UH3z5wimoGwoEDlmhe7LvTa4hMuDgtLhrL4E8WAygR
+OoGEQVhaIIZx8BiDIdIus9YGZft1I9tB/f4XxHFwplFiS8Z8S/9ab2QZ2iv+S6XM
+KUOEX9+Zp5/uEDE3pAbsGIyC8oWs1XhvHmdpCeAg34280oJK7IJ18vCthgVSn1Ny
+mGZJQP9jRYrCapVzWazwUq7eoDyMmN5UTNbVUnQnUMXyZbUS6QnYD5+AnxRQxufI
+2z1dRpwnaF2D7i/HrxjbZ5mjnnQ5QZLiIh2g1jkozI9ZM2GUY1TMAjt9XdBWOxZ/
+1fctrXgiBV7k3/0oZzc94oNoIF9G1tSZvdO7yyvuDItP69GfjUnrgCVWRqxzOEJD
+TBRa7t/FJd3sMum2eEgMTNXdxCiKgadfdVmGTtej+ZkCAwEAAaN1MHMwCQYDVR0T
+BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFOoslEqN/n5L9VNugFgZSSvrwDTo
+MBwGA1UdEQQVMBOBEXNlYW5tY2NAZ21haWwuY29tMBwGA1UdEgQVMBOBEXNlYW5t
+Y2NAZ21haWwuY29tMA0GCSqGSIb3DQEBCwUAA4IBgQBHKwhncXb7vURi24CLRcLj
+NOBLIyTNLu+0ezr80bofHRVEEDiN+CoMI1dwH5ZpjvlXxOXrq5SbVvdpPPzg1Cjp
+y29tCP7oyHsPG9Q5ssF2VpDjgTVoY2EdON/iKKbPiOr1MaFqTcVK6SjpdBMzYyDa
+suy/Zo3c+6R+gF+7D8oldqNO7Q43mBSkWNIW4CMtzLEQ20J18vLXj1hn9gd2E3Ai
+kWUZ07LnKR4sqswnwGavFhs3/fJORiDRmRUoIin3Oay/vl7Mzx5UYYt7op6s+quu
+VazWDwPqyMqnEJMgVGBUnESLknmS68hvd0s0jlZfeu9QgvomJk8Y722ASonu0IoX
+u/tPcOlBWt5Y4lpQcCJKUvNWJd0/Ypaq6ngEWByqsuqmNaHRUO3nGteLUliuUhyn
+eic7ZflI+cd7J3/Pmh0OBhhzi4f4l8znwVQ2/PFX2dOE/PLqQgf26jwvXJG+Z5Hr
+zOgawVlgqyQ5ACIDUJIr+qMUWjeOKyJ2JTte9Jy4CC4=
+-----END CERTIFICATE-----

data/checksums/open_gemdocs-0.1.0.gem.sha512

@@ -0,0 +1 @@
+df9bcef189d3511c88a2a9dcbe6e542d97b72b9ac77a2e5878600480681d41097da17fa26e1c83b958556402fb8bcaddb0239c4526105f67f1d5054a0032f519

data/exe/open-gem-docs

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'uri'
+require 'net/http'
+require 'json'
+require 'optparse'
+require_relative File.join('..', 'lib', 'open_gemdocs')
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: open-gem-docs [options] <gem_name>'
+
+  opts.on('-v', '--version VERSION', 'Specify the version') do |version|
+    options[:version] = version
+  end
+
+  opts.on('-l', '--latest', 'Use the latest version') do
+    options[:latest] = true
+  end
+
+  opts.on('-h', '--help', 'Display this help message') do
+    puts opts
+    exit
+  end
+end.parse!
+
+begin
+  OpenGemdocs::Browser.new(gem_name: ARGV[0], version: options[:version], use_latest: options[:latest]).open_browser
+rescue OpenGemdocs::Error, ArgumentError => e
+  puts e.message
+  exit 1
+end

data/lib/open_gemdocs/browser.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module OpenGemdocs
+  class Browser
+    attr_reader :gem_name, :version, :use_latest
+
+    def initialize(gem_name:, version: nil, use_latest: false)
+      @gem_name = gem_name
+      raise ArgumentError, 'Gem name is required' if gem_name.nil? || gem_name.empty?
+
+      @version = version
+      @use_latest = use_latest
+    end
+
+    def resolve_version
+      return version if version
+
+      if !use_latest && File.exist?('Gemfile.lock')
+        @version = check_bundle_version
+        if @version
+          puts "Using version from Gemfile.lock: #{version}"
+          return version
+        end
+      end
+
+      @use_latest = true
+
+      puts 'No version specified, using latest version'
+    end
+
+    def open_browser
+      resolve_version
+      raise Error, 'No version URL found' unless version_url
+
+      version_str = version ? "@v#{version}" : ''
+      latest_str = use_latest ? ' (latest)' : ''
+      puts "Fetching gem documentation for #{gem_name}#{version_str}#{latest_str}..."
+      # open is a macOS command to open a URL in the default browser
+      raise Error, 'Could not resolve URL' if version_url.nil?
+
+      `open "#{version_url.sub('production.', '')}"`
+    end
+
+    def version_url
+      if use_latest
+        version_data.last['url']
+      else
+        version_data.detect { |row| row['version'] == version }&.fetch('url')
+      end
+    end
+
+    def check_bundle_version
+      `bundle show #{gem_name}`.strip.match(/#{gem_name}-([0-9.]+).*$/)&.[](1)
+    end
+
+    def version_data
+      @version_data ||= begin
+        uri = URI("https://gemdocs.org/gems/#{ARGV[0]}/versions.json")
+        res = Net::HTTP.get_response(uri)
+        unless res.is_a?(Net::HTTPSuccess)
+          raise Error, "HTTP request failed to uri: #{uri} -- #{res.code} #{res.message}"
+        end
+
+        JSON.parse(res.body)['versions']
+      end
+    end
+  end
+end

data/lib/open_gemdocs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenGemdocs
+  VERSION = "0.1.0"
+end

data/lib/open_gemdocs.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'open_gemdocs/version'
+require_relative 'open_gemdocs/browser'
+
+module OpenGemdocs
+  class Error < StandardError; end
+end

data/sig/open_gemdocs.rbs

@@ -0,0 +1,4 @@
+module OpenGemdocs
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: open_gemdocs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean McCleary
+bindir: exe
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEbDCCAtSgAwIBAgIBATANBgkqhkiG9w0BAQsFADA+MRAwDgYDVQQDDAdzZWFu
+  bWNjMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNjb20w
+  HhcNMjUwNDI2MDY1OTA3WhcNMjYwNDI2MDY1OTA3WjA+MRAwDgYDVQQDDAdzZWFu
+  bWNjMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNjb20w
+  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQClsGKKD8z8vSV2l7CZdcsn
+  H7tJqy2gPOziPh8Ah9wCbSFoI/4CzVk5YwYUZsKsFUSUtY6aF+CIEDi7iPqoDT6Y
+  Qsj4P4jAL/TLy3qHFe8fE2UH3z5wimoGwoEDlmhe7LvTa4hMuDgtLhrL4E8WAygR
+  OoGEQVhaIIZx8BiDIdIus9YGZft1I9tB/f4XxHFwplFiS8Z8S/9ab2QZ2iv+S6XM
+  KUOEX9+Zp5/uEDE3pAbsGIyC8oWs1XhvHmdpCeAg34280oJK7IJ18vCthgVSn1Ny
+  mGZJQP9jRYrCapVzWazwUq7eoDyMmN5UTNbVUnQnUMXyZbUS6QnYD5+AnxRQxufI
+  2z1dRpwnaF2D7i/HrxjbZ5mjnnQ5QZLiIh2g1jkozI9ZM2GUY1TMAjt9XdBWOxZ/
+  1fctrXgiBV7k3/0oZzc94oNoIF9G1tSZvdO7yyvuDItP69GfjUnrgCVWRqxzOEJD
+  TBRa7t/FJd3sMum2eEgMTNXdxCiKgadfdVmGTtej+ZkCAwEAAaN1MHMwCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFOoslEqN/n5L9VNugFgZSSvrwDTo
+  MBwGA1UdEQQVMBOBEXNlYW5tY2NAZ21haWwuY29tMBwGA1UdEgQVMBOBEXNlYW5t
+  Y2NAZ21haWwuY29tMA0GCSqGSIb3DQEBCwUAA4IBgQBHKwhncXb7vURi24CLRcLj
+  NOBLIyTNLu+0ezr80bofHRVEEDiN+CoMI1dwH5ZpjvlXxOXrq5SbVvdpPPzg1Cjp
+  y29tCP7oyHsPG9Q5ssF2VpDjgTVoY2EdON/iKKbPiOr1MaFqTcVK6SjpdBMzYyDa
+  suy/Zo3c+6R+gF+7D8oldqNO7Q43mBSkWNIW4CMtzLEQ20J18vLXj1hn9gd2E3Ai
+  kWUZ07LnKR4sqswnwGavFhs3/fJORiDRmRUoIin3Oay/vl7Mzx5UYYt7op6s+quu
+  VazWDwPqyMqnEJMgVGBUnESLknmS68hvd0s0jlZfeu9QgvomJk8Y722ASonu0IoX
+  u/tPcOlBWt5Y4lpQcCJKUvNWJd0/Ypaq6ngEWByqsuqmNaHRUO3nGteLUliuUhyn
+  eic7ZflI+cd7J3/Pmh0OBhhzi4f4l8znwVQ2/PFX2dOE/PLqQgf26jwvXJG+Z5Hr
+  zOgawVlgqyQ5ACIDUJIr+qMUWjeOKyJ2JTte9Jy4CC4=
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email:
+- seanmcc@gmail.com
+executables:
+- open-gem-docs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- certs/mrinterweb.pem
+- checksums/open_gemdocs-0.1.0.gem.sha512
+- exe/open-gem-docs
+- lib/open_gemdocs.rb
+- lib/open_gemdocs/browser.rb
+- lib/open_gemdocs/version.rb
+- sig/open_gemdocs.rbs
+homepage: https://github.com/mrinterweb/open_gemdocs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/mrinterweb/open_gemdocs
+  source_code_uri: https://github.com/mrinterweb/open_gemdocs
+  changelog_uri: https://github.com/mrinterweb/open_gemdocs/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Simple command line tool to open the documentation for a gem.
+test_files: []