clean_test 0.10.0 → 0.10.1

data/.gitignore

@@ -4,3 +4,4 @@ Gemfile.lock
 pkg/*
 coverage
 html
+.*.sw?

data/README.rdoc

@@ -14,8 +14,6 @@ The main problems this library solves are:
 * Understanding what elements of a test are relevant to the test, and which are arbitrary placeholders
 * Removing the requirement that your tests are method names
 
-<b>Note: this gem is still called <tt>test_unit-given</tt> in RubyGems; I'm in the middle of changing the name</b>
-
 == Install
 
     gem install clean_test

data/lib/clean_test/any.rb

@@ -1,7 +1,7 @@
 require 'faker'
 
-module Clean # :nodoc:
-  module Test # :nodoc:
+module Clean #:nodoc:
+  module Test #:nodoc:
     # Public: Provides the ability to vend arbitrary values without using literals, or
     # long calls to Faker.  This has two levels of utility:
     #
@@ -46,7 +46,7 @@ module Clean # :nodoc:
     #       }
     #     }
     module Any
-      MAX_RAND = 50000 # :nodoc:
+      MAX_RAND = 50000 #:nodoc:
 
       # Public: Get any number; one that doesn't matter
       #
@@ -62,11 +62,11 @@ module Clean # :nodoc:
         any :int,options
       end
 
-      # Public: Get an arbitrary string of any potential length (the real max is 2048 characters if you don't override it)
+      # Public: Get an arbitrary string of any potential positive length
       #
       # options - options to control the returned string:
-      #           :max - the max size of the string you want
-      #           :min - the minimum size we want to come back
+      #           :max - the max size of the string you want, must be positive and greater than :min
+      #           :min - the minimum size we want to come back, must be positive and less than :max
       #
       # Example
       #
@@ -77,6 +77,23 @@ module Clean # :nodoc:
         any :string,options
       end
 
+      # Public: Get an arbitrary sentence of arbitrary words of any potential length.  Currently,
+      # this returns a sentence between 10 and 21 words, though you can control that with options
+      #
+      # options - options to control the returned sentence
+      #           :max - the maximum number of words you want returned
+      #           :min - the minimum number of words you want returned; the sentence will be between
+      #                  :min and (:min + 10) words
+      #
+      # Example
+      #
+      #     any_sentence :min => 20  # at least a 20-word sentence
+      #     any_sentence :max => 4   # no more than four words
+      #
+      def any_sentence(options = {})
+        any :sentence,options
+      end
+
       # Public: Get a predefined, arbitrary any.  
       #
       # sym - the any that has been defined already.  By default, the following are defined:
@@ -120,24 +137,36 @@ module Clean # :nodoc:
         @anies ||= default_anies
       end
 
-      ANY_STRING = Proc.new do |options| # :nodoc:
-        max_size = options[:max] || rand(2048)
-        min_size = options[:min] || rand(1024)
-        min_size = max_size if min_size > max_size
+      ANY_STRING = Proc.new do |options| #:nodoc:
+        if options[:min] && options[:max]
+          raise ":min must be less than :max" if options[:min] > options[:max]
+        end
+        if options[:min]
+          raise ":min must be positive" if options[:min] < 1
+        end
 
-        size = rand(max_size)
+        min_size = options[:min]
+        max_size = options[:max]
 
-        size = min_size if size < min_size
+        if min_size.nil? && max_size.nil?
+          min_size = rand(1024) + 1
+          max_size = min_size + rand(1024)
+        elsif min_size.nil?
+          min_size = max_size - rand(max_size)
+          min_size = 1 if min_size < 1
+        else
+          max_size = min_size + rand(min_size) + 1
+        end
 
         string = Faker::Lorem.words(1).join('')
-        while string.length < size
+        while string.length < min_size
           string += Faker::Lorem.words(1).join('') 
         end
 
         string[0..(max_size-1)]
       end
 
-      ANY_NUMBER = Proc.new do |options| # :nodoc:
+      ANY_NUMBER = Proc.new do |options| #:nodoc:
         number = (rand(2 * MAX_RAND) - MAX_RAND).to_f/100.0
         if options.include? :positive
           number + MAX_RAND
@@ -148,7 +177,22 @@ module Clean # :nodoc:
         end
       end
 
-      ANY_INT = Proc.new do |options| # :nodoc:
+      ANY_SENTENCE = Proc.new do |options| #:nodoc:
+        min = 11
+        max = 21
+
+        if options[:max]
+          min = 1
+          max = options[:max]
+        elsif options[:min]
+          min = options[:min]
+          max = min + 10
+        end
+
+        Faker::Lorem.words(rand(max - min) + min).join(' ')
+      end
+
+      ANY_INT = Proc.new do |options| #:nodoc:
         (ANY_NUMBER.call(options)).to_i
       end
 
@@ -161,6 +205,7 @@ module Clean # :nodoc:
           :int => ANY_INT,
           Fixnum => ANY_INT,
           Integer => ANY_INT,
+          :sentence => ANY_SENTENCE,
         }
       end
     end

data/lib/clean_test/given_when_then.rb

@@ -1,5 +1,5 @@
-module Clean # :nodoc:
-  module Test # :nodoc:
+module Clean #:nodoc:
+  module Test #:nodoc:
     # A means of documenting the parts of your test code according
     # to the class "Given/When/Then" system.
     # This does no enforcement of any kind and is merely documentation to make
@@ -160,7 +160,7 @@ module Clean # :nodoc:
         lambda {}
       end
 
-      # Public: Similar to #test_runs, this is used to make clear what
+      # Public: Similar to #the_test_runs, this is used to make clear what
       # you are testing and what the assertions are.  Since many Ruby mock
       # frameworks do not require an explicit "verify" step, you often have tests
       # that have no explicit asserts, the assertions being simply that the mocks were called

data/lib/clean_test/test_case.rb

@@ -3,8 +3,8 @@ require 'clean_test/given_when_then'
 require 'clean_test/any'
 require 'clean_test/test_that'
 
-module Clean # :nodoc:
-  module Test # :nodoc:
+module Clean #:nodoc:
+  module Test #:nodoc:
     # Public: A Base class brings in all modules that are part
     # of Clean::Test.
     #

data/lib/clean_test/test_that.rb

@@ -1,5 +1,5 @@
-module Clean # :nodoc:
-  module Test # :nodoc:
+module Clean #:nodoc:
+  module Test #:nodoc:
     # Public: Module that, when included, makes a class method, +#test_that+ available
     # to create test methods in a more fluent way.  See ClassMethods.
     module TestThat
@@ -48,14 +48,32 @@ module Clean # :nodoc:
           define_method(test_name, &block)
         end
 
+        # Public: Create a test that you don't want to actually run.
+        # This can be handy if you want to temporarily keep a test from
+        # running, but don't want to deal with comments or if (false) blocks.
+        # Tests skipped this way will generate a warning to the standard error.
+        # Arguments are indentical to #test_that
+        def skip_a_test_that(description=nil,&block)
+          description = make_up_name(block) if description.nil?
+          STDERR.puts "warning: test 'test that #{description}' is being skipped" unless $FOR_TESTING_ONLY_SKIP_STDERR
+        end
+
+        # Public: Create a test that is pending or that you intend to implement soon.
+        # This can be handy for sketching out some tests that you want, as this will
+        # print the pending tests to the standard error
+        def someday_test_that(description=nil,&block)
+          description = make_up_name(block) if description.nil?
+          STDERR.puts "warning: test 'test that #{description}' is pending" unless $FOR_TESTING_ONLY_SKIP_STDERR
+        end
+
         private 
 
         def make_up_name(some_proc)
           if some_proc.respond_to? :source_location
             name,location = some_proc.source_location
-            "anonymous test at #{name}, line #{location}"
+            "anonymous test at #{name}, line #{location} passes"
           else
-            "anonymous test for proc #{some_proc.object_id}"
+            "anonymous test for proc #{some_proc.object_id} passes"
           end
         end
       end

data/lib/clean_test/version.rb

@@ -1,5 +1,5 @@
-module Clean # :nodoc:
-  module Test # :nodoc:
-    VERSION = "0.10.0"
+module Clean #:nodoc:
+  module Test #:nodoc:
+    VERSION = "0.10.1"
   end
 end

data/test/test_any.rb

@@ -2,80 +2,110 @@ require 'test/unit'
 require 'clean_test/test_case'
 
 class TestAny < Clean::Test::TestCase
+
+  def setup
+    # Fix the seed to be the same all day so our tests are repeatable
+    srand((Time.now.to_i / (1000 * 60 * 60)))#.tap { |_| puts "seed: #{_}" })
+  end
+
   test_that {
-    Given { random_seeded_for_negative_float }
-    When  { @number = any_number }
-    Then { 
-      assert @number < 0,"any_number should be negative, but we got #{@number}" 
-      assert @number.to_i != @number,"Expected a float"
-    }
-  }
-  test_that {
-    Given { random_seeded_for_positive }
     When  { @number = any_number }
-    Then  { assert @number > 0,"any_number should be positive, but we got #{@number}" }
+    Then  { assert_not_nil @number } 
   }
 
   test_that {
-    Given { random_seeded_for_negative_float }
     When  { @number = any_number :positive }
     Then  { assert @number > 0,"We specified :positive, but got a negative" }
   }
 
   test_that {
-    Given { random_seeded_for_positive }
     When  { @number = any_number :negative }
     Then  { assert @number < 0,"We specified :negative, but got a positive" }
   }
 
   test_that {
-    Given { random_seeded_for_negative_float }
     When  { @number = any_int }
     Then  { 
-      assert @number < 0,"Expected int to be negative"
+      assert_not_nil @number
       assert_equal @number.to_i,@number,"Expected an int, not a #{@number.class}" 
     }
   }
 
   test_that {
-    Given { random_seeded_for_negative_float }
     When  { @int = any_int :positive }
     Then  { assert @int > 0,"We specified :positive, but got a negative" }
   }
 
   test_that {
-    Given { random_seeded_for_positive }
     When  { @int = any_int :negative }
     Then  { assert @int < 0,"We specified :negative, but got a positive" }
   }
 
   test_that {
-    Given { random_seeded_for_long_string }
     When  { @string = any_string }
     Then  { 
-      assert @string.length < 1441,"expected less than our rand value, but got #{@string.length}" 
+      assert_not_nil @string
       assert_equal String,@string.class
     }
   }
 
   test_that {
-    Given { random_seeded_for_long_string }
     When  { @string = any_string :max => 255 }
     Then  { 
-      assert @string.length <= 255,"Expected a string of less than 256 characters, got #{@string.length}" 
       assert_equal String,@string.class
+      assert @string.length <= 255,"Expected a string of less than 256 characters, got #{@string.length}" 
     }
   }
 
   test_that {
-    Given { random_seeded_for_long_string }
     When  { @string = any_string :min => 1000 }
     Then  { 
-      assert @string.length > 1000,"Expected a string of at least 1500 characters, got one of #{@string.length} characters" 
       assert_equal String,@string.class
+      assert @string.length >= 1000,"Expected a string of at least 1000 characters, got one of #{@string.length} characters" 
+    }
+  }
+
+  test_that "min and max must agree" do
+    When {
+      @code = lambda { @string = any_string :min => 10, :max => 3 }
+    }
+    Then {
+      assert_raises(RuntimeError,&@code)
     }
+  end
+
+  [
+    [-10,  1],
+    [  0,  1],
+    [  0,  0],
+    [  0,-10],
+  ].each do |(min,max)|
+    test_that "both min and max must be positive (#{min},#{max})" do
+      When {
+        @code = lambda { @string = any_string :min => min, :max => max }
+      }
+      Then {
+        assert_raises(RuntimeError,&@code)
+      }
+    end
+  end
+
+  test_that {
+    When { @sentence = any_sentence }
+    Then { assert @sentence.split(/\s/).size > 10,@sentence }
+  }
+
+  test_that {
+    When { @sentence = any_sentence :max => 5 }
+    Then { assert @sentence.split(/\s/).size <= 5,@sentence }
+  }
+
+  test_that {
+    When { @sentence = any_sentence :min => 20 }
+    Then { assert @sentence.split(/\s/).size >= 20,@sentence }
   }
 
+
   test_that "we can register custom anys" do 
     Given {
       new_any :foo do
@@ -126,19 +156,4 @@ class TestAny < Clean::Test::TestCase
       }
     end
   end
-
-  private
-
-  def random_seeded_for_long_string
-    Random.srand(34)
-  end
-
-  def random_seeded_for_negative_float
-    Random.srand(45)
-  end
-
-  def random_seeded_for_positive
-    Random.srand(2)
-  end
-
 end

data/test/test_test_that.rb

@@ -3,6 +3,7 @@ require 'clean_test/test_case'
 
 class TestSimpleGiven < Clean::Test::TestCase
 
+
   test_that "when assigning @x to 4, it is 4" do
     Given {
       @x = nil
@@ -27,6 +28,16 @@ class TestSimpleGiven < Clean::Test::TestCase
     }
   }
 
+  $FOR_TESTING_ONLY_SKIP_STDERR = true
+  skip_a_test_that "a skipped test isn't called" do
+    raise "This shouldn't happen!"
+  end
+
+  someday_test_that "a pending test isn't called" do
+    raise "This shouldn't happen, either!"
+  end
+  $FOR_TESTING_ONLY_SKIP_STDERR = false
+
   def test_that_test_that_barfs_with_no_block
     assert_raises RuntimeError do
       self.class.test_that "foo"

metadata

@@ -1,69 +1,89 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: clean_test
-version: !ruby/object:Gem::Version
-  version: 0.10.0
+version: !ruby/object:Gem::Version 
+  hash: 53
   prerelease: 
+  segments: 
+  - 0
+  - 10
+  - 1
+  version: 0.10.1
 platform: ruby
-authors:
+authors: 
 - David Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-18 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-01-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: faker
-  requirement: &70203919977400 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *70203919977400
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rdoc
-  requirement: &70203919976980 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70203919976980
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70203919976560 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70203919976560
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: simplecov
-  requirement: &70203919976140 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70203919976140
-description: You can easily make your plain Ruby Test::Unit test cases clean and clear
-  with Given/When/Then, placeholder values, and textual descriptions without resorting
-  to metaprogramming or complex frameworks.  Use as much or as little as you like
-email:
+  version_requirements: *id004
+description: You can easily make your plain Ruby Test::Unit test cases clean and clear with Given/When/Then, placeholder values, and textual descriptions without resorting to metaprogramming or complex frameworks.  Use as much or as little as you like
+email: 
 - davetron5000@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rvmrc
 - .travis.yml
@@ -82,31 +102,41 @@ files:
 - test/test_circle.rb
 - test/test_simple_given.rb
 - test/test_test_that.rb
-homepage: ''
+has_rdoc: true
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: clean_test
-rubygems_version: 1.8.10
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Clean up your Test::Unit tests
-test_files:
+test_files: 
 - test/bootstrap.rb
 - test/test_any.rb
 - test/test_circle.rb