specifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a4098b51fe3a0a29ab860be282db1a5a8d2007b
+  data.tar.gz: 46e4a79e654b9c3fa4ea7dd16dd0f0e8156e11ac
+SHA512:
+  metadata.gz: a481e8da92542e1274dd295e327945fe0286852a66eae950e3ea99ec6796ea4c60ff6bb207b698a0decf7886dbb6daeaa19cc59cab1026310c59020d101e6ddc
+  data.tar.gz: 075ca1cda8870fd238b161705077f82073d254170a12b36d99fa03a73e16354ee99ef9ccd2581dfcdd22c3cbc787068eb463bf25dd47d8586dedfc255906d3a2

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kevin Sylvestre
+
+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/README.md

@@ -0,0 +1,31 @@
+# Specifier
+
+## Example
+
+```ruby
+class Echo
+  def self.say(message)
+    message
+  end
+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
+
+    it 'says "Goodbye" if you say "Goodbye"' do
+      expect(Echo.say('Goodbye')).to equal('Goodbye')
+    end
+  end
+end
+```
+
+## Usage
+
+```bash
+bundle exec specifier ./specs
+```

data/bin/specifier

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'specifier'
+
+cli = Specifier::CLI.new
+cli.parse

data/lib/specifier.rb

@@ -0,0 +1,35 @@
+require 'find'
+require 'slop'
+
+require 'specifier/version'
+require 'specifier/cli'
+require 'specifier/config'
+require 'specifier/logger'
+require 'specifier/runner'
+require 'specifier/context'
+require 'specifier/example'
+require 'specifier/expectation'
+require 'specifier/memoizer'
+require 'specifier/matcher'
+require 'specifier/formatter'
+
+module Specifier
+
+  def self.specify(scope, &block)
+    context = Context.new(scope, &block)
+    context.run
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.logger
+    @logger ||= Logger.new
+  end
+
+  def self.formatter
+    @formatter ||= Formatter::Progress.new(logger)
+  end
+
+end

data/lib/specifier/cli.rb

@@ -0,0 +1,42 @@
+module Specifier
+  class CLI
+    BANNER = 'usage: specifier [options] [./specs]'.freeze
+
+    def parse(items = ARGV)
+      config = Slop.parse(items) do |options|
+        options.banner = BANNER
+
+        options.on '-h', '--help', 'help' do
+          return help(options)
+        end
+
+        options.on '-v', '--version', 'version' do
+          return version
+        end
+      end
+
+      run(config)
+    end
+
+  private
+
+    def help(options)
+      Specifier.logger.log(String(options))
+    end
+
+    def version
+      Specifier.logger.log(String(VERSION))
+    end
+
+    def run(options)
+      paths = Set.new
+      options.arguments.each do |argument|
+        Find.find(argument) do |path|
+          paths << path if path.match?(/\A(.*).rb\Z/)
+        end
+      end
+      Runner.new(paths: paths).run
+    end
+
+  end
+end

data/lib/specifier/context.rb

@@ -0,0 +1,31 @@
+require 'byebug'
+
+module Specifier
+  class Context
+    attr_accessor :parent
+
+    def initialize(scope, &block)
+      @_scope = scope
+      @_block = block
+      @_examples = Set.new
+    end
+
+    def describe(scope, &block)
+      context = Context.new(scope, &block)
+      context.parent = self
+      context.run
+    end
+
+    def it(descriptor, &block)
+      @_examples << Example.new(descriptor, &block)
+    end
+
+    def run
+      instance_eval(&@_block)
+      @_examples.each do |example|
+        Specifier.formatter.record(example, example.run)
+      end
+    end
+
+  end
+end

data/lib/specifier/example.rb

@@ -0,0 +1,32 @@
+module Specifier
+  class Example
+    Result = Struct.new(:status, :message)
+
+    def initialize(descriptor, &block)
+      @_descriptor = descriptor
+      @_block = block
+    end
+
+    # def let(name, &block)
+    #   define_method(name) do
+    #     @_memoizer.resolve(name, block)
+    #   end
+    # end
+
+    def expect(value)
+      Expectation.new(value)
+    end
+
+    def equal(value)
+      Matcher::Equal.new(value)
+    end
+
+    def run
+      instance_eval(&@_block)
+      return Result.new(:pass)
+    rescue Specifier::Expectation::Miss => miss
+      return Result.new(:fail, miss.message)
+    end
+
+  end
+end

data/lib/specifier/expectation.rb

