m-spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92375890d1da886c3ae53626b708eba8d93d00076dabd9dc9f2282f67d860032
+  data.tar.gz: 62918be644fb75c3d5831c2884cfdf6099203c59cc31bce3129a1566d4b2c6f6
+SHA512:
+  metadata.gz: 332454bdef60665103d66612748d42b9a6bd1af25c96228ae2b0009c236af8871f1d809100ad20905ef4d217ef65e9ecc9a64be6a35a88aab21579447cf59680
+  data.tar.gz: ae2b63dac9719375fa1bc286c43b0b9410ec9cc1e5a08c350301da9aa08e1f8032987315eb62a5f6f2d925cbb8d5a5dfb2133b79b1b0aab89d78930824340725

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dearshrewdwit@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 mspec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Edward Withers
+
+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,90 @@
+# Mspec
+
+The lightest-weight spec framework in ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mspec
+
+## Usage
+
+We care about isolating unit tests, so there's a very simple mocking library.
+
+```ruby
+# source code
+class Animal
+  def roar
+    "ROAAAARRRR!"
+  end
+end
+
+# test code
+describe 'The Animal' do
+  it 'can roar' do
+    animal = Animal.new
+    expect(animal.roar).to eq "ROAAAARRRR!"
+  end
+
+  it 'gives a lovely red when it fails' do
+    animal = Animal.new
+    expect(animal.roar).to eq "little roar!"
+  end
+end
+
+describe 'stubbing' do
+  it 'we can mock too!' do
+    mock = test_double
+    allow(mock).to receive(:speak) { 'Hello!' }
+    expect(mock.speak).to eq 'Hello!'
+  end
+end
+```
+
+To run your specs, pass the spec file directly as an argument. You have to run individual spec files.
+
+```sh
+$ mspec ./spec/animal_spec.rb
+```
+
+```
+The Animal
+  returns a string
+  fails nicely
+  /path/to/directory/app/spec/animal_spec.rb:11:in block (2 levels) in <top (required)>'
+stubbing
+  we can mock too!
+```
+
+It's got simple one-level indentation and simple colour coding for test passes and failures. Failures will give you only the spec file path and line number.
+
+Remember - you'll have to manage test setup and test cleanup yourself, while keeping your test code dry also yourself. Make sure each test runs in isolation.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dearshrewdwit/mspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mspec project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dearshrewdwit/mspec/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mspec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/m-spec

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'm-spec'
+
+spec_file = ARGV[0]
+require spec_file

data/lib/m-spec.rb

@@ -0,0 +1,12 @@
+require "m-spec/version"
+
+require "m-spec/core/expect"
+require "m-spec/core/spec_error"
+require "m-spec/core/spec_result"
+require "m-spec/core/matchers/equal"
+require "m-spec/core/helpers/readable"
+
+require "m-spec/mocks/allow"
+require "m-spec/mocks/mock"
+require "m-spec/mocks/stub"
+require "m-spec/mocks/helpers/readable"

data/lib/m-spec/core/expect.rb

@@ -0,0 +1,17 @@
+module Mspec
+  class Expect
+    def initialize(value)
+      @value = value
+    end
+
+    def to(matcher)
+      begin
+        raise SpecError.new unless matcher.check(@value)
+      rescue SpecError => e
+        data = e
+      end
+
+      SpecResult.new(data)
+    end
+  end
+end

data/lib/m-spec/core/helpers/readable.rb

@@ -0,0 +1,29 @@
+COLOUR_CODES = {
+  true => 32,
+  false => 31
+}
+
+def describe(str)
+  puts str
+  yield
+end
+
+def it(str)
+  spec_result = yield
+  colour_code = COLOUR_CODES[spec_result.success?]
+  puts "  \e[#{colour_code}m#{str}\e[0m"
+  unless spec_result.success?
+    spec_result.simple_stack_trace.each do |stackline|
+      puts "  \e[#{colour_code}m#{stackline}\e[0m"
+    end
+  end
+end
+
+
+def expect(obj)
+  Mspec::Expect.new(obj)
+end
+
+def eq(obj)
+  Mspec::Matchers::Equal.new(obj)
+end

data/lib/m-spec/core/matchers/equal.rb

@@ -0,0 +1,13 @@
+module Mspec
+  module Matchers
+    class Equal
+      def initialize(value)
+        @value = value
+      end
+
+      def check(value)
+        @value == value
+      end
+    end
+  end
+end

data/lib/m-spec/core/spec_error.rb

@@ -0,0 +1,4 @@
+module Mspec
+  class SpecError < StandardError
+  end
+end

data/lib/m-spec/core/spec_result.rb

@@ -0,0 +1,15 @@
+module Mspec
+  class SpecResult
+    def initialize(error)
+      @error = error
+    end
+
+    def success?
+      !@error
+    end
+
+    def simple_stack_trace
+      [@error.backtrace[1]]
+    end
+  end
+end

data/lib/m-spec/mocks/allow.rb

@@ -0,0 +1,13 @@
+module Mspec
+  module Mocks
+    class Allow
+      def initialize(obj)
+        @obj = obj
+      end
+
+      def to(stub)
+        @obj.define_singleton_method(stub.name) { stub.return_value }
+      end
+    end
+  end
+end

data/lib/m-spec/mocks/helpers/readable.rb

@@ -0,0 +1,11 @@
+def test_double(name = 'anonymous')
+  Mspec::Mocks::Mock.new(name)
+end
+
+def allow(obj)
+  Mspec::Mocks::Allow.new(obj)
+end
+
+def receive(method, &block)
+  Mspec::Mocks::Stub.new(method, block.call)
+end

data/lib/m-spec/mocks/mock.rb

@@ -0,0 +1,9 @@
+module Mspec
+  module Mocks
+    class Mock
+      def initialize(name)
+        @name = name
+      end
+    end
+  end
+end

data/lib/m-spec/mocks/stub.rb

@@ -0,0 +1,12 @@
+module Mspec
+  module Mocks
+    class Stub
+      attr_reader :name, :return_value
+
+      def initialize(name, return_value)
+        @name = name
+        @return_value = return_value
+      end
+    end
+  end
+end

data/lib/m-spec/version.rb

@@ -0,0 +1,3 @@
+module Mspec
+  VERSION = "0.1.0"
+end

data/m-spec.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "m-spec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "m-spec"
+  spec.version       = Mspec::VERSION
+  spec.authors       = ["Edward Withers"]
+  spec.email         = ["dearshrewdwit@gmail.com"]
+
+  spec.summary       = %q{The lightest-weight testing framework in Ruby}
+  spec.description   = %q{A testing framework designed both for beginners to reduce the complexity and for experts who want a barebones framework.}
+  spec.homepage      = "https://github.com/dearshrewdwit/m-spec"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: m-spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Edward Withers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+description: A testing framework designed both for beginners to reduce the complexity
+  and for experts who want a barebones framework.
+email:
+- dearshrewdwit@gmail.com
+executables:
+- m-spec
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/m-spec
+- lib/m-spec.rb
+- lib/m-spec/core/expect.rb
+- lib/m-spec/core/helpers/readable.rb
+- lib/m-spec/core/matchers/equal.rb
+- lib/m-spec/core/spec_error.rb
+- lib/m-spec/core/spec_result.rb
+- lib/m-spec/mocks/allow.rb
+- lib/m-spec/mocks/helpers/readable.rb
+- lib/m-spec/mocks/mock.rb
+- lib/m-spec/mocks/stub.rb
+- lib/m-spec/version.rb
+- m-spec.gemspec
+homepage: https://github.com/dearshrewdwit/m-spec
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: The lightest-weight testing framework in Ruby
+test_files: []