m-spec 0.1.7 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dcf77e4015cb8bb7c3a1e9c0bdba696607e9b5e1c194498cb260373e7038921
-  data.tar.gz: 81821b568580532c5b5c4cf18b457f947185a83932d4b9359b57b3e85c211502
+  metadata.gz: 4f6acd7d54cf75d89e1c6775a87596f48765d537726dbde5bfb9f7edbf94d8b3
+  data.tar.gz: dc0fc6487f6b34ebb5bed6fad56c1eaf9b8fb7a834d302deeafd95095fa5433a
 SHA512:
-  metadata.gz: 4638a25c2f039e6bbb4a550db34a1b228414e30037209b50ea273e7173717eed1e931f5bc58bffd888041e0f6a84b54d46fc770bcd970f8ca98c9a150f7af72b
-  data.tar.gz: f1ede96eae952c17fb581b02741cadf44ea619bb0dade5a69f0b27133f482a1642cf8c3e22fee17c2ff8fac7cc7b4aa3172e8b3d0060d6ab3e036d3eefd9012f
+  metadata.gz: 709cbf7e8ac930b83c63c575dbac520bdf49d56eaf9c479f917504f1400e0f2f382426cab4639c3ceae3a17b1aa99dee31151aceffdaa441ee3f457ad96a0a1a
+  data.tar.gz: d64e4dd9cad0bcd54a0c988fa733d53de9a94df8030605d79c01a03632c29bad3ae5977394b736a403dd5ecd727c6fbb0faa01509b249d552013c63e5dd3184b

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in mspec.gemspec
 gemspec

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 three matchers, an equality matcher, an output matcher and an error matcher. Test setup and teardown is your responsibility. For additional features, you must extend the gem.
 
 ## Installation
 
@@ -18,6 +18,14 @@ Or install it yourself as:
 
     $ gem install m-spec
 
+## Setup
+
+Initialize m-spec with a `.m-spec` and a `.rubocop.yml` file
+```sh
+m-spec --init
+```
+
+
 ## Usage
 
 We care about isolating unit tests, so there's a very simple mocking library.
@@ -43,19 +51,38 @@ 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
+
+  it 'can be sent messages with any args' do
+    mock = test_double('a name')
+    allow(mock).to receive(:speak) { 'Hello!' }
+    expect(mock.speak('example arg')).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 +94,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,37 @@
 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.exist?('.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.exist?('./.m-spec')
   File.open('./.m-spec', 'r') do |file|
     options = file.read.split
     if options.include?('--only-rubocop')

data/lib/m-spec.rb

@@ -5,8 +5,12 @@ 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/matchers/raise_error"
+
 require "m-spec/core/helpers/readable"
 
 require "m-spec/mocks/allow"

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

@@ -9,21 +9,22 @@ 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|
+    puts "  \e[#{COLOUR_CODES[:red]}m#{str}\n\e[0m"
+    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 "\n    \e[#{COLOUR_CODES[:light_blue]}m# #{spec_example.trace}\e[0m"
   end
 end
 
-def expect(obj=nil, &block)
-  if obj
+def expect(obj = nil, &block)
+  if !obj.nil?
     Mspec::Expect.new(obj)
   else
     Mspec::Expect.new(block)
@@ -37,3 +38,7 @@ end
 def eq(obj)
   Mspec::Matchers::Equal.new(obj)
 end
+
+def raise_error(error_class)
+  Mspec::Matchers::RaiseError.new(error_class)
+end

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

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

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

@@ -0,0 +1,31 @@
+require 'stringio'
+
+module Mspec
+  module Matchers
+    class RaiseError
+      attr_reader :value, :actual
+
+      def initialize(value)
+        @value = value
+      end
+
+      def check(block)
+        @actual = catch_error do
+          block.call
+        end
+
+        @value == @actual
+      end
+
+      private
+
+      def catch_error(&block)
+        begin
+          block.call
+        rescue StandardError => e
+          e.class
+        end
+      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

@@ -12,8 +12,8 @@ module Mspec
 
     def failure_message
       [
-        "Expected: #{@expected_result.value.inspect}",
-        "Got: #{test_code_result.inspect}",
+        "Expected: ".rjust(10) + "#{@expected_result.value.inspect}",
+        "Got: ".rjust(10) + "#{test_code_result.inspect}",
       ]
     end
 
@@ -25,7 +25,7 @@ module Mspec
 
     def test_code_result
       if @test_code.value.is_a?(Proc)
-        @expected_result.test_code_output_string
+        @expected_result.actual
       else
         @test_code.value
       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/mocks/allow.rb

@@ -6,7 +6,7 @@ module Mspec
       end
 
       def to(stub)
-        @obj.define_singleton_method(stub.name) { stub.return_value }
+        @obj.define_singleton_method(stub.name) { |*| stub.return_value }
       end
     end
   end

data/lib/m-spec/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: m-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.3
 platform: ruby
 authors:
 - Edward Withers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -76,8 +76,11 @@ files:
 - 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/matchers/raise_error.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