rspec-shell_command 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54297361d1210fa38749606c602fe876824c6f64
+  data.tar.gz: 140a1130b2ff8d625482fb8be917d49b49d2832a
+SHA512:
+  metadata.gz: 817f0cf1d2019695c447f0948e44dd6bb5a81a4517289bd1cb7ef3daba99c64cee7bd0f534d385c7ae7d8177bec9aaf6ba9c213e991dd9d606429580daf92589
+  data.tar.gz: bd5e483707d092ce8dae401965b1ce122942f3bc3aa064e77b94b1c318969d56c92622439ee7db658881eb4683326f0e0b2fee27bfb11f6847e99756dfc757e1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Style/SignalException:
+  Exclude:
+    - spec/**/*_spec.rb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 autopp
+
+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,86 @@
+# rspec-shell_command
+![Build Status](https://circleci.com/gh/autopp/rspec-shell_command.svg?style=shield&circle-token=afa2f781f5b99c17e1a41dc10439a2c94eb9c43d)
+
+The RSpec extention for writing a behavior of external command.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-shell_command'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-shell_command
+
+## Usage
+
+```ruby
+require 'rspec/shell_command'
+
+describe '`echo hello; echo goodbye >&2`' do
+  # Enables DSL
+  include RSpec::ShellCommand::DSL
+
+  # Check whether success or fail
+  it 'successes' do
+    expect(`echo hello; echo goodbye >&2`).to success
+  end
+
+  # Check the status code
+  it 'exit with status code 0' do
+    expect(`echo hello; echo goodbye >&2`).to exit_with(0)
+  end
+
+  # Check standard output
+  # (The output matcher behaves like the builtin output)
+  it 'output "hello\n" to stdout' do
+    expect(`echo hello; echo goodbye >&2`).to output("hello\n").to_stdout
+  end
+
+  # Check standard error
+  it 'output a some string to stderr' do
+    expect(`echo hello; echo goodbye >&2`).to output.to_stderr
+  end
+end
+
+# Composing matcher is supported!
+describe '`echo hello; echo goodbye >&2; exit 2`' do
+  include RSpec::ShellCommand::DSL
+
+  subject { `echo hello; echo goodbye >&2; exit 2` }
+
+  # Check the status code using a composing matcher
+  it { is_expected.to exit_with(a_value_between(1, 3)) }
+
+  # Check standard output using a Regexp
+  it { is_expected.to output(/ell/).to_stdout }
+
+  # Check standard error using a composing matcher
+  it { is_expected.to output(a_string_starting_with('good')).to_stderr }
+end
+```
+
+NOTE: When including `RSpec::ShellCommand::DSL`, a backquote operator returns a wrapper object of given command, instead of the standard output.
+
+If you need to use `RSpec::ShellCommand::DSL` at all examples, you can write as bellow at your `spec/spec_helper.rb`:
+
+```ruby
+require 'rspec/shell_command'
+
+RSpec.configure do |c|
+  c.include RSpec::ShellCommand::DSL
+end
+```
+
+## Author
+[@AuToPP](https://twitter.com/AuToPP)
+
+## LICENSE
+[MIT](./LICENSE.txt)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/circle.yml

@@ -0,0 +1,16 @@
+dependencies:
+  pre:
+    - gem install bundler
+
+test:
+  post:
+    - bundle exec rubocop -D
+
+deployment:
+  rubygems:
+    branch: master
+    commands:
+      - git config --local user.name "autopp"
+      - git config --local user.email "autopp@gmail.com"
+      - 'echo ":rubygems_api_key: ${RUBYGEMS_API_KEY}" > ~/.gem/credentials && chmod 0600 ~/.gem/credentials'
+      - bundle exec rake release

data/lib/rspec/shell_command.rb

@@ -0,0 +1,50 @@
+require 'rspec/shell_command/version'
+require 'open3'
+
+module RSpec
+  # Wrapper of external command
+  #
+  # @author autopp <autopp@gmail.com>
+  #
+  class ShellCommand
+    # @!attribute [r] stdout
+    #   @return [String,nil]
+    #     Standard output if given command is already executed, otherwise nil
+    attr_reader :stdout
+
+    # @!attribute [r] stderr
+    #   @return [String]
+    #     Standard error if given command is already executed, otherwise nil
+    attr_reader :stderr
+
+    # @!attribute [r] status
+    #   @return [Process::Status]
+    #     Status of given command if already executed, otherwise nil
+    attr_reader :status
+
+    #
+    # @param [String] wrapped command string
+    #
+    def initialize(cmd)
+      @cmd = cmd.to_s
+      @stdout = @stderr = @status = nil
+    end
+
+    def execute
+      execute! unless executed?
+      self
+    end
+
+    def execute!
+      @stdout, @stderr, @status = Open3.capture3(@cmd)
+      self
+    end
+
+    def executed?
+      !@status.nil?
+    end
+  end
+end
+
+require 'rspec/shell_command/matchers'
+require 'rspec/shell_command/dsl'

data/lib/rspec/shell_command/dsl.rb

@@ -0,0 +1,17 @@
+module RSpec
+  class ShellCommand
+    # The module for using rspec-shell_command's DSL in a spec
+    #
+    # @author autopp <autopp@gmail.com>
+    #
+    module DSL
+      def self.included(cls)
+        cls.include RSpec::ShellCommand::Matchers
+      end
+
+      def `(other)
+        RSpec::ShellCommand.new(other)
+      end
+    end
+  end
+end

data/lib/rspec/shell_command/matchers.rb

@@ -0,0 +1,28 @@
+module RSpec
+  class ShellCommand
+    # Provide matcher methods
+    #
+    # @author autopp <autopp@gmail.com>
+    #
+    module Matchers
+      def success
+        Success.new
+      end
+
+      def exit_with(status)
+        ExitWith.new(status)
+      end
+
+      def output(*args, &block)
+        orig = super
+        expected = args.first
+        Output.new(expected, orig)
+      end
+    end
+  end
+end
+
+require 'rspec/shell_command/matchers/base'
+require 'rspec/shell_command/matchers/success'
+require 'rspec/shell_command/matchers/exit_with'
+require 'rspec/shell_command/matchers/output'

data/lib/rspec/shell_command/matchers/base.rb

@@ -0,0 +1,42 @@
+module RSpec
+  class ShellCommand
+    module Matchers
+      # Base class for a matcher class
+      #
+      # NOTE: This is a internal class
+      #
+      # @author autopp <autopp@gmail.com>
+      #
+      class Base
+        def matches?(actual)
+          unless actual.is_a?(RSpec::ShellCommand)
+            raise TypeError,
+                  "expected RSpec::ShellCommand, but got #{actual.inspect}"
+          end
+          @actual = actual
+          perform_match(actual.execute)
+        end
+
+        def actual_status
+          @actual.status
+        end
+
+        def actual_status_message
+          if actual_status.exited?
+            "exited with status #{actual_status.exitstatus}"
+          elsif actual_status.signaled?
+            "terminated by signal #{actual_status.termsig}"
+          else
+            "been unknown status: #{@actual.inspect}"
+          end
+        end
+
+        def make_expected_and_got_message(expected, got)
+          "\n"\
+          "expected: #{expected}\n"\
+          "     got: #{got}"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/shell_command/matchers/exit_with.rb

@@ -0,0 +1,42 @@
+module RSpec
+  class ShellCommand
+    module Matchers
+      # Provide implementation of exit_with matcher
+      #
+      # Check whether given command exit with expected status
+      #
+      # @author autopp <autopp@gmail.com>
+      #
+      class ExitWith < Base
+        include RSpec::Matchers::Composable
+
+        def initialize(status)
+          @status = status
+        end
+
+        def perform_match(actual)
+          actual_status = actual.status
+          values_match?(@status, actual_status.exitstatus)
+        end
+
+        def failure_message
+          make_expected_and_got_message(
+            "exited with status #{@status}",
+            actual_status_message
+          )
+        end
+
+        def failure_message_when_negated
+          make_expected_and_got_message(
+            "not exited with status #{@status}",
+            actual_status_message
+          )
+        end
+
+        def description
+          "exit with #{description_of(@status)}"
+        end
+      end
+    end
+  end
+end

data/lib/rspec/shell_command/matchers/output.rb

@@ -0,0 +1,87 @@
+module RSpec
+  class ShellCommand
+    module Matchers
+      # Provide implementation of out matcher
+      #
+      # Check whether given command output expected string or pattern
+      #   to stdout or stderr
+      #
+      # @author autopp <autopp@gmail.com>
+      #
+      class Output < Base
+        include RSpec::Matchers::Composable
+
+        def initialize(expected, orig)
+          @expected = expected
+          @orig = orig
+        end
+
+        def matches?(actual)
+          @actual_is_command = actual.is_a?(ShellCommand)
+          return @orig.matches?(actual) unless @actual_is_command
+
+          @actual = actual.execute
+
+          return false unless @stream == :stdout || @stream == :stderr
+
+          if @expected
+            values_match?(@expected, actual_output)
+          else
+            !actual_output.empty?
+          end
+        end
+
+        def failure_message
+          if @actual_is_command
+            "expect command to #{description}"
+          else
+            @orig.failure_message
+          end
+        end
+
+        def failure_message_when_negated
+          if @actual_is_command
+            "expect command to not #{description}"
+          else
+            @orig.failure_message_when_negated
+          end
+        end
+
+        def supports_block_expectations?
+          true
+        end
+
+        def to_stdout
+          @stream = :stdout
+          @orig.to_stdout
+          self
+        end
+
+        def to_stderr
+          @stream = :stderr
+          @orig.to_stderr
+          self
+        end
+
+        def description
+          if @command
+            "output #{description_of(@expected)} to #{@stream}"
+          else
+            "output to #{@stream}"
+          end
+        end
+
+        private
+
+        def actual_output
+          case @stream
+          when :stdout
+            @actual.stdout
+          when :stderr
+            @actual.stderr
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/shell_command/matchers/success.rb

@@ -0,0 +1,29 @@
+module RSpec
+  class ShellCommand
+    module Matchers
+      # Provide implementation of success matcher
+      #
+      # Check whether given command successed
+      #
+      # @author autopp <autopp@gmail.com>
+      #
+      class Success < Base
+        def perform_match(actual)
+          actual.status.success?
+        end
+
+        def failure_message
+          "expect command have to successed, but #{actual_status_message}"
+        end
+
+        def failure_message_when_negated
+          'expect command have not to successed, but successed'
+        end
+
+        def description
+          'success'
+        end
+      end
+    end
+  end
+end

data/lib/rspec/shell_command/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  class ShellCommand
+    VERSION = '0.1.0'.freeze
+  end
+end

data/rspec-shell_command.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/shell_command/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rspec-shell_command'
+  spec.version = RSpec::ShellCommand::VERSION
+  spec.authors = ['autopp']
+  spec.email = ['autopp.inc@gmail.com']
+
+  spec.summary = 'The RSpec extention for describe behavier of external command'
+  spec.description = spec.summary
+  spec.homepage = 'https://github.com/autopp/rspec-shell_command'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: rspec-shell_command
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- autopp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: The RSpec extention for describe behavier of external command
+email:
+- autopp.inc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- lib/rspec/shell_command.rb
+- lib/rspec/shell_command/dsl.rb
+- lib/rspec/shell_command/matchers.rb
+- lib/rspec/shell_command/matchers/base.rb
+- lib/rspec/shell_command/matchers/exit_with.rb
+- lib/rspec/shell_command/matchers/output.rb
+- lib/rspec/shell_command/matchers/success.rb
+- lib/rspec/shell_command/version.rb
+- rspec-shell_command.gemspec
+homepage: https://github.com/autopp/rspec-shell_command
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: The RSpec extention for describe behavier of external command
+test_files: []