elliottcable-slack 0

data/.manifest

@@ -0,0 +1,4 @@
+lib/slack.rb
+Rakefile.rb
+README.markdown
+.manifest

data/README.markdown

@@ -0,0 +1,5 @@
+Slack
+=====
+Convenience magic for [Speck][] (<http://Speck.im/>).
+
+  [Speck]: http://github.com/elliottcable/Speck "Speck on GitHub"

data/Rakefile.rb

@@ -0,0 +1,89 @@
+($:.unshift File.expand_path(File.join( File.dirname(__FILE__), 'lib' ))).uniq!
+require 'slack'
+
+# =======================
+# = Gem packaging tasks =
+# =======================
+begin
+  require 'echoe'
+  
+  task :install => :'package:install'
+  task :package => :'package:package'
+  task :manifest => :'package:manifest'
+  namespace :package do
+    Echoe.new('slack', Slack::Version) do |g|
+      g.project = 'speck'
+      g.author = ['elliottcable']
+      g.email = ['Slack@elliottcable.com']
+      g.summary = "Magic makes everybody's life a little easier, no?"
+      g.url = 'http://github.com/elliottcable/Slack'
+      g.runtime_dependencies = ['speck']
+      g.development_dependencies = ['echoe >= 3.0.2', 'speck', 'yard', 'maruku']
+      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 Slack'
+  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/slack.rb

@@ -0,0 +1,91 @@
+##
+# Methods in `Slack` are provided with the purpose of making it simpler (and
+# sexier!) to create `Speck::Check`s.
+module Slack
+  Version = 0
+  
+  ##
+  # These modules (named after the Class they are intended to be mixed into)
+  # provide convenience methods on those classes.
+  module Mixins
+    
+    module Object
+      ##
+      # This method creates a new `Speck::Check` utilizing a passed block.
+      # 
+      # 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.
+      # 
+      # The intention is that this method be used to quickly check that
+      # particular methods return values as expected. For instance, the
+      # following would be used to check that MyClass#initialize properly
+      # assigns its argument to the `thingie` attribute:
+      #     
+      #     MyClass.new(an_object).check {|my| my.thingie == an_object }
+      #     
+      # The new `Check` instance is automatically documented with the contents
+      # of the line of Ruby that produced the receiver of this method.
+      # --
+      # TODO: Speck Object#check
+      # TODO: Remove the `->{self}` functionality, and implement Mixins::Truthy
+      #       for TrueClass/FalseClass/NilClass
+      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
+        
+        # TODO: Implement documenting the `Check` using a preceding comment,
+        #       if present.
+        # TODO: Move this into its own methods deeper in the library, and
+        # clean it up.
+        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.
+        # TODO: Implement multi–line source documenting.
+        
+        Speck::Check.new(->(){ check[self] }, source)
+          .tap {|check| Speck.current.checks << check }
+      end
+    end
+    ::Object.send :include, Slack::Mixins::Object
+    
+    module Proc
+      ##
+      # This method creates a new `Speck::Check` initialized to pass if the
+      # receiver can be executed without `exception` being raised, or fail if
+      # the receiver raises `exception` when raised.
+      # 
+      # The passed exception object will be `rescue`d from within the block,
+      # but any other exception raised by the block will not be caught.
+      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::Check.new(->(){
+          begin
+            self.call
+          rescue exception
+            return true
+          end
+          return false
+        }, source)
+          .tap {|check| Speck.current.checks << check }
+      end
+    end
+    ::Proc.send :include, Slack::Mixins::Proc
+    
+  end
+  
+end

data/slack.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{slack}
+  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-04}
+  s.description = %q{Magic makes everybody's life a little easier, no?}
+  s.email = ["Slack@elliottcable.com"]
+  s.extra_rdoc_files = ["lib/slack.rb", "README.markdown"]
+  s.files = ["lib/slack.rb", "Rakefile.rb", "README.markdown", ".manifest", "slack.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/elliottcable/Slack}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Slack", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{speck}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Magic makes everybody's life a little easier, no?}
+
+  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_runtime_dependency(%q<speck>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0", "= 3.0.2"])
+      s.add_development_dependency(%q<speck>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<maruku>, [">= 0"])
+    else
+      s.add_dependency(%q<speck>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0", "= 3.0.2"])
+      s.add_dependency(%q<speck>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<maruku>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<speck>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0", "= 3.0.2"])
+    s.add_dependency(%q<speck>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<maruku>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: elliottcable-slack
+version: !ruby/object:Gem::Version 
+  version: "0"
+platform: ruby
+authors: 
+- elliottcable
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-04 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: speck
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !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: 
+- !ruby/object:Gem::Dependency 
+  name: speck
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Magic makes everybody's life a little easier, no?
+email: 
+- Slack@elliottcable.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/slack.rb
+- README.markdown
+files: 
+- lib/slack.rb
+- Rakefile.rb
+- README.markdown
+- .manifest
+- slack.gemspec
+has_rdoc: true
+homepage: http://github.com/elliottcable/Slack
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Slack
+- --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: Magic makes everybody's life a little easier, no?
+test_files: []
+