catechism 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9db9fd7efc9a513e2ead19f022759e11fbd9eb5
+  data.tar.gz: 46a5bef2912e4223340f1ab8d177a8d4641f9055
+SHA512:
+  metadata.gz: d54c417d7f68b765f8ca307d4629249fa93a40f2724b6450aa16d48f754bb6b50c8ce354e400199767f9b6f1fcc2b8b8abeab74c06cb545a660e4c71ef9f4e3a
+  data.tar.gz: d504e27f538c3118329ca69ed43bc29d6a4f41a88aec45c57bcddca3e562a3405265c1f619afd13abd7a5c68c3339be51454dbd1a1093ad6025784994b21f54b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+catechism

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p353

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+guard :shell do
+  watch(/^trials\/(.*)_trial\.rb/) {|m| `bin/catechism run_trial #{m[0]}` }
+  watch(/^(lib\/.*)\.rb/) {|m| `bin/catechism run_trial trials/#{m[1]}_trial.rb` }
+end

data/README.md

@@ -0,0 +1,49 @@
+Catechism
+=========
+
+Catechism is a very small test framework for Ruby.
+
+
+Prerequisites
+-------------
+
+* Ruby 2.0.0
+* A Unix environment
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'catechism'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install catechism
+
+
+Usage
+-----
+
+Create a `trials` directory in the root of your project.
+
+Create files in any path underneath it ending in `_trial.rb`.  Examples can be found in `trials/lib/catechism`.
+
+Then, run your test suite:
+
+    $ catechism
+
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/catechism

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "catechism"
+Catechism::Cli.start

data/catechism.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'catechism/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'catechism'
+  spec.version       = Catechism::VERSION
+  spec.authors       = ['Doc Ritezel and Sarah Mei']
+  spec.email         = ['pair+doc+sarah@ministryofvelocity.com']
+  spec.description   = 'An object-oriented testing framework'
+  spec.summary       = 'Put your code through an object-oriented trial by fire.'
+  spec.homepage      = 'https://github.com/aosabook/500lines/catechism'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^trials/})
+  spec.require_paths = ['lib']
+  spec.bindir        = 'bin'
+
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'gem-release'
+  spec.add_development_dependency 'guard-shell'
+end

data/lib/catechism.rb

@@ -0,0 +1,5 @@
+require "catechism/version"
+require "core_ext/object"
+require "catechism/describe_block"
+require "catechism/subject_wrapper"
+require "catechism/cli"

data/lib/catechism/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+
+class Catechism::Cli < Thor
+  desc 'run_trial TRIAL', 'Run the given trial'
+  def run_trial(trial_path)
+    Kernel.system("bundle exec ruby #{trial_path}") && puts("#{trial_path} was successful.")
+  end
+
+  desc 'run_all_trials', 'Run all trials in the current path'
+  def run_all_trials
+    Dir.glob('trials/**/*_trial.rb') { |trial_path| run_trial(trial_path) }
+  end
+
+  default_task :run_all_trials
+end

data/lib/catechism/describe_block.rb

@@ -0,0 +1,7 @@
+require "catechism/it_block"
+
+class Catechism::DescribeBlock < Struct.new(:description)
+  def it(description, &block)
+    Catechism::ItBlock.new(description, self).instance_eval(&block) if block_given?
+  end
+end

data/lib/catechism/it_block.rb

@@ -0,0 +1,6 @@
+class Catechism::ItBlock < Struct.new(:description, :current_context)
+  def expect(subject = nil, &block)
+    subject = block if block_given?
+    Catechism::SubjectWrapper.new(subject)
+  end
+end

data/lib/catechism/matchers/equal.rb

@@ -0,0 +1,21 @@
+module Catechism
+  module Matchers
+    class Equal < Struct.new(:subject, :expectation, :negated)
+      def equal?
+        subject == expectation
+      end
+
+      def valid?
+        equal? ^ negated
+      end
+
+      def failure_message
+        if negated
+          "#{subject} equals #{expected}"
+        else
+          "#{subject} does not equal #{expected}"
+        end
+      end
+    end
+  end
+end

data/lib/catechism/matchers/raise_error.rb

@@ -0,0 +1,24 @@
+module Catechism::Matchers
+  class RaiseError < Struct.new(:subject, :negated)
+    def raised?
+      begin
+        subject.call
+      rescue StandardError => e
+        return true
+      end
+      false
+    end
+
+    def valid?
+      raised? ^ negated
+    end
+
+    def failure_message
+      if negated
+        "Expected no error to be raised, but an error was raised"
+      else
+        "Expected error to be raised, but no error was raised"
+      end
+    end
+  end
+end

data/lib/catechism/matchers/send.rb

@@ -0,0 +1,37 @@
+module Catechism::Matchers
+  class Send < Struct.new(:subject, :method_name, :negated)
+    attr_reader :destination, :arguments
+
+    def to(destination)
+      @destination = destination
+      raise failure_message unless valid?
+    end
+
+    def with(*arguments)
+      @arguments = arguments
+      self
+    end
+
+    def valid?
+      called = false
+      send_matcher = self
+      destination.class.send(:define_method, method_name) do |*args|
+        if !send_matcher.arguments.nil?
+          called = send_matcher.arguments == args
+        else
+          called = true
+        end
+      end
+      subject.call
+      called ^ negated
+    end
+
+    def failure_message
+      if negated
+        "Expected #{destination} not to receive #{method_name}, but got it anyway"
+      else
+        "Expected #{method_name} on #{destination}, but was not received"
+      end
+    end
+  end
+end

