m-spec 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ce2fb3d3541770936da294b63f3815faea69904333bc06c63403ad76a25dfe7
-  data.tar.gz: 3ae0e86750afbb3458fd8f33cdac13c1ae72ac5a6f771de746e5967a963a7bb2
+  metadata.gz: f055e58c3c0edff2cede566c4eb387246d69b4ee536773ad95addb2b52e6074b
+  data.tar.gz: 58c017bc787dbeefc2411e4131b0681ca1be035ec1bc1d0c9b08765d1e010588
 SHA512:
-  metadata.gz: fe13e5509c611618d7e215c77e799a44f3bc4939afe92e7d09de5404000e7e1bae2af3839f2760dd0d9c43ecf9fb610a057d84878d373d64c3586b864d926783
-  data.tar.gz: 8bed6188d906066b77d945d0e296320febf31488266661ef04994a737a51230db3a5394a0461231047a2c9d7576ca4344a28d728c5d932a8f9ba478c2346b976
+  metadata.gz: 2a4861aebb496805aa16426fa16c6d1fb0fd1f555aa2118946eb03ee5227eece185f0e528eb4433cd9ce81d64bd3c61ccfc0e1bb581d253b9fb6a1b1a5ceba03
+  data.tar.gz: '082a188d2374df2fb7af946b27e346828b26990166edd2dfbf655ed300dd1d2910559adcaff0f6cb71dc350e8ce7d11bc6c2e85b60dca9f6e8d04ad5b106bd21'

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
 ```
 
 ```
@@ -67,6 +80,11 @@ The Animal
     # /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.

data/exe/m-spec

@@ -2,16 +2,33 @@
 require 'm-spec'
 
 def run_rubocop!
-  config = "$GEM_HOME/gems/m-spec-#{Mspec::VERSION}/.rubocop.yml"
-  system("bundle exec rubocop --config #{config}")
+  # 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]
-  require spec_file
+  Mspec::Specs.new(spec_file).run!
 end
 
-if File.exists?('./.m-spec')
+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')

data/lib/m-spec.rb

@@ -5,6 +5,8 @@ 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"

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

@@ -9,16 +9,18 @@ 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
 

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

@@ -12,8 +12,8 @@ module Mspec
 
     def failure_message
       [
-        "Expected: #{@expected_result.value.inspect}",
-        "Got: #{test_code_result.inspect}",
+        "Expected: ".rjust(9) + "#{@expected_result.value.inspect}",
+        "Got: ".rjust(9) + "#{test_code_result.inspect}",
       ]
     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.8"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: m-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Edward Withers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -77,7 +77,9 @@ files:
 - 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