djsun-context 0.5.5

data/History.txt

@@ -0,0 +1,10 @@
+== 0.0.3 2008-10-05
+
+* 1 minor enhancement:
+  * Fiddled with the way contexts are defined; makes the object model make more sense and the code cleaner
+  
+== 0.0.1 2008-10-02
+
+* 1 major enhancement:
+  * Initial release
+  * Contexts, lifecycle, and test methods

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jeremy McAnally
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,29 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+config/hoe.rb
+config/requirements.rb
+context.gemspec
+countloc.rb
+lib/context.rb
+lib/context/context.rb
+lib/context/core_ext/rails_hacks.rb
+lib/context/core_ext/string.rb
+lib/context/lifecycle.rb
+lib/context/shared_behavior.rb
+lib/context/suite.rb
+lib/context/test.rb
+lib/context/version.rb
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+test/test_context.rb
+test/test_core_ext.rb
+test/test_helper.rb
+test/test_lifecycle.rb
+test/test_nested_lifecycle.rb
+test/test_shared.rb
+test/test_test.rb

data/README.rdoc

@@ -0,0 +1,158 @@
+= context – The testing library you've been looking for
+
+http://github.com/jeremymcanally/context
+
+== DESCRIPTION:
+
+If you've ever wanted contexts in your Test::Unit tests, then context is for you.  Your tests will be easier to read and write without all the magic and extra code smell!
+
+== FEATURES/PROBLEMS:
+
+* Add contexts to Test::Unit tests
+* Small DSL for specifying tests that are pretty
+* Ability to chain context lifecycle methods (coming soon)
+
+== SYNOPSIS:
+
+* Add contexts using familiar syntax:
+
+      class UserTest < Test::Unit::TestCase
+        context "A new User" do
+          # Before/after lifecycle blocks
+          before do
+            @user = User.first
+          end
+
+          # Specify tests using DSL
+          test "should have the right full_name" do
+            assert_equal "Dude Man", @user.full_name
+          end
+    
+          test "should be able to set parts of the name" do
+            @user.first_name = "Mad"
+            @user.last_name = "Max"
+            @user.save
+            assert_equal "Mad Max", @user.full_name
+          end
+
+          after do
+            @user.first_name = "Dude"
+            @user.last_name = "Man"
+            @user.save!
+          end
+        end
+      end
+
+* It also has aliases that match other library's syntaxes (all of which can be mixed and matched):
+
+      class UserTest < Test::Unit::TestCase
+        context "A new Account" do
+          test "should be new" do
+            Account.new.new_record?
+          end
+        end
+        
+        # RSpec-esque
+        describe "A new User" do
+          it "should do things" do
+            User.first.do_things!
+          end
+        end
+  
+        # Shoulda-esque
+        context "Another User" do
+          should "do things that are fun" do
+            User.first.do_things!(:fun)
+          end
+        end
+      end
+    
+* Contexts can also be nested:
+
+    class UserTest < Test::Unit::TestCase
+      context "A new User" do
+        context "with clown shoes" do
+          test "should squeak" do
+            assert_true User.find_by_shoes("clown").squeak?
+          end
+        end
+      
+        context "without clown shoes" do
+          test "should not squeak" do
+            assert_false User.find_by_shoes("dressy").squeak?
+          end
+        end
+      end
+    end
+
+* You can also share behavior among contexts:
+
+    class UserTest < Test::Unit::TestCase
+      shared "shared things" do
+        test "things are shared" do
+          # test logic here...
+        end
+      end
+      
+      context "the first thing" do
+        uses "shared things"
+        
+        test "other things..." do
+          # More testing...
+        end
+      end
+    end
+
+* Shared behaviors can also use RSpec syntax
+
+    class UserTest < Test::Unit::TestCase
+      share_examples_for "shared things" do
+        it "things are shared" do
+          # test logic here...
+        end
+      end
+  
+      describe "the first thing" do
+        it_should_behave_like "shared things"
+    
+        it "other things..." do
+          # More testing...
+        end
+      end
+    end
+
+== REQUIREMENTS:
+
+* Test::Unit (you have it; trust me)
+
+== INSTALL:
+    
+    $ gem sources -a http://gems.github.com
+    $ sudo gem install jeremymcanally-context
+
+== LICENSE:
+
+Copyright (c) 2008 Jeremy McAnally
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+== ACKNOWLEDGEMENTS:
+
+Original implementation by myself, but heavily tweaked and borrowed from Rails Core and Pratik Naik.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'context/version'
+
+AUTHOR = 'Jeremy McAnally'  # can also be an array of Authors
+EMAIL = "jeremy@entp.com"
+DESCRIPTION = "Contexts and DSL sugar for your tests"
+GEM_NAME = 'context' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'context' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+#  ['activesupport', '>= 1.3.1']
+]    # An array of rubygem dependencies [name, version]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Context::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'context documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README.rdoc",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/context.gemspec

