open_source_location 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61d2d5169811832ef4c13b63cc916da92ea1ea8d0850e62d5f78217a22076f38
-  data.tar.gz: 64abde7fa0a7a4eb71fd99076602d023af953fbd7139734302a61c87267ca868
+  metadata.gz: 790d9910b6f28dbbf3f35c88dfc3c0258c2d8c15d8f9d21c32e21876daca6097
+  data.tar.gz: de5758fcd68a771c416dccaa1ed29a5fceb1f64259c0eabb12189b989c5e67cb
 SHA512:
-  metadata.gz: 5a2b42a4ebb255d2beb1d9db015481a2b3ba3958d14d26b5658f41223d6e9334f495af71a3b2c61447494ad3445e16bfa2db359d5d3544b1fe9f37b5f5bb6588
-  data.tar.gz: 012b9d0a3e46fe156ddc47ce0e39f8282eb1b59ab41f287bc6408e96027ddb14cce707b4cb0fa32d116bab687e98c74df5b6e0648455fdbbd0890d211bdc9dfe
+  metadata.gz: 639fd6b55007b1fee6d8d37e4471cf0aaa1ab238165c6dd182a872fa0e96756989b43a6dd989eef6121f2f61216074c492a51093b9fa38ed451d8e368206993d
+  data.tar.gz: 7cd21770039a45876519c5ecd88015723085dcb16fd78ff73880ea7a312af3c3c0a8c005c4dc9ab028583c65aaad06869175bb474196c196a5f1732bfbdcab73

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    open_source_location (0.1.0)
+    open_source_location (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -10,23 +10,42 @@ Then use as you wish
 
 ```ruby
 # probably in a console, though doesn't have to be
+require 'open_source' # not needed if it's in your Gemfile, and this environment is loaded by bundler
+
 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 Rails.method(:application)
 oso User.instance_method(:name)
 ```
 
 Line numbers are supported too, currently for Vi and VsCode.
 
+### Configuration
+
+#### Using a specific editor for this gem
+
+It's possible to use the `OPEN_SOURCE_GEM_EDITOR` env variable to set a specific editor for use with this gem, if you don't want to use your standard `EDITOR`.
+
+For example:
+
+```bash
+# .bashrc or wherever
+EDITOR=vim                  # standard terminal based editor
+OPEN_SOURCE_GEM_EDITOR=gvim # a GUI version; opens in a different window. Takes priority over EDITOR
+```
+
+This is optional, and if you normally use a GUI editor anyway it probably won't be needed.
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'open_source_location'
+gem 'open_source_location', require: "open_source"
 ```
 
 And then execute:
@@ -37,6 +56,7 @@ Or install it yourself as:
 
     $ gem install open_source_location
 
+Just make sure you then `require 'open_source'` where you need it.
 
 ## Development
 

data/lib/open_source/version.rb

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

data/lib/open_source.rb

@@ -75,13 +75,13 @@ module OpenSource
     end
 
     def get_command(file, line)
-      editor = ENV["EDITOR"]
+      editor = ENV["OPEN_SOURCE_GEM_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)/
+      when /\s?(?:n|m|g)?vim?(\s|\z)/
         [editor, "+#{line}", file]
       when /\s?code(\s|\z)/
         [editor, "--goto", "#{file}:#{line}"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_source_location
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joseph Johansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies: []
 description:
 email: