m-spec 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 579272e22679383c17c8c38fc3d9bc51ae815a7c2b598625fade1c56f2602f48
-  data.tar.gz: 01f4facd9eb3acbbef1c63271180a557f5e5143de5032d765e2d5b73ba7a77f0
+  metadata.gz: 1dcf77e4015cb8bb7c3a1e9c0bdba696607e9b5e1c194498cb260373e7038921
+  data.tar.gz: 81821b568580532c5b5c4cf18b457f947185a83932d4b9359b57b3e85c211502
 SHA512:
-  metadata.gz: 18e74c2c81a2189ba23bf0a64d853e203dd40804be4f591abc0e0e64a857baaa60cf4406110cac864df8a323e0f777d63dab30aacbd8070638fc752362df416c
-  data.tar.gz: 403789c4529c404b303db5e5d4bf6b39186dcd9c41afc3c648377456e9f1210f886f57295ce922fa193cf4534a8c61c6072484b36bb29c60aa9fed0078894719
+  metadata.gz: 4638a25c2f039e6bbb4a550db34a1b228414e30037209b50ea273e7173717eed1e931f5bc58bffd888041e0f6a84b54d46fc770bcd970f8ca98c9a150f7af72b
+  data.tar.gz: f1ede96eae952c17fb581b02741cadf44ea619bb0dade5a69f0b27133f482a1642cf8c3e22fee17c2ff8fac7cc7b4aa3172e8b3d0060d6ab3e036d3eefd9012f

data/.rubocop.yml

@@ -0,0 +1,12 @@
+#    _____               ____ ____        __     _         __
+#   / ___/ _____ ____ _ / __// __/____   / /    (_)____   / /_
+#   \__ \ / ___// __ `// /_ / /_ / __ \ / /    / // __ \ / __/
+#  ___/ // /__ / /_/ // __// __// /_/ // /___ / // / / // /_
+# /____/ \___/ \__,_//_/  /_/ 1 \____//_____//_//_/ /_/ \__/
+#
+# The linter file that doesn't lead junior developers to bad habits.
+# https://github.com/makersacademy/scaffolint
+#
+# Configure Rubocop to use the config file in the Scaffolint GitHub repo
+inherit_from:
+  - https://raw.githubusercontent.com/makersacademy/scaffolint/v1.1.0/.rubocop.yml

data/README.md

@@ -1,6 +1,6 @@
 # Mspec
 
