m-spec 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f7176104089e7c433938f1f233b00424025973c9eadcb089a691113864cc77
-  data.tar.gz: c5401779d4911d751782dd3fea995b7c984780c23de35a7b2eeb987ff22317ae
+  metadata.gz: 6420629e2b27b246efaca92e6ad572603eaaf05bfaf716b0d386cadebafab8f9
+  data.tar.gz: 33e8d052ef1d6513a06e9048ac12ce95c51b1597c3ef7246b4d360619b304cab
 SHA512:
-  metadata.gz: 3e4085f1f73da8376b825634bc4cae40e23adf175056f1393aec5ebb13985cc68011b5b02aa6f08897fa968083eb570e26078cb4a0f073bae2925d434ee6cc16
-  data.tar.gz: 9979041228817e5f401286158b45538ef685e2e85eaed148b529b33c835b6b327b45b2fa0918328b35a4fb94aa28fefd99ad3b2c4702f33080fc4cc11a2150e2
+  metadata.gz: f9484c58fa989d6dea4c2a94abed38d2d769b04c663c3206588961d41858f3ae1c2afda4cfac94b515c9364191131b96913d335d1379765f8af495ec6da9ddba
+  data.tar.gz: 21ba3b262a018015878cac2b140acbde0e46ad6e916cb17de44e1a25ea4861d49478d67cd05050d354c96ac180647110b3a9937e452c86319cc3098c5ab24255

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,20 +62,38 @@ $ 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 test setup and test cleanup yourself, while keeping your test code dry also 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.
 
-## Development
+## Extending
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo
+```sh
+$ git clone git@github.com:dearshrewdwit/m-spec.git
+$ cd m-spec
+```
+Add more matchers, or extend the mocking library. Then build locally and use.
+```sh
+bundle exec rake build --trace
+gem install pkg/m-spec-[version].gem
+m-spec [spec-file]
+```
+
+## Pushing to Rubygems
+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
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+[Bundler docs](https://bundler.io/guides/creating_gem.html) are a good resource, as are the [rubygems docs](https://guides.rubygems.org/publishing/)
 
 ## Contributing
 

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.1"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: m-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Edward Withers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,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