data/lib/catechism/subject_wrapper.rb

@@ -0,0 +1,31 @@
+require 'catechism/matchers/equal'
+require 'catechism/matchers/raise_error'
+require 'catechism/matchers/send'
+
+class Catechism::SubjectWrapper < Struct.new(:subject)
+  attr_reader :negated
+
+  def to_equal(expected)
+    matcher = Catechism::Matchers::Equal.new(subject, expected, negated)
+    raise matcher.failure_message unless matcher.valid?
+  end
+
+  def to_be_nil
+    matcher = Catechism::Matchers::Equal.new(subject, nil, negated)
+    raise matcher.failure_message unless matcher.valid?
+  end
+
+  def to_raise_error
+    matcher = Catechism::Matchers::RaiseError.new(subject, negated)
+    raise matcher.failure_message unless matcher.valid?
+  end
+
+  def to_send(method_name)
+    Catechism::Matchers::Send.new(subject, method_name, negated)
+  end
+
+  def not
+    @negated = true
+    self
+  end
+end

data/lib/catechism/version.rb

@@ -0,0 +1,3 @@
+module Catechism
+  VERSION = "0.0.1"
+end

data/lib/core_ext/object.rb

@@ -0,0 +1,5 @@
+class Object
+  def describe(description, &block)
+    Catechism::DescribeBlock.new(description).instance_eval(&block) if block_given?
+  end
+end

data/trials/lib/catechism/cli_trial.rb

@@ -0,0 +1,4 @@
+require 'catechism'
+
+describe Catechism::Cli do
+end

data/trials/lib/catechism/context_trial.rb

@@ -0,0 +1,7 @@
+require 'catechism'
+
+describe 'using contexts' do
+  it 'lets you group tests with describes' do
+    expect(current_context.description).to_equal('using contexts')
+  end
+end

data/trials/lib/catechism/matcher_trial.rb

@@ -0,0 +1,42 @@
+require 'catechism'
+
+describe 'using catechism matchers' do
+  class Harness; end
+
+  it 'lets you test equality' do
+    expect(1).to_equal(1)
+    expect(2).not.to_equal(1)
+  end
+
+  it 'lets you test nilness' do
+    expect(nil).to_be_nil
+    expect(1).not.to_be_nil
+  end
+
+  it 'lets you test exception raising' do
+    expect { raise 'hands' }.to_raise_error
+    expect { 3 + 1 }.not.to_raise_error
+  end
+
+  it 'lets you test that an instance receives a message' do
+    tacos = Harness.new
+    expect { tacos.sauce }.to_send(:sauce).to(tacos)
+    expect { tacos.to_s }.not.to_send(:sauce).to(tacos)
+  end
+
+  it 'lets you test that a class receives a message' do
+    expect { Harness.to_s }.to_send(:to_s).to(Harness)
+    expect { Harness.inspect }.not.to_send(:to_s).to(Harness)
+  end
+
+  it 'lets you test that an instance receives a message with arguments' do
+    pants = Object.new
+    expect {
+      pants.tuck_into('socks')
+    }.to_send(:tuck_into).with('socks').to(pants)
+
+    expect {
+      pants.tuck_into('ears')
+    }.not.to_send(:tuck_into).with('socks').to(pants)
+  end
+end

data/trials/line_trial.rb

@@ -0,0 +1,16 @@
+require 'catechism'
+
+describe 'the number of lines' do
+  it 'stays under 500' do
+    lib_files = Dir.glob(File.expand_path('../../lib/**/*.rb', __FILE__))
+    bin_files = Dir.glob(File.expand_path('../../bin/*', __FILE__))
+    trial_files = Dir.glob(File.expand_path('../../trials/**/*.rb', __FILE__))
+
+    lines = (lib_files + bin_files + trial_files).reduce(0) do |line_count, filename|
+      line_count + IO.readlines(filename).size
+    end
+
+    expect(lines < 500).to_equal(true)
+    puts "Current number of lines is #{lines}"
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: catechism
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Doc Ritezel and Sarah Mei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  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: guard-shell
+  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: An object-oriented testing framework
+email:
+- pair+doc+sarah@ministryofvelocity.com
+executables:
+- catechism
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Guardfile
+- README.md
+- bin/catechism
+- catechism.gemspec
+- lib/catechism.rb
+- lib/catechism/cli.rb
+- lib/catechism/describe_block.rb
+- lib/catechism/it_block.rb
+- lib/catechism/matchers/equal.rb
+- lib/catechism/matchers/raise_error.rb
+- lib/catechism/matchers/send.rb
+- lib/catechism/subject_wrapper.rb
+- lib/catechism/version.rb
+- lib/core_ext/object.rb
+- trials/lib/catechism/cli_trial.rb
+- trials/lib/catechism/context_trial.rb
+- trials/lib/catechism/matcher_trial.rb
+- trials/line_trial.rb
+homepage: https://github.com/aosabook/500lines/catechism
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Put your code through an object-oriented trial by fire.
+test_files:
+- trials/lib/catechism/cli_trial.rb
+- trials/lib/catechism/context_trial.rb
+- trials/lib/catechism/matcher_trial.rb
+- trials/line_trial.rb