insist 0.0.1 → 0.0.2

data/Gemfile

@@ -1 +1,7 @@
 source :rubygems
+
+gemspec
+
+group :development do
+  gem "rspec", "~> 2.8.0"
+end

data/Makefile

@@ -44,3 +44,7 @@ publish: test-package
 .PHONY: install
 install: $(GEM)
 	gem install $(GEM)
+
+.PHONY: clean
+clean:
+	-rm -rf .yardoc $(GEM)

data/README.md

@@ -0,0 +1,56 @@
+# insist { on readable assertions }
+
+I like rspec, but I don't like the '#should' junk. It scratches me the wrong
+way, I guess. I find this to be an unreadable mess:
+
+    # yuck, if you ask me.
+    somevalue.should eq(0)
+
+On the flip side, I really like the idea (make tests read like english).
+
+So instead of slapping '#should' on all objects and doing weird stuff like
+`expect { block }.to raise_error(thing)`, I just use blocks for everything in a
+kind of lazy-evaluation wrapping:
+
+    # Check equality
+    insist { value } == 30
+
+    # Insist an exception is raised
+    insist { code }.raises(exception_class)
+
+Reads well, I think.
+
+## Most minimal assertions possible
+
+Using rspec's 'subject' stuff, you can write tests that are perhaps even more minimal while still being clear.
+
+Here's an example test that fails. The subject is an 'insist' object, so you
+can just do the usual '==' and other methods on it:
+
+    describe "thing" do
+      subject { insist { "whoa!" } }
+
+      it "should be, like, awesome!"
+        subject == "awesome!"
+      end
+    end
+
+Running it:
+
+    Failures:
+
+      1) thing should be, like, awesome!
+         Failure/Error: subject == "awesome!"
+         Insist::Failure:
+           Expected "awesome!", but got "whoa!"
+         # ./lib/insist/assert.rb:8:in `assert'
+         # ./lib/insist/comparators.rb:12:in `=='
+         # ./test.rb:5:in `block (2 levels) in <top (required)>'
+
+    Finished in 0.00208 seconds
+    1 example, 1 failure
+
+    Failed examples:
+
+    rspec ./test.rb:4 # thing should be, like, awesome!
+

data/insist.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |spec|
   files = %x{git ls-files}.split("\n")
 
   spec.name = "insist"
-  spec.version = "0.0.1"
+  spec.version = "0.0.2"
   spec.summary = "insist"
   spec.description = "insist"
   spec.license = "none chosen yet"

data/lib/insist.rb

@@ -2,6 +2,7 @@ require "insist/namespace"
 
 require "insist/assert"
 require "insist/comparators"
+require "insist/enumerables"
 require "insist/raises"
 require "insist/failure"
 require "insist/nil"
@@ -21,6 +22,7 @@ class Insist
   class Failure < StandardError; end
 
   include Insist::Comparators
+  include Insist::Enumerables
   include Insist::Nil
   include Insist::Assert
   include Insist::Raises

data/lib/insist/enumerables.rb

@@ -0,0 +1,14 @@
+
+# Provides assertions for enumerable-ish methods
+#
+# Example:
+#
+#     insist { "foo" } == "foo"
+module Insist::Enumerables
+  include Insist::Assert
+
+  def include?(item)
+    assert(value.include?(item),
+           "Expected #{item.inspect} in #{value.inspect}")
+  end
+end

data/lib/insist/raises.rb

@@ -11,4 +11,9 @@ module Insist::Raises
     assert(false, 
            "Expected exception '#{exception_class}' but none was raised")
   end # def raises
+
+  # Asserts a failure
+  def fails
+    raises(Insist::Failure)
+  end # def fails
 end # module Insist::Raises

data/spec/insist/comparators_spec.rb

@@ -12,7 +12,7 @@ describe Insist::Comparators do
     end
 
     it "should fail if the #value is not equal" do
-      insist { subject == 0 }.raises(Insist::Failure)
+      insist { subject == 0 }.fails
     end
   end
 
@@ -22,21 +22,61 @@ describe Insist::Comparators do
       subject <= larger
     end
 
+    it "should be OK if the #value is equal" do
+      subject >= subject.value
+    end
+
     it "should fail if the #value is greater" do
       smaller = subject.value - 1
-      insist { subject <= smaller }.raises(Insist::Failure)
+      insist { subject <= smaller }.fails
     end
   end
 
   describe "#>=" do
-    it "should be OK if the #value is greater than or equal" do
+    it "should be OK if the #value is greater than" do
       smaller = subject.value - 1
       subject >= smaller
     end
 
+    it "should be OK if the #value is equal" do
+      subject >= subject.value
+    end
+
+    it "should fail if the #value is lesser" do
+      larger = subject.value + 1
+      insist { subject >= larger }.fails
+    end
+  end
+
+  describe "#<" do
+    it "should be OK if the #value is less than" do
+      larger = subject.value + 1
+      subject < larger
+    end
+
+    it "should fail if the #value is equal" do
+      insist { subject < subject.value }.fails
+    end
+
+    it "should fail if the #value is greater" do
+      smaller = subject.value - 1
+      insist { subject < smaller }.fails
+    end
+  end
+
+  describe "#>" do
+    it "should be OK if the #value is greater than" do
+      smaller = subject.value - 1
+      subject > smaller
+    end
+
+    it "should fail if the #value is equal" do
+      insist { subject > subject.value }.fails
+    end
+
     it "should fail if the #value is lesser" do
       larger = subject.value + 1
-      insist { subject >= larger }.raises(Insist::Failure)
+      insist { subject > larger }.fails
     end
   end
 end

data/spec/insist/enumerables_spec.rb

@@ -0,0 +1,18 @@
+require "spec_setup"
+require "insist"
+
+describe Insist::Enumerables do
+  subject do
+    Insist.new { [1,2,3] }
+  end
+
+  describe "#include?" do
+    it "should be OK if the #value includes an item" do
+      subject.include?(2)
+    end
+
+    it "should fail if the #value does not include an item" do
+      insist { subject.include?(4) }.fails
+    end
+  end
+end

data/spec/insist/nil_spec.rb

@@ -10,7 +10,7 @@ describe Insist::Nil do
     it "should fail if the #value is not nil" do
       insist do
         insist { "not nil" }.nil?
-      end.raises(Insist::Failure)
+      end.fails
     end
   end
 end

data/test/docs.rb

@@ -11,6 +11,8 @@ describe "documentation tests" do
   end
 
   test "All classes, methods, modules, and constants must be documented" do
+    # YARD's parser works best in ruby 1.9.x, so skip 1.8.x
+    skip if RUBY_VERSION < "1.9.2"
     # Note, the 'find the undocumented things' code here is 
     # copied mostly from: YARD 0.7.5's lib/yard/cli/stats.rb
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: insist
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-08 00:00:00.000000000 Z
+date: 2012-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cabin
-  requirement: &13980620 !ruby/object:Gem::Requirement
+  requirement: &18578060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13980620
+  version_requirements: *18578060
 description: insist
 email:
 - jls@semicomplete.com
@@ -33,17 +33,19 @@ files:
 - .gitignore
 - Gemfile
 - Makefile
-- README
+- README.md
 - insist.gemspec
 - lib/insist.rb
 - lib/insist/assert.rb
 - lib/insist/comparators.rb
+- lib/insist/enumerables.rb
 - lib/insist/failure.rb
 - lib/insist/namespace.rb
 - lib/insist/nil.rb
 - lib/insist/raises.rb
 - notify-failure.sh
 - spec/insist/comparators_spec.rb
+- spec/insist/enumerables_spec.rb
 - spec/insist/nil_spec.rb
 - spec/insist_spec.rb
 - spec/spec_setup.rb
@@ -72,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: insist