@@ -0,0 +1,17 @@
+module Specifier
+  class Expectation
+    class Miss < StandardError
+      def initialize(message)
+        @message = message
+      end
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    def to(matcher)
+      raise Miss, matcher.message unless matcher.match?(@value)
+    end
+  end
+end

data/lib/specifier/formatter.rb

@@ -0,0 +1,2 @@
+require 'specifier/formatter/base'
+require 'specifier/formatter/progress'

data/lib/specifier/formatter/base.rb

@@ -0,0 +1,49 @@
+module Specifier
+  module Formatter
+    class Base
+      Recording = Struct.new(:example, :result) do
+        def status
+          result.status
+        end
+
+        def pass?
+          status.eql?(:pass)
+        end
+
+        def fail?
+          status.eql?(:fail)
+        end
+      end
+
+      def initialize(logger)
+        @logger = logger
+        @recordings = []
+      end
+
+      def record(example, result)
+        @recordings << Recording.new(example, result)
+      end
+
+      def passed
+        @recordings.select(&:pass?)
+      end
+
+      def failed
+        @recordings.select(&:fail?)
+      end
+
+      def summarize
+        @logger.log
+        @logger.log(summary)
+      end
+
+      def summary
+        <<~SUMMARY
+          Total: #{@recordings.count}
+          Passed: #{passed.count}
+          Failed: #{failed.count}
+        SUMMARY
+      end
+    end
+  end
+end

data/lib/specifier/formatter/progress.rb

@@ -0,0 +1,20 @@
+module Specifier
+  module Formatter
+    class Progress < Base
+      def record(example, result)
+        super
+        @logger << symbol(result)
+      end
+
+    private
+
+      def symbol(result)
+        case result.status
+        when :pass then '+'
+        when :fail then '-'
+        end
+      end
+
+    end
+  end
+end

data/lib/specifier/logger.rb

@@ -0,0 +1,25 @@
+module Specifier
+
+  # A generic logger extracting output for testing. Can be accessed via the global.
+  #
+  # Usage:
+  #
+  #   Specifier.logger.log("...")
+  #
+  class Logger
+
+    def initialize(stream = STDOUT)
+      @stream = stream
+    end
+
+    def <<(message)
+      @stream << message
+    end
+
+    def log(message = nil)
+      @stream.puts message
+    end
+
+  end
+
+end

data/lib/specifier/matcher.rb

@@ -0,0 +1,2 @@
+require 'specifier/matcher/base'
+require 'specifier/matcher/equal'

data/lib/specifier/matcher/base.rb

@@ -0,0 +1,11 @@
+module Specifier
+  module Matcher
+    class Base
+      attr_accessor :expected
+
+      def match?(expected)
+        self.expected = expected
+      end
+    end
+  end
+end

data/lib/specifier/matcher/equal.rb

@@ -0,0 +1,18 @@
+module Specifier
+  module Matcher
+    class Equal < Base
+      def initialize(value)
+        @value = value
+      end
+
+      def match?(expected)
+        super
+        expected.eql?(@value)
+      end
+
+      def message
+        "expected #{@expected.inspect} got #{@value.inspect}"
+      end
+    end
+  end
+end

data/lib/specifier/memoizer.rb

@@ -0,0 +1,11 @@
+module Specifier
+  class Memoizer
+    def initialize
+      @resolutions = {}
+    end
+
+    def resolve(name)
+      @resolutions[name] ||= yield
+    end
+  end
+end

data/lib/specifier/runner.rb

@@ -0,0 +1,14 @@
+module Specifier
+  class Runner
+    def initialize(paths:)
+      @paths = paths
+    end
+
+    def run
+      @paths.each do |path|
+        load path
+      end
+      Specifier.formatter.summarize
+    end
+  end
+end

data/lib/specifier/version.rb

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

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: specifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Sylvestre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Thi should probably never be used.
+email:
+- kevin@ksylvest.com
+executables:
+- specifier
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- bin/specifier
+- lib/specifier.rb
+- lib/specifier/cli.rb
+- lib/specifier/config.rb
+- lib/specifier/context.rb
+- lib/specifier/example.rb
+- lib/specifier/expectation.rb
+- lib/specifier/formatter.rb
+- lib/specifier/formatter/base.rb
+- lib/specifier/formatter/progress.rb
+- lib/specifier/logger.rb
+- lib/specifier/matcher.rb
+- lib/specifier/matcher/base.rb
+- lib/specifier/matcher/equal.rb
+- lib/specifier/memoizer.rb
+- lib/specifier/runner.rb
+- lib/specifier/version.rb
+homepage: https://github.com/ksylvest/specifier
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A testing framework written for fun.
+test_files: []