rspec-command 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 457504ff7ab5cb5c741450953f5fd20cc1473227
+  data.tar.gz: 8eee255f1d9c41a737622ad6892595283c06d47b
+SHA512:
+  metadata.gz: 4c39a8ee8bb5cacb71a1818ffb93f1dc010e5cc08d27e9891a3eb368342a5fb02a57990619a81efa37baee4c544e410d4c7775881499498bd08ab8acea648ed3
+  data.tar.gz: 09c473829c9689da567c202f6236087e721b3f51f63c7f3ef3ce833b71de439f55db65a0684cb2262a0385abe8a30a78c5ae04d71fbc95e5eacf75ef348fb19a

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+.yardoc/
+doc/
+coverage/

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+- '2.0'
+- '2.1'
+- '2.2'
+script: bundle exec rake test
+env:
+  global:
+  - secure: EZt9sRP8CzvkF0uFUinzElrUfuTUT8hOk6iu67JV7JkgzfCAZFj3xP2ZK209ObleRWfNlZ/WBGscFfw4Ipfpagnok+I2HnuDqf/Y/asdnTfWwMN0p4Fa4w1LpHztaIXdOwFAhA8osKHwYVAUbEYeQLmxDfqwvAGT4yfBkPNAVZE=
+  - secure: Xvquws40AzLRRsqhUbMpYCRldbk/zEnpcUXjf8ZKlbaz/kDW/lVhTK/GEPcARuO/H2k/xrgH0tJPlpr1znNLw0W28lDbxHs8RTDJVFALl57ZLn10WsfAzXurWDb/fj0YqN5u1IVxpXuvf07QUBMEq+cVkFau8ncIQjzbU1colJQ=

data/.yardopts

@@ -0,0 +1,5 @@
+--plugin classmethods
+--markup markdown
+--hide-void-return
+--hide-api private
+--exclude lib/[^/]+/version.rb

data/Gemfile

@@ -0,0 +1,19 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+source 'https://rubygems.org/'
+
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,181 @@
+# RSpec-Command
+
+[![Build Status](https://img.shields.io/travis/coderanger/rspec-command.svg)](https://travis-ci.org/coderanger/rspec-command)
+[![Gem Version](https://img.shields.io/gem/v/rspec-command.svg)](https://rubygems.org/gems/rspec-command)
+[![Coverage](https://img.shields.io/codecov/c/github/coderanger/rspec-command.svg)](https://codecov.io/github/coderanger/rspec-command)
+[![Gemnasium](https://img.shields.io/gemnasium/coderanger/rspec-command.svg)](https://gemnasium.com/coderanger/rspec-command)
+[![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+`rspec-command` is a helper module for using RSpec to test command-line
+applications.
+
+## Quick Start
+
+Add `gem 'rspec-command'` to your `Gemfile` and then configure it in your
+`spec_helper.rb`:
+
+```ruby
+require 'rspec_command'
+
+RSpec.configure do |config|
+  config.include RSpecCommand
+end
+```
+
+You can then use the helpers in your specs:
+
+```ruby
+require 'spec_helper'
+
+describe 'myapp' do
+  command 'myapp --version'
+  its(:stdout) { is_expected.to include('1.0.0') }
+end
+```
+
+## command
+
+The core helper is `command`. It takes a command to run and sets it as the
+subject for the example group. The command can be given as a string, array, or
+block. If the command is given as an array, no shell processing is done before
+running it. If the gem you are running inside has a Gemfile, all commands will
+be run inside a `bundle exec`. Each command is run in a new temporary directory
+so the results of one test won't affect others.
+
+`command` also optionally takes a hash of options to pass through to
+`Mixlib::ShellOut.new`. Some common options include `:input` to provide data on
+stdin and `:timeout` to change the execution timeout.
+
+The subject will be set to a `Mixlib::ShellOut` object so you can use
+`rspec-its` to check individual attributes:
+
+```ruby
+describe 'myapp' do
+  command 'myapp --version'
+  its(:stdout) { is_expected.to include '1.0.0' }
+  its(:stderr) { is_expected.to eq '' }
+  its(:exitstatus) { is_expected.to eq 0 }
+end
+```
+
+## file
+
+The `file` method writes a file in to the temporary directory. You can provide
+the file content as either a string or a block:
+
+```ruby
+describe 'myapp' do
+  command 'myapp read data1.txt data2.txt'
+  file 'data1.txt', <<-EOH
+a thing
+EOH
+  file 'data2.txt' do
+    "another thing #{Time.now}"
+  end
+  its(:stdout) { is_expected.to include '2 files imported' }
+end
+```
+
+## fixture_file
+
+The `fixture_file` method copies a file or folder from a fixture to the
+temporary directory:
+
+```ruby
+describe 'myapp' do
+  command 'myapp read entries/'
+  fixture_file 'entries'
+  its(:stdout) { is_expected.to include '4 files imported' }
+end
+```
+
+These fixtures are generally kept in `spec/fixtures` but it can be customized
+by redefining `let(:fixture_root)`.
+
+## environment
+
+The `environment` method sets environment variables for subprocesses run by
+`command`:
+
+```ruby
+describe 'myapp' do
+  command 'myapp show'
+  environment MYAPP_DEBUG: true
+  its(:stderr) { is_expected.to include '[debug]' }
+end
+```
+
+## match_fixture
+
+The `match_fixture` matcher lets you check the files created by a command
+against a fixture:
+
+```ruby
+describe 'myapp' do
+  command 'myapp write'
+  it { is_expected.to match_fixture 'write_data' }
+end
+```
+
+## capture_output
+
+The `capture_output` helper lets you redirect the stdout and stderr of a block
+of code to strings. This includes any subprocesses or non-Ruby output. This can
+help with integration testing of CLI code without the overhead of running a full
+subprocess.
+
+The returned object behaves like a string containing the stdout output, but has
+`stdout`, `stderr`, and `exitstatus` attributes to simulate the object used by
+`command`. `exitstatus` will always be `0`.
+
+```ruby
+describe 'myapp' do
+  subject do
+    capture_output do
+      MyApp::CLI.run('show')
+    end
+  end
+  its(:stdout) { is_expected.to include 'Entry:' }
+end
+```
+
+## RSpecCommand::Rake
+
+The `RSpecCommand::Rake` helper is an optional module you can include in your
+example groups to test Rake tasks without the overhead of running Rake in a full
+subprocess.
+
+```ruby
+require 'rspec_command'
+
+RSpec.configure do |config|
+  config.include RSpecCommand::Rake
+end
+
+describe 'rake myapp' do
+  rake_task 'myapp'
+  rakefile <<-EOH
+require 'myapp'
+task 'myapp' do
+  MyApp.rake_task
+end
+EOH
+  its(:stdout) { is_expected.to include 'Initialized new project' }
+end
+```
+
+## License
+
+Copyright 2015, Noah Kantrowitz
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,32 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec, :tag) do |t, args|
+  t.rspec_opts = [].tap do |a|
+    a << '--color'
+    a << '--format Fuubar'
+    a << '--backtrace' if ENV['DEBUG']
+    a << "--tag #{args[:tag]}" if args[:tag]
+  end.join(' ')
+end
+
+desc 'Run all tests'
+task :test => [:spec]
+
+task :default => [:test]