@@ -0,0 +1,44 @@
+Gem::Specification.new do |s|
+  s.name     = "context"
+  s.version  = "0.5.5"
+  s.date     = "2008-10-03"
+  s.summary  = "Contexts and DSL sugar for your tests"
+  s.email    = "jeremy@entp.com"
+  s.homepage = "http://github.com/jeremymcanally/context"
+  s.description = "If you've ever wanted contexts in your Test::Unit tests, then context is for you.  Your tests will be easier to read and write without all the magic and extra code smell!"
+  s.has_rdoc = true
+  s.authors  = ["Jeremy McAnally"]
+  s.files    = [
+  	"README.rdoc", 
+  	"Rakefile", 
+  	"context.gemspec", 
+    "History.txt",
+    "License.txt",
+    "Manifest.txt",
+    "PostInstall.txt",
+    "config/hoe.rb",
+    "config/requirements.rb",
+    "lib/context.rb",
+    "lib/context/version.rb",
+    "lib/context/lifecycle.rb",
+    "lib/context/suite.rb",
+    "lib/context/context.rb",
+    "lib/context/shared_behavior.rb",
+    "lib/context/test.rb",
+    "lib/context/version.rb",
+    "lib/context/core_ext/string.rb",
+    "lib/context/core_ext/rails_hacks.rb",
+    "setup.rb"
+  ]
+  
+  s.test_files = [
+    "test/test_context.rb",
+    "test/test_core_ext.rb",
+    "test/test_lifecycle.rb",
+    "test/test_test.rb",
+    "test/test_helper.rb"
+  ]
+
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
+end

data/lib/context/context.rb

@@ -0,0 +1,64 @@
+module Context
+  module Context
+    # Test::Unit uses ObjectSpace to figure out what Test::Unit:TestCase instances are running
+    # Contexts are not named and therefore sometimes get garbage collected.
+    # Think of #context_list as the shelter for nameless contexts
+    attr_accessor :context_list
+
+    def context_name #:nodoc:
+      @context_name ||= ""
+      if superclass.respond_to?(:context_name)
+        return "#{superclass.context_name} #{@context_name}".gsub(/^\s+/, "")
+      end
+    end
+
+    def context_name=(val) #:nodoc:
+      @context_name = val
+    end
+
+    # Add a context to a set of tests.
+    # 
+    #   context "A new account" do
+    #     it "should not have users"
+    #       assert Account.new.users.empty?
+    #     end
+    #   end
+    # 
+    # The context name is prepended to the test name, so failures look like this:
+    # 
+    #   1) Failure:
+    #   test_a_new_account_should_not_have_users() [./test/test_accounts.rb:4]:
+    #   <false> is not true.
+    # 
+    # Contexts can also be nested like so:
+    # 
+    #   context "A new account" do
+    #     context "created by the web application" do
+    #       it "should have web as its vendor" do
+    #         assert_equal "web", users(:web_user).vendor
+    #       end
+    #     end
+    #   end
+    # 
+    # Since contexts create a singleton instance of a class, each one must have its own before/after blocks.  This
+    # will be tweaked in future releases to allow you to chain these blocks from its parent contexts.
+    #
+    def context(name, &block)
+      cls = Class.new(self)
+      cls.context_name = name
+      # puts "Creating context #{cls.context_name}"
+      
+      # Care about Rails tests in nested contexts
+      cls.tests($1.constantize) if defined?(Rails) && 
+        self.name =~ /^(.*(Controller|Helper|Mailer))Test/ && 
+          self < ActiveSupport::TestCase
+
+      cls.class_eval(&block)
+      (self.context_list ||= []) << cls
+      const_set("Test#{name.to_class_name}#{cls.object_id.abs}", cls)
+      cls
+    end
+
+    %w(contexts describe describes group specify specifies).each {|m| alias_method m, :context}
+  end
+end

