longjump 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5977c83eabf6581782b219db4f1f12c2115cf0eafd48724b67dd2ac012c3481b
+  data.tar.gz: 0a06dfcd713e7eea93f8c0b4c56e059178e6034987190e95330eb73f7eb76046
+SHA512:
+  metadata.gz: 8d222e04fc1a166e201604b9bc59ae275393fa27b40d83485b000ecdffcf5ac391b60a3b7b127dbcfc81d70e10247f89dfeb9113e464ef43871197a489d281bf
+  data.tar.gz: 0c2a12031e59607ccdbc3f1703addba45c15a4b0bc63e7aec6d2e01f1c8e1e50dc54138594e0d83914342989b1229fa5f9a98e8dbd65cf014bca77849b3fb0a5

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in longjump.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    longjump (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.4)
+    mocha (1.13.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  longjump!
+  minitest (~> 5.0)
+  mocha (~> 1.13)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,73 @@
+# longjump
+
+> an athletic event in which competitors jump as far as possible along the ground in one leap.
+
+Longjump is an extensible command line tool that lets you jump into applications as far as possible with a single command.
+
+## Installation
+
+    $ gem install longjump
+
+## Usage
+
+    $ longjump
+
+We recommend `alias lj=longjump` for convenience. But note that longjump will just tell you it has no available jumpers, unless you install a gem with a longjumper!
+
+Gems that contain jumpers begin with `longjumper`.
+
+## Why Longjump
+
+Remembering URI's is hard - and is mostly solved with tools like browser bookmarks. But there are still situations where a command-line launcher that generates URI's and opens them is useful. A few examples:
+
+* You want to jump to a URL in a development environment, but the environment's base URL changes regularly. You want something like `longjump myproject admin` to take you to the admin URL for your project, regardless of which environment you're currently using.
+* You want to open some internal tool with context - maybe feeding a username into a URL structure with something like `longjump directory alex`.
+* You just want a faster way of getting from your command line to a URL, even if it's static.
+
+## Writing Your Longjumper
+
+You'll need to create a gem. We recommend the convention `longjumper-$name` (e.g., [`longjumper-esv`](https://github.com/alexcwatt/longjumper-esv)) for a gem that has a single jumper or `longjumpers-$collection` for a gem that has a collection of jumpers (e.g., `longjumpers-shopify`). Technically longjump is just looking for gem names beginning with `longjumper`.
+
+Then you will need to write one or more "Jumper" classes and put them under `Longjump::Jumpers`. We recommend extending `Base`. Here is an example:
+
+```ruby
+require "longjump/jumpers/base"
+
+module Longjump
+  module Jumpers
+    class GitHubDocs < Base
+      require "cgi"
+
+      command :ghdocs
+      description "GitHub Docs"
+      default_uri "https://docs.github.com/"
+
+      subcommand :cli, regex: "c|cli", uri: "https://docs.github.com/en/github-cli"
+      subcommand :search
+
+      def search(*args)
+        query = args.join(" ")
+        "#{default_uri}en?query=#{query}"
+      end
+    end
+  end
+end
+```
+
+If your `default_uri` is dynamic, you may want to define a method for it instead:
+
+```ruby
+def default_uri
+  SomeService.call
+end
+```
+
+## 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 tags, 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/alexcwatt/longjump.

data/Rakefile

@@ -0,0 +1,10 @@
+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
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "longjump"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/longjump

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "longjump"
+
+Longjump::Cli.call(args: ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/longjump/cli.rb

@@ -0,0 +1,108 @@
+require_relative "opener"
+
+module Longjump
+  class Cli
+    attr_reader :args
+
+    def initialize(args:, opener:, jumpers:)
+      @args = args
+      @opener = opener
+      @jumpers = jumpers
+    end
+
+    def call
+      return help_message if args.empty? || subcommand == "help"
+
+      return jumper_help_message if jumper && subcommand_args[0] == "help"
+
+      return unless uri
+
+      opener.call(uri)
+    end
+
+    private
+
+    def jumpers
+      @jumpers ||= Longjump::Jumpers
+    end
+
+    def opener
+      @opener ||= Opener
+    end
+
+    def jumper
+      @jumper ||= begin
+        jumpers.get(subcommand)
+      rescue Longjump::CouldNotFindJumper
+        puts "longjump could not find jumper: #{subcommand}"
+        nil
+      end
+    end
+
+    def subcommand
+      args[0]
+    end
+
+    def subcommand_args
+      args[1..]
+    end
+
+    def subcommand_args_text
+      subcommand_args.join(' ')
+    end
+
+    def help_message
+      puts "longjump opens websites and apps with context"
+      puts
+      if jumpers.all.any?
+        puts "Available jumpers:"
+        jumpers.all.each do |jumper|
+          puts "  #{jumper.command}: #{jumper.description}"
+        end
+      else
+        puts "No jumpers available - try installing one"
+      end
+    end
+
+    def jumper_help_message
+      puts "#{jumper.command}: #{jumper.description}"
+
+      jumper.subcommands.each do |subcommand|
+        puts "- #{subcommand.command}"
+      end
+    end
+
+    def uri
+      @uri ||= (uri_from_jumper || uri_from_exact_match)
+    end
+
+    def uri_from_jumper
+      return unless jumper
+      uri = jumper.call(subcommand_args)
+      puts "jumper: #{subcommand} did not recognize: #{subcommand_args_text}" unless uri
+      uri
+    rescue Longjump::MultipleSubcommandsMatched
+      puts "jumper: #{subcommand} found multiple matches: #{subcommand_args_text}"
+    end
+
+    def uri_from_exact_match
+      jumpers_with_subcommands = jumpers.all.reject { |jumper| jumper.subcommands.empty? }
+      command_to_uri = jumpers_with_subcommands.each_with_object({}) do |jumper, hash|
+        uri = jumper.call(args)
+        hash[jumper.command] = uri if uri
+      end
+
+      if command_to_uri.size == 1
+        command, uri = command_to_uri.first
+        puts "#{args.join(" ")} matched jumper: #{command}"
+        return uri
+      end
+    end
+
+    class << self
+      def call(args:, opener: nil, jumpers: nil)
+        new(args: args, opener: opener, jumpers: jumpers).call
+      end
+    end
+  end
+end

data/lib/longjump/exceptions.rb

@@ -0,0 +1,7 @@
+module Longjump
+  class Error < StandardError; end
+
+  class CouldNotFindJumper < Error; end
+
+  class MultipleSubcommandsMatched < Error; end
+end

data/lib/longjump/jumpers/base.rb

@@ -0,0 +1,59 @@
+require "longjump/subcommand"
+
+module Longjump
+  module Jumpers
+    class Base
+      def call(args)
+        return default_uri if args.empty?
+
+        matching_subcommands = self.class.subcommands.select { |subcommand| subcommand.match?(args[0]) }
+
+        return nil if matching_subcommands.empty?
+
+        raise MultipleSubcommandsMatched if matching_subcommands.size > 1
+
+        matching_subcommands.first.uri(context: self, args: args[1..])
+      end
+
+      def default_uri
+        self.class.default_uri
+      end
+
+      class << self
+        def call(args)
+          new.call(args)
+        end
+
+        def command(name=nil)
+          @commands ||= []
+          if name
+            @commands << name
+          else
+            @commands[0]
+          end
+        end
+
+        def commands
+          @commands ||= []
+        end
+
+        def description(set_text=nil)
+          @description ||= set_text
+        end
+
+        def default_uri(set_uri=nil)
+          @default_uri ||= set_uri
+        end
+
+        def subcommand(command, regex: nil, uri: nil)
+          @subcommands ||= []
+          @subcommands << Subcommand.new(command, regex: regex, uri: uri)
+        end
+
+        def subcommands
+          @subcommands ||= []
+        end
+      end
+    end
+  end
+end

data/lib/longjump/jumpers.rb

@@ -0,0 +1,19 @@
+require_relative "jumpers/base"
+
+longjumper_gems = Gem::Specification.map { |gem| gem.name.downcase }.filter { |name| name.start_with?("longjumper") }
+longjumper_gems.each { |gem| require gem }
+
+module Longjump
+  module Jumpers
+    def self.all
+      constants.sort.map { |c| const_get(c) }.select { |c| c < Base }
+    end
+
+    def self.get(jumper_name)
+      jumpers = all.select { |jumper| jumper.commands.include?(jumper_name.to_sym) }
+      raise Longjump::CouldNotFindJumper if jumpers.empty?
+
+      jumpers.first
+    end
+  end
+end

data/lib/longjump/opener.rb

@@ -0,0 +1,7 @@
+module Longjump
+  class Opener
+    def self.call(uri)
+      exec("open #{uri}")
+    end
+  end
+end

data/lib/longjump/subcommand.rb

@@ -0,0 +1,26 @@
+module Longjump
+  class Subcommand
+    attr_reader :command, :regex
+
+    def initialize(command, regex: nil, uri: nil)
+      @command = command
+      @regex = regex ? /^(#{regex})$/ : nil
+      @uri = uri
+    end
+
+    def match?(name)
+      name == command.to_s || regex&.match?(name)
+    end
+
+    def uri(context:, args: nil)
+      return @uri if @uri
+
+      begin
+        return context.send(command, *args)
+      rescue ArgumentError
+        puts "Warning: #{command} does not support arguments"
+        return context.send(command)
+      end
+    end
+  end
+end

data/lib/longjump/version.rb

@@ -0,0 +1,3 @@
+module Longjump
+  VERSION = "0.1.0"
+end

data/lib/longjump.rb

@@ -0,0 +1,4 @@
+require "longjump/cli"
+require "longjump/exceptions"
+require "longjump/jumpers"
+require "longjump/version"

data/longjump.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "longjump/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "longjump"
+  spec.version       = Longjump::VERSION
+  spec.authors       = ["Alex Watt"]
+  spec.email         = ["alex@alexcwatt.com"]
+
+  spec.summary       = "Jump to URI's deep inside applications."
+  spec.homepage      = "https://github.com/alexcwatt/longjump"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = ["longjump"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 1.13"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: longjump
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Watt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+description: 
+email:
+- alex@alexcwatt.com
+executables:
+- longjump
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/longjump
+- bin/setup
+- lib/longjump.rb
+- lib/longjump/cli.rb
+- lib/longjump/exceptions.rb
+- lib/longjump/jumpers.rb
+- lib/longjump/jumpers/base.rb
+- lib/longjump/opener.rb
+- lib/longjump/subcommand.rb
+- lib/longjump/version.rb
+- longjump.gemspec
+homepage: https://github.com/alexcwatt/longjump
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Jump to URI's deep inside applications.
+test_files: []