speq 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32ff60fc943c04afc5c85f9b49c020a08f0e38720eed9f02c7be16aa9e4c1777
+  data.tar.gz: b5622c58ca6fd050185092fc4a6fda473393ebdf6d33dc1a8cd1a176c2cbcce6
+SHA512:
+  metadata.gz: e088259968e6271760e885a1aef4e90b23b93073633c9828d8e2c241735ae79d4be980f0055b21aabfbf4883f79aec37632ac8e27987b5cf6c099f6aeda6ec2a
+  data.tar.gz: 316856e55388a2baf6b919da7c017a7bf3fcdabbac396a3adeabad8842ae675d57a53a5ee1c03a932d38f6e4c97955bd6c1b23b9c5c9f43742c50b53bdae576c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in speq.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    speq (0.2.0)
+      colorize (~> 0.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    colorize (0.8.1)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry (~> 0.11.3)
+  rake (~> 10.0)
+  speq!
+
+BUNDLED WITH
+   1.16.6

data/README.md

@@ -0,0 +1,74 @@
+# Speq
+
+## A tiny library to build specs with fewer words
+
+Speq is TDD library for rapid prototyping in Ruby. It aims to work well anytime testing is desired but writing specs with existing tools may feel excessive.
+
+Speq favors simplicity and minimalism, which may not always be compatible with rigorous testing. The existing TDD tools for Ruby are exceptional, and Speq is not a replacement.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'speq'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install speq
+
+## Syntax
+
+Speq excels at running many similar tests and checks. It omits explicit descriptions and outputs simple reports.
+
+```ruby
+does :prime? do
+  given 0, 1, 8, match: false
+  given 2, 3, 97, match: true
+end
+```
+
+## Usage
+
+### Wherever you want
+
+```ruby
+require 'speq'
+
+class Array
+  def my_map
+    Array.new(length) { |index| yield(self[index])}
+  end
+end
+
+# Speq.test...
+```
+
+### With dedicated spec files
+
+Speq also offers a simple CLI that lets you run tests written in dedicated spec files.
+
+Executing the following command:
+
+    $ bundle exec speq
+
+will recursively search the working directory and run all files that end with `_speq.rb`.
+
+To run individual files, specify a list of speq file prefixes. For example, to run tests that are within the files `example_speq.rb` and `sample_speq.rb`, simply execute:
+
+    $ bundle exec speq example sample
+
+Speq files are not expected to require `speq`, but they should require other files that may be needed to run the speqs.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [Speq's GitHub](https://github.com/znrm/speq).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pry'
+
+require 'speq'
+include Speq
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/speq

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'speq/cli'
+Speq::CLI.new(ARGV).run

data/lib/speq/cli.rb

@@ -0,0 +1,31 @@
+require 'find'
+require 'colorize'
+require 'speq/test'
+
+# Provides a CLI for running Speq
+module Speq
+  class CLI
+    attr_accessor :tests
+
+    def initialize(cli_args)
+      @files = find_files(cli_args)
+      @tests = []
+    end
+
+    def find_files(file_prefixes)
+      file_prefixes << '*' if file_prefixes.empty?
+
+      Dir.glob("#{Dir.pwd}/**/{#{file_prefixes.join(',')}}_speq.rb")
+    end
+
+    def does(subject, &block)
+      tests << Test.new(subject, self, &block)
+    end
+
+    def run
+      @files.each { |file| instance_eval(File.read(file), file) }
+      @tests.each(&:report)
+      @tests.all?(&:passed?)
+    end
+  end
+end

data/lib/speq/fake.rb

@@ -0,0 +1,5 @@
+# The Fake class inludes a variety of doubles, mocks, stubs, etc.
+module Speq
+  class Fake
+  end
+end

data/lib/speq/match.rb

@@ -0,0 +1,26 @@
+# The Match class includes a variety of matchers
+module Speq
+  class Match
+    attr_reader :actual, :expected, :passed, :args
+
+    def initialize(actual, match_sym, args, expected = nil)
+      @actual = actual
+      @expected = expected
+      @passed = false
+      @args = args
+
+      evaluate_match(match_sym)
+    end
+
+    def evaluate_match(match_sym)
+      case match_sym
+      when :eql?, :equal?
+        @passed = actual.send(match_sym, expected)
+      end
+    end
+
+    def passed?
+      @passed
+    end
+  end
+end

data/lib/speq/test.rb

@@ -0,0 +1,61 @@
+require 'speq/match'
+
+# The Test class is a simple implementation of unit test block
+module Speq
+  class Test
+    attr_reader :method, :reciever, :report
+
+    def initialize(method_symbol, class_name = Object, &block)
+      @method = method_symbol
+      @reciever = class_name
+      @units = []
+
+      instance_eval(&block)
+      print_report
+    end
+
+    def given(*args, match:)
+      args.each do |arg|
+        return_value = reciever.send(method, *arg)
+
+        @units << Match.new(return_value, :eql?, arg, match)
+      end
+    end
+
+    def on(*receivers, match:)
+      receivers.each do |receiver|
+        return_value = receiver.send(method)
+
+        @units << Match.new(return_value, :eql?, arg, match)
+      end
+    end
+
+    def passed?
+      @units.all?(&:passed?)
+    end
+
+    def print_report
+      report_string = "Testing: #{method}\n"
+
+      @units.each do |one_test|
+        if one_test.passed?
+          outcome_text = 'PASSED'
+          color = :green
+        else
+          outcome_text = 'FAILED'
+          color = :red
+        end
+
+        indent = ' ' * @method.to_s.length
+
+        report_string <<
+          ["\n#{outcome_text} when given: #{one_test.args}\n".colorize(color),
+           "        returned: #{one_test.actual}\n".colorize(color),
+           "        expected: #{one_test.expected}\n".colorize(color)].join
+      end
+      puts report_string
+
+      passed?
+    end
+  end
+end

data/lib/speq/version.rb

@@ -0,0 +1,3 @@
+module Speq
+  VERSION = '0.2.0'.freeze
+end

data/lib/speq.rb

@@ -0,0 +1,13 @@
+require 'speq/version'
+require 'speq/test'
+require 'speq/match'
+require 'speq/fake'
+require 'speq/cli'
+
+module Speq
+  module_function
+
+  def does(subject, &block)
+    Test.new(subject, self, &block).report
+  end
+end

data/speq.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'speq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'speq'
+  spec.version       = Speq::VERSION
+  spec.authors       = ['zaniar moradian']
+  spec.email         = ['moradianzaniar@gmail.com']
+
+  spec.summary       = 'A tiny library to build specs with fewer words.'
+  spec.homepage      = 'https://github.com/znrm/speq'
+  spec.license       = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = ['speq']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
+
+  spec.add_dependency 'colorize', '~> 0.8.1'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: speq
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- zaniar moradian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: 
+email:
+- moradianzaniar@gmail.com
+executables:
+- speq
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/speq
+- lib/speq.rb
+- lib/speq/cli.rb
+- lib/speq/fake.rb
+- lib/speq/match.rb
+- lib/speq/test.rb
+- lib/speq/version.rb
+- speq.gemspec
+homepage: https://github.com/znrm/speq
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A tiny library to build specs with fewer words.
+test_files: []