hot_or_not 0.1.11 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.11
+0.2.0

data/bin/hot_or_not

@@ -4,9 +4,33 @@ require 'rubygems'
 require File.dirname(__FILE__) + '/../lib/hot_or_not'
 require 'optparse'
 
+def constantize(camel_cased_word)
+  names = camel_cased_word.split('::')
+  names.shift if names.empty? || names.first.empty?
+
+  constant = Object
+  names.each do |name|
+    constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+  end
+  constant
+end
+
+def get_announcer(announcer)
+  klass = constantize(announcer) rescue nil
+  return klass unless klass.nil?
+  begin
+    constantize("HotOrNot::#{announcer}Announcer")
+  rescue NameError
+    puts "Announcer #{announcer} cannot be found"
+    exit 1
+  end
+end
+
 defaults = {
   :output_directory => 'test_results',
-  :test_names       => :all
+  :test_names       => :all,
+  :announcer        => 'TestUnit',
+  :requires         => []
 }
 
 options = {}
@@ -16,6 +40,15 @@ parser = ::OptionParser.new do |opts|
     options[:output_directory] = d
   end 
 
+  opts.on("--announcer [ANNOUNCER]", "Announcer to use for output results (full constant if not in HotOrNot). DEFAULT: #{defaults[:announcer]}") do |a|
+    options[:announcer] = a
+  end
+
+  opts.on("-r", "--require [FILE]", "Require an additional file.") do |file|
+    options[:requires] ||= []
+    options[:requires] << file
+  end
+
   opts.on('-n', '--name [NAMES]', "Test names to run. DEFAULT: all") do |test_names|
     options[:test_names] = test_names.split(',')
   end
@@ -51,5 +84,7 @@ end
 suite_name = File.basename(yaml_file).gsub('.yml', '').gsub('.erb', '')
 output_dir = File.join options[:output_directory], suite_name
 
-announcer = HotOrNot::ConsoleAnnouncer.new output_dir
+options[:requires].each { |file| require file }
+
+announcer = get_announcer(options[:announcer]).new output_dir
 HotOrNot::Runner.run_from(yaml_file, announcer).run! options[:test_names]

data/lib/hot_or_not/announcers/inline_announcer.rb

@@ -0,0 +1,56 @@
+module HotOrNot
+  class InlineAnnouncer
+    include Announcer
+
+    def initialize(output_dir)
+      @output_dir = output_dir
+      @counts = Hash.new(0)
+      @start = nil
+    end
+
+    def starting
+      puts "Starting to compare the bodies"
+      @start = Time.now
+    end
+
+    def ending
+      completion_time = Time.now - @start
+      total = @counts.values.reduce(:+)
+      puts
+      puts "Finished in %.6f seconds." % [completion_time]
+      puts
+      puts "#{total} body comparisons, #{@counts[:success]} hot bodies, #{@counts[:failure]} not-hot bodies, #{@counts[:error]} errored bodies"
+    end
+
+    def announce_success(result)
+      @counts[:success] += 1
+      say 'Hot', result
+    end
+
+    def announce_failure(result)
+      @counts[:failure] += 1
+      say 'Not Hot', result
+      result.output_to_files_in results_dir
+    end
+
+    def announce_error(result)
+      @counts[:error] += 1
+      say 'Error', result
+      result.output_to_files_in results_dir
+    end
+
+    private
+    def say(what, result)
+      what += ':'
+      puts "%-10s #{result.full_name}" % [what]
+    end
+
+    def results_dir
+      @results_dir ||= @output_dir.tap do |dir| 
+        FileUtils.rm_rf dir
+        FileUtils.mkdir_p dir
+      end
+    end
+
+  end
+end

data/lib/hot_or_not/announcers/{console_announcer.rb → test_unit_announcer.rb}

@@ -1,5 +1,5 @@
 module HotOrNot
-  class ConsoleAnnouncer
+  class TestUnitAnnouncer
     include Announcer
 
     def initialize(output_dir)
@@ -23,7 +23,7 @@ module HotOrNot
         counts[status] += 1
       end
 
-      puts "Finsihed in %.6f seconds." % [completion_time]
+      puts "Finished in %.6f seconds." % [completion_time]
       puts
       puts "#{@results.count} body comparisons, #{counts[:success]} hot bodies, #{counts[:failure]} not-hot bodies, #{counts[:error]} errored bodies"
     end

data/lib/hot_or_not/compare_url.rb

@@ -27,7 +27,7 @@ module HotOrNot
     def self.load_from(filename)
       contents = YAML.load(run_erb(filename)).symbolize_keys!
       side_a, side_b, comparisons = contents.delete(:side_a), contents.delete(:side_b), contents.delete(:comparisons)
