open_gemdocs 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 163ed0b411faca022538670ef2cf3d1eb32bdd14ab18da40ec40ebd0cacf614d
-  data.tar.gz: 49da57a40d0e42119d72b22307c4ab65e8220a8dbaff4fdf40ede8614b176381
+  metadata.gz: b3b77411ddcdfaa696359a3fac6f61d78342a7137ad190b4ba9f9a0075717861
+  data.tar.gz: 7660e4c4ebc1d654cba3cf25348f6b05be92d62e3ef20e935d237a1fe5ddb692
 SHA512:
-  metadata.gz: 808f9bdd8aedd3c9207be40d17c1e8c8b8d51e96beda2337f57eb57b3d12eeae505bfd46b60cbee3ca87406dcd511e77f36ca352bbd22a47a68935888b815fed
-  data.tar.gz: 727d07b3051bdf906d8e5f272ee5f3d3005f5069e0313c141e0298ac17960cb191ad258868df2819e84e11f611fef598dba8d5763e14c1b30305d161b6ec52b1
+  metadata.gz: d8fd831a4cc43d04b5b07991de61549895d76da155a18c31035bd1b99bb773ab020b049e0dfddb5be07133e4ca2538c24a5cd939706f8675decc3835ff2ebaac
+  data.tar.gz: 607c5ef41e813a04f44f2fc6af9e3e1b19b81f2da366a5ff79906b95b79cd27c180b7c790c302e83400a29dd85b3d0963ebe8d5458ea89430e45f6c1dbec2b55

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.1] - 2025-04-26
+### Changed
+- Fixed a bug where the `--local` option was not working correctly when a specific gem was specified. The command now correctly serves the documentation for the specified gem from the local server.
+
+## [0.2.0] - 2025-04-26
+### Added
+- Added support for serving local documentation for all installed gems using the `--local` option. This allows users to view documentation for gems that are not available online.
+
 ## [0.1.0] - 2025-04-25
 
 - Initial release

data/README.md

@@ -1,20 +1,21 @@
 # OpenGemdocs
 
-This is a simple command line tool that helps open gem documentation. There are two documentation sources you can use.
+This is ruby gem that provides 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
+1. local gems served with the yard gem via `yard server --gems` or `yard server --gemfile` accessible at http://localhost:8808.
 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 of the gem you are using unles you specify `--latest` or `--version` options
-* Defaults to open the latest version of the documentation
+* 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
 
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add open_gemdocs
+bundle add open_gemdocs --group development
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:

data/checksums/open_gemdocs-0.2.1.gem.sha512

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

data/checksums/open_gemdocs-0.2.2.gem.sha512

@@ -0,0 +1 @@
+9c01c65161cfae3c148eb7e00013337aa034e4b789ca062d87d038ba521ec452ec541fa8174db8c1f4dc53ae421aa6d05749f5d9d46111b82481dc9c6f938c87

data/exe/open-gem-docs

@@ -28,7 +28,7 @@ OptionParser.new do |opts|
     exit
   end
 
-  opts.on('-s', '--stop', 'stops the yarn server') do
+  opts.on('-s', '--stop', 'stops the yard server') do
     OpenGemdocs::Yard.stop_server
     exit
   end

data/lib/open_gemdocs/version.rb

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

data/lib/open_gemdocs/yard.rb

@@ -3,7 +3,7 @@
 module OpenGemdocs
   module Yard
     extend self
-    SERVER_COMMAND = 'yard server --gems --daemon ./'
+    SERVER_COMMAND = 'yard server --daemon'
 
     def browse_gem(gem_name)
       if server_running?
@@ -22,7 +22,13 @@ module OpenGemdocs
       `gem list yard -i`.strip == 'true'
     end
 
-    def start_yard_server = `#{SERVER_COMMAND}`
+    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?
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_gemdocs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Sean McCleary
@@ -53,6 +53,8 @@ files:
 - 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
+- checksums/open_gemdocs-0.2.2.gem.sha512
 - exe/open-gem-docs
 - lib/open_gemdocs.rb
 - lib/open_gemdocs/browser.rb