stringup 0.2.0 → 0.3.0

data/README.markdown

@@ -1,24 +1,23 @@
 Stringup
 ========
 
-Quick and dirty test harness for executables, testing assertions
-before and after it is run.
+A quick and dirty test harness for testing assertions before and after
+an executable is run.
 
 Synopsis
 --------
 
-Run stringup with:
+Stringup is a simple language used to define scenarios that model
+the correct behavior of an executable.
 
-    $ stringup execute /path/to/stringup/scenarios/description.rb
-
-The description file consists of exactle one `command` line and any
+The description file consists of exactly one `command` line and any
 number of `scenario` definitions; for example, the following file can
 be used to verify running `touch /tmp/foo` will create a new file:
 
     command 'touch /tmp/foo'
 
     scenario :new, "Creates a file" do
-      assert_creates '/tmp/foo'
+      assert_creates_file '/tmp/foo'
     end
 
 If this was in `scenarios.rb`, you could run this with stringup:
@@ -29,7 +28,7 @@ If you had named the scenario `default`, the `--scenario` option
 wouldn't have been necessary, ie:
 
     scenario :default "Creates a file" do
-      assert_creates '/tmp/foo'
+      assert_creates_file '/tmp/foo'
     end
 
     $ stringup execute scenarios.rb
@@ -78,6 +77,11 @@ eg:
 
     $ stringup help execute
 
+Examples
+--------
+
+See the `examples/` directory.
+
 Assertions
 ----------
 
@@ -92,14 +96,14 @@ Note: If you put your assertions in `~/.stringup/assertions/*.rb`,
 they'll automatically be loaded.  If you create any interesting
 assertions, make sure you let me know!
 
-### assert_creates
+### assert_creates_file
 
 Checks to see if a file was created.
 
 You can pass `:file => true` or `:directory => true` to ensure the
 file is a regular file or directory.
 
-### assert_removes
+### assert_removes_file
 
 Checks to see if a file was removed.
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/examples/puppet/scenarios.rb

@@ -1,5 +1,5 @@
 command 'puppet %s'
 
 scenario :creation, "Creates a file" do
-  assert_creates '/tmp/foo'
+  assert_creates_file '/tmp/foo'
 end

data/examples/touch/scenarios.rb

@@ -1,5 +1,5 @@
 command 'touch /tmp/foo'
 
 scenario :creation, "Creates a file" do
-  assert_creates '/tmp/foo'
+  assert_creates_file '/tmp/foo'
 end

data/lib/stringup/assertions/{file_creates_assertion.rb → creates_file_assertion.rb}

@@ -1,6 +1,6 @@
 module Stringup
-  class FileCreatesAssertion < FileAssertion
-    assertion :creates
+  class CreatesFileAssertion < FileAssertion
+    assertion :creates_file
 
     def before(test_case)
       test_case.assert !File.exist?(@path), "File already exists at #{@path}"

data/lib/stringup/assertions/{file_removes_assertion.rb → removes_file_assertion.rb}

@@ -1,6 +1,6 @@
 module Stringup
-  class FileRemovesAssertion < FileAssertion
-    assertion :removes
+  class RemovesFileAssertion < FileAssertion
+    assertion :removes_file
 
     def after(test_case)
       test_case.assert !File.exist?(@path), "File still exists at #{@path}"

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Bruce Williams
@@ -65,9 +65,9 @@ files:
 - examples/touch/scenarios.rb
 - lib/stringup.rb
 - lib/stringup/assertion.rb
+- lib/stringup/assertions/creates_file_assertion.rb
 - lib/stringup/assertions/file_assertion.rb
-- lib/stringup/assertions/file_creates_assertion.rb
-- lib/stringup/assertions/file_removes_assertion.rb
+- lib/stringup/assertions/removes_file_assertion.rb
 - lib/stringup/cli.rb
 - lib/stringup/runner.rb
 - lib/stringup/scenario.rb