gem-local 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e36d6e61332c32a6b59f16b65dc5c3bee0db3bf7
-  data.tar.gz: 2647fd75bda2cd6a431259530fe774da97f7265f
+  metadata.gz: d1b94904afdc5de2c12787a6ac78b3c1cc5c7dcb
+  data.tar.gz: 7187a5b97309f43fc8251ad45941eb3cfe210de4
 SHA512:
-  metadata.gz: 17c01ff9231ba646576c7d1e55a128921a108ec9be37c878ee783a4f26a34c50ab2244fbb1494b3b4933f47ff7fc198d3368036433b92e2ee8cf9dec9394d3d4
-  data.tar.gz: d6854207619b7b2b33c531f2ce9edb62547a6de85adb41791f99e6926f6b7a054de51c7873ce2fb72c4d4802a48503f25c12665194684d84124224c8f2aaf564
+  metadata.gz: cfb2befa4dbd2f372be0b0a976f209cad45a4fa2eb18be52a6a0587b2eca72d721917bdcd26add2e731f5ef68aac3891bec587dedcab487eedac5e1dd1c2bea9
+  data.tar.gz: b8ad9e202b219b4bb3888fd7068c589a71310d8505bfbf308612af413262a26139be08da83fb77fec2e6e2ac70094c117eb012c7988bf963c1174757bdc0a04c

data/README.md

