m-spec 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92375890d1da886c3ae53626b708eba8d93d00076dabd9dc9f2282f67d860032
-  data.tar.gz: 62918be644fb75c3d5831c2884cfdf6099203c59cc31bce3129a1566d4b2c6f6
+  metadata.gz: fe47e5d229c865a8619c6f62bc61d85535df6455cdc3f6c6c3f4c23071b633bd
+  data.tar.gz: 4a9085d8178b12ef11170b053f8e17d27a8e8a0666219541a3937f616af133f6
 SHA512:
-  metadata.gz: 332454bdef60665103d66612748d42b9a6bd1af25c96228ae2b0009c236af8871f1d809100ad20905ef4d217ef65e9ecc9a64be6a35a88aab21579447cf59680
-  data.tar.gz: ae2b63dac9719375fa1bc286c43b0b9410ec9cc1e5a08c350301da9aa08e1f8032987315eb62a5f6f2d925cbb8d5a5dfb2133b79b1b0aab89d78930824340725
+  metadata.gz: 0a9982cf39b798aadc96fb67629bfc77935e4e417b22843a9bf411a5cc5431a64378e98ac3610eb6e34ebe2c92f1bc8072324baae2cbb7c77c2df2a6169045f0
+  data.tar.gz: c20edd5f8e4f083bdc675d16ed844069c15386a4e78056c2c7017c6c9930a2bd4961d7df130ecd13368a798a81a8a7fc3b80e4c445e2c27c00f3c6e9c43f1560

data/README.md

@@ -1,13 +1,13 @@
 # Mspec
 
-The lightest-weight spec framework in ruby
+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
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'mspec'
+gem 'm-spec'
 ```
 
 And then execute:
@@ -16,7 +16,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install mspec
+    $ gem install m-spec
 
 ## Usage
 
@@ -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
@@ -55,31 +55,49 @@ end
 To run your specs, pass the spec file directly as an argument. You have to run individual spec files.
 
 ```sh
-$ mspec ./spec/animal_spec.rb
+$ 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
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/dearshrewdwit/mspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dearshrewdwit/m-spec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -87,4 +105,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Mspec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dearshrewdwit/mspec/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Mspec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dearshrewdwit/m-spec/blob/master/CODE_OF_CONDUCT.md).

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,16 +11,17 @@ 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)
   Mspec::Expect.new(obj)
 end

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/spec_result.rb

@@ -1,6 +1,8 @@
 module Mspec
   class SpecResult
-    def initialize(error)
+    def initialize(expectation, matcher, error)
+      @expectation = expectation
+      @matcher = matcher
       @error = error
     end
 
@@ -8,8 +10,15 @@ module Mspec
       !@error
     end
 
-    def simple_stack_trace
-      [@error.backtrace[1]]
+    def failure_message
+      [
+        "Expected: #{@matcher.value}",
+        "Got: #{@expectation.value}",
+      ]
+    end
+
+    def trace
+      "#{@error.backtrace[1]}"
     end
   end
 end

data/lib/m-spec/version.rb

@@ -1,3 +1,3 @@
 module Mspec
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: m-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Edward Withers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler