neospec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38bd481896e0d5370273be416eff657d82318f3e1ff9f517bdb16bb14e80167e
+  data.tar.gz: 5583a0d624da8f0b6a1f9afc0590ec565f5cbe5aa1ec2bdca5eb1d69a7235cf4
+SHA512:
+  metadata.gz: 5bb3bffd7c3b17f9ca90109e6ec9097de59d353b2ae7c6ee4747c7f8ab55dd580f7059e15c4c205c46bf99450ea36d2a11e6281560ae4dd60f4f79f214365984
+  data.tar.gz: 803bb7a2562b2138d40e04857c0b2463a8bfdb99084e5ee06479e5dff2322ddfe18168364ab932fa3fc9e8a2dc4ded3da643bea0c19d51ccff6b156f9d306274

data/.buildkite/bin/check-formatting

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+.buildkite/bin/install-ruby
+.buildkite/bin/setup-ruby
+
+bundle exec rake standard

data/.buildkite/bin/install-asdf

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+if [ ! -f "/root/.asdf/bin/asdf" ]; then
+  ASDF_VERSION=v0.16.4
+  ASDF_PLATFORM=amd64
+  ASDF_URL=https://github.com/asdf-vm/asdf/releases/download/$ASDF_VERSION/asdf-$ASDF_VERSION-linux-$ASDF_PLATFORM.tar.gz
+
+  wget -O /root/asdf.tar.gz "${ASDF_URL}"
+  tar xfv /root/asdf.tar.gz
+  mkdir -p /root/.asdf/bin/
+  mv asdf /root/.asdf/bin/asdf
+  rm /root/asdf.tar.gz
+
+  asdf plugin add ruby
+fi

data/.buildkite/bin/install-ruby

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+.buildkite/bin/install-asdf
+
+if [[ -n ${1+x} ]]; then
+  asdf set ruby $1
+fi
+
+asdf plugin update ruby
+asdf install ruby

data/.buildkite/bin/install-taylor

@@ -0,0 +1,15 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+TAYLOR_VERSION=$1
+
+if [ ! -f "/root/.taylor-versions/taylor-${TAYLOR_VERSION}" ]; then
+  TAYLOR_URL=https://github.com/HellRok/Taylor/releases/download/${TAYLOR_VERSION}/taylor-linux-${TAYLOR_VERSION}.zip
+
+  wget -O /root/taylor.zip "${TAYLOR_URL}"
+  unzip /root/taylor.zip
+  mkdir -p /root/.taylor-versions/
+  mv taylor /root/.taylor-versions/taylor-${TAYLOR_VERSION}
+  rm /root/taylor.zip
+fi
+

data/.buildkite/bin/setup-ruby

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -euxo pipefail
+
+gem install bundler
+bundle install

data/.buildkite/bin/test-ruby

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+RUBY_VERSION=$1
+
+.buildkite/bin/install-ruby $RUBY_VERSION
+
+ruby spec/run.rb

data/.buildkite/bin/test-taylor

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+TAYLOR_VERSION=$1
+
+.buildkite/bin/install-taylor $TAYLOR_VERSION
+
+/root/.taylor-versions/taylor-${TAYLOR_VERSION} spec/run.rb

data/.buildkite/pipeline.yml