data/lib/context/core_ext/rails_hacks.rb

@@ -0,0 +1,10 @@
+class Test::Unit::TestCase
+  class << self
+    def setup_for_shoulda
+      self.instance_eval do
+        alias :setup :before
+        alias :teardown :after
+      end
+    end
+  end
+end

data/lib/context/core_ext/string.rb

@@ -0,0 +1,17 @@
+class String
+  # Replaces spaces and tabs with _ so we can use the string as a method name
+  # Also replace dangerous punctuation
+  def to_method_name
+    self.downcase.gsub(/[\s:',\.~;!#=\(\)&]+/,'_')
+  end
+  
+  # Borrowed from +camelize+ in ActiveSupport
+  def to_module_name
+    self.to_method_name.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+  
+  # Borrowed from +camelize+ in ActiveSupport
+  def to_class_name
+    self.to_method_name.gsub(/\/(.?)/) { "#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+  end
+end

data/lib/context/lifecycle.rb

@@ -0,0 +1,103 @@
+class Test::Unit::TestCase
+  class << self
+    attr_accessor :before_each_callbacks, :before_all_callbacks, :after_each_callbacks, :after_all_callbacks, :before_should_callbacks
+
+    # Add logic to run before the tests (i.e., a +setup+ method)
+    #
+    #     before do
+    #       @user = User.first
+    #     end
+    # 
+    def before(period = :each, &block)
+      unless block_given?
+        block  = period
+        period = :each
+      end
+
+      send("before_#{period}_callbacks") << block
+    end
+    
+    alias :setup :before
+    
+    # Add logic to run after the tests (i.e., a +teardown+ method)
+    #
+    #     after do
+    #       User.delete_all
+    #     end
+    #
+    def after(period = :each, &block)
+      unless block_given?
+        block  = period
+        period = :each
+      end
+
+      send("after_#{period}_callbacks") << block
+    end
+    
+    alias :teardown :after
+
+    def gather_callbacks(callback_type, period) # :nodoc:
+      callbacks = superclass.respond_to?(:gather_callbacks) ? superclass.gather_callbacks(callback_type, period) : []
+      callbacks.push(*send("#{callback_type}_#{period}_callbacks"))
+    end
+  end
+
+  self.before_all_callbacks    = []
+  self.before_each_callbacks   = []
+  self.after_each_callbacks    = []
+  self.after_all_callbacks     = []
+  self.before_should_callbacks = {}
+
+  def self.inherited(child) # :nodoc:
+    super
+    child.before_all_callbacks    = []
+    child.before_each_callbacks   = []
+    child.after_each_callbacks    = []
+    child.after_all_callbacks     = []
+    child.before_should_callbacks = {}
+
+    child.class_eval do
+      def setup(&block)
+        super
+        
+        unless self.class.before_should_callbacks[method_name].nil?
+          instance_eval(&self.class.before_should_callbacks[method_name])
+        end
+
+        run_each_callbacks :before
+      end
+
+      def teardown
+        super
+
+        run_each_callbacks :after
+      end
+    end if self == Test::Unit::TestCase
+  end
+
+  def run_each_callbacks(callback_type) # :nodoc:
+    self.class.gather_callbacks(callback_type, :each).each do |c| 
+      c.is_a?(Proc) ? instance_eval(&c) : send(c)
+    end
+  end
+
+  def run_all_callbacks(callback_type) # :nodoc:
+    previous_ivars = instance_variables
+    self.class.gather_callbacks(callback_type, :all).each { |c| instance_eval(&c) if c }
+    (instance_variables - previous_ivars).inject({}) do |hash, ivar|
+      hash.update ivar => instance_variable_get(ivar)
+    end
+  rescue Object => exception
+    raise <<-BANG
+  Error running the #{callback_type}(:all) callback for #{name}
+  #{exception.class.name}: #{exception.message}
+  #{exception.backtrace.join("\n")}
+    BANG
+  end
+
+  def set_values_from_callbacks(values) # :nodoc:
+    values.each do |name, value|
+      instance_variable_set name, value
+    end
+  end
+end

data/lib/context/shared_behavior.rb

@@ -0,0 +1,97 @@
+module Context
+  class SharedBehavior < Module
+    def self.create_from_behavior(beh) # :nodoc:
+      mod = self.new
+      mod._behavior = beh
+      mod
+    end
+  
+    def _behavior=(beh) # :nodoc:
+      @_behavior = beh
+    end
+  
+    def included(including_module) # :nodoc:
+      including_module.class_eval(&@_behavior)
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  class << self
+    # Share behavior among different contexts.  This creates a module (actually, a Module subclass)
+    # that is included using the +use+ method (or one of its aliases) provided by context or +include+ 
+    # if you know the module's constant name.
+    #
+    # ==== Examples
+    #   
+    #   shared "other things" do
+    #     it "should do things but not some things" do
+    #       # behavior is fun
+    #     end
+    #   end
+    #
+    #   use "other things"
+    #   # or...
+    #   it_should_behave_like "other things"
+    #
+    #   shared :client do
+    #     it "should be a client to our server" do
+    #       # TODO: client behavior here
+    #     end
+    #   end
+    #
+    #   use :client
+    #   # or...
+    #   uses "client"
+    #   behaves_like "client"
+    #
+    def shared(name, &block)
+      case name.class.name
+      when "String"
+        name = name.to_module_name
+      when "Symbol"
+        name = name.to_s.to_module_name
+      else
+        raise ArgumentError, "Provide a String or Symbol as the name of the shared behavior group"
+      end
+      
+      Object.const_set(name, Context::SharedBehavior.create_from_behavior(block))
+    end
+    
+    %w(shared_behavior share_as share_behavior_as shared_examples_for).each {|m| alias_method m, :shared}
+    
+    # Pull in behavior shared by +shared+ or a module.  
+    #
+    # ==== Examples
+    #   
+    #   shared "other things" do
+    #     it "should do things but not some things" do
+    #       # behavior is fun
+    #     end
+    #   end
+    #
+    #   use "other things"
+    #   # or...
+    #   it_should_behave_like "other things"
+    #
+    #   module Things
+    #   end
+    #
+    #   uses Things
+    #
+    def use(shared_name)
+      case shared_name.class.name
+      when "Context::SharedBehavior", "Module"
+        include shared_name
+      when "String"
+        include Object.const_get(shared_name.to_module_name)
+      when "Symbol"
+        include Object.const_get(shared_name.to_s.to_module_name)
+      else
+        raise ArgumentError, "Provide a String or Symbol as the name of the shared behavior group or the module name"
+      end
+    end
+    
+    %w(uses it_should_behave_like behaves_like uses_examples_from).each {|m| alias_method m, :use}
+  end
+end