-The lightest-weight spec framework in ruby. Built for learning at [Makers](https://makers.tech).
+The lightest-weight spec framework in ruby. Built for learning at [Makers](https://makers.tech). You have one matcher, the comparison matcher, and test setup and teardown is your responsibility. For additional features, you must extend the gem.
 
 ## Installation
 
@@ -37,7 +37,7 @@ describe 'The Animal' do
     expect(animal.roar).to eq "ROAAAARRRR!"
   end
 
-  it 'gives a lovely red when it fails' do
+  it 'fails nicely' do
     animal = Animal.new
     expect(animal.roar).to eq "little roar!"
   end
@@ -62,14 +62,27 @@ $ m-spec ./spec/animal_spec.rb
 The Animal
   returns a string
   fails nicely
-  /path/to/directory/app/spec/animal_spec.rb:11:in block (2 levels) in <top (required)>'
+    Expected: ROAAAARRRR!
+    Got: little roar!
+    # /path/to/directory/spec/animal_spec.rb:11:in `block (2 levels) in <top (required)>'
 stubbing
   we can mock too!
 ```
 
-It's got simple one-level indentation and simple colour coding for test passes and failures. Failures will give you only the spec file path and line number.
+It's got simple one-level indentation, simple colour coding for test passes and failures, and simple failure messages with expected and actual values and the failing spec file path and line number.
+
+Remember - you'll have to manage yourself: test setup and teardown, keeping test code dry, each test running in isolation, and loading source code properly.
+
+## Rubocop
+
+M-spec comes with rubocop by default, using this [set of rules](https://github.com/makersacademy/scaffolint). To configure your test suite to disable rubocop or to only run rubcop, add an optional configuration file named `.m-spec` to your project root where you run your specs from. You don't need the configuration file - by default your specs will run first, followed by rubocop.
+
+You can add either of two options
+- `--no-rubocop` which will ignore running rubocop
+- `--only-rubocop` which will ignore running your tests
+
+See [rubocop documentation](https://docs.rubocop.org/rubocop/index.html) for more info - you might be interested in reading about rubocop's autocorrect command.
 
-Remember - you'll have to manage test setup and test cleanup yourself, while keeping your test code dry also yourself. Make sure each test runs in isolation.
 
 ## Extending
 
@@ -86,7 +99,7 @@ m-spec [spec-file]
 ```
 
 ## Pushing to Rubygems
-Sign up for an account, check for the gem name you want, and then follow the hints and errors when you
+Sign up for an account, check for the gem name you want, change the gem metadata to represent what you want, and then follow the hints and errors when you
 ```sh
 $ bundle exec rake release
 ```

data/exe/m-spec

@@ -1,5 +1,29 @@
 #!/usr/bin/env ruby
 require 'm-spec'
 
-spec_file = ARGV[0]
-require spec_file
+def run_rubocop!
+  config = "$GEM_HOME/gems/m-spec-#{Mspec::VERSION}/.rubocop.yml"
+  system("bundle exec rubocop --config #{config}")
+end
+
+def run_specs!
+  spec_file = ARGV[0]
+  require spec_file
+end
+
+if File.exists?('./.m-spec')
+  File.open('./.m-spec', 'r') do |file|
+    options = file.read.split
+    if options.include?('--only-rubocop')
+      run_rubocop!
+    elsif options.include?('--no-rubocop')
+      run_specs!
+    else
+      run_specs!
+      run_rubocop!
+    end
+  end
+else
+  run_specs!
+  run_rubocop!
+end

data/lib/m-spec.rb

@@ -1,9 +1,12 @@
+require 'stringio'
+
 require "m-spec/version"
 
 require "m-spec/core/expect"
 require "m-spec/core/spec_error"
 require "m-spec/core/spec_result"
 require "m-spec/core/matchers/equal"
+require "m-spec/core/matchers/output"
 require "m-spec/core/helpers/readable"
 
 require "m-spec/mocks/allow"

data/lib/m-spec/core/expect.rb

@@ -1,5 +1,7 @@
 module Mspec
   class Expect
+    attr_reader :value
+
     def initialize(value)
       @value = value
     end
@@ -11,7 +13,7 @@ module Mspec
         data = e
       end
 
-      SpecResult.new(data)
+      SpecResult.new(self, matcher, data)
     end
   end
 end

data/lib/m-spec/core/helpers/readable.rb

@@ -1,6 +1,7 @@
 COLOUR_CODES = {
-  true => 32,
-  false => 31
+  green: 32,
+  red: 31,
+  light_blue: 36
 }
 
 def describe(str)
@@ -10,18 +11,27 @@ end
 
 def it(str)
   spec_result = yield
-  colour_code = COLOUR_CODES[spec_result.success?]
-  puts "  \e[#{colour_code}m#{str}\e[0m"
-  unless spec_result.success?
-    spec_result.simple_stack_trace.each do |stackline|
-      puts "  \e[#{colour_code}m#{stackline}\e[0m"
+  if spec_result.success?
+    puts "  \e[#{COLOUR_CODES[:green]}m#{str}\e[0m"
+  else
+    puts "  \e[#{COLOUR_CODES[:red]}m#{str}\e[0m"
+    spec_result.failure_message.each do |line|
+      puts "    \e[#{COLOUR_CODES[:red]}m#{line}\e[0m"
     end
+    puts "    \e[#{COLOUR_CODES[:light_blue]}m# #{spec_result.trace}\e[0m"
   end
 end
 
+def expect(obj=nil, &block)
+  if obj
+    Mspec::Expect.new(obj)
+  else
+    Mspec::Expect.new(block)
+  end
+end
 
-def expect(obj)
-  Mspec::Expect.new(obj)
+def output(string)
+  Mspec::Matchers::Output.new(string)
 end
 
 def eq(obj)

data/lib/m-spec/core/matchers/equal.rb

@@ -1,6 +1,8 @@
 module Mspec
   module Matchers
     class Equal
+      attr_reader :value
+
       def initialize(value)
         @value = value
       end

data/lib/m-spec/core/matchers/output.rb

@@ -0,0 +1,31 @@
+require 'stringio'
+
+module Mspec
+  module Matchers
+    class Output
+      attr_reader :value, :test_code_output_string
+
+      def initialize(value)
+        @value = value
+      end
+
+      def check(block)
+        output = mock_output do
+          block.call
+        end
+        @test_code_output_string = output.string
+
+        @value == @test_code_output_string
+      end
+
+      private
+
+      def mock_output(output=StringIO.new, &block)
+        $stdout = output
+        block.call
+        $stdout = STDOUT
+        output
+      end
+    end
+  end
+end

data/lib/m-spec/core/spec_result.rb

@@ -1,6 +1,8 @@
 module Mspec
   class SpecResult
-    def initialize(error)
+    def initialize(expectation, matcher, error)
+      @test_code = expectation
+      @expected_result = matcher
       @error = error
     end
 
@@ -8,8 +10,25 @@ module Mspec
       !@error
     end
 
-    def simple_stack_trace
-      [@error.backtrace[1]]
+    def failure_message
+      [
+        "Expected: #{@expected_result.value.inspect}",
+        "Got: #{test_code_result.inspect}",
+      ]
+    end
+
+    def trace
+      "#{@error.backtrace[1]}"
+    end
+
+    private
+
+    def test_code_result
+      if @test_code.value.is_a?(Proc)
+        @expected_result.test_code_output_string
+      else
+        @test_code.value
+      end
     end
   end
 end

data/lib/m-spec/version.rb

@@ -1,3 +1,3 @@
 module Mspec
-  VERSION = "0.1.2"
+  VERSION = "0.1.7"
 end

data/m-spec.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rubocop", "~> 0.79.0"
+
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", ">= 12.3.3"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: m-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Edward Withers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -60,6 +75,7 @@ files:
 - lib/m-spec/core/expect.rb
 - lib/m-spec/core/helpers/readable.rb
 - lib/m-spec/core/matchers/equal.rb
+- lib/m-spec/core/matchers/output.rb
 - lib/m-spec/core/spec_error.rb
 - lib/m-spec/core/spec_result.rb
 - lib/m-spec/mocks/allow.rb