m-spec 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 857fb56c14bef8568ca65cfb7b8dd8a690276d39db4a074ff4ff1bcc87f40623
-  data.tar.gz: e1e45c135ad1ba9fa443ce1bedd7c29da423801487132e486685ef348539cef2
+  metadata.gz: f055e58c3c0edff2cede566c4eb387246d69b4ee536773ad95addb2b52e6074b
+  data.tar.gz: 58c017bc787dbeefc2411e4131b0681ca1be035ec1bc1d0c9b08765d1e010588
 SHA512:
-  metadata.gz: 58a02ecbc7553aefa81164debb276264ab9e434a76c5702d4b1081283ed0f4e7523d7d92c7742b27b49a0a0692282a2dea9eb15c6caf5d3b338063735c1f0d34
-  data.tar.gz: 41d3a4c22032f454c9b4176307457020fda0a2ee00ff7564a736dd1d9b035a3f72203f8940910e4dd32af2e270aeda564636fff7ced719b7b075a8c50c2733dc
+  metadata.gz: 2a4861aebb496805aa16426fa16c6d1fb0fd1f555aa2118946eb03ee5227eece185f0e528eb4433cd9ce81d64bd3c61ccfc0e1bb581d253b9fb6a1b1a5ceba03
+  data.tar.gz: '082a188d2374df2fb7af946b27e346828b26990166edd2dfbf655ed300dd1d2910559adcaff0f6cb71dc350e8ce7d11bc6c2e85b60dca9f6e8d04ad5b106bd21'

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). You have one matcher, the comparison matcher, and test setup and teardown is your responsibility. For additional features, you must extend the gem.
+The lightest-weight spec framework in ruby. Built for learning at [Makers](https://makers.tech). You have two matchers, an equality matcher and an output matcher, and test setup and teardown is your responsibility. For additional features, you must extend the gem.
 
 ## Installation
 
@@ -43,19 +43,32 @@ describe 'The Animal' do
   end
 end
 
-describe 'stubbing' do
-  it 'we can mock too!' do
+describe 'test doubles' do
+  it 'can be stubbed' do
     mock = test_double
     allow(mock).to receive(:speak) { 'Hello!' }
     expect(mock.speak).to eq 'Hello!'
   end
+  it 'can have optional names' do
+    mock = test_double('a name')
+    allow(mock).to receive(:speak) { 'Hello!' }
+    expect(mock.speak).to eq 'Hello!'
+  end
+end
+
+describe 'testing output' do
+  it 'captures strings' do
+    expect { puts('hello') }.to output("hello\n")
+  end
 end
 ```
 
-To run your specs, pass the spec file directly as an argument. You have to run individual spec files.
+To run your specs, pass the spec file directly as an argument. You have to run individual spec files, or create a file that requires your specs.
 
 ```sh
 $ m-spec ./spec/animal_spec.rb
+# or
+$ m-spec ./spec_runner.rb
 ```
 
 ```
@@ -64,14 +77,30 @@ The Animal
   fails nicely
     Expected: ROAAAARRRR!
     Got: little roar!
-    /path/to/directory/spec/animal_spec.rb:11:in `block (2 levels) in <top (required)>'
+    # /path/to/directory/spec/animal_spec.rb:11:in `block (2 levels) in <top (required)>'
 stubbing
   we can mock too!
+
+Inspecting 3 files
+...
+
+3 files inspected, no offenses detected
 ```
 
 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 test setup and teardown yourself and keeping your test code dry yourself. Make sure each test runs in isolation.
+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.
+
 
 ## Extending
 
@@ -88,7 +117,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,46 @@
 #!/usr/bin/env ruby
 require 'm-spec'
 
-spec_file = ARGV[0]
-require spec_file
+def run_rubocop!
+  # needs default
+  if File.exists?('.rubocop.yml')
+    puts "\n---Readability Tests---\n\n"
+    system("bundle exec rubocop")
+  else
+    puts "ERROR: No '.rubocop.yml' found, please create one at your project root or re-initialize m-spec with `m-spec --init`"
+  end
+end
+
+def run_specs!
+  spec_file = ARGV[0]
+  Mspec::Specs.new(spec_file).run!
+end
+
+if ARGV[0] == '--init'
+  contents = File.read("#{ENV['GEM_HOME']}/gems/m-spec-#{Mspec::VERSION}/.rubocop.yml")
+  File.open('.rubocop.yml', 'w') do |file|
+    file.write(contents)
+  end
+  puts 'created: .rubocop.yml'
+
+  contents = "# This has been auto-generated. Feel free to delete these comments.\n#\n# Try adding options below: '--no-rubocop' or '--only-rubocop' without the quotes."
+  File.open('.m-spec', 'w') do |file|
+    file.write(contents)
+  end
+  puts 'created: .m-spec'
+elsif 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,14 @@
+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/spec_example"
+require "m-spec/core/specs"
 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/helpers/readable.rb

@@ -9,21 +9,31 @@ def describe(str)
   yield
 end
 
-def it(str)
-  spec_result = yield
-  if spec_result.success?
+def it(str, specs = Mspec::Specs.instance)
+  spec_example = Mspec::SpecExample.new(str, yield)
+  specs.add(spec_example)
+
+  if spec_example.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|
+    spec_example.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"
+    puts "    \e[#{COLOUR_CODES[:light_blue]}m# #{spec_example.trace}\e[0m"
+  end
+end
+
+def expect(obj=nil, &block)
+  if !obj.nil?
+    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/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_example.rb

@@ -0,0 +1,26 @@
+module Mspec
+  class SpecExample
+    attr_reader :description, :result
+
+    def initialize(description, result)
+      @description = description
+      @result = result
+    end
+
+    def success?
+      @result.success?
+    end
+
+    def failure?
+      !success?
+    end
+
+    def failure_message
+      @result.failure_message
+    end
+
+    def trace
+      @result.trace
+    end
+  end
+end

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

@@ -1,8 +1,8 @@
 module Mspec
   class SpecResult
     def initialize(expectation, matcher, error)
-      @expectation = expectation
-      @matcher = matcher
+      @test_code = expectation
+      @expected_result = matcher
       @error = error
     end
 
@@ -12,13 +12,23 @@ module Mspec
 
     def failure_message
       [
-        "Expected: #{@expectation.value}",
-        "Got: #{@matcher.value}",
+        "Expected: ".rjust(9) + "#{@expected_result.value.inspect}",
+        "Got: ".rjust(9) + "#{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/core/specs.rb

@@ -0,0 +1,35 @@
+module Mspec
+  class Specs
+    attr_reader :data
+
+    def initialize(file)
+      @file = file
+      @data = []
+      @@instance = self
+    end
+
+    def run!
+      require(@file)
+      summary
+    end
+
+    def add(spec)
+      @data << spec
+    end
+
+    def self.instance
+      @@instance
+    end
+
+    def summary
+      puts "\n---Summary---\n\n"
+      puts "#{@data.length} examples found"
+      failures = @data.select(&:failure?)
+
+      puts "#{failures.length} failures"
+      failures.each_with_index do |spec, index|
+        puts "     \e[#{COLOUR_CODES[:red]}m#{index+1}. #{spec.trace}\e[0m"
+      end
+    end
+  end
+end

data/lib/m-spec/version.rb

@@ -1,3 +1,3 @@
 module Mspec
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 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.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Edward Withers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-08-13 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,8 +75,11 @@ 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_example.rb
 - lib/m-spec/core/spec_result.rb
+- lib/m-spec/core/specs.rb
 - lib/m-spec/mocks/allow.rb
 - lib/m-spec/mocks/helpers/readable.rb
 - lib/m-spec/mocks/mock.rb