@@ -0,0 +1,52 @@
+steps:
+  - label: 'Formatting'
+    commands:
+      - .buildkite/bin/check-formatting
+
+  - label: 'Ruby - 3.5'
+    commands:
+      - .buildkite/bin/test-ruby 3.5.0-preview1
+
+  - label: 'Ruby - 3.4'
+    commands:
+      - .buildkite/bin/test-ruby 3.4.5
+
+  - label: 'Ruby - 3.3'
+    commands:
+      - .buildkite/bin/test-ruby 3.3.8
+
+  - label: 'Ruby - 3.2'
+    commands:
+      - .buildkite/bin/test-ruby 3.2.8
+
+  - label: 'Ruby - 3.1'
+    commands:
+      - .buildkite/bin/test-ruby 3.1.7
+
+  - label: 'Ruby - 3.0'
+    commands:
+      - .buildkite/bin/test-ruby 3.0.7
+
+  - label: 'Ruby - 2.7'
+    commands:
+      - .buildkite/bin/test-ruby 2.7.8
+
+  - label: 'Ruby - 2.6'
+    commands:
+      - .buildkite/bin/test-ruby 2.6.10
+
+  - label: 'JRuby - 10'
+    commands:
+      - .buildkite/bin/test-ruby jruby-10.0.0.1
+
+  - label: 'JRuby - 9'
+    commands:
+      - .buildkite/bin/test-ruby jruby-9.4.13.0
+
+  - label: 'TruffleRuby - 24'
+    commands:
+      - .buildkite/bin/test-ruby truffleruby-24.2.1
+
+  - label: 'Taylor - v0.3.14.1'
+    commands:
+      - .buildkite/bin/test-taylor v0.3.14.1

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.5

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org" do
+  gem "rake"
+  gem "standardrb"
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+GEM
+  specs:
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    json (2.13.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rubocop (1.75.8)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.50.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.75.5)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.8.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.25.0)
+    standardrb (1.0.1)
+      standard
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  rake!
+  standardrb!
+
+BUNDLED WITH
+   2.6.9

data/README.md

@@ -0,0 +1,43 @@
+# neospec
+
+## Usage
+
+Add `gem "neospec"` to your `Gemfile` and run `bundle install`.
+
+Then it can be as simple as:
+
+```ruby
+require "neospec"
+
+unit = Neospec::Suite.new
+neospec = Neospec.new(suites: [unit])
+
+unit.describe "An example test" do
+  Given "apples are ripe" do
+    @apples = :ripe
+  end
+
+  And "bananas are ripe" do
+    @bananas = :ripe
+  end
+
+  Then "apples and bananas are as ripe as each other" do
+    expect(@apples).to_equal(@bananas)
+  end
+
+  But "the bananas become TOO ripe" do
+    @bananas = :over_ripe
+  end
+
+  Then "apples and bananas are now not as ripe as each other" do
+    expect(@apples).not_to_equal(@bananas)
+  end
+end
+
+neospec.run!
+```
+
+## Not yet implemented
+
+- Early exit upon hitting a failure
+- Expect errors

data/Rakefile

@@ -0,0 +1,16 @@
+require "standard/rake"
+
+task neospec: ["neospec:ruby", "neospec:taylor"]
+
+task "neospec:ruby" do
+  require "./spec/run"
+end
+
+task "neospec:taylor" do
+  exec "taylor spec/run.rb"
+end
+
+task "example" do
+  $LOAD_PATH << "./lib"
+  require "./docs/example_spec"
+end

data/docs/example_spec.rb

@@ -0,0 +1,28 @@
+require "neospec"
+
+unit = Neospec::Suite.new
+neospec = Neospec.new(suites: [unit])
+
+unit.describe "An example test" do
+  Given "apples are ripe" do
+    @apples = :ripe
+  end
+
+  And "bananas are ripe" do
+    @bananas = :ripe
+  end
+
+  Then "apples and bananas are as ripe as each other" do
+    expect(@apples).to_equal(@bananas)
+  end
+
+  But "the bananas become TOO ripe" do
+    @bananas = :over_ripe
+  end
+
+  Then "apples and bananas are now not as ripe as each other" do
+    expect(@apples).not_to_equal(@bananas)
+  end
+end
+
+neospec.run!

data/lib/neospec/color.rb

@@ -0,0 +1,8 @@
+class Neospec
+  module Color
+    GREEN = "\033[0;32m"
+    RED = "\033[0;31m"
+    BLUE = "\033[0;34m"
+    RESET = "\033[0m"
+  end
+end

data/lib/neospec/expector.rb

