specifier 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a4098b51fe3a0a29ab860be282db1a5a8d2007b
-  data.tar.gz: 46e4a79e654b9c3fa4ea7dd16dd0f0e8156e11ac
+  metadata.gz: fcc4798a1f25e09eca4bafa1fcd12d394252cf41
+  data.tar.gz: 760454e29ac6570d2656d668373d526b3db51bfa
 SHA512:
-  metadata.gz: a481e8da92542e1274dd295e327945fe0286852a66eae950e3ea99ec6796ea4c60ff6bb207b698a0decf7886dbb6daeaa19cc59cab1026310c59020d101e6ddc
-  data.tar.gz: 075ca1cda8870fd238b161705077f82073d254170a12b36d99fa03a73e16354ee99ef9ccd2581dfcdd22c3cbc787068eb463bf25dd47d8586dedfc255906d3a2
+  metadata.gz: 944625dab26f7964579a42490722e1a1c02729172211feb3f5fbe6388925e99084faff054046b0a89848eb5b91f0e13fd5eee7f80713c871b9112b8e7b2e617e
+  data.tar.gz: 4d0810069845ecc67a544461c6518f06cff5d33ef86db94fa4359ee3c0d703d75374a5af33ac9b263c83fda2aca4f91659e376c24835392ba149603c13418a47

data/README.md

@@ -1,10 +1,16 @@
 # Specifier
 
+## Installation
+
+```bash
+gem install specifier
+```
+
 ## Example
 
 ```ruby
 class Echo
-  def self.say(message)
+  def say(message)
     message
   end
 end
@@ -12,13 +18,11 @@ end
 
 ```ruby
 Specifier.specify Echo do
-  describe '.say' do
-    it 'says "Hello" if you say "Hello"' do
-      expect(Echo.say('Hello')).to equal('Hello')
-    end
+  let(:echo) { Echo.new }
 
-    it 'says "Goodbye" if you say "Goodbye"' do
-      expect(Echo.say('Goodbye')).to equal('Goodbye')
+  describe '#say' do
+    it 'says "Hello" if you say "Hello"' do
+      expect(echo.say('Hello')).to equal('Hello')
     end
   end
 end
@@ -29,3 +33,14 @@ end
 ```bash
 bundle exec specifier ./specs
 ```
