open_gemdocs 0.1.0 → 0.2.1

checksums.yaml

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

data/README.md

@@ -1,6 +1,14 @@
 # OpenGemdocs
 
-This is a simple command line tool that helps open gem documentation on https://gemdocs.org.
+This is a simple command line tool that helps open gem documentation. There are two documentation sources this gem supports.
+
+1. local gems served with the yarn gem
+2. [https://gemdocs.org](https://gemdocs.org) - a good ruby gem documentation host
+
+* If ran from a directory with a Gemfile.lock, it will open the documentation for the version specified in Gemfile.lock. When using the online source, you can specify `--latest` or `--version` options.
+* Defaults to open the latest version of the documentation if not `--local` or a `Gemfile.lock` is not found in the current directory.
+* Can specify a version of the docs to view
+* When ran with `--local`, it will either serve docs for all gems you have installed or the versions specified in your Gemfile.
 
 ## Installation
 
@@ -20,15 +28,39 @@ gem install open_gemdocs
 
 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:
+To see the available options.
+```bash
+open-gem-docs --help
+```
 
+### Example usage
+If you are in a directory with a Gemfile.lock, it will open the documentation for the version of the gem you are using unless you specify `--latest` or `--version` options.
+
+If you are not in a directory with a Gemfile.lock, it will open the latest version of the documentation.
 ```bash
-open_gemdocs --help
+open-gem-docs rspec
 ```
+(Assuming you are in a directory with a Gemfile.lock, it will open the rspec docs for the version you are using.)
 
-To see the available options.
+Open a specific version (regardless of what is in your Gemfile.lock)
+```bash
+open-gem-docs -v 3.12.0 rspec
+```
 
-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.
+Open the latest version of the documentation
+```bash
+open-gem-docs --latest rspec
+```
+
+To use a local documentation server. Run the following command from a directory where Gemfile.lock exists. This will serves the documentation for your currently installed gems.
+```bash
+open-gem-docs --local
+```
+
+You can also jump directly to a local doc gem page:
+```bash
+open-gem-docs --local rspec
+```
 
 ## Development
 

data/checksums/open_gemdocs-0.2.0.gem.sha512

@@ -0,0 +1 @@
+d38b05b2644370819c8ace560260816630b1c77dba752edeab3f4a8fc7d32dcf914582ff054a48ff61d6f904a513f46279273eaf3e686611df51724dc94ad1ed

data/checksums/open_gemdocs-0.2.1.gem.sha512

@@ -0,0 +1 @@
+47c51e49929fa17823bb73e851d2647a3cba1f2e70bba6da9b23cf9881a0ad96add9d6b585bd9d4594383f9ee965e756fc739b452f38033c41c1b1ed22af8458

data/exe/open-gem-docs

@@ -12,11 +12,14 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = 'Usage: open-gem-docs [options] <gem_name>'
 
+  opts.on('--local', 'Use local documentation') do
+    options[:local] = true
+  end
   opts.on('-v', '--version VERSION', 'Specify the version') do |version|
     options[:version] = version
   end
 
-  opts.on('-l', '--latest', 'Use the latest version') do
+  opts.on('--latest', 'Use the latest version') do
     options[:latest] = true
   end
 
@@ -24,10 +27,34 @@ OptionParser.new do |opts|
     puts opts
     exit
   end
+
+  opts.on('-s', '--stop', 'stops the yarn server') do
+    OpenGemdocs::Yard.stop_server
+    exit
+  end
 end.parse!
 
 begin
-  OpenGemdocs::Browser.new(gem_name: ARGV[0], version: options[:version], use_latest: options[:latest]).open_browser
+  if options[:local]
+    unless OpenGemdocs::Yard.yard_installed?
+      puts 'To use the local documentation, you need to install Yard.'
+      puts 'Please install yard with `gem install yard`.'
+      puts 'Would you like to install it now? (y/n)'
+      case gets.chomp.downcase
+      when 'y'
+        system('gem install yard')
+        puts 'Yard installed successfully.'
+        puts 'Now you can use the local documentation with `open-gem-docs --local <gem_name>`'
+      else
+        puts 'Yard is required to use the local documentation.'
+        puts 'Please install it and try again.'
+      end
+      exit 0
+    end
+    OpenGemdocs::Yard.browse_gem(ARGV[0])
+  else
+    OpenGemdocs::Browser.new(gem_name: ARGV[0], version: options[:version], use_latest: options[:latest]).open_browser
+  end
 rescue OpenGemdocs::Error, ArgumentError => e
   puts e.message
   exit 1

data/lib/open_gemdocs/version.rb

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

data/lib/open_gemdocs/yard.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenGemdocs
+  module Yard
+    extend self
+    SERVER_COMMAND = 'yard server --daemon'
+
+    def browse_gem(gem_name)
+      if server_running?
+        puts "Yard server is already running. Opening browser..."
+        system("open http://localhost:8808/docs/#{gem_name}")
+      else
+        puts "Starting Yard server in the background..."
+        start_yard_server
+        sleep 2 # Give the server some time to start
+        system("open http://localhost:8808/docs/#{gem_name}")
+      end
+      puts "  When you're done, remember to stop the server with `open-gem-docs --stop`"
+    end
+
+    def yard_installed?
+      `gem list yard -i`.strip == 'true'
+    end
+
+    def start_yard_server
+      if File.exist?('Gemfile.lock')
+        `#{SERVER_COMMAND} --gemfile`
+      else
+        `#{SERVER_COMMAND} --gems`
+      end
+    end
+
+    def server_running? = find_yard_pids.any?
+
+    def find_yard_pids
+      # Find pids bound to port 8808
+      `lsof -i TCP:8808 | grep -E "^ruby.*:8808"`.strip.split("\n").map { |line| line.split(/\s+/)[1] }
+    end
+
+    def stop_server
+      yard_pids = find_yard_pids
+      if yard_pids.any?
+        puts "Stopping Yard server processes: #{yard_pids.join(', ')}"
+        `kill #{yard_pids.join(' ')}`
+        puts "Yard server processes stopped."
+      else
+        puts "No Yard server processes found to stop"
+      end
+    end
+  end
+end

data/lib/open_gemdocs.rb

@@ -2,6 +2,7 @@
 
 require_relative 'open_gemdocs/version'
 require_relative 'open_gemdocs/browser'
+require_relative 'open_gemdocs/yard'
 
 module OpenGemdocs
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_gemdocs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sean McCleary
@@ -52,10 +52,13 @@ files:
 - Rakefile
 - certs/mrinterweb.pem
 - checksums/open_gemdocs-0.1.0.gem.sha512
+- checksums/open_gemdocs-0.2.0.gem.sha512
+- checksums/open_gemdocs-0.2.1.gem.sha512
 - exe/open-gem-docs
 - lib/open_gemdocs.rb
 - lib/open_gemdocs/browser.rb
 - lib/open_gemdocs/version.rb
+- lib/open_gemdocs/yard.rb
 - sig/open_gemdocs.rbs
 homepage: https://github.com/mrinterweb/open_gemdocs
 licenses: