insist 0.0.1

data/.batcave/manifest

@@ -0,0 +1,5 @@
+---
+things:
+  ruby:
+    args:
+    - insist

data/.gitignore

@@ -0,0 +1,2 @@
+.yardoc
+coverage

data/Gemfile

@@ -0,0 +1 @@
+source :rubygems

data/Makefile

@@ -0,0 +1,46 @@
+GEMSPEC=$(shell ls *.gemspec)
+VERSION=$(shell awk -F\" '/spec.version/ { print $$2 }' $(GEMSPEC))
+NAME=$(shell awk -F\" '/spec.name/ { print $$2 }' $(GEMSPEC))
+GEM=$(NAME)-$(VERSION).gem
+
+.PHONY: test
+test:
+	sh notify-failure.sh ruby test/all.rb
+
+.PHONY: testloop
+testloop:
+	while true; do \
+		$(MAKE) test; \
+		$(MAKE) wait-for-changes; \
+	done
+
+.PHONY: serve-coverage
+serve-coverage:
+	cd coverage; python -mSimpleHTTPServer
+
+.PHONY: wait-for-changes
+wait-for-changes:
+	-inotifywait --exclude '\.swp' -e modify $$(find $(DIRS) -name '*.rb'; find $(DIRS) -type d)
+
+.PHONY: package
+package: | $(GEM)
+
+.PHONY: gem
+gem: $(GEM)
+
+$(GEM):
+	gem build $(GEMSPEC)
+
+.PHONY: test-package
+test-package: $(GEM)
+	# Sometimes 'gem build' makes a faulty gem.
+	gem unpack $(GEM)
+	rm -rf ftw-$(VERSION)/
+
+.PHONY: publish
+publish: test-package
+	gem push $(GEM)
+
+.PHONY: install
+install: $(GEM)
+	gem install $(GEM)

data/insist.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  files = %x{git ls-files}.split("\n")
+
+  spec.name = "insist"
+  spec.version = "0.0.1"
+  spec.summary = "insist"
+  spec.description = "insist"
+  spec.license = "none chosen yet"
+
+  # Note: You should set the version explicitly.
+  spec.add_dependency "cabin", ">0" # for logging. apache 2 license
+  spec.files = files
+  spec.require_paths << "lib"
+  spec.bindir = "bin"
+
+  spec.authors = ["Jordan Sissel"]
+  spec.email = ["jls@semicomplete.com"]
+  #spec.homepage = "..."
+end
+

data/lib/insist.rb

@@ -0,0 +1,53 @@
+require "insist/namespace"
+
+require "insist/assert"
+require "insist/comparators"
+require "insist/raises"
+require "insist/failure"
+require "insist/nil"
+
+# Insist on correctness.
+#
+#
+# Example:
+#
+#     data = { "hello" => "world" }
+#     insist { data["hello"] } == "world"
+#
+# This class aims to work similarly to how rspec's "should" stuff does, but
+# instead of molesting Object allows you to neatly wrap values with blocks
+# while still checking for expected values.
+class Insist
+  class Failure < StandardError; end
+
+  include Insist::Comparators
+  include Insist::Nil
+  include Insist::Assert
+  include Insist::Raises
+
+  # Create a new insist with a block.
+  #
+  # Example:
+  #
+  #   Insist.new { value }
+  #
+  # Better:
+  #
+  #   insist { value }
+  def initialize(&block)
+    @callback = block
+  end
+
+  def value
+    # TODO(sissel): make caching the value optional
+    @value ||= @callback.call
+    return @value
+  end
+end # class Insist
+
+module Kernel
+  # A shortcut to 'Insist.new'
+  def insist(&block)
+    return Insist.new(&block)
+  end
+end

data/lib/insist/assert.rb

@@ -0,0 +1,10 @@
+
+module Insist::Assert
+  # Assert something is true.
+  #
+  # This will raise Insist::Failure with the given message if the 'truthy'
+  # value is false.
+  def assert(truthy, message)
+    raise Insist::Failure.new(message) if !truthy
+  end # def assert
+end # module Insist::Assert

data/lib/insist/comparators.rb

@@ -0,0 +1,45 @@
+
+# Provides the '==' assertion method.
+#
+# Example:
+#
+#     insist { "foo" } == "foo"
+module Insist::Comparators
+  include Insist::Assert
+
+  # value == expected
+  def ==(expected)
+    assert(value == expected,
+           "Expected #{expected.inspect}, but got #{value.inspect}")
+  end # def ==
+
+  # value <= expected
+  def <=(expected)
+    assert(value <= expected,
+           "Expected #{value.inspect} <= #{expected.inspect}")
+  end # def <=
+ 
+  # value >= expected
+  def >=(expected)
+    assert(value >= expected,
+           "Expected #{value.inspect} >= #{expected.inspect}")
+  end # def >=
+
+  # value > expected
+  def >(expected)
+    assert(value > expected,
+           "Expected #{value.inspect} > #{expected.inspect}")
+  end # def >
+
+  # value < expected
+  def <(expected)
+    assert(value < expected,
+           "Expected #{value.inspect} < #{expected.inspect}")
+  end # def <
+ 
+  # value != expected
+  def !=(expected)
+    assert(value != expected,
+           "Expected #{value.inspect} != #{expected.inspect}")
+  end # def !=
+end # module Insist::Comparators

data/lib/insist/failure.rb

@@ -0,0 +1,4 @@
+# A failure. This is raised if an `insist` check fails.
+class Insist::Failure < StandardError
+  # Nothing here.
+end

data/lib/insist/namespace.rb

@@ -0,0 +1 @@
+class Insist; end

data/lib/insist/nil.rb

@@ -0,0 +1,7 @@
+
+module Insist::Nil
+  # Assert nil
+  def nil?
+    assert(value.nil?,  "Expected nil, got #{@value.inspect}")
+  end # def nil?
+end # module Insist::Nil

data/lib/insist/raises.rb

@@ -0,0 +1,14 @@
+
+module Insist::Raises
+  # Assert raises
+  def raises(exception_class)
+    begin
+      value
+    rescue exception_class => e
+      return # We're OK
+    end
+
+    assert(false, 
+           "Expected exception '#{exception_class}' but none was raised")
+  end # def raises
+end # module Insist::Raises

data/notify-failure.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+"$@"
+status=$?
+
+if [ ! -z "$TMUX" ] ; then
+  if [ "$status" -ne 0 ] ; then
+    tmux display-message "Tests Fail"
+  else
+    tmux display-message "Tests OK"
+  fi
+fi
+
+exit $status
+

data/spec/insist/comparators_spec.rb

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

data/spec/insist/nil_spec.rb

@@ -0,0 +1,16 @@
+require "spec_setup"
+require "insist"
+
+describe Insist::Nil do
+  describe "#nil?" do
+    it "should be OK if the #value is nil" do
+      insist { nil }.nil?
+    end
+
+    it "should fail if the #value is not nil" do
+      insist do
+        insist { "not nil" }.nil?
+      end.raises(Insist::Failure)
+    end
+  end
+end

data/spec/insist_spec.rb

@@ -0,0 +1,14 @@
+require "spec_setup"
+require "insist"
+
+describe Insist do
+  subject do
+    Insist.new { "Hello world" }
+  end
+
+  describe "#value" do
+    it "should return the block value" do
+      insist { subject.value } == "Hello world"
+    end
+  end
+end

data/spec/spec_setup.rb

@@ -0,0 +1 @@
+$: << File.join(File.dirname(File.dirname(__FILE__)), "lib")

data/test/all.rb

@@ -0,0 +1,24 @@
+require "rubygems"
+require "minitest/spec"
+require "minitest/autorun"
+
+# Get coverage report
+require "simplecov"
+SimpleCov.start
+
+# Add '../lib' to the require path.
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+def use(path)
+  puts "Loading tests from #{path}"
+  require File.expand_path(path)
+end
+
+dirname = File.dirname(__FILE__)
+use File.join(dirname, "docs.rb")
+
+# Load tests from ./*/**/*.rb (usually ./libraryname/....)
+glob = File.join(dirname, "*", "**", "*.rb")
+Dir.glob(glob).each do |path|
+  use path
+end

data/test/docs.rb

@@ -0,0 +1,40 @@
+require "rubygems"                                                                                               
+require "yard"                                                                                                   
+require File.join(File.expand_path(File.dirname(__FILE__)), "testing")
+
+describe "documentation tests" do
+  before do
+    # Use YARD to parse all ruby files found in '../lib'
+    libdir = File.join(File.dirname(__FILE__), "..", "lib")
+    YARD::Registry.load(Dir.glob(File.join(libdir, "**", "*.rb")))
+    @registry = YARD::Registry.all
+  end
+
+  test "All classes, methods, modules, and constants must be documented" do
+    # Note, the 'find the undocumented things' code here is 
+    # copied mostly from: YARD 0.7.5's lib/yard/cli/stats.rb
+    #
+    # Find all undocumented classes, modules, and constants
+    undocumented = @registry.select do |o| 
+      [:class, :module, :constant].include?(o.type) && o.docstring.blank?
+    end
+
+    # Find all undocumented methods
+    methods = @registry.select { |m| m.type == :method }
+    methods.reject! { |m| m.is_alias? || !m.is_explicit? }
+    undocumented += methods.select do |m| 
+      m.docstring.blank? && !m.overridden_method
+    end
+
+    if (undocumented.length > 0)
+      message = ["The following are not documented"]
+      undocumented.each do |o|
+        message << "* #{o.type.to_s} #{o.to_s} <#{o.file}:#{o.line}>"
+      end
+
+      flunk(message.join("\n"))
+    else
+      pass
+    end
+  end
+end

data/test/testing.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "minitest/spec"
+
+# Add '../lib' to the require path.
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+# I don't really like monkeypatching, but whatever, this is probably better
+# than overriding the 'describe' method.
+class MiniTest::Spec
+  class << self
+    # 'it' sounds wrong, call it 'test'
+    alias :test :it
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: insist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jordan Sissel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cabin
+  requirement: &13980620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *13980620
+description: insist
+email:
+- jls@semicomplete.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .batcave/manifest
+- .gitignore
+- Gemfile
+- Makefile
+- README
+- insist.gemspec
+- lib/insist.rb
+- lib/insist/assert.rb
+- lib/insist/comparators.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/nil_spec.rb
+- spec/insist_spec.rb
+- spec/spec_setup.rb
+- test/all.rb
+- test/docs.rb
+- test/testing.rb
+homepage: 
+licenses:
+- none chosen yet
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: insist
+test_files: []
+has_rdoc: