bundler-install_dash_docs 0.1.0-universal-darwin

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 83327e5b8a5b5b9edd567bc4c15ef462e79ec0bbb50c0b8f71cd0d4ac9e53c75
+  data.tar.gz: 74acf93aaab6e169e0bcc3e79b9f2c9a76cb2d65b06ae9be6a394e023b38c8af
+SHA512:
+  metadata.gz: 659ffe45b856a624ff3d693f4fc8dc8ebaef077e09083ea6e8759f2bbe32cb84178fe67232063bdd5baf502d210d95a82984a7cd2624e35698a3f19fe23dc857
+  data.tar.gz: f5aec2f4868975502426b15e5c66f8b2e78731ae67c9079cf0eedbb3447224a982b30b35032f663da1782801753756c340fef2af266c8e3e9b007afba09c7835

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-04
+
+- Initial release. Invokes `dash-install://` for gems in the lockfile

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at dan@djackson.org. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bundler-install_dash_docs.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard", "~> 1.3"
+gem "gem-release"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    bundler-install_dash_docs (0.1.0-universal-darwin)
+      addressable (~> 2.2)
+      thor (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    gem-release (2.2.2)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.2)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.7.2)
+      rubocop (= 1.25.1)
+      rubocop-performance (= 1.13.2)
+    thor (1.2.1)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  universal-darwin
+
+DEPENDENCIES
+  bundler-install_dash_docs!
+  gem-release
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Dan Jackson
+
+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,40 @@
+# Bundler::InstallDashDocs
+
+A [bundler plugin](https://bundler.io/bundle_plugin.html) that reads your Gemfile.lock and installs the matching documentation into
+[Dash.app](https://kapeli.com/dash).
+
+This only makes sense on macOS, and due to limitations in the APIs provided by Dash.app, it can only install the current versions. In the future, I'd love if this could manage a docset for a project, but Dash.app doesn't support that yet.
+
+Requires Dash v3.1.0 per https://kapeli.com/dash_install
+
+## Installation
+
+You probably want to install this at the system level, so it's available for any project that uses bundler. Perhaps:
+
+    $ gem install bundler-install_dash_docs
+
+## Usage
+
+    $ bundle install_dash_docs install
+
+👆 is the most likely usage you'll want. Instead of `install` you can ask for the `version`, or get `help`. Flags to `install` can change the verbosity level: `-q` or `--trace`; can ask for a `--dry-run`; or change the subset of gems installed.
+
+`bundle install_dash_docs help install` will show all the options available.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/e28eta/bundler-install_dash_docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/e28eta/bundler-install_dash_docs/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bundler::InstallDashDocs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/bundler-install_dash_docs/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/bundler-install_dash_docs.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/bundler/install_dash_docs/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "bundler-install_dash_docs"
+  spec.version = Bundler::InstallDashDocs::VERSION
+  spec.authors = ["Dan Jackson"]
+  spec.email = ["dan@djackson.org"]
+
+  spec.summary = "Bundler plugin to install gem documentation into the macOS documentation browser Dash https://kapeli.com/dash"
+  spec.homepage = "https://github.com/e28eta/bundler-install_dash_docs"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.platform = "universal-darwin" # Dash.app is macOS-only, this plugin is broken on other platforms
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/e28eta/bundler-install_dash_docs"
+  spec.metadata["changelog_uri"] = "https://github.com/e28eta/bundler-install_dash_docs/blob/main/CHANGELOG.md"
+  spec.metadata["funding_uri"] = "https://github.com/sponsors/e28eta"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "addressable", "~> 2.2"
+  spec.add_dependency "thor", "~> 1.2"
+end

data/exe/bundler-install_dash_docs

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "bundler/install_dash_docs"
+Bundler::InstallDashDocs::CLI.start

data/lib/bundler/install_dash_docs/cli.rb

@@ -0,0 +1,59 @@
+require "thor"
+require "bundler"
+
+module Bundler
+  module InstallDashDocs
+    class CLI < ::Thor
+      ::Bundler::Plugin::API.command("install_dash_docs", self)
+
+      desc "install", "Install docsets for all gems in this bundle into Dash.app"
+      method_option :quiet, type: :boolean, default: false, aliases: "-q", desc: "Supresses normal output of the gem names and versions"
+      method_option :dry_run, type: :boolean, default: false, aliases: "-n", desc: "Print out what would be performed, but do not install docsets in Dash"
+      method_option :gemfile_lock, type: :string, lazy_default: "", aliases: "-G", desc: "Provide custom path to the Gemfile.lock to parse"
+      method_option :trace, type: :boolean, default: false, desc: "Print commands executed"
+      method_option :dependencies_only, type: :boolean, default: false, desc: "Default behavior is to install all gems from the Gemfile.lock. This option only installs those found in the Dependencies section, which are the ones explicitly listed in the Gemfile"
+      def install
+        quiet = options[:quiet]
+
+        lockfile_contents = read_custom_gemfile_lock(options[:gemfile_lock], quiet)
+        lockfile = Lockfile.new(lockfile_contents)
+        gems = if options[:dependencies_only]
+          puts "Only processing gems from Dependencies section" unless quiet
+          lockfile.dependencies
+        else
+          puts "Processing all gems" unless quiet
+          lockfile.all_gems
+        end
+        puts
+
+        gems.each { |name, version|
+          Dash.install(name, version, quiet: quiet, trace: options[:trace], dry_run: options[:dry_run])
+        }
+      end
+
+      desc "version", "Prints bundler-install_dash_docs version"
+      def version
+        puts "bundler-install_dash_docs #{VERSION}"
+      end
+
+      def self.exit_on_failure?
+        true
+      end
+
+      private
+
+      def read_custom_gemfile_lock(gemfile, quiet)
+        if gemfile.nil?
+          nil
+        elsif gemfile.empty?
+          raise(ArgumentError, "--gemfile_lock/-G requires a path")
+        elsif !File.exist?(gemfile)
+          raise(FileNotFound, "custom Gemfile.lock file not found: #{gemfile}")
+        else
+          puts "Reading custom Gemfile.lock from `#{gemfile}`" unless quiet
+          Bundler.read_file(gemfile)
+        end
+      end
+    end
+  end
+end

data/lib/bundler/install_dash_docs/dash.rb

@@ -0,0 +1,30 @@
+module Bundler
+  module InstallDashDocs
+    ##
+    # Methods for interacting with Dash.app
+    class Dash
+      ##
+      # Installs the provided gem documentation into Dash.app
+      #
+      # @param [String] gem_name the name of the gem
+      # @param [String] version the specific version of the gem
+      # @param [Boolean] quiet if set to true, informative log messages are suppressed
+      # @param [Boolean] trace if set to true, the `open` command that's executed is logged
+      # @param [Boolean] dry_run if set to true, `open` command is not executed (but might be printed if trace == true)
+      def self.install(gem_name, version, quiet: false, trace: false, dry_run: false)
+        puts "Installing docs for #{gem_name} #{version}" unless quiet
+        url = DashInstallUrl.new(gem_name, version)
+        command = [
+          "open",
+          "-g",
+          url.to_str
+        ]
+        puts("+ " + command.join(" ")) if trace
+        unless dry_run
+          system(*command)
+          sleep 2
+        end
+      end
+    end
+  end
+end

data/lib/bundler/install_dash_docs/dash_install_url.rb

@@ -0,0 +1,30 @@
+require "addressable/uri"
+
+module Bundler
+  module InstallDashDocs
+    ##
+    # A dash-specific URL for installing the given gem's documentation at specified version
+    #
+    # documentation https://kapeli.com/dash_install
+    class DashInstallUrl
+      attr_reader :gem_name, :version
+
+      ##
+      # @param [String] gem_name the name of the gem
+      # @param [String] version the specific version of the gem
+      def initialize(gem_name, version)
+        @gem_name = gem_name
+        @version = version
+      end
+
+      ##
+      # @return [String] properly encoded URL to tell Dash.app to install this gem's documentation
+      def to_str
+        enc_name = Addressable::URI.encode_component(@gem_name, Addressable::URI::CharacterClasses::UNRESERVED)
+        enc_version = Addressable::URI.encode_component(@version, Addressable::URI::CharacterClasses::UNRESERVED)
+
+        "dash-install://repo_name=Ruby%20Docsets&entry_name=#{enc_name}&version=#{enc_version}"
+      end
+    end
+  end
+end

data/lib/bundler/install_dash_docs/lockfile.rb

@@ -0,0 +1,54 @@
+require "bundler"
+
+module Bundler
+  module InstallDashDocs
+    ##
+    # Reads & parses a Gemfile.lock Lockfile, to extract the gems listed in it
+    #
+    # Note that some gems may be listed multiple times, with different versions
+    class Lockfile
+      ##
+      # Array of [gem_name, version] pairs that are listed in the Dependencies section. Most likely ones that're specifically requested
+      # by the Gemfile
+      attr_reader :dependencies
+      ##
+      # Array of [gem_name, version] pairs that includes all gems from the Lockfile
+      attr_reader :all_gems
+
+      ##
+      # Constructor that parses gem names and versions from the Lockfile
+      #
+      # @param [String, nil] lockfile_contents if non-nil, this string's contents are used instead of the Bundler.default_lockfile
+      def initialize(lockfile_contents = nil)
+        lockfile_contents ||= Bundler.default_lockfile.read
+        @parser = Bundler::LockfileParser.new(lockfile_contents)
+
+        # dictionary of gem name to array of Bundler::LazySpecification
+        @specs = @parser.specs.group_by(&:name)
+
+        # create arrays of [name, version] pairs for all specs,
+        # and only for dependencies from Gemfile
+        @all_gems, @dependencies = [
+          @specs,
+          @parser.dependencies
+        ].map { |hash|
+          hash.keys
+            .sort
+            .flat_map { |name|
+            versions_for_name(name).map { |version| [name, version] }
+          }
+        }
+      end
+
+      private
+
+      # Returns an array of version strings
+      def versions_for_name(name)
+        @specs[name]
+          .map(&:version).map(&:to_s) # pull version from LazySpecification
+          .sort
+          .uniq
+      end
+    end
+  end
+end

data/lib/bundler/install_dash_docs/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bundler
+  module InstallDashDocs
+    VERSION = "0.1.0"
+  end
+end

data/lib/bundler/install_dash_docs.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "install_dash_docs/version"
+require_relative "install_dash_docs/cli"
+require_relative "install_dash_docs/dash"
+require_relative "install_dash_docs/dash_install_url"
+require_relative "install_dash_docs/lockfile"
+
+module Bundler
+  module InstallDashDocs
+    class ArgumentError < StandardError; end
+
+    class FileNotFound < StandardError; end
+  end
+end

data/plugins.rb

@@ -0,0 +1 @@
+require "bundler/install_dash_docs"

data/sig/bundler/install_dash_docs.rbs

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

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: bundler-install_dash_docs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: universal-darwin
+authors:
+- Dan Jackson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description:
+email:
+- dan@djackson.org
+executables:
+- bundler-install_dash_docs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bundler-install_dash_docs.gemspec
+- exe/bundler-install_dash_docs
+- lib/bundler/install_dash_docs.rb
+- lib/bundler/install_dash_docs/cli.rb
+- lib/bundler/install_dash_docs/dash.rb
+- lib/bundler/install_dash_docs/dash_install_url.rb
+- lib/bundler/install_dash_docs/lockfile.rb
+- lib/bundler/install_dash_docs/version.rb
+- plugins.rb
+- sig/bundler/install_dash_docs.rbs
+homepage: https://github.com/e28eta/bundler-install_dash_docs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/e28eta/bundler-install_dash_docs
+  source_code_uri: https://github.com/e28eta/bundler-install_dash_docs
+  changelog_uri: https://github.com/e28eta/bundler-install_dash_docs/blob/main/CHANGELOG.md
+  funding_uri: https://github.com/sponsors/e28eta
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Bundler plugin to install gem documentation into the macOS documentation
+  browser Dash https://kapeli.com/dash
+test_files: []