pry-command-set-registry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05d4205804afc01b492f5cb8eb27d6dd04cfdc92
+  data.tar.gz: 2ca8db0ba026143442b230cfb204021ed8023763
+SHA512:
+  metadata.gz: d3402499952d253cf878d1c3d6dbc51bab67264b3f6858e4c5e224a9d34b4e3861407a5c082429b3402be15fa98a66c002f90588d33566055d68f80051111153
+  data.tar.gz: d3cffdcf66b28b058032b68dbe3120bc0a145036e711c751ec73e9de4225356123ae9e85566960c0f66f447bc6e284b3cdc909f233d9c5dc923c3bc4b7843be5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "guard"
+  gem "guard-minitest"
+  gem "minitest", ">= 3.0"
+  gem "mocha"
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard(:minitest, :all_after_pass => false, :all_on_start => false) do
+  watch(%r{^lib/pry[_\-]command[_\-]set[_\-]registry\.rb$}) { "test" }
+  watch(%r{^lib/pry_command_set_registry/(.+)\.rb$}) { |m| "test/unit/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$}) { "test" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Danny Guinther
+
+MIT License
+
+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,33 @@
+# PryCommandSetRegistry
+
+Plugin for managing registration and loading of command sets in pry.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pry-command-set-registry'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pry-command-set-registry
+
+## Usage
+
+Require library file:
+
+```ruby
+  require "pry-command-set-registry"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/tdg5/pry-command-set-registry/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/lib/pry-command-set-registry.rb

@@ -0,0 +1,2 @@
+require "pry"
+require "pry_command_set_registry"

data/lib/pry_command_set_registry.rb

@@ -0,0 +1,17 @@
+require "pry"
+require "pry_command_set_registry/version"
+require "pry_command_set_registry/registry"
+require "pry_command_set_registry/command_set"
+require "pry_command_set_registry/commands"
+
+module PryCommandSetRegistry
+  class << self
+    extend Forwardable
+    attr_accessor :registry
+    def_delegators :registry, :command_set, :command_sets, :define_command_set
+  end
+  self.registry ||= Registry.new
+  private_class_method :registry=
+end
+
+Pry.commands.import(PryCommandSetRegistry::Commands)

data/lib/pry_command_set_registry/command_set.rb

@@ -0,0 +1,19 @@
+module PryCommandSetRegistry
+  class CommandSet < Pry::CommandSet
+    attr_reader :commands, :description, :name
+
+    def initialize(name, description, &block)
+      raise "Block required!" unless block_given?
+      super(&block)
+      @description = description
+      @name = name.to_s
+      apply_group_name_to_commands
+    end
+
+    private
+
+    def apply_group_name_to_commands
+      commands.values.each { |command| command.group(name) }
+    end
+  end
+end

data/lib/pry_command_set_registry/commands.rb

@@ -0,0 +1,32 @@
+module PryCommandSetRegistry
+  desc = "Commands for interacting with the Pry command set registry"
+  Commands = CommandSet.new("PryCommandSetRegistry", desc) do
+    command("import-set", "Import a Pry command set") do |command_set_name|
+      raise Pry::CommandError, "Provide a command set name" if command_set_name.nil?
+
+      begin
+        set = target.eval(command_set_name)
+      rescue NameError
+        set = PryCommandSetRegistry.command_set(command_set_name)
+        ::Kernel.raise if set.nil?
+      end
+      _pry_.commands.import(set)
+    end
+
+    command("list-sets", "List registered command sets") do
+      _pry_.output.puts "Registered Command Sets:"
+      _pry_.output.puts format_command_set_listing(PryCommandSetRegistry.command_sets)
+    end
+
+    helpers do
+      def format_command_set_listing(command_sets)
+        return "" if command_sets.none?
+        max_len = command_sets.keys.max_by(&:length).length
+        sets = command_sets.map do |set_name, set|
+          "  #{set_name.ljust(max_len)}  -  #{set.description}"
+        end
+        sets.join("\n")
+      end
+    end
+  end
+end

data/lib/pry_command_set_registry/registry.rb

@@ -0,0 +1,19 @@
+module PryCommandSetRegistry
+  class Registry
+    attr_reader :command_sets
+
+    def initialize
+      @command_sets = {}
+    end
+
+    def command_set(name)
+      sanitized_name = name.to_s.sub(/^:/, "")
+      command_sets[sanitized_name]
+    end
+
+    def define_command_set(name, description, &block)
+      command_set = CommandSet.new(name, description, &block)
+      command_sets[command_set.name] = command_set
+    end
+  end
+end

data/lib/pry_command_set_registry/version.rb

@@ -0,0 +1,3 @@
+module PryCommandSetRegistry
+  VERSION = "0.0.1".freeze
+end

data/pry-command-set-registry.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pry_command_set_registry/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pry-command-set-registry"
+  spec.version       = PryCommandSetRegistry::VERSION
+  spec.authors       = ["Danny Guinther"]
+  spec.email         = ["dannyguinther@gmail.com"]
+  spec.summary       = %q{Plugin for managing registration and loading of command sets in pry.}
+  spec.description   = %q{Plugin for managing registration and loading of command sets in pry.}
+  spec.homepage      = "https://github.com/tdg5/pry-command-set-registry"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "pry"
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require "minitest/autorun"
+require "mocha/setup"
+require "pry_command_set_registry"
+
+# Use alternate shoulda-style DSL for tests
+module PryCommandSetRegistry
+  class TestCase < Minitest::Spec
+    class << self
+      alias :setup :before
+      alias :teardown :after
+      alias :context :describe
+      alias :should :it
+    end
+  end
+end

data/test/unit/command_set_test.rb

@@ -0,0 +1,50 @@
+require "test_helper"
+
+class CommandSetTest < PryCommandSetRegistry::TestCase
+  Subject = PryCommandSetRegistry::CommandSet
+
+  context "instance methods" do
+    context "#initialize" do
+      setup do
+        @name = "Foo"
+        @description = "Bar"
+        @command_set_proc = default_command_set_proc
+      end
+
+      should "create a new instance from the given arguments" do
+        instance = Subject.new(@name, @description, &@command_set_proc)
+
+        assert_equal @name, instance.name
+        assert_equal @description, instance.description
+        assert_equal true, @command_set_proc_obj[:proc_called]
+      end
+
+      should "correctly initialize the command set" do
+        instance = Subject.new(@name, @description, &@command_set_proc)
+        instance.run_command({}, "test")
+        assert_equal true, @command_set_proc_obj[:command_called]
+      end
+
+      should "correctly set group names" do
+        instance = Subject.new(@name, @description, &@command_set_proc)
+        assert_equal @name, instance.commands.values.first.group
+      end
+    end
+  end
+
+  # Proc is called with instance eval, so closure must be used to allow
+  # referencing in test and in command proc.
+  def default_command_set_proc
+    @command_set_proc_obj = closure_obj = {
+      :command_called => false,
+      :proc_called => false,
+    }
+    proc do
+      closure_obj[:proc_called] = true
+      command("test", "test command") do
+        closure_obj[:command_called] = true
+      end
+    end
+  end
+end
+

data/test/unit/commands_test.rb

@@ -0,0 +1,81 @@
+require "test_helper"
+
+class CommandsTest < PryCommandSetRegistry::TestCase
+  context "import-set" do
+    should "raise Pry::CommandError if no set name is given" do
+      assert_raises(Pry::CommandError) do
+        Pry.commands.run_command({}, "import-set")
+      end
+    end
+
+    should "raise NameError if caught NameError doesn't match command set" do
+      context = Pry.binding_for(Object.new)
+      assert_raises(NameError) do
+        Pry.commands.run_command({ :target => context }, "import-set", "command_set")
+      end
+    end
+
+    should "retrieve defined command set if one exists" do
+      registry_command_called = false
+      PryCommandSetRegistry.define_command_set("Test", "test") do
+        command("test", "test") do
+          registry_command_called = true
+        end
+      end
+      run_command("import-set Test")
+      run_command("test")
+      assert_equal true, registry_command_called
+    end
+
+    should "favor command sets that resolve against the current binding" do
+      registry_command_called = false
+      PryCommandSetRegistry.define_command_set("Test", "test") do
+        command("test", "test") do
+          registry_command_called = true
+        end
+      end
+
+      context_command_called = false
+      test_set = PryCommandSetRegistry::CommandSet.new("Test", "test") do
+        command("test", "test") do
+          context_command_called = true
+        end
+      end
+      test_struct = Struct.new(:command_set)
+      test_instance = test_struct.new(test_set)
+      context = Pry.binding_for(test_instance)
+      run_command("import-set command_set", :context => context)
+      run_command("test")
+      assert_equal true, context_command_called
+      assert_equal false, registry_command_called
+    end
+  end
+
+  context "list-sets" do
+    setup do
+      # Reset registry
+      clean_registry = PryCommandSetRegistry::Registry.new
+      PryCommandSetRegistry.send(:registry=, clean_registry)
+    end
+
+    should "List no registered sets when none are registered" do
+      output = StringIO.new
+      run_command("list-sets", :output => output)
+      assert_equal "Registered Command Sets:\n\n", output.string
+    end
+
+    should "List registered sets" do
+      output = StringIO.new
+      name = "Foo"
+      desc = "Bar"
+      PryCommandSetRegistry.define_command_set(name, desc) {}
+      run_command("list-sets", :output => output)
+      expected_output = "Registered Command Sets:\n  Foo  -  Bar\n"
+      assert_equal expected_output, output.string
+    end
+  end
+
+  def run_command(command, options = {})
+    Pry.run_command(command, options)
+  end
+end

data/test/unit/pry_command_set_registry_test.rb

@@ -0,0 +1,35 @@
+require "test_helper"
+
+class PryCommandSetRegistryTest < PryCommandSetRegistry::TestCase
+  Subject = PryCommandSetRegistry
+
+  context Subject.name do
+    subject { Subject }
+
+    should "be defined" do
+      assert defined?(subject), "Expected #{subject.name} to be defined!"
+    end
+
+    should "have a registry" do
+      assert_kind_of PryCommandSetRegistry::Registry, Subject.registry
+    end
+
+    should "delegate ::command_set to ::registry" do
+      query = "Foo"
+      Subject.registry.expects(:command_set).with(query)
+      Subject.command_set(query)
+    end
+
+    should "delegate ::command_sets to ::registry" do
+      Subject.registry.expects(:command_sets)
+      Subject.command_sets
+    end
+
+    should "delegate ::define_command_set to ::registry" do
+      name = "Foo"
+      desc = "Bar"
+      Subject.registry.expects(:define_command_set).with(name, desc)
+      Subject.define_command_set(name, desc)
+    end
+  end
+end

data/test/unit/registry_test.rb

@@ -0,0 +1,28 @@
+require "test_helper"
+
+class RegistryTest < PryCommandSetRegistry::TestCase
+  Subject = PryCommandSetRegistry::Registry
+
+  context "instance_methods" do
+    subject { Subject.new }
+
+    context "#initialize" do
+      should "initialize #command_sets to an empty Hash" do
+        assert_equal({}, subject.command_sets)
+      end
+    end
+
+    context "#define_command_set" do
+      should "create a new CommandSet with the given args" do
+        name = "foo"
+        description = "bar"
+        called = false
+        command_set_proc = proc { called = true }
+        group = subject.define_command_set(name, description, &command_set_proc)
+        assert_equal name, group.name
+        assert_equal description, group.description
+        assert_equal true, called, "CommandSet proc was not called!"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: pry-command-set-registry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danny Guinther
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Plugin for managing registration and loading of command sets in pry.
+email:
+- dannyguinther@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pry-command-set-registry.rb
+- lib/pry_command_set_registry.rb
+- lib/pry_command_set_registry/command_set.rb
+- lib/pry_command_set_registry/commands.rb
+- lib/pry_command_set_registry/registry.rb
+- lib/pry_command_set_registry/version.rb
+- pry-command-set-registry.gemspec
+- test/test_helper.rb
+- test/unit/command_set_test.rb
+- test/unit/commands_test.rb
+- test/unit/pry_command_set_registry_test.rb
+- test/unit/registry_test.rb
+homepage: https://github.com/tdg5/pry-command-set-registry
+licenses:
+- MIT
+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: Plugin for managing registration and loading of command sets in pry.
+test_files:
+- test/test_helper.rb
+- test/unit/command_set_test.rb
+- test/unit/commands_test.rb
+- test/unit/pry_command_set_registry_test.rb
+- test/unit/registry_test.rb
+has_rdoc: