pry_test_case 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1a76df0eb0f7de7bb2523abcd4750411680700e
+  data.tar.gz: 1e1dc6128bfe0607a66b927952af3d68e41edd73
+SHA512:
+  metadata.gz: 4a610a5aa1750c2423ee0e3687666e78452d506762e733d4b9539a14e7b63c03e4c64d1befb67731db2bdc2ce8504c8e4b4e81ed00acd9d8c112aba3219060e0
+  data.tar.gz: d94dff19e1f5442630e48f9ae1139cfd614e70282ffc1224d5cbbb93e2b808744865ae4da724b306db4f6776b48f6f14405a30ce2faeb50d9de6cfdce9ec64d2

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/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode
+  - rbx-2

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :doc do
+  gem "yard"
+end
+
+group :test do
+  gem "coveralls", :require => false
+  gem "guard"
+  gem "guard-minitest"
+  gem "minitest", ">= 3.0"
+  gem "mocha"
+  gem "simplecov", :require => false
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard(:minitest, :all_after_pass => false, :all_on_start => false) do
+  watch(%r{^lib/pry_test_case/(.+)\.rb$}) { |m| "test/unit/#{m[1]}_test.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/unit/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^(lib/pry_test_case|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,46 @@
+# PryTestCase
+[![Gem Version](https://badge.fury.io/rb/pry_test_case.svg)](http://badge.fury.io/rb/pry_test_case)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/pry_test_case)
+[![Build Status](https://travis-ci.org/tdg5/pry_test_case.svg)](https://travis-ci.org/tdg5/pry_test_case)
+[![Coverage Status](https://coveralls.io/repos/tdg5/pry_test_case/badge.svg)](https://coveralls.io/r/tdg5/pry_test_case)
+[![Code Climate](https://codeclimate.com/github/tdg5/pry_test_case/badges/gpa.svg)](https://codeclimate.com/github/tdg5/pry_test_case)
+[![Dependency Status](https://gemnasium.com/tdg5/pry_test_case.svg)](https://gemnasium.com/tdg5/pry_test_case)
+
+Library providing a test case class and other helpers for testing Pry commands
+and extensions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pry_test_case'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install pry_test_case
+```
+
+## Usage
+
+Require the library in your `test_helper.rb` or similar file:
+
+```ruby
+require "pry_test_case"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/tdg5/pry_test_case/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_test_case.rb

@@ -0,0 +1,6 @@
+require "pry_test_case/version"
+
+# The primary Module and namespace of the PryTestCase gem. Home to the TestCase
+# class and other helpers for testing Pry commands and extensions.
+module PryTestCase
+end

data/lib/pry_test_case/command_helpers.rb

@@ -0,0 +1,72 @@
+# Mixin providing methods for executing Pry commands in various contexts and
+# environments.
+module PryTestCase::CommandHelpers
+  # Evaluates the given command string as the Pry CLI would evaluate it. Behaves
+  # more like executing the given command in a live Pry session would. This
+  # means that Pry will intercept some behaviors that may be valuable to your
+  # tests. For more direct access to the results and errors of a command
+  # execution, see {#command_exec_direct}.
+  #
+  # @param [String] command_string The command string to execute including any
+  #   arguments that the command string might take.
+  # @param [Hash] options Optional arguments for manipulating the command
+  #   execution environment.
+  # @option options [Binding] :target (TOPLEVEL_BINDING) The target Binding that the command should
+  #   be executed in. Also aliased as *:context*.
+  # @option options [Boolean] :show_output (true) Flag indicating whether or not the
+  #   output of the command should be displayed.
+  # @option options [IO] :output (Pry.config.output) The IO object that the
+  #   output of the command should be written to. If *:show_output* is false,
+  #   the given IO object will be ignored and a new StringIO object will be used
+  #   instead.
+  # @option options [Pry::CommandSet] :commands (Pry.config.commands) The
+  #   command set that the generated Pry instance should be created with.
+  # @return [Object] The result of the command execution. The exact value
+  #   returned varies depending on the command.
+  # @see #command_exec_direct
+  def command_exec_cli(command_string, options = {})
+    Pry.run_command(command_string, options)
+    result = Pry.current[:pry_cmd_result]
+    result && result.retval != Pry::Command::VOID_VALUE ? result.retval : result
+  end
+
+  # Evaluates the given command string and runs the command directly without
+  # going through the Pry CLI eval cycle. Allows more direct access to errors
+  # and other things the CLI can make hard to get direct access to. To execute a
+  # command in an environment more similar to a live Pry session, see
+  # {#command_exec_cli}.
+  #
+  # @param [String] command_string The command string to execute including any
+  #   arguments that the command string might take.
+  # @param [Hash] options Optional arguments for manipulating the command
+  #   execution environment.
+  # @option options [Binding] :target (TOPLEVEL_BINDING) The target Binding that the command should
+  #   be executed in. Also aliased as *:context*.
+  # @option options [IO] :output (Pry.config.output) The IO object that the
+  #   output of the command should be written to.
+  # @option options [Pry::CommandSet] :command_set (Pry.config.commands) The
+  #   command set that should be passed to the specified command when it is
+  #   initialized.
+  # @option options [Pry] :pry_instance The Pry instance that should be passed
+  #   to the specified command when it is initialized. By default a new Pry
+  #   instance will be generated from the given options.
+  # @return [Object] The result of the command execution. The exact value
+  #   returned varies depending on the command.
+  # @see #command_exec_cli
+  def command_exec_direct(command_string, options = {})
+    exec_options = {
+      :target => TOPLEVEL_BINDING,
+      :output => Pry.config.output,
+      :command_set => Pry.config.commands,
+    }.merge!(options)
+    exec_options[:eval_string] = command_string
+    exec_options[:pry_instance] ||= Pry.new({
+      :target => exec_options[:target],
+      :output => exec_options[:output],
+      :commands => exec_options[:command_set],
+    })
+    args = command_string.split(/\s+/)
+    match = args.shift
+    Pry.commands.run_command(exec_options, match, *args)
+  end
+end

data/lib/pry_test_case/version.rb

@@ -0,0 +1,4 @@
+module PryTestCase
+  # The version of the PryTestCase gem
+  VERSION = "0.0.2".freeze
+end

data/pry_test_case.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pry_test_case/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pry_test_case"
+  spec.version       = PryTestCase::VERSION
+  spec.authors       = ["Danny Guinther"]
+  spec.email         = ["dannyguinther@gmail.com"]
+  spec.summary       = "Library for testing Pry commands and extensions."
+  spec.description   = <<-DESC
+                       Library providing a test case class and other helpers for
+                       testing Pry commands and extensions.
+                       DESC
+  spec.homepage      = "https://github.com/tdg5/pry_test_case"
+  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", "~> 0"
+  spec.add_development_dependency "pry", "~> 0"
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require "test_helpers/coverage" if ENV["CI"]
+require "minitest/autorun"
+require "mocha/setup"
+require "pry"
+require "pry_test_case"
+require "test_helpers/test_case"

data/test/test_helpers/coverage.rb

@@ -0,0 +1,7 @@
+require "simplecov"
+require "coveralls"
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.root(File.expand_path("../..", __FILE__))
+SimpleCov.start do
+  add_filter "test"
+end

data/test/test_helpers/test_case.rb

@@ -0,0 +1,11 @@
+# Use alternate shoulda-style DSL for tests
+module PryTestCase::Test
+  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_helpers_test.rb

@@ -0,0 +1,81 @@
+require "test_helper"
+require "pry_test_case/command_helpers"
+
+module PryTestCase::Test
+  class CommandHelpersTest < TestCase
+    Subject = PryTestCase::CommandHelpers
+    TestSubject = Class.new { include Subject }
+    Pry.commands.create_command("command-with-return-value", :keep_retval => true) do
+      def process
+        args.first
+      end
+    end
+
+    context Subject.name do
+      subject { TestSubject.new }
+
+      context "#command_exec_cli" do
+        should "pass the given command and options directly to Pry.run_command" do
+          command = "some-command"
+          options = { :fake => :options }
+          # Replicate bypassed side-effect
+          (mock_result = mock).stubs(:retval).returns(true)
+          Pry.current[:pry_cmd_result] = mock_result
+          Pry.expects(:run_command).with(command, options)
+          subject.command_exec_cli(command, options)
+        end
+
+        should "return the result of the command" do
+          expected_value = "result"
+          result = subject.command_exec_cli("command-with-return-value #{expected_value}", :show_output => false)
+          assert_equal expected_value, result
+        end
+      end
+
+      context "#command_exec_direct" do
+        setup do
+          @command = "some-command"
+          @arg = "with_args"
+          @command_with_arg = "#{@command} #{@arg}"
+        end
+
+        should "pass the given command and options to Pry.commands.run_command" do
+          opts = {
+            :target => "target",
+            :output => "output",
+            :command_set => "command_set",
+            :pry_instance => "pry_instance",
+          }
+          expected_opts = opts.merge(:eval_string => @command_with_arg)
+          Pry.commands.expects(:run_command).with(expected_opts, @command, @arg)
+          subject.command_exec_direct(@command_with_arg, opts)
+        end
+
+        should "generate sane defaults for options not given" do
+          expected_opts = {
+            :command_set => Pry.config.commands,
+            :eval_string => @command_with_arg,
+            :output => Pry.config.output,
+            :target => TOPLEVEL_BINDING,
+          }
+          pry_instance_opts = {
+            :commands => expected_opts[:command_set],
+            :output => expected_opts[:output],
+            :target => expected_opts[:target],
+          }
+          pry_instance = Pry.new(pry_instance_opts.dup)
+          Pry.expects(:new).with(pry_instance_opts).returns(pry_instance)
+          expected_opts[:pry_instance] = pry_instance
+          Pry.commands.expects(:run_command).with(expected_opts, @command, @arg)
+          subject.command_exec_direct(@command_with_arg)
+        end
+
+        should "return the result of the command" do
+          expected_value = "result"
+          result = subject.command_exec_direct("command-with-return-value #{expected_value}", :output => StringIO.new)
+          assert_equal expected_value, result
+        end
+      end
+    end
+  end
+end

data/test/unit/pry_test_case_test.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+module PryTestCase::Test
+  class PryTestCaseTest < TestCase
+    Subject = PryTestCase
+
+    context Subject.name do
+      should "be defined" do
+        msg = "Expected Subject to refer to a module of a different name"
+        refute_equal "Subject", Subject.name, msg
+
+        msg = "Could not find #{Subject.name} module"
+        assert Object.const_defined?(Subject.name), msg
+      end
+
+      should "define a semantic version" do
+        msg = "Could not find version constant!"
+        assert Subject.const_defined?(:VERSION), msg
+
+        assert_match(/\d+\.\d+\.\d+/, Subject.const_get(:VERSION))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: pry_test_case
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Danny Guinther
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+                         Library providing a test case class and other helpers for
+                         testing Pry commands and extensions.
+email:
+- dannyguinther@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pry_test_case.rb
+- lib/pry_test_case/command_helpers.rb
+- lib/pry_test_case/version.rb
+- pry_test_case.gemspec
+- test/test_helper.rb
+- test/test_helpers/coverage.rb
+- test/test_helpers/test_case.rb
+- test/unit/command_helpers_test.rb
+- test/unit/pry_test_case_test.rb
+homepage: https://github.com/tdg5/pry_test_case
+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: Library for testing Pry commands and extensions.
+test_files:
+- test/test_helper.rb
+- test/test_helpers/coverage.rb
+- test/test_helpers/test_case.rb
+- test/unit/command_helpers_test.rb
+- test/unit/pry_test_case_test.rb
+has_rdoc: