lookout-rake 3.0.0

data/README

@@ -0,0 +1,66 @@
+                                 Lookout-Rake
+
+  Lookout-Rake provides Rake tasks for testing using Lookout.
+
+§ Installation
+
+    Install Lookout-Rake with
+
+    % gem install lookout
+
+§ Usage
+
+    Include the following code in your ‹Rakefile›:
+
+      require 'lookout/rake-3.0'
+
+      Lookout::Rake::Tasks::Test.new
+
+    If the ‹:default› task hasn’t been defined it’ll be set to depend on the
+    ‹:test› task.  The ‹:check› task will also depend on the ‹:test› task.
+    There’s also a ‹:test:coverage› task that gets defined that uses the
+    coverage library that comes with Ruby 1.9 to check the test coverage when
+    the tests are run.
+
+    You can hook up your test task to use your Inventory¹:
+
+      require 'library/version.rb'
+
+      Lookout::Rake::Tasks::Test.new :inventory => Library::Version
+
+    Also, if you use the tasks that come with Inventory, the test task will
+    hook into the inventory you tell them to use automatically.
+
+    To use Lookout together with Vim², place ‹contrib/rakelookout.vim› in
+    ‹~/.vim/compiler› and add
+
+      compiler rakelookout
+
+    to ‹~/.vim/after/ftplugin/ruby.vim›.  Executing ‹:make› from inside Vim
+    will now run your tests and an errors and failures can be visited with
+    ‹:cnext›.  Execute ‹:help quickfix› for additional information.
+
+    Another useful addition to your ‹~/.vim/after/ftplugin/ruby.vim› file may
+    be
+
+      nnoremap <buffer> <silent> <Leader>M <Esc>:call <SID>run_test()<CR>
+      let b:undo_ftplugin .= ' | nunmap <buffer> <Leader>M'
+
+      function! s:run_test()
+        let test = expand('%')
+        let line = 'LINE=' . line('.')
+        if test =~ '^lib/'
+          let test = substitute(test, '^lib/', 'test/', '')
+          let line = ""
+        endif
+        execute 'make' 'TEST=' . shellescape(test) line
+      endfunction
+
+    Now, pressing ‹<Leader>M› will either run all tests for a given class, if
+    the implementation file is active, or run the test at or just before the
+    cursor, if the test file is active.  This is useful if you’re currently
+    receiving a lot of errors and/or failures and want to focus on those
+    associated with a specific class or on a specific test.
+
+¹ Get information on Inventory at http://disu.se/software/inventory/
+² Find out more about Vim at http://www.vim.org/

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+require 'inventory/rake-1.0'
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'lookout/rake-3.0'
+
+Inventory::Rake::Tasks.define Lookout::Rake::Version, :gem => proc{ |_, s|
+  s.author = 'Nikolai Weibull'
+  s.email = 'now@bitwi.se'
+  s.homepage = 'https://github.com/now/lookout-rake'
+}
+Lookout::Rake::Tasks::Test.new

data/lib/lookout/rake-3.0.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+
+# Namespace for Lookout.
+module Lookout end
+
+# Namespace for Rake integration of Lookout.
+module Lookout::Rake
+  load File.expand_path('../rake/version.rb', __FILE__)
+  Version.load
+end

data/lib/lookout/rake/tasks.rb

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+# Namespace for Rake tasks.
+module Lookout::Rake::Tasks
+end

data/lib/lookout/rake/tasks/test.rb

