teaspoon 0.9.1 → 1.0.0

data/lib/teaspoon/exceptions.rb

@@ -1,46 +1,159 @@
 module Teaspoon
-  class Error < Exception; end
-  class EnvironmentNotFound < Teaspoon::Error; end
-  class MissingDependency < Teaspoon::Error; end
-  class ServerException < Teaspoon::Error; end
-  class RunnerException < Teaspoon::Error; end
-  class ExporterException < Teaspoon::Error; end
-  class UnknownFramework < Teaspoon::Error; end
-  class UnknownCoverage < Teaspoon::Error; end
-  class UnknownDriver < Teaspoon::Error; end
-  class UnknownDriverOptions < Teaspoon::Error; end
-  class UnknownFormatter < Teaspoon::Error; end
-  class UnknownSuite < Teaspoon::Error; end
-  class AssetNotServable < Teaspoon::Error; end
-  class Failure < Teaspoon::Error; end
-  class DependencyFailure < Teaspoon::Error; end
-  class ThresholdNotMet < Teaspoon::Error; end
-  class FileNotWritable < Teaspoon::Error; end
-
-  module ExceptionHandling
-    def self.add_rails_handling
-      return unless Teaspoon.configuration.driver == "phantomjs"
-
-      # debugging should be off to display errors in the suite_controller
-      # Rails.application.config.assets.debug = false
-
-      # we want rails to display exceptions
-      Rails.application.config.action_dispatch.show_exceptions = true
-
-      # override the render exception method in ActionDispatch to raise a javascript exception
-      render_exceptions_with_javascript
-    end
-
-    private
-
-    def self.render_exceptions_with_javascript
-      ActionDispatch::DebugExceptions.class_eval do
-        def render_exception(_env, exception)
-          message = "#{exception.class.name}: #{exception.message}"
-          body = "<script>throw Error(#{[message, exception.backtrace].join("\n").inspect})</script>"
-          [200, { "Content-Type" => "text/html;", "Content-Length" => body.bytesize.to_s }, [body]]
-        end
+  class Error < StandardError
+  end
+
+  class Failure < Teaspoon::Error
+  end
+
+  class EnvironmentNotFound < Teaspoon::Error
+    def initialize(msg = nil, searched:)
+      msg ||= "Unable to locate environment; searched in [#{searched}]. Have you run the installer?"
+      super(msg)
+    end
+  end
+
+  # loading / configuration errors
+
+  class UnknownFramework < Teaspoon::Error
+    def initialize(msg = nil, name:, available:)
+      msg ||= "Unknown framework: expected \"#{name}\" to be a registered framework. Available frameworks are #{available}."
+      if available.blank?
+        msg += " Do you need to update your Gemfile to use the teaspoon-#{name} gem? If you are upgrading, please see https://github.com/modeset/teaspoon/blob/master/CHANGELOG.md"
       end