-      raise "You're file is not of the proper format" unless side_a && side_b && comparisons
+      raise "Your file is not in the proper format" unless side_a && side_b && comparisons
       comparisons.map do |h|
         h.symbolize_keys!
         name = h.delete :name

data/lib/hot_or_not/comparison_result.rb

@@ -11,7 +11,7 @@ module HotOrNot
     end
 
     attr_reader :message
-    def_delegators :@compare_url, :short_name
+    def_delegators :@compare_url, :short_name, :full_name
 
     def initialize(compare_url, side_a_results, side_b_results)
       @compare_url, @side_a_results, @side_b_results = compare_url, side_a_results, side_b_results
@@ -47,9 +47,14 @@ module HotOrNot
     end
 
     def output_to_files_in(directory)
-      write_to directory, "side_a", side_a_body
-      write_to directory, "side_b", side_b_body
-      write_to directory, "diff", diff
+      return if success?
+      if error?
+        write_to directory, "error", message
+      else
+        write_to directory, "side_a", side_a_body
+        write_to directory, "side_b", side_b_body
+        write_to directory, "diff", diff
+      end
     end
 
     private

data/test/announcers/inline_announcer_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+module HotOrNot
+  class InlineAnnouncerTest < AnnouncerTestCase
+    context "run" do
+      setup do
+        intercept_io
+        output_dir = 'test_results'
+        @announcer = InlineAnnouncer.new output_dir
+      end
+
+      teardown do
+        reset_io
+      end
+
+      context "the inline console output" do
+        should "print Hot and testname for passing test" do
+          urls = [mock_compare_url('Passing Test', '/api/foo', 'foo', 'foo')]
+          Runner.new(urls, @announcer).run!
+
+          expected_output = /^Hot:\s+Passing Test$/
+          assert_match expected_output, test_output[1].chomp
+        end
+
+        should "print Not Hot and testname for failing test" do
+          urls = [mock_compare_url('Failing Test', '/api/foo', 'foo', 'bar')]
+          Runner.new(urls, @announcer).run!
+
+          expected_output = /^Not Hot:\s+Failing Test$/
+          assert_match expected_output, test_output[1].chomp
+        end
+
+        should "print Error and testname for test that causes error" do
+          urls = [mock_compare_url('Error test', '/api/foo', 'foo', 'bar', 404)]
+          Runner.new(urls, @announcer).run!
+
+          assert_match /^Error:\s+Error test$/, test_output[1].chomp
+        end
+      end
+    end
+  end
+end

data/test/announcers/test_unit_announcer_test.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+module HotOrNot
+  class TestUnitAnnouncerTest < AnnouncerTestCase
+    context "run" do
+      setup do
+        intercept_io
+        output_dir = 'test_results'
+        @announcer = TestUnitAnnouncer.new output_dir
+      end
+
+      teardown do
+        reset_io
+      end
+
+      context "the console output" do
+        should "print '.' for passing test" do
+          urls = [mock_compare_url('Foo', '/api/foo', 'foo', 'foo')]
+          Runner.new(urls, @announcer).run!
+
+          assert_equal '.', test_output[1].chomp
+        end
+
+        should "print 'N' for a failing test" do
+          urls = [mock_compare_url('Foo', '/api/foo', 'foo', 'bar')]
+          Runner.new(urls, @announcer).run!
+
+          assert_equal 'N', test_output[1].chomp
+          assert_equal '  1) Not Hot:', test_output[2].chomp
+        end
+
+        should "print 'E' for a test that errors out" do
+          urls = [mock_compare_url('Foo', '/api/foo', 'foo', 'bar', 404)]
+          Runner.new(urls, @announcer).run!
+
+          assert_equal 'E', test_output[1].chomp
+        end
+      end
+
+    end
+  end
+end

data/test/test_helper.rb

@@ -58,3 +58,32 @@ class Test::Unit::TestCase
     [response, error]
   end
 end
+
+module HotOrNot
+  class AnnouncerTestCase < Test::Unit::TestCase
+    private
+    def intercept_io
+      @output_filename = 'test_runner_tests.txt'
+      @output_file = File.open(@output_filename, 'w+')
+      @orig_stdout = STDOUT.dup
+      STDOUT.reopen(@output_file)
+    end
+
+    def reset_io
+      @output_file.close
+      @test_output = nil
+      FileUtils.rm_f @output_filename if leave_last_ouput?
+      STDOUT.reopen @orig_stdout
+    end
+
+    def leave_last_ouput?
+      ENV['HORN_io'].to_s.downcase != 'false'
+    end
+    
+    def test_output
+      @test_output ||= (
+        STDOUT.flush
+        File.readlines(@output_file) )
+    end
+  end
+end

metadata