@@ -0,0 +1,170 @@
+# -*- coding: utf-8 -*-
+
+# Rake task for running expectation tests.
+class Lookout::Rake::Tasks::Test
+  include Rake::DSL
+
+  LoaderPath = File.join(File.dirname(__FILE__), 'test/loader.rb')
+  Paths = %w'lib'
+
+  # Defines a Rake task for running expectation tests named _:name_.  Also
+  # defines a task for running expectations with coverage name
+  # _:name_:coverage.  If _:name_ `#==` `:test`, then the default task is set
+  # to depend on it, unless the default task has already been defined, as well
+  # as the `:check` task.
+  #
+  # Optionally yields the _task_ being created so that it may be adjusted
+  # further before being defined.
+  # @param [Hash] options
+  # @option options [Symbol] :name (:test) The name of the task
+  # @option options [Array<String>] :paths (['lib']) The paths to add to
+  #   `$LOAD_PATH`
+  # @option options [Array<String>] :requires ([]) The libraries to require
+  # @option options [Array<String>] :files (FileList[ENV['TEST']]) The
+  #   expectation files to load
+  # @option options [Inventory] :inventory (Inventory::Rake::Tasks.inventory)
+  #   The Inventory to look for :paths, :requires, and :files in, see
+  #   {#inventory=} (the default is only used if `inventory/rake-1.0` has
+  #   been required)
+  # @option options [Gem::Specification] :specification The Gem specification
+  #   to look for :paths and :requires in, see {#specification=}
+  # @option options [Array<String>] :options (['-w']) The options to pass to
+  #   ruby
+  # @yield [?]
+  # @yieldparam [Test] task
+  def initialize(options = {})
+    self.name = options.fetch(:name, :test)
+    self.paths = options.fetch(:paths, Paths)
+    self.requires = options.fetch(:requires, [])
+    self.files = options.fetch(:files){ ENV.include?('TEST') ? FileList[ENV['TEST']] : nil }
+    inventory = options[:inventory] ||
+      (provided?('inventory/rake-1.0') and Inventory::Rake::Tasks.inventory) and
+      self.inventory = inventory
+    self.specification = options.fetch(:specification) if options.include? :specification
+    self.options = options.fetch(:options, %w'-w')
+    yield self if block_given?
+    define
+  end
+
+  # @return [Symbol] The name of the task
+  attr_reader :name
+
+  # @param [Symbol] value
+  # @return [Symbol] The new name of the task: _value_
+  attr_writer :name
+
+  # @return [Array<String>] The paths to add to `$LOAD_PATH`; may load
+  #   {#specification}
+  def paths
+    return @paths if @paths and not @paths.equal? Paths
+    self.specification = specification
+    @paths
+  end
+
+  # @param [Array<String>] value
+  # @return [Array<String>] The new paths to add to `$LOAD_PATH`: _value_
+  attr_writer :paths
+
+  # @return [Array<String>] The libraries to require; may load {#specification}
+  def requires
+    return @requires unless @requires.empty?
+    self.specification = specification
+    @requires
+  end
+
+  # @param [Array<String>] value
+  # @return [Array<String>] The new libraries to require: _value_
+  attr_writer :requires
+
+  # @return [Array<String>] The expectation files to load; defaults to
+  #   `FileList['test/unit/**/*.rb]`
+  def files
+    @files ||= FileList['test/unit/**/*.rb']
+  end
+
+  # @param [Array<String>] value
+  # @return [Array<String>] The new expectation files to load: _value_
+  attr_writer :files
+
+  # @return [Inventory] The inventory to use
+  attr_reader :inventory
+
+  # @param [Inventory] inventory
+  # @return [Inventory] The new inventory to use for {#paths}, {#requires}, and
+  #   {#files}: _inventory_
+  def inventory=(inventory)
+    self.paths = inventory.lib_directories
+    self.requires = [inventory.package_require]
+    @files ||= inventory.unit_test_files
+    inventory
+  end
+
+  # @return [Gem::Specification] The specification to use; will try to find one
+  #   by looking for `*.gemspec` in the current directory
+  # @raise [RuntimeError] If no specification has been set and one can’t be
+  #   found in the current directory (the project root directory)
+  def specification
+    return @specification if defined? @specification
+    return nil unless defined? ::Gem
+    gemspec = Dir['*.gemspec'].first
+    fail 'gem specification was not given and could not be found in project root: %s' %
+      Dir.pwd unless gemspec
+    @specification = Gem::Specification.load(gemspec)
+  end
+
+  # @param [Gem::Specification] specification
+  # @return [Gem::Specification] The new specification to use for {#paths} and
+  #   {#requires}: _specification_
+  def specification=(specification)
+    self.paths = specification.require_paths
+    self.requires = [specification.name.gsub('-', '/')]
+    specification
+  end
+
+  # @return [Array<String>] The options to pass to ruby
+  attr_reader :options
+
+  # @param [Array<String>] value
+  # @return [Array<String>] The new options to pass to ruby: _value_
+  attr_writer :options
+
+  def define
+    desc @name == :test ? 'Run tests' : 'Run tests for %s' % @name
+    task @name do
+      run
+    end
+
+    desc @name == :test ? 'Check test coverage' : 'Check test coverage for %s' % @name
+    task :"#{@name}:coverage" do
+      run %w'-c'
+    end
+
+    task :default => @name unless Rake::Task.task_defined? :default
+
+    task :check => :test if @name == :test
+  end
+
+  private
+
+  def run(arguments = [])
+    ruby '%s -- %s %s' % [(options + paths.uniq.map{ |e| '-I%s' % e }).join(' '),
+                          escape(LoaderPath),
+                          requires.uniq.map{ |r| '-r%s' % r }.
+                            concat(line).concat(arguments).
+                            push('--').
+                            concat(files.map{ |e| escape(e) }).join(' ')]
+  end
+
+  def line
+    return [] unless ENV['LINE'] and not ENV['LINE'].empty?
+    ['-l%d' % ENV['LINE'].to_i]
+  end
+
+  def escape(path)
+    path.gsub(/([^A-Za-z0-9_\-.,:\/@\n])/n, '\\\\\\1').gsub(/\n/, "'\n'")
+  end
+
+  def provided?(path)
+    $LOADED_FEATURES.any?{ |e| e.end_with? path + File.extname(e) }
+  end
+end

data/lib/lookout/rake/tasks/test/loader.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+require 'lookout-3.0'
+exit false unless Lookout::Interface::Commandline.new.call

data/lib/lookout/rake/version.rb

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+
+require 'inventory-1.0'
+
+module Lookout::Rake
+  Version = Inventory.new(3, 0, 0){
+    def dependencies
+      super + Inventory::Dependencies.new{
+        development 'inventory-rake', 1, 2, 0
+        optional 'rake', 0, 9, 2
+      }
+    end
+
+    def requires
+      %w'
+        rake
+      '
+    end
+
+    def libs
+      %w'
+        lookout/rake/tasks.rb
+        lookout/rake/tasks/test.rb
+      '
+    end
+
+    def additional_libs
+      super + %w'
+        lookout/rake/tasks/test/loader.rb
+      '
+    end
+
+    def unit_tests
+      super - %w'
+        lookout/rake/tasks/test/loader.rb
+      '
+    end
+  }
+end

data/test/unit/lookout/rake-3.0.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

data/test/unit/lookout/rake/tasks.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

data/test/unit/lookout/rake/tasks/test.rb

@@ -0,0 +1,106 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+  expect '-w -Ilib -- %s -rtest-1.0 -- test/unit/test-1.0.rb test/unit/test/version.rb' %
+      Lookout::Rake::Tasks::Test::LoaderPath do
+    command = nil
+    Rake.application = Rake::Application.new
+    Lookout::Rake::Tasks::Test.new(:inventory => Inventory.new(1, 0, 0, 'test/lib/test/version.rb')){ |t|
+      stub(t).ruby{ |s| command = s }
+    }
+    Rake.application[:test].invoke
+    command
+  end
+
+  expect '-w -Ilib -- %s -rtest-1.0 -l123 -- test/unit/test-1.0.rb test/unit/test/version.rb' %
+      Lookout::Rake::Tasks::Test::LoaderPath do
+    command = nil
+    Rake.application = Rake::Application.new
+    Lookout::Rake::Tasks::Test.new(:inventory => Inventory.new(1, 0, 0, 'test/lib/test/version.rb')){ |t|
+      stub(t).ruby{ |s| command = s }
+    }
+    with_environment 'LINE' => '123' do
+      Rake.application[:test].invoke
+    end
+    command
+  end
+
+  expect '-w -Ilib -- %s -rtest-1.0 -c -- test/unit/test-1.0.rb test/unit/test/version.rb' %
+      Lookout::Rake::Tasks::Test::LoaderPath do
+    command = nil
+    Rake.application = Rake::Application.new
+    Lookout::Rake::Tasks::Test.new(:inventory => Inventory.new(1, 0, 0, 'test/lib/test/version.rb')){ |t|
+      stub(t).ruby{ |s| command = s }
+    }
+    Rake.application[:'test:coverage'].invoke
+    command
+  end
+
+  expect '-w -Ilib -- %s -rtest-1.0 -- test/unit/test-1.0.rb test/unit/test/version.rb' %
+      Lookout::Rake::Tasks::Test::LoaderPath do
+    with_constant 'Inventory::Rake::Tasks', Module.new do
+      stub(Inventory::Rake::Tasks).inventory{
+        Inventory.new(1, 0, 0, 'test/lib/test/version.rb')
+      }
+      stub($LOADED_FEATURES).any?{ true }
+      command = nil
+      Rake.application = Rake::Application.new
+      Lookout::Rake::Tasks::Test.new{ |t|
+        stub(t).ruby{ |s| command = s }
+      }
+      Rake.application[:test].invoke
+      command
+    end
+  end
+
+  expect RuntimeError.new(/\Agem specification was not given/) do
+    stub(Dir).[]{ [] }
+    Rake.application = Rake::Application.new
+    Lookout::Rake::Tasks::Test.new
+    Rake.application[:test].invoke
+    command
+  end
+
+  expect '-w -Ilib -- %s -rtest -- test/unit/test.rb test/unit/test/version.rb' %
+      Lookout::Rake::Tasks::Test::LoaderPath do
+    stub(Dir).[]{ %w'test.gemspec' }
+    stub(Gem::Specification).load{ Gem::Specification.new{ |s| s.name = 'test' } }
+    command = nil
+    Rake.application = Rake::Application.new
+    Lookout::Rake::Tasks::Test.new(:files => %w'test/unit/test.rb test/unit/test/version.rb'){ |t|
+      stub(t).ruby{ |s| command = s }
+    }
+    Rake.application[:test].invoke
+    command
+  end
+
+  expect '-w -Ilib -- %s -rtest -- test/unit/test.rb test/unit/test/version.rb' %
+      Lookout::Rake::Tasks::Test::LoaderPath do
+    command = nil
+    Rake.application = Rake::Application.new
+    Lookout::Rake::Tasks::Test.new(:specification => Gem::Specification.new{ |s|
+                                     s.name = 'test'
+                                   },
+                                   :files => %w'test/unit/test.rb test/unit/test/version.rb'){ |t|
+      stub(t).ruby{ |s| command = s }
+    }
+    Rake.application[:test].invoke
+    command
+  end
+
+  expect %w'lib' do
+    stub(Dir).[]{ %w'test.gemspec' }
+    stub(Gem::Specification).load{ Gem::Specification.new{ |s| s.name = 'test' } }
+    Rake.application = Rake::Application.new
+    Lookout::Rake::Tasks::Test.new(:paths => nil,
+                                   :files => %w'test/unit/test.rb test/unit/test/version.rb').paths
+  end
+
+  expect %w'test' do
+    stub(Dir).[]{ %w'test.gemspec' }
+    stub(Gem::Specification).load{ Gem::Specification.new{ |s| s.name = 'test' } }
+    Rake.application = Rake::Application.new
+    Lookout::Rake::Tasks::Test.new(:paths => nil,
+                                   :files => %w'test/unit/test.rb test/unit/test/version.rb').requires
+  end
+end

