bundler-ri 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1380fa50c668f7811d3c1e822bd5ebce350ab0458a368f9d7bec082ee0491ac
+  data.tar.gz: 922ceb262eb90dc4093d16009f939132912af6881af88932a8da602392cda040
+SHA512:
+  metadata.gz: a45d9ad89989ab850ed66be5ae5fd5414f79e3e66e4f825183065aa51875643a6d596b616bcf183850c5680b524cc4ec58566e113e96d7014324c5a0c895c77c
+  data.tar.gz: 6f1d7559ddc24c5931f04dabf8e69174385d76020fc6257bbe3fa088c920f9eb51c9f4c67c6690e82a4f4edf68a97abf25e85ca24af72072b550ea8e2a170741

data/README.md

@@ -0,0 +1,31 @@
+# bundler-ri
+
+A bundler plugin to be able to browse bundle-relevant ri docs. Somewhat of a WIP but it does work (kinda)
+
+## Usage
+
+Adds a hook to `bundle install` that will generate `rdoc --ri` docs for bundler dependencies and store them in `./.bundle/plugin/ri`. You probably don't want to check that into git if you're using this.
+
+With the plugin installed `bundle ri` will do what `ri` usually does but its doc search path will include the generated docs for your dependencies.
+
+See: https://bundler.io/man/bundle-plugin.1.html
+
+See: https://guides.rubygems.org/bundler_plugins/
+
+## Development
+
+`bundle install` for the dev dependencies
+
+`bundle exec rspec` to run the tests
+
+`bundle exec standardrb --fix` to lint and autocorrect
+
+### TODO
+
+* tests
+* don't regenerate docs we've already generated
+* transitive dependencies (some things like `rails` really rely on them)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bundler-ri.

data/Rakefile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+task default: :build

data/lib/bundler/ri.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "rdoc"
+
+module Bundler
+  class RI < Plugin::API
+    VERSION = "0.1.0"
+
+    def self.register
+      Bundler::Plugin.add_command("ri", Command)
+      Bundler::Plugin.add_hook(Bundler::Plugin::Events::GEM_AFTER_INSTALL_ALL) do |deps|
+        AfterInstallHook.new(deps).run
+      end
+    end
+
+    module Helpers
+      def ri_path
+        Bundler::Plugin.root.join("ri")
+      end
+
+      def ri_path_for(dep)
+        ri_path.join(resolved_name_for(dep))
+      end
+
+      def resolved_name_for(dep)
+        abs_path_for(dep).split("/").last
+      end
+
+      def abs_path_for(dep)
+        if dep.source
+          Bundler.root.to_s
+        else
+          dep.to_spec.full_gem_path
+        end
+      end
+    end
+
+    class Command
+      include Helpers
+
+      def exec(command, args)
+        raise BundlerError.new("must run command 'ri' in root") unless SharedHelpers.in_bundle?
+
+        Bundler.definition.dependencies.map { ri_path_for(_1).to_s }.each do |p|
+          next unless File.directory?(p)
+
+          args << "--doc-dir"
+          args << p
+        end
+
+        RDoc::RI::Driver.run(args)
+      end
+    end
+
+    class AfterInstallHook
+      include Helpers
+
+      def initialize(deps)
+        @deps = deps
+      end
+
+      def run
+        puts "bundler-ri: installing ri docs"
+
+        current_docs = []
+
+        @deps.each do |dep|
+          src_path = abs_path_for(dep).to_s
+          doc_path = ri_path_for(dep).to_s
+
+          RDoc::RDoc.new.document(
+            [
+              "--root", src_path,
+              "-o", doc_path,
+              "-r",
+              "-q"
+            ]
+          )
+
+          current_docs << doc_path
+        end
+
+        puts "bundler-ri: docs installed"
+        current_docs.each { puts _1 }
+
+        Dir.glob(ri_path.join("*")).each do |p|
+          FileUtils.rm_rf(p) unless current_docs.include? p
+        end
+      end
+    end
+  end
+end

data/plugins.rb

@@ -0,0 +1,3 @@
+require "bundler/ri"
+
+Bundler::RI.register

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: bundler-ri
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aidan Coyle
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- packrat386@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/bundler/ri.rb
+- plugins.rb
+homepage: https://github.com/packrat386/bundler-ri
+licenses: []
+metadata:
+  homepage_uri: https://github.com/packrat386/bundler-ri
+  source_code_uri: https://github.com/packrat386/bundler-ri
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: plugin to search for ri docs in your bundle
+test_files: []