open_gemdocs 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caa6b9319f8f30e6cd853d913be8d48cdbf7391795141d427f5a8fcbb281857c
-  data.tar.gz: b7645ceac6e716e4cc04f5a4fc5e773246d461228c3573b7a0edc1765c50d56a
+  metadata.gz: 9684f9464ae5cbc9eba19ed1caddc8196b31f2005d7344291d867582dfddb747
+  data.tar.gz: 50c1a060f146fa2d404a628ce5fc2cf4462ac539bcc0a4dd12ce9654eed28400
 SHA512:
-  metadata.gz: da408504c8dd77206dfe9b277887514e5c46ebe5004ef3e3b629c8163d4c3e119758c66e859a07a312150ec98013cdecc1a98bd042b25851429d9aa61cedd318
-  data.tar.gz: 951fb401b1bc62bd133bb96bfe2cff936eef72acf3852ede3fc111892e8cd79b5a24088bc7465195d91b595e1bba93e5c02838f929041d1562a5b0d45653643e
+  metadata.gz: 51d7f7b96bc64e97a3e401ea3bfccf9bfb831d46ddb08825835187257369cee1c04ba0fb560c04cabaa0aa36370ce03b23c4c1b427f7d633348b9d3a328683f2
+  data.tar.gz: 39587826433c8ee774d6d6117459975cf14ea5cb7964196c24b9f64895d60f4dc73be82efea0604568336d60e074125bac658b59135641428052d1902fb873e3

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,8 +1,8 @@
 # OpenGemdocs
 
-This is a simple command line tool that helps open gem documentation. There are two documentation sources this gem supports.
+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 specified in Gemfile.lock. When using the online source, you can specify `--latest` or `--version` options.
@@ -15,7 +15,7 @@ This is a simple command line tool that helps open gem documentation. There are
 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.2.gem.sha512

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

data/checksums/open_gemdocs-0.2.3.gem.sha512

@@ -0,0 +1 @@
+bd0a8fc16bd14139184056791b43220f134fd3f33ad9513eba78cec2025c3c20fbcd166d4e644b60dd47fe564bbe83f114ffca6532446293f38c5e299006348c

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
@@ -36,21 +36,6 @@ end.parse!
 
 begin
   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

data/lib/open_gemdocs/version.rb

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

data/lib/open_gemdocs/yard.rb

@@ -18,10 +18,6 @@ module OpenGemdocs
       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`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_gemdocs
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Sean McCleary
@@ -35,7 +35,21 @@ cert_chain:
   zOgawVlgqyQ5ACIDUJIr+qMUWjeOKyJ2JTte9Jy4CC4=
   -----END CERTIFICATE-----
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
 description: ''
 email:
 - seanmcc@gmail.com
@@ -54,6 +68,8 @@ files:
 - 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
+- checksums/open_gemdocs-0.2.3.gem.sha512
 - exe/open-gem-docs
 - lib/open_gemdocs.rb
 - lib/open_gemdocs/browser.rb