slayer 0.4.0.beta2 → 0.4.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6ddcd92133adc30cc39358c00cfd4cf8494d879
-  data.tar.gz: b427f2b04fe18881c4448de84e06e2593a1bcece
+  metadata.gz: bc1abc0497cd05cba5c5a1aecbd39cafe49f6fa9
+  data.tar.gz: 8678738d7df065faa235dd87fae989fc5d13ec0a
 SHA512:
-  metadata.gz: 578355462582a7e68883d7aa7d73f9e52f4d8870d797c63f3f75061c9ccdd445342e9f51c0348583a022403e3a7569503808952764b07816536627eca2cf5a95
-  data.tar.gz: 6ce3eda0fce30e75602a50fefd714d3df12baf17a89f1fdd37914c6b47120fd1488830ac4e6a8a63fbae6b8c2410a51ddce178296b56788ebba1d9543a102865
+  metadata.gz: 2f0eac2da4477755087461d3604032a0c144f02816b9d6a35d490b58dbdd533fb4c29423439ae0872343a3175c6317617fdbdb94d43827a44d5f998d0bd41cf4
+  data.tar.gz: 749f72cead7773c2a66d134649dadd0b4b924f495c51e6b46b7a32ef7964f7741990afa1b594f6a0da368b51a29fd4fe705a43f36060865d83b1a41f5e14abad

data/.githooks/pre-push

@@ -1,7 +1,14 @@
 #!/usr/bin/env bash
 
+if [[ $DOCKER_CONTAINER -ne 1 ]]; then
+    if [[ $(docker-compose ps -q | wc -l) -gt 0 ]]; then
+        source bin/helpers/docker
+        runOnDocker ruby
+    fi
+fi
+
 echo "Starting unit tests"
-bundle exec rake test
+bundle exec rake spec
 if [ $? -ne 0 ]; then
     echo ""
     echo ""

data/.gitignore

@@ -1,14 +1,17 @@
-*.gem
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
+/Gemfile.lock
 /log*/*
 .byebug_history
 
+# rspec failure tracking
+.rspec_status
+
 .DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -5,8 +5,12 @@ AllCops:
   Include:
     - 'lib/**/*.rb'
     - 'test/**/*.rb'
+    - 'spec/**/*.rb'
+    - '**/Gemfile'
+    - '**/Rakefile'
   Exclude:
     - 'bin/**/*'
+    - 'test/fixtures/**/*.rb'
 
 
 Style/RedundantSelf:
@@ -21,19 +25,19 @@ Style/GuardClause:
 Style/ClassAndModuleChildren:
   Enabled: false
 
-Style/EmptyLinesAroundClassBody:
+Layout/EmptyLinesAroundClassBody:
   Enabled: false
 
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-Style/CommentIndentation:
+Layout/CommentIndentation:
   Enabled: false
 
 Style/BracesAroundHashParameters:
   Enabled: false
 
-Style/IndentationConsistency:
+Layout/IndentationConsistency:
   EnforcedStyle: rails
 
 Metrics/LineLength:
@@ -42,9 +46,13 @@ Metrics/LineLength:
 Metrics/ClassLength:
   Max: 120
 
-Style/EmptyLineBetweenDefs:
+Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 
+Naming/UncommunicativeMethodParamName:
+  AllowedNames:
+    - _
+
 # Temporarily disabled until this can be resolved in the todo file
 # Style/Documentation:
 #   Exclude:

data/.travis.yml

@@ -1,6 +1,6 @@
 sudo: false
-before_install: gem update --system
+before_install: gem install bundler -v 1.16.1
 language: ruby
 rvm:
   - 2.3.0
-  - 2.4.0
+  - 2.4.2

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Added documentation for CHANGELOG to README

data/Dockerfile

@@ -0,0 +1,16 @@
+FROM ruby:2.5.1-alpine
+MAINTAINER wyatt@apsis.io
+
+RUN apk add --no-cache --update \
+    bash \
+    alpine-sdk \
+    sqlite-dev
+
+ENV APP_HOME /app
+WORKDIR $APP_HOME
+
+COPY . $APP_HOME/
+
+EXPOSE 3000
+
+CMD ["bash"]

data/README.md

@@ -238,7 +238,7 @@ To use with RSpec, update your `spec_helper.rb` file to include:
 
 `require 'slayer/rspec'`
 
