elliottcable-speck 0

data/.manifest

@@ -0,0 +1,8 @@
+lib/speck/check.rb
+lib/speck/core_ext/check_mixins.rb
+lib/speck/core_ext.rb
+lib/speck.rake
+lib/speck.rb
+Rakefile.rb
+README.markdown
+.manifest

data/README.markdown

@@ -0,0 +1,3 @@
+Speck
+=====
+Specs… supah–light.

data/Rakefile.rb

@@ -0,0 +1,89 @@
+($:.unshift File.expand_path(File.join( File.dirname(__FILE__), 'lib' ))).uniq!
+require 'speck'
+
+# =======================
+# = Gem packaging tasks =
+# =======================
+begin
+  require 'echoe'
+  
+  task :install => :'package:install'
+  task :package => :'package:package'
+  task :manifest => :'package:manifest'
+  namespace :package do
+    Echoe.new('speck', Speck::Version) do |g|
+      g.project = 'speck'
+      g.author = ['elliottcable']
+      g.email = ['Speck@elliottcable.com']
+      g.summary = "Supah-light 'n sexy specking!"
+      g.url = 'http://github.com/elliottcable/speck'
+      g.runtime_dependencies = []
+      g.development_dependencies = ['echoe >= 3.0.2']
+      g.manifest_name = '.manifest'
+      g.retain_gemspec = true
+      g.rakefile_name = 'Rakefile.rb'
+      g.ignore_pattern = /^\.git\/|^meta\/|\.gemspec/
+    end
+  end
+  
+rescue LoadError
+  desc 'You need the `echoe` gem to package Speck'
+  task :package
+end
+
+# ===============
+# = Speck tasks =
+# ===============
+begin
+  # require 'speck'
+  
+  task :default => :'speck:run'
+  task :speck => :'speck:run'
+  namespace :speck do
+    load 'speck.rake'
+  end
+  
+rescue LoadError
+  desc 'You need the `speck` gem to run specks'
+  task :speck
+end
+
+# =======================
+# = Documentation tasks =
+# =======================
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  
+  task :documentation => :'documentation:generate'
+  namespace :documentation do
+    YARD::Rake::YardocTask.new :generate do |t|
+      t.files   = ['lib/**/*.rb']
+      t.options = ['--output-dir', File.join('meta', 'documentation'),
+                   '--readme', 'README.markdown',
+                   '--markup', 'markdown', '--markup-provider', 'maruku']
+    end
+    
+    YARD::Rake::YardocTask.new :dotyardoc do |t|
+      t.files   = ['lib/**/*.rb']
+      t.options = ['--no-output',
+                   '--readme', 'README.markdown',
+                   '--markup', 'markdown', '--markup-provider', 'maruku']
+    end
+    
+    task :open do
+      system 'open ' + File.join('meta', 'documentation', 'index.html') if RUBY_PLATFORM['darwin']
+    end
+  end
+  
+rescue LoadError
+  desc 'You need the `yard` and `maruku` gems to generate documentation'
+  task :documentation
+end
+
+desc 'Check everything over before commiting'
+task :aok => [:'documentation:generate', :'documentation:open',
+              :'package:manifest',
+              :'speck:run']
+
+task :ci => [:'documentation:generate', :'speck:run']

data/lib/speck.rake

@@ -0,0 +1,27 @@
+def ansi text, code
+  "\033[#{code}#{text}\033[0m"
+end
+
+def red text; ansi(text, "31m") end
+def green text; ansi(text, "32m") end
+
+desc 'Recursively runs all root specks'
+task :run do
+  roots = Speck::specks.select {|s| s.parent == nil }
+  
+  playback = lambda do |speck|
+    speck.execute
+    speck.checks.each do |check|
+      begin
+        check.execute
+        puts check.description.ljust(72) + green(" # => " + check.status.inspect)
+      rescue Speck::Exception::CheckFailed
+        # TODO: Print a description of why the error failed, what was expected
+        #       and what was actually received.
+        puts check.description.ljust(72) + red(" # !  " + check.status.inspect)
+      end
+    end
+    speck.children.each &playback
+  end
+  roots.each &playback
+end

data/lib/speck.rb

