speckle 0.1.18 → 0.1.19

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2ZiNzc1MmNlZDEzYTMxZWE5MDgwMDZmZmM3ODVhOTUxMDA5NTNkMg==
+    ZDlkY2JlNWI2YzU0Nzk1YWEyOWQ5M2YwZGNkNGIxMjIwZTIwMGI0ZA==
   data.tar.gz: !binary |-
-    OWY0MGFjOWNmYjZlNzc3NTU4NmFjZjAyZjhkZTdhNTZkM2JkZjE1NA==
+    OWNlZjUyYTc2MjdmYTQwMzhiMTg1MzBhNTZmZjdjMmFmYTlkYTdjZg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NjBjOTNiNDlkYTFkNjk2YjliZTY5OTBjNmNlM2UzOGNlMDllZGE3Y2YwMzZm
-    Zjk4MzM5ODVjMDVjNWVkZWYzNTI5OTY0MWE1NjM5YTcwMGFhMzExNzBhZTJl
-    OTM3N2I4Y2VkMmM3YWQ1YTk4ZmVmNzE4MWM1NzgxYTY3ZjIwZGI=
+    ODllNmEwN2E0ZGEzZDk5ZTNiMDljMmEyOGY5MTE0MjQyMmFiOGY2MDMzNzU3
+    Njk1Mzc4YzY1MmE0YzU1NDA4ZTkzZGI2NjEwNWE5ZGQxMjUxY2JiZTUzYTI5
+    ODRjZTU5ZmY3Y2EzZjU3MjI0ODZjODBiMDI3ODk0MzNiZTc4OGQ=
   data.tar.gz: !binary |-
-    YTkxNmQ1ZGQ2ZjgwZWMxMTRjZmE2MmI1ZjFmN2EwODIzNmRiMjhlOTAwMTk1
-    YjVlMDUxZjg0YjFkNzBlMzBiOTVlYzRkMGY1MjEwZmU3Y2Y4MjgyOTNmZDYx
-    M2MwYTRhOWJlZjg4NzNiNGI1NjA0YWFmYzc4OGIzNGUzZWMyYjY=
+    NTAxMmE2M2MzNmQwOGQ2ZjA4NTFjNTQxMzQxODczMmY5MDNhMDE0MmM1ZjJj
+    OTBjMDY0YTM5ZGFlMTgwYzkyZjQ2ZTUwMzA3Y2QwYTllYWYyNGJmZDFmNWVl
+    ZTFjZDU0YjdlOGJlOWUxNWIzZjcyOTM4MDhmMjg5N2VkMGM5YTg=

data/README.md

@@ -1,14 +1,277 @@
-# Speckle
+## Speckle
 