@@ -3,6 +3,19 @@ Command: gem local
 
 > **Lets you register and manage [local bundler git repos](http://bundler.io/v1.5/git.html#local) per-project.**
 
+If you're developing a gem alongside projects that consume them, you've probably used `gem 'name', path: '~/local/path/to/gem'` in your Gemfile before.
+
+Of course, if you accidentally commit this, you'll probably cause somebody or someserver some grief down the line. This is why [local bundler git repos](http://bundler.io/v1.5/git.html#local) exist: so that by using `gem 'name', git: 'repo', branch: 'master'`, you can program against a local gem dependency while always leaving your Gemfile in a valid state.
+
+However, actually *using* `bundler config local....` is a bit of a pain:
+
+- you have to remember to use the `--local` flag every invocation, otherwise you might bork other local projects using the dependency
+- you have to remember to unset the configuration if you check out a version of your Gemfile without the `gem git:, branch:` bit
+- you have to remember what that configuration was and to reset it when you checkout back to your branch
+- if you frequently develop against local gems, you have to do this for every gem, in every project, and remember where you are in the above workflow every time you revisit a project after a few days
+
+`gem local` makes this a little less of a hassle.
+
 Installation
 ------------
 
@@ -15,27 +28,25 @@ gem install gem-local
 Usage
 -----
 
-### Initialization
-
-If using git, inside a project with a `Gemfile` where you want to be able to toggle local bundler gem loadpaths, run:
+After installing the gem, inside your project, run:
 
 ```sh
 gem local install
 ```
 
-This ensures that the local `.bundle/config` and `.gemlocal` files don't get committed.
+This isn't strictly neccessary--it just ensures that your local `.bundle/config` and `.gemlocal` files don't get committed.
 
-### Adding local repos
+#### Adding local repos
 
-Define the dependencies of this project that you have local copies of, and their locations:
+Define your project dependencies that you have local copies of, and their locations:
 
 ```sh
 gem local add my-dependency ~/code/ruby/gems/my-dependency
 ```
 
-This lets `git local` know about this dependency.
+This lets `git local` know about this dependency. Note that relative paths are supported, and `~` gets expanded, which is the format `bundle config` expects.
 
-### Using local repos
+#### Using local repos
 
 When you want to use your local copy, run
 
@@ -43,21 +54,28 @@ When you want to use your local copy, run
 gem local use my-dependency
 ```
 
-It updates the **local** bundler config (not *global*, as bundler does by default, which many tutorials run with) to refer to the path you supplied it.
+It updates the **local** bundler config (not *global*, as bundler does by default, which many guides run with) to refer to the path you supplied it.
 
-### Ignoring local repos
+#### Ignoring local repos
 
-When you want to use the remote version again, run
+When you want to use the standard remote version of the dependency again, run
 
 ```sh
 gem local ignore my-dependency
 ```
 
-This will remove it from your bundler config and update your `.gitlocal` accordingly to know it's been disabled.
+This will remove it from your bundler config and update your `.gitlocal` accordingly. If you've ever seen the message:
+
+```sh
+Cannot use local override for gem-name at path/to/gem because :branch is not specified in Gemfile.
+Specify a branch or use `bundle config --delete` to remove the local override
+```
+
+you've probably checked out a different version of your Gemfile without updating your bundle config. Now you can do so with `gem local off gem-name` and not completely forget how to re-configure things when you check your WIP branch back out.
 
-### Multiple gems at once
+#### Multiple gems at once
 
-The `use` and `ignore` commands (and their aliases--see the `help`) work for multiple registered gems at once, as well as all registered gems if you don't specify any.
+The `use` and `ignore` commands (and their aliases--see them in `help <cmd>`) work for multiple gems at once, as well as all registered gems if you don't specify any.
 
 ```sh
 gem local status
@@ -65,23 +83,23 @@ gem local status
 # on:  bar @ /Users/rubyist/code/oss/bar
 # on:  fizz @ /Users/rubyist/code/oss/fizz
 # on:  buzz @ /Users/rubyist/code/oss/buzz
-# off:  metasyntactic @ /Users/rubyist/code/oss/variable
+# off: metasyntactic @ /Users/rubyist/code/oss/variable
 
 gem local ignore bar fizz
 # off: foo @ /Users/rubyist/code/oss/foo
 # off: bar @ /Users/rubyist/code/oss/bar
 # off: fizz @ /Users/rubyist/code/oss/fizz
 # on:  buzz @ /Users/rubyist/code/oss/buzz
-# off:  metasyntactic @ /Users/rubyist/code/oss/variable
+# off: metasyntactic @ /Users/rubyist/code/oss/variable
 
-gem local enable
+gem local use
 # on:  foo @ /Users/rubyist/code/oss/foo
 # on:  bar @ /Users/rubyist/code/oss/bar
 # on:  fizz @ /Users/rubyist/code/oss/fizz
 # on:  buzz @ /Users/rubyist/code/oss/buzz
 # on:  metasyntactic @ /Users/rubyist/code/oss/variable
 
-gem local disable
+gem local ignore
 # off: foo @ /Users/rubyist/code/oss/foo
 # off: bar @ /Users/rubyist/code/oss/bar
 # off: fizz @ /Users/rubyist/code/oss/fizz
@@ -89,17 +107,17 @@ gem local disable
 # off: metasyntactic @ /Users/rubyist/code/oss/variable
 ```
 
-### Rebuilding the local gem db
+#### Rebuilding the local gem db
 
-If invocations of `bundle config --local local...` cause your `.gemlocal` file to get out of sync with bundler's settings in `.bundle/config`, run
+If manual invocations of `bundle config --local local...` cause your `.gemlocal` file to get out of sync with bundler's settings in `.bundle/config`, run
 
 ```sh
 gem local rebuild
 ```
 
-to update your file against bundler's configuration.
+to update your file against bundler's version.
 
-### Other commands
+#### Other commands
 
 For other commands and usage, see
 
@@ -107,14 +125,13 @@ For other commands and usage, see
 gem local help
 ```
 
-### Detailed help
-
-For details on a command, for example `install`, run
+For full details of a command, for example `install`, run
 
 ```sh
 gem local help install
 ```
 
-## Contributing
+Contributing
+------------
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/christhekeele/gem-local.

data/gem-local.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "gem-local"
-  spec.version       = "0.1.6"
+  spec.version       = "0.1.7"
   spec.authors       = ["Chris Keele"]
   spec.email         = ["dev@chriskeele.com"]
 

data/lib/rubygems/commands/local_command.rb

@@ -71,7 +71,7 @@ help [cmd]        | Displays help information.
     if name and location and args.empty?
       setting = Setting.new(location)
       if bundler_add name, setting
-        update_config(name, location: setting.location, status: setting.status)
+        update_configuration(name, location: setting.location, status: setting.status)
       end
     else
       arity_error __method__
@@ -81,14 +81,14 @@ help [cmd]        | Displays help information.
 
   def status(name = nil, *args)
     if not name and args.empty?
-      config.each do |name, setting|
+      configuration.each do |name, setting|
         puts show_setting_for(name, setting)
       end
     elsif name
-      if setting = config[name]
+      if setting = configuration[name]
         puts show_setting_for(name, setting)
       else
-        raise "`gem local #{__method__}` could not find `#{name}` in:\n#{find_config}"
+        raise "`gem local #{__method__}` could not find `#{name}` in:\n#{find_configuration}"
       end
     else
       arity_error __method__
@@ -99,8 +99,8 @@ help [cmd]        | Displays help information.
 
   def remove(name = nil, *args)
     if name and args.empty?
-      config.delete(name)
-      write_config(config)
+      configuration.delete(name)
+      write_configuration(configuration)
     else
       arity_error __method__
     end
@@ -108,16 +108,16 @@ help [cmd]        | Displays help information.
   alias_method :delete, :remove
   
   def use(*names)
-    names = config.keys if names.empty?
+    names = configuration.keys if names.empty?
     names.each do |name|
-      if setting = config[name]
+      if setting = configuration[name]
         if bundler_add name, setting
-          update_config(name, status: "on")
+          update_configuration(name, status: "on")
         else
           raise "Could not activate gem, make sure `bundle config local.#{name}` #{setting.location} succeeds"
         end
       else
-        raise "`gem local #{__method__}` could not find `#{name}` in:\n#{find_config}"
+        raise "`gem local #{__method__}` could not find `#{name}` in:\n#{find_configuration}"
       end
     end
   end
@@ -128,16 +128,16 @@ help [cmd]        | Displays help information.
   alias_method :reactivate, :use
   
   def ignore(*names)
-    names = config.values if names.empty?
+    names = configuration.values if names.empty?
     names.each do |name|
-      if setting = config[name]
+      if setting = configuration[name]
         if bundler_remove name, setting
-          update_config(name, status: "off")
+          update_configuration(name, status: "off")
         else
           raise "Could not deactivate gem, make sure `bundle config --delete local.#{name}` succeeds"
         end
       else
-        raise "`gem local #{__method__}` could not find `#{name}` in:\n#{find_config}"
+        raise "`gem local #{__method__}` could not find `#{name}` in:\n#{find_configuration}"
       end
     end
   end
@@ -148,12 +148,12 @@ help [cmd]        | Displays help information.
   
   def rebuild(*args)
     if args.empty?
-      config = read_config.dup
-      clear_config_cache
-      File.open(find_config, "w") do |file|
-        config.each do |name, old_setting|
+      configuration = read_configuration.dup
+      clear_configuration_cache
+      File.open(find_configuration, "w") do |file|
+        configuration.each do |name, old_setting|
           if setting = bundler_value(name, old_setting)
-            file.puts config_for(name, setting.location, setting.status)
+            file.puts configuration_for(name, setting.location, setting.status)
           end
         end
       end
@@ -217,7 +217,7 @@ private
         aliases: %w[new],
       },
       "status" => {
-        description: "Displays the current local gem configuration, or the specified gem's config.",
+        description: "Displays the current local gem configuration, or the specified gem's configuration.",
         usage: "gem local status [gem]",
         arguments: "takes zero or one arguments",
         aliases: %w[config show],
@@ -294,7 +294,7 @@ private
     info[:description]
   end
   
-  def config_for(name, location, status)
+  def configuration_for(name, location, status)
     "%-3.3s #{name} #{location}" % status
   end
   
@@ -305,17 +305,17 @@ private
   
 # PLUMBING
 
-  def config
-    @config ||= read_config
+  def configuration
+    @configuration ||= read_configuration
   end
   
-  def clear_config_cache
-    @config = nil
+  def clear_configuration_cache
+    @configuration = nil
   end
 
-  def read_config
-    File.open(find_config) do |file|
-      config = Hash[
+  def read_configuration
+    File.open(find_configuration) do |file|
+      Hash[
         file.readlines.reject do |line|
           line.start_with? "#" or line.strip.empty?
         end.map do |line|
@@ -323,7 +323,7 @@ private
           if status and name and location and args.empty?
             [name, Setting.new(location, status)]
           else
-            raise "`gem local` config in `#{find_config}` is corrupt, each non-empty non-commented line must contain a status, a gem name, and the local path to that gem, separated by spaces\nerror at:\n#{line}"
+            raise "`gem local` config in `#{find_configuration}` is corrupt, each non-empty non-commented line must contain a status, a gem name, and the local path to that gem, separated by spaces\nerror at:\n#{line}"
           end
         end
       ]
@@ -342,27 +342,27 @@ private
     end
   end
   
-  def find_config
+  def find_configuration
     find_file Bundler.default_gemfile.dirname + '.gemlocal'
   rescue Bundler::GemfileNotFound
     raise "`gem local` could not locate a `Gemfile` file, which it uses to determine the root of your project"
   end
   
-  def write_config(config)
-    File.open(find_config, "w") do |file|
-      config.each do |name, setting|
-        file.puts config_for(name, setting.location, setting.status)
+  def write_configuration(configuration)
+    File.open(find_configuration, "w") do |file|
+      configuration.each do |name, setting|
+        file.puts configuration_for(name, setting.location, setting.status)
       end
     end
   end
   
-  def update_config(name, properties = {})
-    new_setting = config[name] || Setting.new(nil)
+  def update_configuration(name, properties = {})
+    new_setting = configuration[name] || Setting.new(nil)
     properties.each do |field, value|
       new_setting.send(:"#{field}=", value)
     end
-    config[name] = new_setting
-    write_config config
+    configuration[name] = new_setting
+    write_configuration configuration
     puts show_setting_for(name, new_setting)
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem-local
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Chris Keele