gem-local 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12ba8318b72fa89c9de01c0c45d33e82ffbd68c1
+  data.tar.gz: a474d6db2f9c21046c6096edf0b03e69db253c8a
+SHA512:
+  metadata.gz: 3231969743c51456cfe24ebd4dcf98334c40d5d55e364deb5fdc4573eeaa742ef225905ada636b5e64cd4badbc5567770682d9e2cf97c9e19fd677ce8b399cbb
+  data.tar.gz: 0f1824d82c50ac6362fde55a1a79adb5d576ea3ae68984471204f60398cee34c1b6f50047240af80a0112de8f9969138592428082530a0def08a027ff708c0e8

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.gemlocal

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gem-local.gemspec
+gemspec

data/README.md

@@ -0,0 +1,66 @@
+Command: gem local
+==================
+
+> **Lets you register and manage [local bundler git repos](http://bundler.io/v1.5/git.html#local) per-project.**
+
+Installation
+------------
+
+Install this rubygems extension through rubygems:
+
+```sh
+gem install gem-local
+```
+
+Usage
+-----
+
+Inside a project with a `Gemfile` where you want to be able to toggle local bundler gem loadpaths, run:
+
+```sh
+gem local install
+```
+
+Define the dependencies of this project that you have local copies of, and their locations:
+
+```sh
+gem local add my-dependency ~/code/ruby/gems/my-dependency
+```
+
+When you want to use your local copy, run
+
+```sh
+gem local use my-dependency
+```
+
+When you want to use the remote version again, run
+
+```sh
+gem local ignore my-dependency
+```
+
+You can use/ignore multiple gems by supplying a list, or you can use/ignore all at once by not specifying any gem in particular.
+
+If invocations of `bundle config local...` cause your `.gemlocal` file to get out of sync with bundler's settings, run
+
+```sh
+gem local rebuild
+```
+
+to update your file against bundler's configuration.
+
+For other commands and usage, see
+
+```sh
+gem local help
+```
+
+For details on a command, for example `install`, run
+
+```sh
+gem local help install
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/christhekeele/gem-local.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gem/local"
+
+# 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

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/gem-local.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "gem-local"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Chris Keele"]
+  spec.email         = ["dev@chriskeele.com"]
+
+  spec.summary       = "A configuration manager for bundler's local gem settings."
+  spec.description   = "The `gem local` command allows you to track, change, update per-project usage of `bundle config local.<gem>` settings."
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/rubygems/commands/local_command.rb

@@ -0,0 +1,359 @@
+require 'bundler'
+
+class Gem::Commands::LocalCommand < Gem::Command
+  
+  class Setting
+    attr_accessor :location, :status
+    def initialize(location,  status = "off")
+      @location, @status = location, status
+    end
+  end
+  
+  def initialize
+    super("local", "A configuration manager for bundler's local gem settings.")
+  end
+  
+  def description
+    <<-DESC
+The `gem local` command allows you to save, toggle, and recall per-project usage of `bundle config local.<gem>` settings.
+    DESC
+  end
+  
+  def arguments
+    <<-ARGS
+add <gem> <path>  | Adds or overwrites a local gem configuration.
+status [gem]      | Displays all or a particular local gem configuration.
+remove <gem>      | Removes a local gem from `gem local` configuration.
+use [gem, ...]    | Enables local gem(s).
+ignore [gem, ...] | Disables local gem(s).
+rebuild           | Regenerates your `.gemlocal` from bundle config state.
+install           | Adds `.gemlocal` artifact to project `.gitignore`.
+help [cmd]        | Displays help information.
+    ARGS
+  end
+  
+  def usage
+    "#{program_name} subcommand <gem> <path>" + "\n" + arguments
+  end
+  
+  def execute
+    if cmd = options[:args].shift
+      if available_cmds.include? cmd
+        public_send cmd, *options[:args]
+      else
+        raise "`gem local #{cmd}` is not a valid command, try:\n" + arguments
+      end
+    else
+      help
+    end
+  end
+
+# COMMANDS
+
+  def add(name = nil, location = nil, *args)
+    if name and location and args.empty?
+      setting = Setting.new(location)
+      if bundler_add name, setting
+        update_config(name, :status, setting.status)
+      end
+    else
+      arity_error __method__
+    end
+  end
+  alias_method :new, :add
+
+  def status(name = nil, *args)
+    if not name and args.empty?
+      config.each do |name, setting|
+        puts show_setting_for(name, setting)
+      end
+    elsif name
+      if setting = config[name]
+        puts show_setting_for(name, setting)
+      else
+        raise "`gem local #{__method__}` could not find `#{name}` in:\n#{find_config}"
+      end
+    else
+      arity_error __method__
+    end
+  end
+  alias_method :show, :status
+
+  def remove(name = nil, *args)
+    if name and args.empty?
+      config.delete(name)
+      write_config(config)
+    else
+      arity_error __method__
+    end
+  end
+  alias_method :delete, :remove
+  
+  def use(*names)
+    names = config.values if names.empty?
+    names.each do |name|
+      if setting = config[name]
+        if bundler_add name, setting
+          update_config(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}"
+      end
+    end
+  end
+  alias_method :on, :use
+  alias_method :activate, :use
+  alias_method :enable, :use
+  alias_method :renable, :use
+  alias_method :reactivate, :use
+  
+  def ignore(*names)
+    names = config.values if names.empty?
+    names.each do |name|
+      if setting = config[name]
+        if bundler_remove name, setting
+          update_config(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}"
+      end
+    end
+  end
+  alias_method :off, :ignore
+  alias_method :deactivate, :ignore
+  alias_method :disable, :ignore
+  
+  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|
+          if setting = bundler_value(name, old_setting)
+            file.puts config_for(name, setting.location, setting.status)
+          end
+        end
+      end
+      show
+    else
+      arity_error __method__
+    end    
+  end
+  
+  def install(*args)
+    if args.empty?
+      File.open(find_file('.gitignore'), "a+") do |file|
+        %w[.bundle .gemlocal].each do |ignorable|
+          unless file.lines.any?{ |line| line.include? ignorable }
+            file.puts ignorable 
+          end
+        end
+      end
+    else
+      arity_error __method__
+    end    
+  end
+  alias_method :init, :install
+  
+  def help(cmd = nil, *args)
+    if not cmd and args.empty?
+      puts description + "\n" + arguments
+    elsif cmd
+      puts info_for(__method__)
+    else
+      arity_error __method__
+    end    
+  end
+  
+private
+
+# COMMANDS
+
+  def cmds
+    @cmds ||= {
+      "add"    => {
+        description: "Adds or overwrites a local gem configuration and activates the gem from sourcein bundler.",
+        usage: "add <gem> <path>",
+        arguments: "takes exactly two arguments",
+        aliases: %w[new],
+      },
+      "status" => {
+        description: "Displays the current local gem configuration, or the specified gem's config.",
+        usage: "status [gem]",
+        arguments: "takes zero or one arguments",
+        aliases: %w[show],
+      },
+      "remove" => {
+        description: "Remove a local gem from `gem local` management.",
+        usage: "remove <gem>",
+        arguments: "takes exactly one argument",
+        aliases: %w[delete],
+      },
+      "use"    => {
+        description: "Activates all registered local gems, or the specified gem, in bundler.",
+        usage: "use [gem]",
+        arguments: "takes any number of arguments",
+        aliases: %w[on activate enable renable reactivate],
+      },
+      "ignore"    => {
+        description: "Deactivates all registered local gems, or the specified gem, in bundler.",
+        usage: "ignore [gem]",
+        arguments: "takes any number of arguments",
+        aliases: %w[off deactivate disable],
+      },
+      "rebuild" => {
+        description: "Regenerates your local `.gemlocal` file from the bundle config if they get out of sync.",
+        usage: "rebuild",
+        arguments: "takes zero arguments",
+        aliases: %w[],
+      },
+      "install" => {
+        description: "Adds `.gemlocal` and `.bundle` artifacts to project `.gitignore`",
+        usage: "install",
+        arguments: "takes zero arguments",
+        aliases: %w[init],
+      },
+      "help"   => {
+        description: "Displays help information, either about `gem local` or a `gem local` subcommand.",
+        usage: "help [cmd]",
+        arguments: "takes zero or one arguments",
+        aliases: %w[],
+      },
+    }
+  end
+  
+  def available_cmds
+    cmds.map do |cmd, info|
+      [cmd, info[:aliases]]
+    end.flatten.compact
+  end
+
+# FORMATTING
+
+  def show_setting_for(name, setting)
+    "%-4.4s #{name} @ #{setting.location}" % "#{setting.status}:"
+  end
+
+  def info_for(cmd)
+    info = cmds[cmd.to_s]
+    usage_for(info) + "\n" + aliases_for(info) + "\n" + description_for(info)
+  end
+  
+  def usage_for(info)
+    "USAGE: #{info[:usage]}"
+  end
+  
+  def aliases_for(info)
+    "aliases: "+ Array(info[:aliases]).flatten.join(', ')
+  end
+
+  def description_for(info)
+    info[:description]
+  end
+  
+  def config_for(name, location, status)
+    "%-3.3s #{name} #{location}" % status
+  end
+  
+  def arity_error(cmd)
+    info = cmds[cmd.to_s]
+    raise "`gem local #{cmd}` #{info[:arguments]}" + "\n" + info_for(cmd)
+  end
+  
+# PLUMBING
+
+  def config
+    @config ||= read_config
+  end
+  
+  def clear_config_cache
+    @config = nil
+  end
+
+  def read_config
+    File.open(find_config) do |file|
+      config = Hash[
+        file.readlines.reject do |line|
+          line.start_with? "#" or line.strip.empty?
+        end.map do |line|
+          status, name, location, *args = line.strip.split
+          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}"
+          end
+        end
+      ]
+    end
+  end
+  
+  def touch_file(path)
+    FileUtils.touch(path).unshift
+  end
+
+  def find_file(path)
+    if File.exists? path
+      path
+    else
+      touch_file path
+    end
+  end
+  
+  def find_config
+    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)
+      end
+    end
+  end
+  
+  def update_config(name, field, value)
+    new_setting = config[name]
+    new_setting.send(:"#{field}=", value)
+    config[name] = new_setting
+    write_config config
+    puts show_setting_for(name, new_setting)
+  end
+  
+  def bundler_add(name, setting)
+    Bundler.settings["local.#{name}"] = setting.location
+    !! Bundler.settings["local.#{name}"]
+  end
+  
+  def bundler_remove(name, setting)
+    Bundler.settings["local.#{name}"] = nil
+    not Bundler.settings["local.#{name}"]
+  end
+  
+  def bundler_value(name, setting)
+    if new_setting = bundler_values[name]
+      new_setting
+    else
+      setting.status = "off"
+      setting
+    end
+  end
+  
+  def bundler_values
+    @bundler_values ||= Hash[
+      Bundler.settings.send(:load_config, Bundler.settings.send(:local_config_file)).select do |setting, value|
+        setting =~ /^BUNDLE_LOCAL__/
+      end.map do |setting, value|
+        [ setting[/^BUNDLE_LOCAL__(?<name>.*?)$/, :name].downcase, value ]
+      end.map do |name, location|
+        [ name, Setting.new(location, "on")]
+      end
+    ]
+  end
+  
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,3 @@
+require "rubygems/command_manager"
+
+Gem::CommandManager.instance.register_command(:local)

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: gem-local
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Keele
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: The `gem local` command allows you to track, change, update per-project
+  usage of `bundle config local.<gem>` settings.
+email:
+- dev@chriskeele.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gem-local.gemspec
+- lib/rubygems/commands/local_command.rb
+- lib/rubygems_plugin.rb
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A configuration manager for bundler's local gem settings.
+test_files: []