@@ -0,0 +1,83 @@
+# All library files are required at the bottom, because in this unique case we
+# need `Speck` defined before we can use it to `Speck` anything.
+
+class Speck
+  Version = 0
+  
+  class <<self
+    
+    ##
+    # All defined Specks.
+    attr_accessor :specks
+    def specks; @specks ||= Array.new; end
+    
+    ##
+    # The current stack of nested `Speck`s.
+    # 
+    # @see #current
+    attr_accessor :stack
+    def stack; @stack ||= Array.new; end
+    
+    ##
+    # Returns the currently active `Speck`.
+    # 
+    # When your `Speck`s are being run, there is a `stack` of `Speck` objects,
+    # consisting of the current nesting list of `Speck`s being run.
+    def current
+      stack.last
+    end
+  end
+  
+  ##
+  # The block to be executed
+  attr_accessor :speck
+  
+  ##
+  # Child `Speck`s
+  attr_accessor :children
+  def children; @children ||= Array.new; end
+  
+  ##
+  # Parent `Speck`
+  attr_accessor :parent
+  
+  ##
+  # The checks involved in the current `Speck`.
+  attr_accessor :checks
+  def checks; @checks ||= Array.new; end
+  
+  ##
+  # Creates a new `Speck`.
+  def initialize *targets, &speck
+    @speck = speck
+    @parent = Speck.current
+    
+    @parent.children << self if @parent
+    Speck.specks << self
+  end
+  
+  ##
+  # Executes the `Speck`.
+  def execute
+    Speck::Mixins::mixin!
+    
+    Speck.stack << self
+    speck.call
+    Speck.stack.pop
+  end
+  
+  
+  ##
+  # A root class, and container class, for `Speck` exceptions.
+  class Exception < StandardError
+    # Raised any time checks are run outside of a `Speck`
+    NoEnvironment = Class.new self
+    
+    # Raised when a `Check` fails
+    CheckFailed = Class.new self
+  end
+  
+end
+
+require 'speck/core_ext'
+require 'speck/check'

data/lib/speck/check.rb

@@ -0,0 +1,70 @@
+class Speck
+  ##
+  # Represents a queued thing to be checked of some sort, within a `Speck`.
+  class Check
+    ##
+    # A block to be executed.
+    attr_accessor :lambda
+    
+    ##
+    # A description for the check. Usually a relevant line of code.
+    attr_accessor :description
+    
+    ##
+    # The status of the `Check`. `nil` indicates the `Check` hasn’t been
+    # executed, and `true` or `false` indicate the success of the latest
+    # execution.
+    attr_accessor :status
+    
+    ##
+    # Checks the truthiness of this `Check`’s `status`.
+    def success?
+      !!status
+    end
+    Speck.new :status do
+      object = Object.new
+      Check.new(->{true}).execute.status
+        .check {|s| s == true}
+      Check.new(->{object}).execute.status
+        .check {|s| s == object}
+      
+      Check.new(->{true}).execute.success?.check
+      Check.new(->{object}).execute.success?.check
+      
+      Check.new(->{false}).tap {|c| c.execute rescue nil } .status
+        .check {|s| s == false}
+      Check.new(->{nil}).tap {|c| c.execute rescue nil } .status
+        .check {|s| s == false}
+    end
+    
+    def initialize(lambda, description = "<undocumented>")
+      @lambda = lambda
+      @description = description
+    end
+    Speck.new Check, :new do
+      my_lambda = ->{}
+      Check.new(my_lambda).lambda.check {|l| l == my_lambda }
+      
+      Check.new(->{}, "WOO! BLANK CHECK!").description
+        .check {|d| d == "WOO! BLANK CHECK!" }
+    end
+    
+    ##
+    # Executes this `Check`, raising an error if the block returns nil or
+    # false.
+    def execute
+      @lambda.call.tap {|result| @status = result ? result : false }
+      raise Exception::CheckFailed unless success?
+      self
+    end
+    Speck.new :execute do
+      Check.new(->{true}).execute.check {|c| c.success? }
+      ->{ Check.new(->{false}).execute }
+        .check_exception Speck::Exception::CheckFailed
+      
+      Check.new(->{"value"}).execute.check
+      Check.new(->{2 * 2}).execute.check {|value| value == 4 }
+    end
+    
+  end
+end

data/lib/speck/core_ext.rb

