spex 0.5.1 → 0.5.2

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/lib/spex/assertion.rb

@@ -25,6 +25,14 @@ module Spex
       Assertion.registry[name.to_sym] = self
     end
 
+    def self.example(description, text)
+      examples << [description, text]
+    end
+
+    def self.examples
+      @examples ||= []
+    end
+
     def self.options
       @options ||= {}
     end

data/lib/spex/assertions/changed_group_assertion.rb

@@ -6,6 +6,13 @@ module Spex
     option :to, "To group name or gid"
     option :from, "From group name or gid"
     
+    example "Changed the file group", "assert '/tmp/foo', :changed_group => true"
+    example "Did not change the file group", "assert '/tmp/foo', :changed_group => false"
+    example "Changed the file group from 'wheel' to 'www-users'", "assert '/tmp/foo', :changed_group => {:from => 'wheel', :to => 'www-users'}"
+    example "Changed the file group from gid 210 to gid 288", "assert '/tmp/foo', :changed_group => {:from => 210, :to => 288}"
+    example "Changed the file group to 'users'", "assert '/tmp/foo', :changed_group => {:to => 'users'}"
+    example "Changed the file group to gid 203", "assert '/tmp/foo', :changed_group => {:to => 203}"
+    
     def before
       assert File.exist?(target), "File does not exist at #{target}"
       if from_groupname

data/lib/spex/assertions/changed_mode_assertion.rb

@@ -3,6 +3,11 @@ module Spex
     as :changed_mode, "file mode change"
     option :from, "Mode changed from (octal, eg 0600)"
     option :to, "Mode changed to (octal, eg 0700)"
+    
+    example "Changed the file mode", "assert '/tmp/foo', :changed_mode => true"
+    example "Did not change the file mode", "assert '/tmp/foo', :changed_mode => false"
+    example "Changed the file mode from 0666 to 0755", "assert '/tmp/foo', :changed_mode => {:from => 0666, :to => 0755}"
+    example "Changed the file mode to 0750", "assert '/tmp/foo', :changed_mode => {:to => 0750}"
 
     def before
       assert File.exist?(target), "File does not exist at #{target}"

data/lib/spex/assertions/changed_owner_assertion.rb

@@ -5,6 +5,13 @@ module Spex
     as :changed_owner, 'file owner change'
     option :from, "From username or uid"
     option :to, "To username or uid"
+
+    example "Changed the file owner", "assert '/tmp/foo', :changed_owner => true"
+    example "Did not change the file owner", "assert '/tmp/foo', :changed_owner => false"
+    example "Changed the file owner from 'root' to 'bruce'", "assert '/tmp/foo', :changed_owner => {:from => 'root', :to => 'bruce'}"
+    example "Changed the file owner from uid 501 to uid 503", "assert '/tmp/foo', :changed_owner => {:from => 501, :to => 503}"
+    example "Changed the file owner to 'jim'", "assert '/tmp/foo', :changed_owner => {:to => 'jim'}"
+    example "Changed the file owner to uid 506", "assert '/tmp/foo', :changed_owner => {:to => 506}"
     
     def before
       assert File.exist?(target), "File does not exist at #{target}"

data/lib/spex/assertions/created_assertion.rb

@@ -2,6 +2,10 @@ module Spex
   class CreatedAssertion < FileAssertion
     as :created, 'file creation'
     option :type, "Type ('file' or 'directory'), optional"
+    example "File was created", "assert '/tmp/foo', :created => true"
+    example "File was not created", "assert '/tmp/foo', :created => false"
+    example "Regular file was created", "assert '/tmp/foo', :created => {:type => 'file'}"
+    example "Directory was created", "assert '/tmp/foo', :created => {:type => 'directory'}"    
 
     def before
       assert !File.exist?(target), "File already exists at #{target}"

data/lib/spex/assertions/modified_assertion.rb

@@ -9,6 +9,12 @@ module Spex
     as :modified, 'file modification'
     option :added, "Added content (string or regexp)"
     option :removed, "Removed content (string or regexp)"
+    example "Modified a file", "assert '/tmp/foo', :modified => true"
+    example "Did not modify a file", "assert '/tmp/foo', :modified => false"
+    example "Added a line with 'a substring' in it", "assert '/tmp/foo', :modified => {:added => 'a substring'}"
+    example "Added a line matching /a substring pattern/", "assert '/tmp/foo', :modified => {:added => /a substring pattern/}"
+    example "Removed a line with 'a substring' in it", "assert '/tmp/foo', :modified => {:removed => 'a substring'}"
+    example "Removed a line matching /a substring pattern/", "assert '/tmp/foo', :modified => {:removed => /a substring pattern/}"
 
     def prepare
       track_checksum!

data/lib/spex/assertions/removed_assertion.rb

@@ -1,9 +1,12 @@
 module Spex
-  class RemovesFileAssertion < FileAssertion
-    as :removes, 'file removal'
-    option :mode, "Mode, in octal (eg: 0600), optional"
+  class RemovedAssertion < FileAssertion
+    as :removed, 'file removal'
     option :type, "Type (:file or :directory), optional"
-
+    example "File was removed", "assert '/tmp/foo', :removed => true"
+    example "File was not removed", "assert '/tmp/foo', :removed => false"
+    example "Regular file was removed", "assert '/tmp/foo', :removed => {:type => 'file'}"
+    example "Directory was removed", "assert '/tmp/foo', :removed => {:type => 'directory'}"    
+    
     def before
       assert File.exist?(target), "File does not exist at #{target}"
       check_type

data/lib/spex/cli.rb

@@ -14,7 +14,7 @@ module Spex
     
     def parser
       @parser ||= OptionParser.new do |opts|
-        opts.banner = 'spex DEFINITION_FILE [OPTIONS]'
+        opts.banner = "spex [OPTIONS] DEFINITION_FILE"
         opts.separator "\nOPTIONS:"
         opts.on_tail('--help', '-h', 'Show this message') do
           puts opts
@@ -23,6 +23,10 @@ module Spex
         opts.on('--describe', '-d', 'Describe DEFINITION_FILE') do
           options.describe = true
         end
+        opts.on('--assertions', '-a', "List supported assertions") do
+          display_assertions
+          exit
+        end
       end
     end
 
@@ -49,6 +53,30 @@ module Spex
       end
     end
 
+    def display_assertions
+      Assertion.registry.each_value do |klass|
+        line = "Assertion: :#{klass.name} (#{klass.description})"
+        puts line
+        if klass.options.any? || klass.examples.any?
+          puts('=' * line.size)
+        end
+        if klass.options.any?
+          puts "\nOptions\n-------\n\n"
+          klass.options.each do |key, value|
+            puts "*  :#{key}, #{value.description}"
+          end
+        end
+        if klass.examples.any?
+          puts "\nExamples\n--------\n\n"
+          klass.examples.each do |description, example|
+            puts "#{description}:"
+            puts "\n    #{example}\n\n"
+          end
+        end
+        puts
+      end
+    end
+
     def describe(script)
       script.scenarios.each do |scenario|
         puts %(In scenario "#{scenario.name}")

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Bruce Williams