+
+## Status
+
+[![travis](https://img.shields.io/travis/ksylvest/specifier.svg)](https://travis-ci.org/ksylvest/specifier)
+[![gemnasium](https://img.shields.io/gemnasium/ksylvest/specifier.svg)](https://gemnasium.com/ksylvest/specifier)
+[![coveralls](https://img.shields.io/coveralls/ksylvest/specifier.svg)](https://coveralls.io/r/ksylvest/specifier)
+[![codeclimate](https://img.shields.io/codeclimate/github/ksylvest/specifier.svg)](https://codeclimate.com/github/ksylvest/specifier)
+
+## Copyright
+
+Copyright (c) 2016 - 2017 Kevin Sylvestre. See LICENSE for details.

data/lib/specifier.rb

@@ -3,21 +3,29 @@ require 'slop'
 
 require 'specifier/version'
 require 'specifier/cli'
+require 'specifier/colorizer'
 require 'specifier/config'
 require 'specifier/logger'
 require 'specifier/runner'
 require 'specifier/context'
+require 'specifier/definition'
 require 'specifier/example'
 require 'specifier/expectation'
-require 'specifier/memoizer'
 require 'specifier/matcher'
+require 'specifier/memoizer'
 require 'specifier/formatter'
 
 module Specifier
+  def self.contexts
+    @contexts ||= []
+  end
 
   def self.specify(scope, &block)
-    context = Context.new(scope, &block)
-    context.run
+    contexts << Context.setup(scope, &block)
+  end
+
+  def self.run
+    contexts.each(&:run)
   end
 
   def self.config
@@ -29,7 +37,7 @@ module Specifier
   end
 
   def self.formatter
-    @formatter ||= Formatter::Progress.new(logger)
+    @formatter ||= Formatter.formatters[config.formatter || Specifier::Formatter::DEFAULT].new(logger)
   end
 
 end

data/lib/specifier/cli.rb

@@ -1,4 +1,12 @@
 module Specifier
+
+  # Used when interacting with the suite from the command line interface (CLI).
+  #
+  # Usage:
+  #
+  #   cli = Specifier::CLI.new
+  #   cli.parse
+  #
   class CLI
     BANNER = 'usage: specifier [options] [./specs]'.freeze
 
@@ -13,6 +21,8 @@ module Specifier
         options.on '-v', '--version', 'version' do
           return version
         end
+
+        options.string '-f', '--formatter', 'formatter', default: Specifier::Formatter::DEFAULT
       end
 
       run(config)
@@ -29,6 +39,8 @@ module Specifier
     end
 
     def run(options)
+      Specifier.config.formatter = options[:formatter]
+
       paths = Set.new
       options.arguments.each do |argument|
         Find.find(argument) do |path|

data/lib/specifier/colorizer.rb

@@ -0,0 +1,26 @@
+module Specifier
+
+  # Used to colorize messages for console output.
+  #
+  # Usage:
+  #
+  #   Specifier::Colorizer.muted("...")
+  #   Specifier::Colorizer.passed("...")
+  #   Specifier::Colorizer.failed("...")
+  #
+  module Colorizer
+
+    def self.muted(message)
+      "\e[37m#{message}\e[0m"
+    end
+
+    def self.failed(message)
+      "\e[31m#{message}\e[0m"
+    end
+
+    def self.passed(message)
+      "\e[32m#{message}\e[0m"
+    end
+
+  end
+end

data/lib/specifier/config.rb

@@ -0,0 +1,13 @@
+module Specifier
+
+  # Configuration options used internally such as the formatter. Can be accessed via the global.
+  #
+  # Usage:
+  #
+  #   Specifier.config
+  #
+  class Config
+    attr_accessor :formatter
+  end
+
+end

data/lib/specifier/context.rb

@@ -1,29 +1,72 @@
-require 'byebug'
-
 module Specifier
+
+  # Defines a context that can be deeply nested (evaluates from oldest to newest in ancestry).
+  #
+  # Usage:
+  #
+  #   let "..." do
+  #     # ...
+  #   end
+  #
+  #   it "..." do
+  #     # ...
+  #   end
+  #
+  #   describe "..." do
+  #   end
+  #
   class Context
     attr_accessor :parent
+    attr_accessor :children
+    attr_accessor :description
 
-    def initialize(scope, &block)
-      @_scope = scope
-      @_block = block
-      @_examples = Set.new
+    def self.setup(description, parent = nil, &block)
+      context = Context.new(description, &block)
+      context.parent = parent
+      parent.children << context if parent
+      context.instance_eval(&block)
+      context
     end
 
-    def describe(scope, &block)
-      context = Context.new(scope, &block)
-      context.parent = self
-      context.run
+    def initialize(description, &block)
+      @description = description
+      @block = block
+      @children = []
+      @examples = []
+      @definitions = []
     end
 
-    def it(descriptor, &block)
-      @_examples << Example.new(descriptor, &block)
+    def describe(description, &block)
+      self.class.setup(description, self, &block)
+    end
+
+    def let(name, &block)
+      definition = Definition.new(name, &block)
+      @definitions << definition
+      definition
+    end
+
+    def it(description, &block)
+      example = Example.new(description, &block)
+      @examples << example
+      example
     end
 
     def run
-      instance_eval(&@_block)
-      @_examples.each do |example|
-        Specifier.formatter.record(example, example.run)
+      Specifier.formatter.context(self) do
+        @examples.each do |example|
+          setup(example)
+          result = example.run
+          Specifier.formatter.record(example, result)
+        end
+        @children.each(&:run)
+      end
+    end
+
+    def setup(example)
+      parent&.setup(example)
+      @definitions.each do |definition|
+        definition.define(example)
       end
     end
 

data/lib/specifier/definition.rb

@@ -0,0 +1,28 @@
+module Specifier
+
+  # Configures a definition (used for let statements).
+  #
+  # Usage:
+  #
+  #   definition = Specifier::Definition.new("...") do
+  #     # ...
+  #   end
+  #
+  #   definition.define(object)
+  #
+  class Definition
+
+    def initialize(name, &block)
+      @name = name
+      @memoizer = Memoizer.new(&block)
+    end
+
+    def define(object)
+      memoizer = @memoizer
+      object.define_singleton_method(@name) do
+        memoizer.evaluate
+      end
+    end
+
+  end
+end

data/lib/specifier/example.rb

@@ -1,17 +1,24 @@
 module Specifier
+
+  # Configures an example (used for it statements).
+  #
+  # Usage:
+  #
+  #   example = Specifier::Example.new("...") do
+  #     expect(value).to equal(value)
+  #   end
+  #
+  #   example.run
+  #
   class Example
     Result = Struct.new(:status, :message)
 
-    def initialize(descriptor, &block)
-      @_descriptor = descriptor
-      @_block = block
-    end
+    attr_accessor :description
 
-    # def let(name, &block)
-    #   define_method(name) do
-    #     @_memoizer.resolve(name, block)
-    #   end
-    # end
+    def initialize(description, &block)
+      @description = description
+      @block = block
+    end
 
     def expect(value)
       Expectation.new(value)
@@ -22,7 +29,7 @@ module Specifier
     end
 
     def run
-      instance_eval(&@_block)
+      instance_eval(&@block)
       return Result.new(:pass)
     rescue Specifier::Expectation::Miss => miss
       return Result.new(:fail, miss.message)

data/lib/specifier/expectation.rb

@@ -1,4 +1,12 @@
 module Specifier
+
+  # Configures an expectation (used for expect statements).
+  #
+  # Usage:
+  #
+  #   expectation = Specifier::Expectation.new("today")
+  #   expectation.to(matcher) # 'raises 'Miss'
+  #
   class Expectation
     class Miss < StandardError
       def initialize(message)

data/lib/specifier/formatter.rb

@@ -1,2 +1,17 @@
+module Specifier
+  module Formatter
+    def self.formatters
+      @formatters ||= {}
+    end
+  end
+end
+
 require 'specifier/formatter/base'
+require 'specifier/formatter/documentation'
 require 'specifier/formatter/progress'
+
+module Specifier
+  module Formatter
+    DEFAULT = Progress::NAME
+  end
+end

data/lib/specifier/formatter/base.rb

@@ -1,5 +1,14 @@
 module Specifier
   module Formatter
+
+    # A base defintion for formatting the specifier results.
+    #
+    # Usage:
+    #
+    #   formatter = Specifier::Formatter::Base.new
+    #   formatter.record(example, result)
+    #   formatter.summarize
+    #
     class Base
       Recording = Struct.new(:example, :result) do
         def status
@@ -18,12 +27,25 @@ module Specifier
       def initialize(logger)
         @logger = logger
         @recordings = []
+        @contexts = []
       end
 
       def record(example, result)
         @recordings << Recording.new(example, result)
       end
 
+      def context(context)
+        @contexts << context
+        yield
+      end
+
+      def summarize
+        @logger.log
+        @logger.log(summary)
+      end
+
+    protected
+
       def passed
         @recordings.select(&:pass?)
       end
@@ -32,18 +54,14 @@ module Specifier
         @recordings.select(&:fail?)
       end
 
-      def summarize
-        @logger.log
-        @logger.log(summary)
-      end
-
       def summary
         <<~SUMMARY
-          Total: #{@recordings.count}
-          Passed: #{passed.count}
-          Failed: #{failed.count}
+          Total: #{Colorizer.muted(@recordings.count)}
+          Passed: #{Colorizer.passed(passed.count)}
+          Failed: #{Colorizer.failed(failed.count)}
         SUMMARY
       end
     end
+
   end
 end

data/lib/specifier/formatter/documentation.rb

@@ -0,0 +1,54 @@
+module Specifier
+  module Formatter
+
+    # A custom defintion for formatting the specifier results.
+    #
+    # Usage:
+    #
+    #   formatter = Specifier::Formatter::Documentation.new
+    #   formatter.context(context) do
+    #     formatter.record(example, result)
+    #   end
+    #   formatter.summarize
+    #
+    class Documentation < Base
+      INDENTATION = '  '.freeze
+      NAME = 'documentation'.freeze
+
+      Formatter.formatters[NAME] = self
+
+      def initialize(logger)
+        super
+        @indentation = 0
+      end
+
+      def record(example, result)
+        super
+
+        message =
+          case result.status
+          when :pass then Colorizer.passed(indent(example.description))
+          when :fail then Colorizer.failed(indent(example.description))
+          end
+
+        @logger.log(message)
+      end
+
+      def context(context)
+        @logger.log(indent(context.description))
+
+        @indentation = @indentation.next
+        super
+        @indentation = @indentation.pred
+      end
+
+    private
+
+      def indent(message)
+        INDENTATION * @indentation + String(message)
+      end
+
+    end
+
+  end
+end

data/lib/specifier/formatter/progress.rb

@@ -1,20 +1,36 @@
 module Specifier
   module Formatter
+
+    # A custom defintion for formatting the specifier results.
+    #
+    # Usage:
+    #
+    #   formatter = Specifier::Formatter::Progress.new
+    #   formatter.context(context) do
+    #     formatter.record(example, result)
+    #   end
+    #   formatter.summarize
+    #
     class Progress < Base
+      NAME = 'progress'.freeze
+      PASS = '+'.freeze
+      FAIL = '-'.freeze
+
+      Formatter.formatters[NAME] = self
+
       def record(example, result)
         super
-        @logger << symbol(result)
-      end
 
-    private
+        message =
+          case result.status
+          when :pass then Specifier::Colorizer.passed(PASS)
+          when :fail then Specifier::Colorizer.failed(FAIL)
+          end
 
-      def symbol(result)
-        case result.status
-        when :pass then '+'
-        when :fail then '-'
-        end
+        @logger << message
       end
 
     end
+
   end
 end

data/lib/specifier/logger.rb

@@ -7,6 +7,18 @@ module Specifier
   #   Specifier.logger.log("...")
   #
   class Logger
+    module Color
+      BLACK  = 0
+      RED    = 1
+      GREEN  = 2
+      YELLOW = 3
+    end
+
+    module Formatting
+      DEFAULT = 0
+      BOLD    = 1
+      ITALIC  = 3
+    end
 
     def initialize(stream = STDOUT)
       @stream = stream

data/lib/specifier/memoizer.rb

@@ -1,11 +1,24 @@
 module Specifier
+
+  # It remembers things (used for within let statements).
+  #
+  # Usage:
+  #
+  #   memoizer = Specifier::Memoizer.new do
+  #     # ...
+  #   end
+  #   memoizer.evaluate
+  #
   class Memoizer
-    def initialize
-      @resolutions = {}
+
+    def initialize(&block)
+      @block = block
     end
 
-    def resolve(name)
-      @resolutions[name] ||= yield
+    def evaluate
+      return @result if defined?(@result)
+      @result = @block.call
     end
+
   end
 end

data/lib/specifier/runner.rb

@@ -1,4 +1,12 @@
 module Specifier
+
+  # Handles load and execution of specs.
+  #
+  # Usage:
+  #
+  #   runner = Specifier::Runner.new(paths: "./spec")
+  #   runner.run
+  #
   class Runner
     def initialize(paths:)
       @paths = paths
@@ -8,6 +16,8 @@ module Specifier
       @paths.each do |path|
         load path
       end
+
+      Specifier.run
       Specifier.formatter.summarize
     end
   end

data/lib/specifier/version.rb

@@ -1,3 +1,3 @@
 module Specifier
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: specifier
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Sylvestre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -108,12 +108,15 @@ files:
 - bin/specifier
 - lib/specifier.rb
 - lib/specifier/cli.rb
+- lib/specifier/colorizer.rb
 - lib/specifier/config.rb
 - lib/specifier/context.rb
+- lib/specifier/definition.rb
 - lib/specifier/example.rb
 - lib/specifier/expectation.rb
 - lib/specifier/formatter.rb
 - lib/specifier/formatter/base.rb
+- lib/specifier/formatter/documentation.rb
 - lib/specifier/formatter/progress.rb
 - lib/specifier/logger.rb
 - lib/specifier/matcher.rb