@@ -0,0 +1,55 @@
+class Neospec
+  class Expector
+    attr_reader :failure, :result
+
+    def initialize(result:, actual:, stack:, logger:)
+      @actual = actual
+      @stack = stack
+      @logger = logger
+      @result = result
+    end
+
+    def log(message, context: nil)
+      @logger.log(message, context: context, result: @result)
+    end
+
+    def succeeded(message)
+      @result.expectations += 1
+      log(message, context: :expect)
+    end
+
+    def failed(message)
+      @result.expectations += 1
+      @result.failures << Neospec::Spec::Result::Failure.new(
+        stack: @stack,
+        message: "Expected #{message}"
+      )
+
+      log(message, context: :expect)
+    end
+
+    def to_equal(expected)
+      if @actual == expected
+        succeeded "to be equal"
+      else
+        failed "'#{expected}' to equal '#{@actual}'"
+      end
+    end
+
+    def not_to_equal(expected)
+      if @actual != expected
+        succeeded "not to be equal"
+      else
+        failed "'#{expected}' not to equal '#{@actual}'"
+      end
+    end
+
+    def to_be_a(expected)
+      if @actual.is_a?(expected)
+        succeeded "to be a #{expected}"
+      else
+        failed "'#{expected}' to equal '#{@actual.class}'"
+      end
+    end
+  end
+end

data/lib/neospec/logger/basic.rb

@@ -0,0 +1,32 @@
+class Neospec
+  module Logger
+    class Basic
+      def initialize(color: true, output: $stdout)
+        @color = color
+        @output = output
+      end
+
+      def log(message, context: nil, result: nil)
+        case context
+        when :describe
+          if @color
+            @output.puts "#{Neospec::Color::BLUE}#{message}#{Neospec::Color::RESET}"
+          else
+            @output.puts message
+          end
+        when :expect
+          if @color
+            str = "    "
+            str << (result.successful? ? "#{Neospec::Color::GREEN}✓" : "#{Neospec::Color::RED}✗")
+            str << " #{context} #{message}#{Neospec::Color::RESET}"
+            @output.puts str
+          else
+            @output.puts "    #{result.successful? ? "✓" : "✗"} #{context} #{message}"
+          end
+        else
+          @output.puts "  #{context} #{message}"
+        end
+      end
+    end
+  end
+end

data/lib/neospec/logger/symbols.rb

@@ -0,0 +1,18 @@
+class Neospec
+  module Logger
+    class Symbols
+      def initialize(color: true, output: $stdout)
+        @color = color
+        @output = output
+      end
+
+      def log(message, context: nil, result: nil)
+        if context == :expect
+          @output.write "#{
+            result.successful? ? "#{Neospec::Color::GREEN}✓" : "#{Neospec::Color::RED}✗"
+          }#{Neospec::Color::RESET}"
+        end
+      end
+    end
+  end
+end

data/lib/neospec/report/basic.rb

@@ -0,0 +1,57 @@
+class Neospec
+  module Report
+    module Basic
+      def self.call(results, output: $stdout)
+        output.puts "\n#{successes(results)}#{failures(results)}"
+      end
+
+      def self.successes(results)
+        <<~STR.chomp
+          Finished in #{formatted_duration(results.duration)}
+
+          Results:
+            Specs:\t#{results.specs.size}
+            Expectations:\t#{results.expectations}
+        STR
+      end
+
+      def self.failures(results)
+        return if results.successful?
+
+        output = "\n  Failures:\t#{results.failures.size}\n\n"
+        output << "Failures:\n"
+
+        output += results.failures.map do |failure|
+          failure_output = ["  #{Neospec::Color::RED}#{failure.message}#{Neospec::Color::RESET}"]
+          failure.stack.first(5).each do |location|
+            failure_output << "    > #{location}"
+          end
+
+          failure_output.join("\n")
+        end.join("\n\n")
+
+        output
+      end
+
+      def self.formatted_duration(duration)
+        if duration < 1
+          "#{(duration * 1000).round(2)} milliseconds"
+        elsif duration < 60
+          "#{duration.round(2)} seconds"
+        elsif duration < 3600
+          minutes = (duration / 60).to_i
+          seconds = (duration % 60).to_i
+          "#{minutes} minute#{(minutes == 1) ? "" : "s"} #{seconds} second#{(seconds == 1) ? "" : "s"}"
+        elsif duration < 86400
+          hours = (duration / 3600).to_i
+          minutes = ((duration % 3600) / 60).to_i
+          "#{hours} hour#{(hours == 1) ? "" : "s"} #{minutes} minute#{(minutes == 1) ? "" : "s"}"
+        else
+          days = (duration / 86400).to_i
+          hours = ((duration % 86400) / 3600).to_i
+          "#{days} day#{(days == 1) ? "" : "s"} #{hours} hour#{(hours == 1) ? "" : "s"}"
+        end
+      end
+    end
+  end
+end