-This provides you with two new matchers: `be_successful_result` and `be_failed_result`, both of which can be chained with a `with_status` expectation:
+This provides you with two new matchers: `be_successful_result` and `be_failed_result`, both of which can be chained with a `with_status`, `with_message`, or `with_value` expectations:
 
 ```ruby
 RSpec.describe RSpecCommand do
@@ -248,15 +248,19 @@ RSpec.describe RSpecCommand do
 
       it { is_expected.to be_success_result }
       it { is_expected.not_to be_failed_result }
-      it { is_expected.not_to be_successful_result.with_status(:no_status) }
+      it { is_expected.to be_success_result.with_status(:no_status) }
+      it { is_expected.to be_success_result.with_message("message") }
+      it { is_expected.to be_success_result.with_value("value") }
     end
 
     context 'should fail' do
       subject(:result) { RSpecCommand.call(should_pass: false) }
 
       it { is_expected.to be_failed_result }
-      it { is_expected.not_to be_failed_result }
-      it { is_expected.not_to be_failed_result.with_status(:no_status) }
+      it { is_expected.not_to be_success_result }
+      it { is_expected.to be_failed_result.with_status(:no_status) }
+      it { is_expected.to be_failed_result.with_message("message") }
+      it { is_expected.to be_failed_result.with_value("value") }
     end
   end
 end
@@ -264,6 +268,35 @@ end
 
 ### Minitest
 
+To use with Minitest, update your 'test_helper' file to include:
+
+`require slayer/minitest`
+
+This provides you with new assertions: `assert_success` and `assert_failed`:
+
+```ruby
+require "minitest/autorun"
+
+class MinitestCommandTest < Minitest::Test
+  def setup
+    @success_result = MinitestCommand.call(should_pass: true)
+    @failed_result = MinitestCommand.call(should_pass: false)
+  end
+
+  def test_is_success
+    assert_success @success_result, status: :no_status, message: 'message', value: 'value'
+    refute_failed @success_result, status: :no_status, message: 'message', value: 'value'
+  end
+
+  def test_is_failed
+    assert_failed @failed_result, status: :no_status, message: 'message', value: 'value'
+    refute_success @failed_result, status: :no_status, message: 'message', value: 'value'
+  end
+end
+```
+
+**Note:** There is no current integration for `Minitest::Spec`.
+
 ## Rails Integration
 
 While Slayer is independent of any framework, we do offer a first-class integration with Ruby on Rails. To install the Rails extensions, add this line to your application's Gemfile:
@@ -349,10 +382,18 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 To generate documentation run `yard`. To view undocumented files run `yard stats --list-undoc`.
 
+### Development w/ Docker
+
+    $ docker-compose up
+    $ bin/ssh_to_container
+    $ bin/console
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/apsislabs/slayer.
 
+Any PRs should be accompanied with documentation in `README.md`, and changes documented in [`CHANGELOG.md`](https://keepachangelog.com/).
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,10 +1,17 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+RSpec::Core::RakeTask.new(:spec)
+
+if defined? Chandler
+  # Set Chandler options
+  Chandler::Tasks.configure do |config|
+    config.changelog_path = 'CHANGELOG.md'
+    config.github_repository = 'apsislabs/slayer'
+  end
+
+  # Add chandler as a prerequisite for `rake release`
+  task 'release:rubygem_push' => 'chandler:push'
 end
 
-task default: :test
+task default: :spec

data/bin/console

@@ -11,4 +11,4 @@ require "slayer"
 # Pry.start
 
 require "irb"
-IRB.start
+IRB.start(__FILE__)

data/bin/helpers/docker

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+# runOnDocker SERVICE
+runOnDocker() {
+  if [[ $DOCKER_CONTAINER -ne 1 ]]; then
+    echo "On Host. Executing command on container"
+    docker-compose exec -T $1 $0
+    exit $?
+  fi
+}
+
+export -f runOnDocker

data/bin/rubo_fix

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+source bin/helpers/docker
+runOnDocker ruby
+
+echo "== Starting rubocop =="
+bundle exec rubocop --format worst --format simple --format offenses --auto-correct

data/bin/run_tests

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+source bin/helpers/docker
+runOnDocker ruby
+
+echo "== Starting unit tests =="
+bundle exec rake test
+if [ $? -ne 0 ]; then
+    echo -e "\n== Tests failed; push aborted! ==\n"
+    exit 1
+fi
+
+echo "== Starting rubocop =="
+bundle exec rubocop --format worst --format simple --format offenses
+if [ $? -ne 0 ]; then
+    echo -e "\n== Rubocop failed; push aborted! ==\n"
+    echo -e "To auto-correct errors run:"
+    echo -e "\tbin/rubo_fix"
+    exit 1
+fi

data/bin/setup

@@ -3,7 +3,7 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle install
+bundle check || bundle install
 
 # Do any other automated setup that you need to do here
 bin/install-githooks

data/bin/ssh_to_container

@@ -0,0 +1,3 @@
+#! /bin/bash
+
+docker-compose run ruby sh

data/docker-compose.yml

@@ -0,0 +1,19 @@
+version: '3'
+
+services:
+  ruby:
+    build: .
+    volumes:
+      - bundle_cache:/bundle
+      - .:/app
+    environment:
+      - BUNDLE_JOBS=5
+      - BUNDLE_PATH=/bundle
+      - BUNDLE_BIN=/bundle/bin
+      - GEM_HOME=/bundle
+      - DOCKER_CONTAINER=1
+    command:
+      - docker/start.sh
+
+volumes:
+  bundle_cache:

data/docker/start.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+echo "Beginning Setup"
+/app/bin/setup
+
+echo "Environment Ready"
+tail -f /etc/hosts

data/lib/slayer/command.rb

@@ -3,14 +3,17 @@ module Slayer
     singleton_skip_hook :call
 
     class << self
-      def method_added(name)
-        return unless name == :call
-        super(name)
-      end
-
       def call(*args, &block)
         self.new.call(*args, &block)
       end
+
+      private
+
+      def inherited(klass)
+        super(klass)
+        klass.wrap_service_methods!
+        klass.only_hook :call
+      end
     end
 
     def call

data/lib/slayer/minitest.rb

@@ -0,0 +1,66 @@
+# :nocov:
+require 'minitest/assertions'
+# rubocop:disable Style/Documentation
+# rubocop:disable Metrics/MethodLength
+module Minitest::Assertions
+  def assert_success(result, status: nil, message: nil, value: nil)
+    assert result.success?, 'Expected command to succeed.'
+
+    unless status.nil?
+      assert_equal(
+        status,
+        result.status,
+        "Expected command to succeed with status: :#{status}, got: :#{result.status}"
+      )
+    end
+
+    unless message.nil?
+      assert_equal(
+        message,
+        result.message,
+        "Expected command to succeed with message: #{message}, got: #{result.message}"
+      )
+    end
+
+    unless value.nil?
+      assert_equal(
+        value,
+        result.value,
+        "Expected command to succeed with value: #{value}, got: #{result.value}"
+      )
+    end
+  end
+  alias refute_failed assert_success
+
+  def refute_success(result, status: nil, message: nil, value: nil)
+    refute result.success?, 'Expected command to fail.'
+
+    unless status.nil?
+      refute_equal(
+        status,
+        result.status,
+        "Expected command to fail with status: :#{status}, got: :#{result.status}"
+      )
+    end
+
+    unless message.nil?
+      refute_equal(
+        message,
+        result.message,
+        "Expected command to fail with message: #{message}, got: #{result.message}"
+      )
+    end
+
+    unless value.nil?
+      refute_equal(
+        value,
+        result.value,
+        "Expected command to fail with value: #{value}, got: #{result.value}"
+      )
+    end
+  end
+  alias assert_failed refute_success
+end
+# rubocop:enable Style/Documentation
+# rubocop:enable Metrics/MethodLength
+# :nocov:

data/lib/slayer/rspec.rb

@@ -1,42 +1,78 @@
 require 'rspec/expectations'
-
+# rubocop:disable Metrics/BlockLength
 RSpec::Matchers.define :be_success_result do
   match do |result|
-    result.success?
+    status_matches = @status.nil? || @status == result.status
+    message_matches = @message.nil? || @message == result.message
+    value_matches = @value.nil? || @value == result.value
+
+    result.success? && status_matches && message_matches && value_matches
   end
 
   chain :with_status do |status|
     @status = status
   end
 
+  chain :with_message do |message|
+    @message = message
+  end
+
+  chain :with_value do |value|
+    @value = value
+  end
+
+  # :nocov:
   failure_message do |result|
-    return 'expected command to succeed' if @status.nil?
-    return "expected command to succeed with status :#{@status}, but got :#{result.status}"
+    return 'expected command to succeed' if @status.nil? && @value.nil? && @message.nil?
+    return "expected command to succeed with status: :#{@status}, but got: :#{result.status}" unless @status.nil?
+    return "expected command to succeed with value: #{@value}, but got: #{result.value}" unless @value.nil?
+    return "expected command to succeed with message: #{@message}, but got: :#{result.message}" unless @message.nil?
   end
 
   failure_message_when_negated do |result|
-    return "expected command not to have status :#{@status}" if @status.present? && result.status == @status
+    return "expected command not to have message: #{@message}" if !@message.nil? && result.message == @message
+    return "expected command not to have value: #{@value}" if !@value.nil? && result.value == @value
+    return "expected command not to have status :#{@status}" if !@status.nil? && result.status == @status
     return 'expected command to fail'
   end
+  # :nocov:
 end
 
 RSpec::Matchers.define :be_failed_result do
   match do |result|
-    return result.failure? if @status.nil?
-    return result.failure? && (result.status == @status)
+    status_matches = @status.nil? || @status == result.status
+    message_matches = @message.nil? || @message == result.message
+    value_matches = @value.nil? || @value == result.value
+
+    result.failure? && status_matches && message_matches && value_matches
   end
 
   chain :with_status do |status|
     @status = status
   end
 
+  chain :with_message do |message|
+    @message = message
+  end
+
+  chain :with_value do |value|
+    @value = value
+  end
+
+  # :nocov:
   failure_message do |result|
-    return 'expected command to fail' if @status.nil?
-    return "expected command to fail with status :#{@status}, but got :#{result.status}"
+    return 'expected command to fail' if @status.nil? && @value.nil? && @message.nil?
+    return "expected command to fail with status: :#{@status}, but got: :#{result.status}" unless @status.nil?
+    return "expected command to fail with value: #{@value}, but got: #{result.value}" unless @value.nil?
+    return "expected command to fail with message: #{@message}, but got: :#{result.message}" unless @message.nil?
   end
 
   failure_message_when_negated do |result|
-    return "expected command not to have status :#{@status}" if @status.present? && result.status == @status
+    return "expected command to have message: #{@message}" if !@message.nil? && result.message == @message
+    return "expected command to have value: #{@value}" if !@value.nil? && result.value == @value
+    return "expected command to have status :#{@status}" if !@status.nil? && result.status == @status
     return 'expected command to succeed'
   end
+  # :nocov:
 end
+# rubocop:enable Metrics/BlockLength

data/lib/slayer/service.rb

@@ -5,8 +5,24 @@ module Slayer
   class Service
     include Hook
 
-    skip_hook :pass, :flunk, :flunk!, :try!
-    singleton_skip_hook :pass, :flunk, :flunk!, :try!
+    skip_hook(
+      :pass,
+      :flunk,
+      :flunk!,
+      :try!,
+      :wrap_service_methods?,
+      :__opt_in
+    )
+    singleton_skip_hook(
+      :pass,
+      :flunk,
+      :flunk!,
+      :try!,
+      :wrap_service_methods?,
+      :wrap_service_methods!,
+      :do_not_wrap_service_methods!,
+      :__opt_in
+    )
 
     attr_accessor :result
 
@@ -35,6 +51,22 @@ module Slayer
         return r.value if r.success?
         flunk!(value: value || r.value, status: status || r.status, message: message || r.message)
       end
+
+      def wrap_service_methods!
+        @__opt_in = true
+      end
+
+      def wrap_service_methods?
+        __opt_in
+      end
+
+      private
+
+        def __opt_in
+          @__opt_in = false unless defined?(@__opt_in)
+          @__opt_in == true
+        end
+
     end
 
     def pass(*args)
@@ -53,6 +85,10 @@ module Slayer
       self.class.try!(*args, &block)
     end
 
+    def wrap_service_methods?
+      self.class.wrap_service_methods?
+    end
+
     # Make sure child classes also hook correctly
     def self.inherited(klass)
       klass.include Hook
@@ -63,6 +99,8 @@ module Slayer
 
     # rubocop:disable Metrics/MethodLength
     def self.__service_hook(_, instance, service_block)
+      return yield unless wrap_service_methods?
+
       begin
         result = yield
       rescue ResultFailureError => error
@@ -94,5 +132,5 @@ module Slayer
     private_class_method :inherited
     private_class_method :__service_hook
 
-  end # class Service
-end # module Slayer
+  end
+end

data/lib/slayer/version.rb

@@ -1,3 +1,3 @@
 module Slayer
-  VERSION = '0.4.0.beta2'
+  VERSION = '0.4.0.beta3'
 end

data/slayer.gemspec

@@ -20,14 +20,16 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'virtus', '~> 1.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'chandler'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
+  spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'mocha', '~> 1.2'
-  spec.add_development_dependency 'rubocop', '~> 0.48.1'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '= 0.57.2'
   spec.add_development_dependency 'simplecov', '~> 0.13'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slayer
 version: !ruby/object:Gem::Version
-  version: 0.4.0.beta2
+  version: 0.4.0.beta3
 platform: ruby
 authors:
 - Wyatt Kirby
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-14 00:00:00.000000000 Z
+date: 2019-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: chandler
+  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: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -96,33 +110,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.48.1
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,6 +151,20 @@ dependencies:
     - - "~>"
       - !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.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.57.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -176,22 +204,32 @@ files:
 - ".githooks/pre-push"
 - ".gitignore"
 - ".hound.yml"
+- ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"
+- CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/helpers/docker
 - bin/install-githooks
+- bin/rubo_fix
+- bin/run_tests
 - bin/setup
+- bin/ssh_to_container
+- docker-compose.yml
+- docker/start.sh
 - lib/ext/string_ext.rb
 - lib/slayer.rb
 - lib/slayer/command.rb
 - lib/slayer/errors.rb
 - lib/slayer/form.rb
 - lib/slayer/hook.rb
+- lib/slayer/minitest.rb
 - lib/slayer/result.rb
 - lib/slayer/result_matcher.rb
 - lib/slayer/rspec.rb