@@ -1,187 +1,136 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hot_or_not
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 11
-  version: 0.1.11
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Joel Friedman
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-26 00:00:00 -05:00
-default_executable: hot_or_not
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70199395090880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 6
-        - 1
+      - !ruby/object:Gem::Version
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70199395090880
+- !ruby/object:Gem::Dependency
   name: diffy
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70199395089640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 0
-        - 3
+      - !ruby/object:Gem::Version
         version: 2.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70199395089640
+- !ruby/object:Gem::Dependency
   name: facets
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70199395088200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 41
-        segments: 
-        - 2
-        - 9
-        - 1
+      - !ruby/object:Gem::Version
         version: 2.9.1
   type: :runtime
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70199395088200
+- !ruby/object:Gem::Dependency
   name: json
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &70199395085280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 5
-        - 2
+      - !ruby/object:Gem::Version
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70199395085280
+- !ruby/object:Gem::Dependency
   name: hpricot
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70199395083640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 55
-        segments: 
-        - 0
-        - 8
-        - 4
+      - !ruby/object:Gem::Version
         version: 0.8.4
   type: :runtime
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70199395083640
+- !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &70199395082420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70199395082420
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &70199395080480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70199395080480
+- !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &70199395078960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 6
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.6.0
   type: :development
   prerelease: false
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70199395078960
+- !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &70199395077620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70199395077620
+- !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &70199395074400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id010
-description: Run this with a new version of your site comparing to current version to verify no break changes are made to your api's
+  version_requirements: *70199395074400
+description: Run this with a new version of your site comparing to current version
+  to verify no break changes are made to your api's
 email: asher.friedman@gmail.com
-executables: 
+executables:
 - hot_or_not
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - .document
 - Gemfile
 - Gemfile.lock
@@ -192,53 +141,48 @@ files:
 - bin/hot_or_not
 - lib/hot_or_not.rb
 - lib/hot_or_not/announcer.rb
-- lib/hot_or_not/announcers/console_announcer.rb
+- lib/hot_or_not/announcers/inline_announcer.rb
+- lib/hot_or_not/announcers/test_unit_announcer.rb
 - lib/hot_or_not/compare_url.rb
 - lib/hot_or_not/comparison_result.rb
 - lib/hot_or_not/ext/hash.rb
 - lib/hot_or_not/runner.rb
 - lib/hot_or_not/url_result.rb
+- test/announcers/inline_announcer_test.rb
+- test/announcers/test_unit_announcer_test.rb
 - test/compare_url_test.rb
 - test/comparison_result_test.rb
-- test/console_announcer_test.rb
 - test/data/simple_urls.yml
 - test/data/simple_urls.yml.erb
 - test/runner_test.rb
 - test/test_helper.rb
 - test/url_result_test.rb
-has_rdoc: true
 homepage: https://github.com/joelash/hot_or_not
-licenses: 
+licenses:
 - MIT
 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 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -1646296402133696515
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A tool for side-by-side comparsion of web apis
 test_files: []
-

data/test/console_announcer_test.rb

@@ -1,67 +0,0 @@
-require File.expand_path(File.dirname(__FILE__)) + '/test_helper'
-
-module HotOrNot
-  class ConsoleAnnouncerTest < Test::Unit::TestCase
-    context "run" do
-      setup do
-        intercept_io
-        output_dir = 'test_results'
-        @announcer = ConsoleAnnouncer.new output_dir
-      end
-
-      teardown do
-        reset_io
-      end
-
-      context "the console output" do
-        should "print '.' for passing test" do
-          urls = [mock_compare_url('Foo', '/api/foo', 'foo', 'foo')]
-          Runner.new(urls, @announcer).run!
-
-          assert_equal '.', test_output[1].chomp
-        end
-
-        should "print 'N' for a failing test" do
-          urls = [mock_compare_url('Foo', '/api/foo', 'foo', 'bar')]
-          Runner.new(urls, @announcer).run!
-
-          output = test_output
-          assert_equal 'N', output[1].chomp
-          assert_equal '  1) Not Hot:', output[2].chomp
-        end
-
-        should "print 'E' for a test that errors out" do
-          urls = [mock_compare_url('Foo', '/api/foo', 'foo', 'bar', 404)]
-          Runner.new(urls, @announcer).run!
-
-          o = test_output
-          assert_equal 'E', o[1].chomp
-        end
-      end
-
-    end
-    
-    private
-    def intercept_io
-      @output_filename = 'test_runner_tests.txt'
-      @output_file = File.open(@output_filename, 'w+')
-      @orig_stdout = STDOUT.dup
-      STDOUT.reopen(@output_file)
-    end
-
-    def reset_io
-      @output_file.close
-      FileUtils.rm_f @output_filename if leave_last_ouput?
-      STDOUT.reopen @orig_stdout
-    end
-
-    def leave_last_ouput?
-      ENV['HORN_io'].to_s.downcase != 'false'
-    end
-    
-    def test_output
-      STDOUT.flush
-      File.readlines(@output_file)
-    end
-  end
-end