-Behaviour driven framework for testing vim scripts written in Riml.
+Behaviour driven development framework for testing Vim plugins written in [Riml][1].
 
 [![Build Status](https://travis-ci.org/dsawardekar/speckle.png)](https://travis-ci.org/dsawardekar/speckle)
 
+### About Riml
+For people unfamiliar with `Riml`. [Riml][1] is a programming language that compiles to Vimscript. It's constructs are very similar to languages like `Ruby` and `Coffeescript`. It also provides a layer of abstraction to write OOP code that is converted to Vimscript's Funcref prototype chains.
+
+### How Speckle works
+Speckle uses `Riml`s object-oriented constructs to provide
+a BDD testing framework for Riml. You can use it for both unit testing and functional testing. Using Riml and Speckle you can write Vim plugins using common OOP software idioms and have the same familar tools available in your development workflow.
+
+Speckle is both a test compiler and test execution engine. It does compilation of the `_spec.riml` specs with [Riml][1] and runs them in a Vim instance, capturing assertions, stacktraces and errors and reports them back after
+closing the launched vim instance.
+
+[1]:https://github.com/luke-gru/riml
+
 ## Installation
 
     $ gem install speckle
 
-## Usage
+## Basic Usage
+
+Here's an example using Speckle.
+
+```ruby
+riml_include 'dsl.riml'
+
+class MyFirstSpec
+  defm describe
+    return 'My First Spec'
+  end
+
+  defm it_can_check_equality_of_strings
+    my_string = 'v' . 'i' . 'm'
+    expect(my_string).to_equal(vim)
+  end
+end
+```
+
+A test example is a `Riml` class with a test method that begins with `it`. You can optionally provide a `describe` method to change the displayed name for test in the reporter output.
+
+Note the `riml_include dsl.riml`. This include provides Speckle's `expect` dsl for use inside the test examples. The path to this include is autoconfigured by Speckle. For including your own classes specify the path like `-I lib`. Where lib is the directory containing your Vim plugin .riml files.
+
+Speckle looks for tests in the `spec` folder by default. The tests should be named in the form `{name}_spec.riml`. The above example could be saved as
+`spec/my_first_spec.riml`. To run this test use,
+
+    $ speckle
+
+If the test succeeded you will get a message like,
+
+```log
+✓ 1 tests completed (5ms)
+Passed: 1, Failures: 0, Errors: 0, Assertions: 1
+```
+
+If you change the input string to only `vi` and run it again you will
+see a message like,
+
+```log
+EqualityMatcher #it can check equality of strings
+    AssertionError: expected “vi” to equal “vim”
+
+
+✖ 1 tests completed (5ms)
+Passed: 0, Failures: 1, Errors: 0, Assertions: 0
+```
+
+## Matchers
+
+### Equivalence
+
+```ruby
+expect(actual).to_equal(expected)  # passes if actual == expected
+expect(actual).to_not_equal(expected) # passes if actual != expected
+```
+
+Note: A type mismatch will be thrown when comparing values with
+different types.
+
+### Comparisons
+
+```ruby
+expect(actual).to_be_gt(expected) # -ve to_not_be_gt
+expect(actual).to_be_gte(expected) # -ve to_not_be_gte
+expect(actual).to_be_lte(expected) # -ve to_not_be_lte
+expect(actual).to_be_lt(expected) # -ve to_not_be_lt
+expect(actual).to_be_within([delta, expected]) # -ve to_not_be_within
+expect(actual).to_be_between([min, max]) # -ve to_not_be_between
+```
+
+### Regular expressions
+
+```ruby
+expect(actual).to_match(pattern) # -ve to_not_match
+```
+
+### Boolean
+
+```ruby
+expect(actual).to_be_true(expected) # -ve to_be_false
+expect(actual).to_be_ok(expected) # -ve to_not_be_ok
+```
+
+### Existance
+
+```ruby
+expect(actual).to_exist()  # passes if exists(actual) is not false
+expect(actual).to_not_exist() # -ve
+```
+
+### Dictionary
+```ruby
+expect(actual).to_have_key(expected) # passes if actual is a dict with key expected
+expect(actual).to_not_have_key(expected) # -ve
+```
+### Length
+
+```ruby
+expect(actual).to_have_length(expected)  # passes if len(actual) == expected
+expect(actual).to_not_have_length(expected) # -ve
+```
+
+## Custom Matchers
+
+In addition to the above default matchers you can create custom
+matchers easily.
+
+Consider a Person class in Riml.
+
+```ruby
+class Person
+  def initialize(name)
+    self.name = name
+  end
+
+  defm get_name()
+    return self.name
+  end
+end
+```
+
+To write matcher to check if a person has the correct name we can
+write a `PersonNameMatcher`. The class must implement the methods, `match`, `failure_message_for_match` and `failure_message_for_mismatch` as shown below.
+
+```ruby
+class PersonNameMatcher
+  defm match(expected, actual)
+    self.result = actual.get_name()
+    return self.result == expected
+  end
+
+  defm failure_message_for_match(expected, actual)
+    return "expected person name to be “#{expected}” but was “#{self.result}”"
+  end
+
+  defm failure_message_for_mismatch(expected, actual)
+    return "expected person name to not be “#{expected}” but was “#{self.result}”"
+  end
+end
+
+```
+
+Then inside your spec you need to register this matcher using `define_matcher`,
+
+```ruby
+matcher = new PersonNameMatcher()
+define_matcher('to_have_name', 'to_not_have_name', matcher)
+```
+
+Now in a test you can use the custom matcher methods, `to_have_name`, and it's negative `to_not_have_name`.
+
+```ruby
+defm it_can_check_for_persons_name
+  expect(self.person).to_have_name('john')
+end
+
+defm it_can_check_for_negation_of_persons_name
+  expect(self.person).to_not_have_name('foo')
+end
+```
+
+## Hooks
+
+Speckle supports `before`, `before_each`, `after` and `after_each` hooks
+that will be run before/after the entire suite or before/after every test.
+
+```ruby
+defm before
+end
+
+defm before_each
+end
+
+defm after
+end
+
+defm after_each
+end
+```
+
+## Logging (alternate to echomsg)
+
+Speckle provides a logger that captures output messages without
+halting execution of tests. This allows development of vim plugins
+without needing to use `echomsg` extensively.
+
+The logger api is,
+
+```
+get_logger().log(msg, ...)
+get_logger().info(msg, ...)
+get_logger().warn(msg, ...)
+get_logger().error(msg, ...)
+get_logger().debug(msg, ...)
+```
+
+When running the tests the error messages are shown inline like below.
+
+```log
+LoggerSpec
+  ✓ it logs a message
+
+      log: Hello World
+      log: A test warning
+      log: An error warning
+
+```
+
+## Stacktraces
+
+Another useful feature of Speckle is it displays stacktraces in a
+meaningful form to help with debugging.
+
+The example below has a call to an undefined function.
+
+```ruby
+defm it_has_unknown_function
+  CallFooFunction()
+end
+```
+
+When this test is run the following stacktrace will be shown.
+
+```ruby
+VariousErrorsSpec #it has unknown function
+    Vim(call):E117: Unknown function: <SNR>144_CallFooFunction
+       at <SNR>143_s:Speckle_run
+       at <SNR>143_s:Runner_start
+       at <SNR>143_s:SpecRunner_start
+       at <SNR>144_s:VariousErrorsSpec_it_has_unknown_function, line 2
+```
+
+## Isolated Testing
+
+Speckle can be made to run only specific tests using the `--grep` option. For example, to only run tests in the `spec/models` folder use
+
+        $ speckle --grep spec/models
+
+Further to only run specific tests we can tag the test with a keyword, and then use `--tag keyword` to run only those tests. Tagging is done by adding a `_tagname` suffix to the test method name. For example to tag a spec with the tag `perf`, you would use,
+
+```ruby
+defm it_will_work_perf
+end
+```
+
+And run the test with,
+
+        $ speckle --tag perf
+
+Both these flags can be combined to limit the tests run.
+
+## Complete Usage
 
     $ speckle [options] [file(s) OR directory]
     -a, --all                        Compile and run tests (default)
@@ -20,7 +283,7 @@ Options:
     -I, --libs <libs>                Specify additional riml library path(s)
     -g, --grep <pattern>             Only run tests matching the pattern
     -i, --invert                     Inverts --grep matches
-    -r, --reporter <reporter>        Specify the reporter to use (spec, min, dot, tap)
+    -r, --reporter <reporter>        Specify the reporter to use (spec, min, dot, tap, fivemat)
     -b, --bail                       Bail on first test failure
     -w, --watch                      Watch tests for changes
     -m, --vim <vim>                  Vim program used to test, default(vim)
@@ -34,8 +297,10 @@ Options:
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1. Speckle uses [git flow](https://github.com/nvie/gitflow) based branching model.
+2. Pull requests should go against the `develop` branch.
+3. Try to include failing tests if possible.
+
+## License
+
+MIT License. Copyright (c) 2013 Darshan Sawardekar.

data/lib/runners/runner.riml

@@ -25,6 +25,7 @@ class Runner
 
   defm add(spec)
     add(self.specs, spec)
+    return spec
   end
 
   defm start(reporter, stats)

data/lib/runners/spec_runner.riml

@@ -23,7 +23,13 @@ class SpecRunner
   defm start(reporter, stats)
     spec = self.spec
     did_fail = false
-    context = self.call_hook('describe')
+    if has_key(spec, 'describe')
+      context = self.call_hook('describe')
+    elseif has_key(spec, 'spec_name')
+      context = spec.spec_name
+    else
+      context = 'Unknown Spec'
+    end
     reporter.on_context_start(context, stats)
 
     try

data/lib/speckle/cli/environment.rb

@@ -4,6 +4,7 @@ module Speckle
 
     require 'optparse'
     require 'ostruct'
+    require 'find'
 
     class Environment
       include Loader
@@ -94,7 +95,7 @@ module Speckle
           opts.on('-v', '--verbose', 'Display verbose output') do
             options.verbose = true
           end
-          
+
           opts.on('-D', '--debug', 'Display debug output') do
             options.verbose = true
             options.debug = true
@@ -140,14 +141,30 @@ module Speckle
           options.action = :show_parser_error
         end
 
+        if action_needs_args?(options.action) and options.libs.nil?
+          options.libs = build_riml_path(['lib', 'spec'])
+        end
+
         options
       end
 
       def action_needs_args?(action)
         [:compile_and_test, :compile, :test].include? action
       end
-    end
 
+      def build_riml_path(dirs, pattern = /.*\.riml$/, spec_pattern = /.*_spec\.riml$/)
+        libs = []
+        dirs.each do |dir|
+          Find.find(dir) do |path|
+            if path =~ pattern && path !~ spec_pattern
+              libs << File.dirname(path)
+            end
+          end
+        end
+
+        libs.uniq.join(':')
+      end
+    end
 
   end
 end

data/lib/speckle/version.rb

@@ -1,3 +1,3 @@
 module Speckle
-  VERSION = "0.1.18"
+  VERSION = "0.1.19"
 end

data/lib/speckle.riml

@@ -120,7 +120,7 @@ class g:Speckle
   defm get_bail
     return g:speckle_bail
   end
-  
+
   defm get_tag
     return g:speckle_tag
   end
@@ -156,7 +156,12 @@ class g:Speckle
     map(classes, "substitute(v:val, 'function ', '', '')")
 
     for klass in classes
-      eval("a:runner.add(#{klass})")
+      klass_instance = eval("a:runner.add(#{klass})")
+      res = matchlist(klass, '\v%(\<SNR\>\d+_)?(.*)SpecConstructor\(\)$')
+      if len(res) >= 2
+        spec_name = res[1]
+        klass_instance.spec_name = spec_name
+      end
     end
   end
 end

data/spec/before_hooks_spec.riml

@@ -35,4 +35,3 @@ class BeforeEachHookSpec
     expect(self.stuff).to_equal('foo')
   end
 end
-

data/spec/with_describe_spec.riml

@@ -0,0 +1,7 @@
+riml_include 'dsl.riml'
+
+class MySpecWithoutDescribeSpec
+  defm it_will_work_too
+    expect(true).to_be_true()
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speckle
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - Darshan Sawardekar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riml
@@ -186,6 +186,7 @@ files:
 - spec/speckle_mode_spec.riml
 - spec/stacktrace_spec.riml
 - spec/tagged_spec.riml
+- spec/with_describe_spec.riml
 - spec_errors/hook_errors_spec.riml
 - spec_errors/various_errors_spec.riml
 - speckle.gemspec
@@ -241,3 +242,4 @@ test_files:
 - spec/speckle_mode_spec.riml
 - spec/stacktrace_spec.riml
 - spec/tagged_spec.riml
+- spec/with_describe_spec.riml