+      super(msg)
+    end
+
+    def available
+    end
+  end
+
+  class UnknownFrameworkVersion < Teaspoon::Error
+    def initialize(msg = nil, name:, version:)
+      msg ||= "Unknown framework version: expected \"#{name}\" to have version #{version}."
+      super(msg)
+    end
+
+    def available
+    end
+  end
+
+  class UnknownDriver < Teaspoon::Error
+    def initialize(msg = nil, name:, available:)
+      msg ||= "Unknown driver: expected \"#{name}\" to be a registered driver. Available drivers are #{available}"
+      super(msg)
+    end
+
+    def available
+    end
+  end
+
+  class UnknownFormatter < Teaspoon::Error
+    def initialize(msg = nil, name:, available:)
+      msg ||= "Unknown formatter: expected \"#{name}\" to be a registered formatter. Available formatters are #{available}"
+      super(msg)
+    end
+
+    def available
+    end
+  end
+
+  class UnspecifiedFramework < Teaspoon::Error
+    def initialize(msg = nil, name:)
+      msg ||= "Missing framework: expected \"#{name}\" suite to configure one using `suite.use_framework`."
+      super(msg)
+    end
+
+    def available
+    end
+  end
+
+  class UnspecifiedDependencies < Teaspoon::Error
+    def initialize(msg = nil, framework:, version:)
+      msg ||= "Missing dependencies: expected framework \"#{framework}\" (#{version}) to specify the `dependencies` option when registering."
+      super(msg)
+    end
+
+    def available
+    end
+  end
+
+  class UnknownSuite < Teaspoon::Error
+    def initialize(msg = nil, name:)
+      msg ||= "Unknown suite configuration: expected \"#{name}\" to be a configured suite."
+      super(msg)
+    end
+
+    def available
+    end
+  end
+
+  class UnknownCoverage < Teaspoon::Error
+    def initialize(msg = nil, name:)
+      msg ||= "Unknown coverage configuration: expected \"#{name}\" to be a configured coverage."
+      super(msg)
+    end
+
+    def available
+    end
+  end
+
+  class NotFoundInRegistry < Teaspoon::Error
+    def initialize(msg = nil, name:, available:)
+      msg ||= "Unknown configuration: expected \"#{name}\" to be registered. Available options are #{available}"
+      super(msg)
+    end
+
+    def available
+    end
+  end
+
+  # general running errors
+
+  class RunnerError < Teaspoon::Error
+  end
+
+  class FileWriteError < Teaspoon::Error
+  end
+
+  class MissingDependencyError < Teaspoon::Error
+    def initialize(msg = nil)
+      msg ||= "Unable to locate a required external dependency."
+      super(msg)
+    end
+  end
+
+  class DependencyError < Teaspoon::Error
+    def initialize(msg = nil)
+      msg ||= "Problem calling out to an external dependency."
+      super(msg)
+    end
+  end
+
+  class ServerError < Teaspoon::Error
+    def initialize(msg = nil, desc: nil)
+      msg ||= "Unable to start teaspoon server; #{desc || 'for an unknown reason'}."
+      super(msg)
+    end
+  end
+
+  class DriverOptionsError < Teaspoon::Error
+    def initialize(msg = nil, types: nil)
+      msg ||= "Malformed driver options#{types ? ": expected a valid #{types}." : '.'}"
+      super(msg)
+    end
+  end
+
+  class AssetNotServableError < Teaspoon::Error
+    def initialize(msg = nil, filename: nil)
+      msg ||= "Unable to serve asset: expected \"#{filename || 'unknown file'}\" to be within a registered asset path."
+      super(msg)
+    end
+  end
+
+  class IstanbulNotFoundError < Teaspoon::Error
+    def initialize(msg = nil)
+      msg ||= "You requested coverage reports, but Teaspoon cannot find the istanbul binary. Run: npm install -g istanbul"
+      super(msg)
     end
   end
 end

data/lib/teaspoon/exporter.rb