data/lib/neospec/results.rb

@@ -0,0 +1,29 @@
+class Neospec
+  class Results
+    attr_accessor :suites
+
+    def initialize(suites: [])
+      @suites = suites
+    end
+
+    def specs
+      @suites.flat_map(&:specs)
+    end
+
+    def successful?
+      specs.all?(&:successful?)
+    end
+
+    def failures
+      specs.flat_map(&:failures)
+    end
+
+    def duration
+      specs.sum(0, &:duration)
+    end
+
+    def expectations
+      specs.sum(0, &:expectations)
+    end
+  end
+end

data/lib/neospec/runner/basic.rb

@@ -0,0 +1,11 @@
+class Neospec
+  module Runner
+    class Basic
+      def run(logger:, suite:)
+        suite.specs.each do |spec|
+          spec.run(logger: logger)
+        end
+      end
+    end
+  end
+end

data/lib/neospec/spec/result/failure.rb

@@ -0,0 +1,14 @@
+class Neospec
+  class Spec
+    class Result
+      class Failure
+        attr_reader :stack, :message
+
+        def initialize(stack:, message:)
+          @stack = stack
+          @message = message
+        end
+      end
+    end
+  end
+end

data/lib/neospec/spec/result.rb

@@ -0,0 +1,31 @@
+class Neospec
+  class Spec
+    class Result
+      attr_accessor :expectations, :failures, :start, :finish
+
+      def initialize
+        @expectations = 0
+        @failures = []
+        @start = nil
+        @finish = nil
+      end
+
+      def successful?
+        @failures.empty?
+      end
+
+      def start!
+        @start = Time.now
+      end
+
+      def finish!
+        @finish = Time.now
+      end
+
+      def duration
+        return if @start.nil? || @finish.nil?
+        @finish - @start
+      end
+    end
+  end
+end

data/lib/neospec/spec.rb

@@ -0,0 +1,66 @@
+class Neospec
+  class Spec
+    COMMANDS = %w[Given And But When Then]
+
+    def initialize(description:, block:)
+      # Everything here is prefixed to prevent people's specs overriding it,
+      # this came to be because I've already accidentally done this a few
+      # times.
+      @__result = Neospec::Spec::Result.new
+      @__description = description
+      @__block = block
+    end
+
+    def description
+      @__description
+    end
+
+    def result
+      @__result
+    end
+
+    def duration
+      @__result.duration
+    end
+
+    def successful?
+      @__result.successful?
+    end
+
+    def expectations
+      @__result.expectations
+    end
+
+    def failures
+      @__result.failures
+    end
+
+    def log(message, context: nil, result: nil)
+      @__logger.log(message, context: context, result: result)
+    end
+
+    def run(logger:)
+      @__logger = logger
+      instance_exec { log(@__description, context: :describe) }
+      result.start!
+      instance_exec(&@__block)
+      result.finish!
+    end
+
+    COMMANDS.each do |command|
+      define_method(command) do |description, &block|
+        log(description, context: command.to_sym)
+        block.call
+      end
+    end
+
+    def expect(value)
+      Neospec::Expector.new(
+        result: @__result,
+        actual: value,
+        stack: caller,
+        logger: @__logger
+      )
+    end
+  end
+end

data/lib/neospec/suite.rb

@@ -0,0 +1,28 @@
+class Neospec
+  class Suite
+    attr_accessor :specs, :runner
+
+    def initialize(runner: Neospec::Runner::Basic.new)
+      @runner = runner
+      @specs = []
+    end
+
+    def results
+      @specs.map(&:result)
+    end
+
+    def describe(description, &block)
+      @specs << Neospec::Spec.new(
+        description: description,
+        block: block
+      )
+    end
+
+    def run(logger:)
+      runner.run(
+        logger: logger,
+        suite: self
+      )
+    end
+  end
+end

data/lib/neospec/version.rb

@@ -0,0 +1,3 @@
+class Neospec
+  VERSION = "0.0.1"
+end