@@ -0,0 +1 @@
+require 'speck/core_ext/check_mixins'

data/lib/speck/core_ext/check_mixins.rb

@@ -0,0 +1,74 @@
+class Speck
+  ##
+  # These methods, when mixed into their respective classes, provide some
+  # conveniences when it comes to creating `Check`s.
+  module Mixins
+    
+    ##
+    # This method will quickly mix all of our `Mixins` into their respective
+    # targets.
+    def self.mixin!
+      Speck::Mixins.constants
+        .map {|mod| Speck::Mixins.const_get(mod) }
+        .each {|mod| mod::Target.send :include, mod }
+    end
+    
+    module Object; Target = ::Object
+      ##
+      # This method is responsible for running some sort of test on the
+      # receiver.
+      # 
+      # It expects a block (returning true or false) to be passed. The block
+      # will be passed the receiver, so you can run comparators on it, or
+      # whatever else you like.
+      # 
+      # `#check` can also be called without block on truthy objects (`true`,
+      # `false`, or `nil`, any other object will be treated as `true`)
+      def check &check
+        check = ->(_){self} unless block_given?
+        
+        # TODO: Should we allow specks in the root environment? Could be useful
+        #       for quick checks…
+        raise Exception::NoEnvironment unless Speck.current
+        
+        file, line, _ = Kernel::caller.first.split(':')
+        source = File.open(file).readlines[line.to_i - 1]
+        source.strip!
+        source = source.partition(".check").first
+        # TODO: Get rid of the "(…)" around the resulting string.
+        
+        Speck::Check.new(->(){ check[self] }, source)
+          .tap {|check| Speck.current.checks << check }
+      end
+    end
+    
+    module Proc; Target = ::Proc
+      
+      ##
+      # This method is responsible for checking that a particular proc raises
+      # a particular exception type when called.
+      def check_exception exception = Exception
+        # TODO: Should we allow specks in the root environment? Could be useful
+        #       for quick checks…
+        raise Exception::NoEnvironment unless Speck.current
+        
+        file, line, _ = Kernel::caller.first.split(':')
+        source = File.open(file).readlines[line.to_i - 1]
+        source.strip!
+        source = source.partition(".check_exception").first
+        # TODO: Get rid of the "->{…}" around the resulting string.
+        
+        Speck.current.checks <<
+          Speck::Check.new(->(){
+            begin
+              self.call
+            rescue exception
+              return true
+            end
+            return false
+          }, source)
+      end
+      
+    end
+  end
+end

data/speck.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{speck}
+  s.version = "0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["elliottcable"]
+  s.date = %q{2009-08-03}
+  s.description = %q{Supah-light 'n sexy specking!}
+  s.email = ["Speck@elliottcable.com"]
+  s.extra_rdoc_files = ["lib/speck/check.rb", "lib/speck/core_ext/check_mixins.rb", "lib/speck/core_ext.rb", "lib/speck.rake", "lib/speck.rb", "README.markdown"]
+  s.files = ["lib/speck/check.rb", "lib/speck/core_ext/check_mixins.rb", "lib/speck/core_ext.rb", "lib/speck.rake", "lib/speck.rb", "Rakefile.rb", "README.markdown", ".manifest", "speck.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/elliottcable/speck}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Speck", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{speck}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Supah-light 'n sexy specking!}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0", "= 3.0.2"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0", "= 3.0.2"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0", "= 3.0.2"])
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: elliottcable-speck
+version: !ruby/object:Gem::Version 
+  version: "0"
+platform: ruby
+authors: 
+- elliottcable
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.0.2
+    version: 
+description: Supah-light 'n sexy specking!
+email: 
+- Speck@elliottcable.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/speck/check.rb
+- lib/speck/core_ext/check_mixins.rb
+- lib/speck/core_ext.rb
+- lib/speck.rake
+- lib/speck.rb
+- README.markdown
+files: 
+- lib/speck/check.rb
+- lib/speck/core_ext/check_mixins.rb
+- lib/speck/core_ext.rb
+- lib/speck.rake
+- lib/speck.rb
+- Rakefile.rb
+- README.markdown
+- .manifest
+- speck.gemspec
+has_rdoc: true
+homepage: http://github.com/elliottcable/speck
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Speck
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: speck
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Supah-light 'n sexy specking!
+test_files: []
+