open_source_location 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61d2d5169811832ef4c13b63cc916da92ea1ea8d0850e62d5f78217a22076f38
+  data.tar.gz: 64abde7fa0a7a4eb71fd99076602d023af953fbd7139734302a61c87267ca868
+SHA512:
+  metadata.gz: 5a2b42a4ebb255d2beb1d9db015481a2b3ba3958d14d26b5658f41223d6e9334f495af71a3b2c61447494ad3445e16bfa2db359d5d3544b1fe9f37b5f5bb6588
+  data.tar.gz: 012b9d0a3e46fe156ddc47ce0e39f8282eb1b59ab41f287bc6408e96027ddb14cce707b4cb0fa32d116bab687e98c74df5b6e0648455fdbbd0890d211bdc9dfe

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in open_source.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    open_source_location (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  open_source_location!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Joseph Johansen
+
+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,53 @@
+# Open Source
+
+Quickly open the source file of a Class, Module, or Method in your favourite editor, from Ruby.
+
+## Usage
+
+First make sure your EDITOR environment variable is set ([How do I find and set my $EDITOR environment variable?](https://askubuntu.com/questions/432524/how-do-i-find-and-set-my-editor-environment-variable)).
+
+Then use as you wish
+
+```ruby
+# probably in a console, though doesn't have to be
+open_source "User" # opens file where User class is defined
+oso User           # same as above; use the aliases for ease of use!
+oso Authenticable  # opens file where Authenticable module is defined
+oso :log           # opens file where "log" method is defined
+oso "log"          # same
+oso method :log    # you get the idea
+oso User.instance_method(:name)
+```
+
+Line numbers are supported too, currently for Vi and VsCode.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'open_source_location'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install open_source_location
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/johansenja/open_source.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "open_source"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/open_source/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OpenSource
+  VERSION = "0.1.0"
+end

data/lib/open_source.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative "open_source/version"
+
+module OpenSource
+  class UnopenableError < StandardError; end
+  class UnreachableError < StandardError; end
+  class UnknownLocationError < StandardError; end
+  class NoEditorError < StandardError; end
+
+  module Public
+    def open_source(obj)
+      case obj.class
+      when Class, Module
+        case obj
+        when String
+          begin
+            Utils.handle_constant! Object.const_get obj
+          rescue NameError
+            Utils.handle_method_or_name! obj
+          end
+        when Symbol
+          Utils.handle_method_or_name! obj
+        when Method, UnboundMethod
+          Utils.handle_method_or_name! obj
+        else
+          Utils.handle_constant! obj
+        end
+      else
+        raise UnopenableError, "Cannot open #{obj.inspect} (#{obj.class}) in an editor"
+      end
+    end
+
+    # TODO: consider if any other aliases could be useful
+    %i[oso].each { |m| alias_method m, :open_source }
+  end
+
+  module Utils
+    module_function
+
+    def handle_constant!(const)
+      raise UnopenableError, "Cannot open an anonymous #{const.class}" unless const.class.name
+
+      loc = Object.const_source_location const.to_s
+
+      if !loc
+        raise UnopenableError, "Cannot open #{const} in an editor"
+      elsif loc.empty?
+        raise UnknownLocationError, "Cannot find the location of #{const} - perhaps it is defined in native code."
+      else
+        open_location loc
+      end
+    end
+
+    def handle_method_or_name!(meth)
+      case meth
+      when Symbol, String
+        meth = method meth
+      end
+
+      loc = meth.source_location
+      if loc
+        open_location loc
+      else
+        raise UnknownLocationError, "Cannot find the location of #{meth} - perhaps it is defined in native code."
+      end
+    rescue NameError
+      raise UnopenableError, "Cannot open #{meth.inspect} (#{meth.class}) in an editor"
+    end
+
+    def open_location(loc)
+      file, line = loc
+      command = Utils.get_command file, line
+      Runner.run *command
+    end
+
+    def get_command(file, line)
+      editor = ENV["EDITOR"]
+
+      # different editors handle going to specific lines differently
+      case editor
+      when nil
+        raise NoEditorError, "the EDITOR env variable must be set to use this feature"
+      when /\s?n?vim?(\s|\z)/
+        [editor, "+#{line}", file]
+      when /\s?code(\s|\z)/
+        [editor, "--goto", "#{file}:#{line}"]
+      else
+        # fallback - ignore line number
+        # TODO: add support for other editors
+        [editor, file]
+      end
+    end
+
+    class Runner
+      def self.run(*cmd)
+        system *cmd
+      end
+    end
+  end
+end
+
+include OpenSource::Public

data/open_source.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/open_source/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_source_location"
+  spec.version       = OpenSource::VERSION
+  spec.authors       = ["Joseph Johansen"]
+  spec.email         = ["joe@stotles.com"]
+
+  spec.summary       = "Open a method, class or module in your favourite editor"
+  spec.homepage      = "https://github.com/johansenja/open_source"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/johansenja/open_source"
+
+  # 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 { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: open_source_location
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Johansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- joe@stotles.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/open_source.rb
+- lib/open_source/version.rb
+- open_source.gemspec
+homepage: https://github.com/johansenja/open_source
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/johansenja/open_source
+  source_code_uri: https://github.com/johansenja/open_source
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Open a method, class or module in your favourite editor
+test_files: []