@@ -12,7 +12,7 @@ module Teaspoon
       Dir.mktmpdir do |temp_path|
         Dir.chdir(temp_path) do
           %x{#{executable} --convert-links --adjust-extension --page-requisites --span-hosts #{@url.shellescape} 2>&1}
-          raise Teaspoon::ExporterException, "Unable to export #{@suite} suite." unless $?.exitstatus == 0
+          raise Teaspoon::DependencyError.new("Unable to export #{@suite} suite.") unless $?.exitstatus == 0
           create_export(File.join(temp_path, @url.match(/^http:\/\/([^\/]+).*/)[1]))
         end
       end
@@ -24,7 +24,7 @@ module Teaspoon
       return @executable if @executable
       @executable = which("wget")
       return @executable unless @executable.blank?
-      raise Teaspoon::MissingDependency, "Could not find wget for exporting."
+      raise Teaspoon::MissingDependencyError.new("Unable to locate `wget` for exporter.")
     end
 
     def create_export(path)

data/lib/teaspoon/formatter.rb

@@ -0,0 +1,30 @@
+require "teaspoon/registry"
+require "teaspoon/registry/has_default"
+
+module Teaspoon
+  module Formatter
+    extend Teaspoon::Registry
+    extend Teaspoon::Registry::HasDefault
+
+    not_found_in_registry Teaspoon::UnknownFormatter
+  end
+end
+
+# CONTRIBUTORS:
+# If you add a formatter you should do the following before it will be considered for merging.
+# - add it to this list so it can be autoloaded
+# - write specs for it
+# - add it to the readme so it's documented
+
+Teaspoon::Formatter.register(:dot, "Teaspoon::Formatter::Dot", "teaspoon/formatter/dot", description: "dots", default: true)
+Teaspoon::Formatter.register(:clean, "Teaspoon::Formatter::Clean", "teaspoon/formatter/clean", description: "like dots but doesn't log re-run commands")
+Teaspoon::Formatter.register(:documentation, "Teaspoon::Formatter::Documentation", "teaspoon/formatter/documentation", description: "descriptive documentation")
+Teaspoon::Formatter.register(:json, "Teaspoon::Formatter::Json", "teaspoon/formatter/json", description: "json formatter (raw teaspoon)")
+Teaspoon::Formatter.register(:junit, "Teaspoon::Formatter::Junit", "teaspoon/formatter/junit", description: "junit compatible formatter")
+Teaspoon::Formatter.register(:pride, "Teaspoon::Formatter::Pride", "teaspoon/formatter/pride", description: "yay rainbows!")
+Teaspoon::Formatter.register(:rspec_html, "Teaspoon::Formatter::RspecHtml", "teaspoon/formatter/rspec_html", description: "RSpec inspired HTML format")
+Teaspoon::Formatter.register(:snowday, "Teaspoon::Formatter::Snowday", "teaspoon/formatter/snowday", description: "makes you feel all warm inside")
+Teaspoon::Formatter.register(:swayze_or_oprah, "Teaspoon::Formatter::SwayzeOrOprah", "teaspoon/formatter/swayze_or_oprah", description: "quote from either Patrick Swayze or Oprah Winfrey")
+Teaspoon::Formatter.register(:tap, "Teaspoon::Formatter::Tap", "teaspoon/formatter/tap", description: "test anything protocol formatter")
+Teaspoon::Formatter.register(:tap_y, "Teaspoon::Formatter::TapY", "teaspoon/formatter/tap_y", description: "tap_yaml, format used by tapout")
+Teaspoon::Formatter.register(:teamcity, "Teaspoon::Formatter::Teamcity", "teaspoon/formatter/teamcity", description: "teamcity compatible formatter")

data/lib/teaspoon/{formatters → formatter}/base.rb

@@ -1,39 +1,5 @@
-require "set"
-require "teaspoon/formatters/description"
-
 module Teaspoon
-  module Formatters
-    @@known_formatters = SortedSet.new
-
-    def self.known_formatters
-      @@known_formatters
-    end
-
-    def self.register(name, details)
-      description = Description.new(name, details)
-      @@known_formatters << description
-      autoload description.class_name, description.require_path
-    end
-
-    # CONTRIBUTORS:
-    # If you add a formatter you should do the following before it will be considered for merging.
-    # - add it to this list so it can be autoloaded
-    # - write specs for it
-    # - add it to the readme so it's documented
-
-    register :clean,           description: "like dots but doesn't log re-run commands"
-    register :documentation,   description: "descriptive documentation"
-    register :dot,             description: "dots", default: true
-    register :json,            description: "json formatter (raw teaspoon)"
-    register :junit,           description: "junit compatible formatter"
-    register :pride,           description: "yay rainbows!"
-    register :rspec_html,      description: "RSpec inspired HTML format"
-    register :snowday,         description: "makes you feel warm inside"
-    register :swayze_or_oprah, description: "quote from either Patrick Swayze or Oprah Winfrey"
-    register :tap,             description: "test anything protocol formatter"
-    register :tap_y,           description: "tap_yaml, format used by tapout"
-    register :teamcity,        description: "teamcity compatible formatter"
-
+  module Formatter
     class Base
       attr_accessor :total_count, :run_count, :passes, :pendings, :failures, :errors
 
@@ -163,7 +129,7 @@ module Teaspoon
       def log_to_file(str, output_file)
         @_output_file = File.open(output_file, "a") { |f| f.write(str) }
       rescue IOError => e
-        raise Teaspoon::FileNotWritable, e.message
+        raise Teaspoon::FileWriteError.new(e.message)
       end
 
       def colorize(str, color_code)

data/lib/teaspoon/{formatters/clean_formatter.rb → formatter/clean.rb}

@@ -1,6 +1,8 @@
+require "teaspoon/formatter/dot"
+
 module Teaspoon
-  module Formatters
-    class CleanFormatter < DotFormatter
+  module Formatter
+    class Clean < Dot
       private
 
       def log_failed_examples

data/lib/teaspoon/{formatters/documentation_formatter.rb → formatter/documentation.rb}

@@ -1,8 +1,9 @@
-require "teaspoon/formatters/modules/report_module"
+require "teaspoon/formatter/base"
+require "teaspoon/formatter/modules/report_module"
 
 module Teaspoon
-  module Formatters
-    class DocumentationFormatter < Base
+  module Formatter
+    class Documentation < Base
       include ReportModule
 
       protected

data/lib/teaspoon/{formatters/dot_formatter.rb → formatter/dot.rb}

@@ -1,8 +1,9 @@
-require "teaspoon/formatters/modules/report_module"
+require "teaspoon/formatter/base"
+require "teaspoon/formatter/modules/report_module"
 
 module Teaspoon
-  module Formatters
-    class DotFormatter < Base
+  module Formatter
+    class Dot < Base
       include ReportModule
 
       protected

data/lib/teaspoon/{formatters/json_formatter.rb → formatter/json.rb}

@@ -1,6 +1,8 @@
+require "teaspoon/formatter/base"
+
 module Teaspoon
-  module Formatters
-    class JsonFormatter < Base
+  module Formatter
+    class Json < Base
       protected
 
       def log_runner(result)

data/lib/teaspoon/{formatters/junit_formatter.rb → formatter/junit.rb}

@@ -1,8 +1,9 @@
+require "teaspoon/formatter/base"
 require "cgi"
 
 module Teaspoon
-  module Formatters
-    class JunitFormatter < Base
+  module Formatter
+    class Junit < Base
       protected
 
       def log_runner(result)

data/lib/teaspoon/{formatters → formatter}/modules/report_module.rb

@@ -1,5 +1,5 @@
 module Teaspoon
-  module Formatters
+  module Formatter
     module ReportModule
       RED = 31
       GREEN = 32

data/lib/teaspoon/{formatters/pride_formatter.rb → formatter/pride.rb}

@@ -1,6 +1,8 @@
+require "teaspoon/formatter/dot"
+
 module Teaspoon
-  module Formatters
-    class PrideFormatter < DotFormatter
+  module Formatter
+    class Pride < Dot
       PI_3 = Math::PI / 3
 
       def initialize(*args)

data/lib/teaspoon/{formatters/rspec_html_formatter.rb → formatter/rspec_html.rb}

@@ -1,8 +1,9 @@
 require "erb"
+require "teaspoon/formatter/base"
 
 module Teaspoon
-  module Formatters
-    class RspecHtmlFormatter < Base
+  module Formatter
+    class RspecHtml < Base
       def initialize(*args)
         super
         @suite_start_template = template Templates::SUITE_START

data/lib/teaspoon/{formatters/snowday_formatter.rb → formatter/snowday.rb}

@@ -1,8 +1,9 @@
 # encoding: utf-8
+require "teaspoon/formatter/dot"
 
 module Teaspoon
-  module Formatters
-    class SnowdayFormatter < DotFormatter
+  module Formatter
+    class Snowday < Dot
       protected
 
       def log_spec(result)

data/lib/teaspoon/formatter/swayze_or_oprah.rb

@@ -0,0 +1,111 @@
+require "teaspoon/formatter/base"
+
+module Teaspoon
+  module Formatter
+    class SwayzeOrOprah < Base
+      protected
+
+      def log_result(_result)
+        return log_str("\nNo quote for you.") if failures.size > 0
+        names, quote = random_quote
+        log_line("\n#{quote.inspect} -- Oprah Winfrey or Patrick Swayze?")
+        process_response(names)
+      end
+
+      private
+
+      DATA = [
+        {
+          author: ["patrick swayze", "patrick", "swayze", "ps", "p"],
+          quotes: <<-QUOTES.strip_heredoc.split("|").strip
+            When those you love die, the best you can do is honor their spirit for as long as you live. You make a \
+            commitment that you're going to take whatever lesson that person or animal was trying to teach you, and \
+            you make it true in your own life... it's a positive way to keep their spirit alive in the world, by \
+            keeping it alive in yourself.|The way to screw up somebody's life is to give them what they want. There's \
+            just something about dance ... It's like a primal thing in all of us.|Pain don't hurt.|What winning is to \
+            me is not giving up, is no matter what's thrown at me, I can take it. And I can keep going.|Good-looking \
+            people turn me off. Myself included.|One thing I'm not going to do is chase staying alive. You spend so \
+            much time chasing staying alive, you won't live.|The way to screw up somebody's life is to give them what \
+            they want.|There's just something about dance. It's like a primal thing in all of us.|As always, I \
+            appreciate all the love and support people have sent and continue to send my way.|Everything is designed \
+            to help you sell out.|How do you nurture a positive attitude when all the statistics say you're a dead \
+            man? You go to work.|I am very, very clear on how difficult it is for a young kid out there to go into the \
+            arts without taking a lot of heat from his peers.|I don't know how many hills and valleys I've had, how \
+            many times I've had to refocus my world and my life and my career. I don't know what's on the other \
+            side.|I don't want to be a poster child for cancer.|I don't want to be Mr. Romantic Leading Man. I don't \
+            want to be the Dance Dude. I don't want to be the Action Guy. If I had to do any one of those all my life, \
+            it'd drive me crazy.|I dropped about 20 pounds in the blink of an eye. And then when you see it in the \
+            mirror, when all of a sudden you pull your eyes down, and the bottom of your eyes go yellow and jaundice \
+            sets in - then you know something's wrong.|I got completely fed up with that Hollywood blockbuster \
+            mentality. I couldn't take it seriously any longer.|I had a lot of anger because I wasn't happy with the \
+            way I had been raised.|I just love to work hard.|I keep dreaming of a future, a future with a long and \
+            healthy life, not lived in the shadow of cancer but in the light.|I keep my heart and my soul and my \
+            spirit open to miracles.|I like to believe that I've got a lot of guardian warriors sittin' on my shoulder \
+            including my dad.|I took after my father.|I wanna live.|I will go so far as to say probably smoking had \
+            something to do with my pancreatic cancer.|I'm trying to shut up and let my angels speak to me and tell me \
+            what I'm supposed to do.|I've had so many injuries.
+          QUOTES
+        },
+
+        {
+          author: ["oprah winfrey", "oprah", "winfrey", "ow", "o"],
+          quotes: <<-QUOTES.strip_heredoc.split("|").strip
+            Lots of people want to ride with you in the limo, but what you want is someone who will take the bus with \
+            you when the limo breaks down.|Be thankful for what you have; you'll end up having more. If you \
+            concentrate on what you don't have, you will never, ever have enough.|The more you praise and celebrate \
+            your life, the more there is in life to celebrate.|Surround yourself with only people who are going to \
+            lift you higher.|Breathe. Let go. And remind yourself that this very moment is the only one you know you \
+            have for sure.|As you become more clear about who you really are, you'll be better able to decide what is \
+            best for you - the first time around.|It isn't until you come to a spiritual  understanding of who you are \
+            - not necessarily a religious feeling, but deep down, the spirit within - that you can begin to take \
+            control.|I am a woman in process. I'm just trying like everybody else. I try to take every conflict, every \
+            experience, and learn from it. Life is never dull.|Turn your wounds into wisdom.|Doing the best at this \
+            moment puts you in the best place for the next moment.|Where there is no struggle, there is no \
+            strength.|Do the one thing you think you cannot do. Fail at it. Try again. Do better the second time. The \
+            only people who never tumble are those who never mount the high wire. This is your moment. Own it.|Passion \
+            is energy. Feel the power that comes from focusing on what excites you.|I don't think of myself as a poor \
+            deprived ghetto girl who made good. I think of myself as somebody who from an early age knew I was \
+            responsible for myself, and I had to make good.|Think like a queen. A queen is not afraid to fail. Failure \
+            is another steppingstone to greatness.|I believe that every single event in life happens in an opportunity \
+            to choose love over fear.|The greatest discovery of all time is that a person can change his future by \
+            merely changing his attitude.|I don't believe in failure. It is not failure if you enjoyed the process.|I \
+            don't think you ever stop giving. I really don't. I think it's an on-going process. And it's not just \
+            about being able to write a check. It's being able to touch somebody's life.|The struggle of my life \
+            created empathy - I could relate to pain, being abandoned, having people not love me.|What material \
+            success does is provide you with the ability to concentrate on other things that really matter. And that \
+            is being able to make a difference, not only in your own life, but in other people's lives.|Books were my \
+            pass to personal freedom. I learned to read at age three, and soon discovered there was a whole world to \
+            conquer that went beyond our farm in Mississippi.|Biology is the least of what makes someone a \
+            mother.|Real integrity is doing the right thing, knowing that nobody's going to know whether you did it or \
+            not.|I have a lot of things to prove to myself. One is that I can live my life fearlessly.
+          QUOTES
+        }
+      ]
+
+      def process_response(names)
+        log_str("Will your run be successful? [swayze or oprah]: ")
+        if names.include?(gets.chomp)
+          log_line("\nYou got it right!\n")
+        else
+          log_line("\nWrong, too bad!\n")
+          raise the roof, YO && "Let's get busy"
+        end
+      end
+
+      def random_quote
+        set = DATA[rand(DATA.size)]
+        [set[:author], set[:quotes][rand(set[:quotes].size)]]
+      end
+
+      def the(*_)
+        Exception.new("poorly answered question")
+      end
+
+      def roof
+        0
+      end
+
+      YO = 0
+    end
+  end
+end