data/test/unit/lookout/rake/version.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+Expectations do
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: lookout-rake
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nikolai Weibull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inventory
+  requirement: &15797340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *15797340
+- !ruby/object:Gem::Dependency
+  name: inventory-rake
+  requirement: &15796764 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: *15796764
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &15796212 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *15796212
+description: ! "                                 Lookout-Rake\n\n  Lookout-Rake provides
+  Rake tasks for testing using Lookout.\n\n§ Installation\n\n    Install Lookout-Rake
+  with\n\n    % gem install lookout\n\n§ Usage\n\n    Include the following code in
+  your ‹Rakefile›:\n\n      require 'lookout/rake-3.0'\n\n      Lookout::Rake::Tasks::Test.new\n\n
+  \   If the ‹:default› task hasn’t been defined it’ll be set to depend on the\n    ‹:test›
+  task.  The ‹:check› task will also depend on the ‹:test› task.\n    There’s also
+  a ‹:test:coverage› task that gets defined that uses the\n    coverage library that
+  comes with Ruby 1.9 to check the test coverage when\n    the tests are run.\n\n
+  \   You can hook up your test task to use your Inventory¹:\n\n      require 'library/version.rb'\n\n
+  \     Lookout::Rake::Tasks::Test.new :inventory => Library::Version\n\n    Also,
+  if you use the tasks that come with Inventory, the test task will\n    hook into
+  the inventory you tell them to use automatically.\n\n    To use Lookout together
+  with Vim², place ‹contrib/rakelookout.vim› in\n    ‹~/.vim/compiler› and add\n\n
+  \     compiler rakelookout\n\n    to ‹~/.vim/after/ftplugin/ruby.vim›.  Executing
+  ‹:make› from inside Vim\n    will now run your tests and an errors and failures
+  can be visited with\n    ‹:cnext›.  Execute ‹:help quickfix› for additional information.\n\n
+  \   Another useful addition to your ‹~/.vim/after/ftplugin/ruby.vim› file may\n
+  \   be\n\n      nnoremap <buffer> <silent> <Leader>M <Esc>:call <SID>run_test()<CR>\n
+  \     let b:undo_ftplugin .= ' | nunmap <buffer> <Leader>M'\n\n      function! s:run_test()\n
+  \       let test = expand('%')\n        let line = 'LINE=' . line('.')\n        if
+  test =~ '^lib/'\n          let test = substitute(test, '^lib/', 'test/', '')\n          let
+  line = \"\"\n        endif\n        execute 'make' 'TEST=' . shellescape(test) line\n
+  \     endfunction\n\n    Now, pressing ‹<Leader>M› will either run all tests for
+  a given class, if\n    the implementation file is active, or run the test at or
+  just before the\n    cursor, if the test file is active.  This is useful if you’re
+  currently\n    receiving a lot of errors and/or failures and want to focus on those\n
+  \   associated with a specific class or on a specific test.\n\n¹ Get information
+  on Inventory at http://disu.se/software/inventory/\n² Find out more about Vim at
+  http://www.vim.org/\n"
+email: now@bitwi.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/lookout/rake/tasks.rb
+- lib/lookout/rake/tasks/test.rb
+- lib/lookout/rake-3.0.rb
+- lib/lookout/rake/version.rb
+- lib/lookout/rake/tasks/test/loader.rb
+- test/unit/lookout/rake/tasks.rb
+- test/unit/lookout/rake/tasks/test.rb
+- test/unit/lookout/rake-3.0.rb
+- test/unit/lookout/rake/version.rb
+- README
+- Rakefile
+homepage: https://github.com/now/lookout-rake
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 4
+summary: Lookout-Rake provides Rake tasks for testing using Lookout.
+test_files: []