matest 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f5aa7cbf9baa6a1ecd2ea22af65d958de666e95
-  data.tar.gz: 85753ee9e65a6a0141c521a732572bb1bbae86a3
+  metadata.gz: 7e6e7d1a7872997bc4b3fad1f258f0093f9f32ea
+  data.tar.gz: 78015cdf727f064505dbba282a5e008bdf8ecf1b
 SHA512:
-  metadata.gz: f3b856079130676b3490d263568a1b617937bc9c9a0b172e13ea0a283142ab42bca64a07827d92eef012a5da31afb9b606e0529cb53d41514e02f472661016dc
-  data.tar.gz: 181eecd3f1c33a2bdd8b7628eb579805b4a82e241f2b407614d3763526308d0bf60245d1ef53d05dff3d9745cf710ac22001ad60d57980ce5b300382b4ca0585
+  metadata.gz: 05aaa86b1200e3dc2b973ceab2efd6e0f5c78dbbdd1addcfc974f77131819ec89bdb97a160d0b61290fc5629ae8d85f57e5cdc40e4043774a3730c54c714d8e3
+  data.tar.gz: 627b3b5a0a537325677319564fd80f3de92a99acbdfc95f981b51535d2e9c06f3d0aba7921c623ed76014303787fcf6165be6aa2b1226bb8a6c1c090ef29065a

data/README.md

@@ -1,6 +1,18 @@
 # Matest
 
-Tests Gasoleros (Cheap tests)
+Tests Gasoleros (Very cheap tests)
+
+## Description
+
+Matest is a very small testing library.
+
+It doesn't use the usual assertion style (`assert(1, 1)`) nor the rspec style(`1.should == 1` or `1.must_equal(1)`).
+
+It uses natural assertions.
+
+This means that:
+- A test will pass if it returns true
+- A test will fail if it returns false
 
 ## Installation
 
@@ -20,7 +32,134 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To run Matest, you just need to execute the `mt` command, passing as arguments the desired test files.
+
+```bash
+$ mt spec/my_spec.rb
+```
+
+You can also use wildcards.
+
+For example, to run all the specs in a directory:
+```bash
+$ mt spec/*_spec.rb
+```
+
+Or to run recursively
+```bash
+$ mt spec/**/*_spec.rb
+```
+
+## Specs
+
+To define a test, first you need to set a scope, and inside it, define your spec.
+```ruby
+scope do
+  spec do
+    true
+  end
+end
+```
+
+If the return value of the `spec` block is `true`, the spec will pass and if it's false it will `fail`.
+
+If you return anithing else, you'll get a `NOT A NATURAL ASSERTION` status.
+
+You can also add descriptions to either the `scope` or the `spec` blocks:
+
+```ruby
+scope "a description" do
+  spec "another description" do
+    true
+  end
+end
+```
+
+## Raising Errors
+
+If your test raises an error during the run, youll get an `ERROR` status and you'll see the backtrace.
+
+## Skipping
+
+You can skip a test in two possible ways: You can declare a spec whithout a block or use the `xspec` method.
+
+```ruby
+scope do
+  xspec "I'll be skipped" do
+    true
+  end
+  spec "I'll be skipped too"
+end
+```
+
+This will skip you spec and inform you when you run.
+
+You can skip the whole scope  by using `xscope` instead of `scope`.
+
+Take into account that `xscope` is a no-op so you won't be informed when you skip a scope.
+
+## Let and let!
+
+Matest steals the `let` and `let!` features from `RSpec` and `Minitest`.
+
+With `let` you can declare a lazy variable valid on the current scope and all sub-scopes.
+
+Here are some examples of what you can do with them:
+
+```ruby
+scope do
+  let(:m1) { :m1 }
+  let!(:m3) { :m3 }
+  
+  let(:m4) { :m4 }
+  let!(:m5) { :m5 }
+
+  spec do
+    m1 == :m1
+  end
+
+  spec do
+    ! defined?(m2)
+  end
+
+  spec do
+    m3 == :m3
+  end
+
+  spec do
+    ! defined?(@m4)
+  end
+
+  spec do
+    !! defined?(@m5)
+  end
+  
+  scope do
+    let(:m2) { :m2 }
+    spec do
+      m1 == :m1
+    end
+
+    spec do
+      m2 == :m2
+    end
+  end
+end
+```
+
+## Aliases
+
+You may be used to other keywords provenient from different testing frameworks. Matest has a couple of alias that you may use indistinctly to fit your style.
+
+`scope` has the following aliases:
+- `context` (and `xcontext`)
+- `describe` (and `xdescribe`)
+- `group` (and `xgroup`)
+
+`spec` has the following aliases:
+- `it` (and `xit`)
+- `test` (and `xtest`)
+- `example` (and `xexample`)
 
 ## Contributing
 

data/lib/matest.rb

@@ -157,8 +157,8 @@ module Matest
       spec(description)
     end
 
-    [:it, :spec, :test, :example].each do |m|
-      alias m :spec
+    [:it, :test, :example].each do |m|
+      alias :"#{m}" :spec
       alias :"x#{m}" :xspec
     end
 
@@ -204,3 +204,12 @@ end
 def scope(description=nil, &block)
   Matest::Runner.runner << Matest::ExampleGroup.new(block)
 end
+
+def xscope(description=nil, &block)
+  # no-op
+end
+
+[:describe, :context, :group].each do |m|
+  alias :"#{m}" :scope
+  alias :"x#{m}" :xscope
+end

data/lib/matest/version.rb

@@ -1,3 +1,3 @@
 module Matest
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/matest_spec.rb

@@ -102,10 +102,11 @@ describe "spec" do
   end
 
   it "exists only inside a scope" do
-    spec do
+    -> {
+      spec do
       true
-    end
-
+      end
+    }.must_raise(NoMethodError)
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: matest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Federico Iachetti