rack-raker 0.0.1 → 0.1.1

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+gem 'rack'
+gem 'rake'
+
+group :development do
+  gem 'test-spec'
+end

data/Rakefile

@@ -1,10 +1,13 @@
-require 'rake'
+require 'bundler'
 require 'rake/testtask'
 
+Bundler::GemHelper.install_tasks
+
 task :default => :test
 
-Rake::TestTask.new('test') do |t|
-  t.pattern = 'test/**/*_test.rb'
-  t.warning = true
-  t.verbose = true
+desc 'Run the tests'
+task :test do
+  require 'rake/runtest'
+  $LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
+  Rake.run_tests 'test/**/*_test.rb'
 end

data/config.ru

@@ -1,13 +1,15 @@
 require 'rack'
-require 'lib/rack/raker'
+$LOAD_PATH << 'lib'
+require 'rack/raker'
 
-use Rack::Reloader, 5
+use Rack::Reloader, 0
 
 rakefile = ::File.join(::File.dirname(__FILE__), 'Rakefile')
 
+# Raker::Middleware
 use Rack::Raker, rakefile
-# To test Raker::Middleware
 require 'rack/lobster'
 run Rack::Lobster.new
 
+# # Raker::App
 # run Rack::Raker.new(rakefile)

data/lib/rack/raker.rb

@@ -1,13 +1,11 @@
 module Rack
   module Raker
 
-    VERSION = '0.0.1'
-
     autoload :App,         'rack/raker/app'
     autoload :Middleware,  'rack/raker/middleware'
     autoload :TaskManager, 'rack/raker/task_manager'
+    autoload :VERSION,     'rack/raker/version'
 
-    # TODO: Add optional URL map.
     def self.new(*args)
       if args.first.class == String
         # run

data/lib/rack/raker/app.rb

@@ -1,33 +1,71 @@
-require 'sinatra/base'
+require 'erb'
 
 module Rack
   module Raker
-    class App < Sinatra::Base
+    class App
+      def initialize(rakefile, *args)
+        @rakefile = rakefile
+        @users = args.pop if args.last.is_a?(Hash)
+        @path = (args.first || '/rake').chomp('/')
+        @manager = TaskManager.new(@rakefile)
+      end
 
-      set :root, ::File.dirname(__FILE__) + '/app'
+      def call(env)
+        request = Request.new(env)
 
-      def initialize(*args)
-        @args = args
-        @rakefile = args.first
-        @manager = TaskManager.new(@rakefile)
+        if request.path_info =~ /^#{@path}\/$/
+          process 'index', lambda { index }, env
+        elsif request.path_info =~ /^#{@path}\/([^\/]+)\/$/ && @manager.has?($1)
+          process 'show', lambda { show($1) }, env
+        elsif request.path_info.start_with?(@path) && request.path_info[-1] != 47
+          [301, {'Content-Type' => 'text/plain','Location' => "#{request.path}/"}, ['moved permanently']]
+        else
+          [404, {'Content-Type' => 'text/plain'}, ['not found']]
+        end
       end
 
-      # TODO: Show task descriptions (or make an actual UI).
-      get '/rake/?' do
+      def index
         @tasks = @manager.tasks
-        erb :index
       end
 
-      get '/rake/:task' do |task|
-        @task = task
-        @output = @manager.run(task)
-        # TODO: Maybe show a helpful failure message.
-        redirect '/' unless @output
-        erb :show
+      def show(task)
+        @output, @error = nil, nil
+        begin
+          @output = @manager.run(task)
+        rescue Exception => ex
+          @error = ex.message
+        end
+      end
+
+      private
+
+      def process(action, block, env)
+        if @users.nil?
+          process_internal(action, block)
+        else
+          app = Rack::Auth::Digest::MD5.new(lambda { process_internal(action, block) }) do |username|
+            @users[username]
+          end
+          app.realm  = 'Rack::Raker'
+          app.opaque = opaque
+          app.call(env)
+        end
+      end
+
+      def opaque
+        @opaque ||= @users.key?('opaque') ? @users.delete('opaque') : 'rack-raker'
+      end
+
+      def process_internal(action, block)
+        block.call
+        html = render('layout') { render(action) }
+        [200, {'Content-Type' => 'text/html'}, [html]]
       end
 
-      not_found do
-        redirect '/rake'
+      def render(view)
+        path = ::File.join(::File.dirname(__FILE__), "views/#{view}.erb")
+        content = ::File.open(path) { |file| file.read }
+        ERB.new(content).result(binding)
       end
 
     end # App

data/lib/rack/raker/middleware.rb

@@ -3,16 +3,14 @@ module Rack
     class Middleware
 
       def initialize(*args)
-        @args = args
-        @app = args.shift
-        @rakefile = args.first
+        @rack = args.shift
+        @app  = App.new(*args)
       end
 
       def call(env)
-        request = Request.new(env)
-        @status, @headers, @body = @app.call(env)
-        return [@status, @headers, @body] unless request.path =~ /^\/rake/
-        Raker::App.new(@rakefile).call(env)
+        res = @app.call(env)
+        res = @rack.call(env) if res[0] == 404
+        res
       end
 
     end # Middleware

data/lib/rack/raker/task_manager.rb

@@ -1,27 +1,42 @@
+require 'open3'
+
 module Rack
   module Raker
     class TaskManager
 
+      class RakefileNotFound < Exception; end
+
       attr_accessor :tasks
 
       def initialize(rakefile)
+        raise RakefileNotFound unless ::File.exists?(rakefile)
         @rakefile = rakefile
       end
 
+      def rake
+        @rake ||= %x[ whereis rake ].match(/rake: ([^\s]+)/)[1]
+      end
+
       # Return an array of Rake tasks.
       def tasks
-        output = %x[ rake -f #{@rakefile} -s -T ]
+        output = %x[ #{rake} -f #{@rakefile} -s -T ]
         @tasks ||= output.split("\n").map do |task|
-          task.match(/^rake\s([\w:]+)/)[1]
-        end
+          task.match(/^rake\s([^\s]+)\s+#\s(.+)/)[1..2]
+        end.compact
+      end
+
+      def has?(task)
+        tasks.select { |name,desc| task == name }.size == 1
       end
 
       # Run the specified Rake +task+ and returns the (string) output, or false upon failure.
       # TODO: Maybe move the +rake_opts+ elsewhere.
       def run(task, rake_opts = ['-s'])
-        output = %x[ rake -f #{@rakefile} #{rake_opts.join(' ')} #{task} 2>/dev/null ]
-        output = false if output.empty?
-        output
+        Open3.popen3("#{rake} -f #{@rakefile} #{rake_opts.join(' ')} #{task}") do |stdinn, stdout, stderr|
+          err = stderr.read.split(/\n/).delete_if { |line| /[^:]+:\d+: warning: .+/ =~ line }.join("\n")
+          raise err unless err.empty?
+          stdout.read
+        end
       end
 
     end # TaskManager

data/lib/rack/raker/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Raker
+    VERSION = '0.1.1'
+  end
+end

data/lib/rack/raker/views/index.erb

@@ -0,0 +1,10 @@
+<h3><code>$ rake -T</code></h3>
+
+<table>
+  <% @tasks.each do |task, desc| %>
+    <tr>
+      <td><a href="<%= "#{@path}/#{task}/" %>"><%= task %></a></td>
+      <td><%= desc %></td>
+    </tr>
+  <% end %>
+</table>

data/lib/rack/raker/views/layout.erb

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Rack::Raker</title>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <style type="text/css">
+      html, body { padding: 0; margin: 0; font-family: Arial,Verdana,Helvetica; font-size:14px; height:100%; }
+      #container { min-height:100%; position:relative; }
+      h1 { background: #000; margin: 0; padding: 8px; color: #FFF; } 
+      h3 { margin: 20px; color: #900; }
+      h3 a { color: #900; }
+      .body { margin: 0 20px; padding: 0 0 80px; }
+      table { margin: 0; border: 1px solid #ccc; padding: 0; border-spacing: 0; border-collapse: collapse; } 
+      table tr td { margin: 20px;border:solid 1px #ccc;padding:6px; }
+      div.footer { padding:20px 0;background:#efefef;margin-top:20px;border-top:solid 1px #ccc;color:#999; font-size:13px; text-indent:20px; position:absolute; bottom:0; width:100%; }
+      div.footer a { color:#999; }    
+      pre { background:#ffd;padding:20px;margin:10px;border:solid 1px #fc0; }
+      pre.error { background:#fcc;border-color:#f00; }
+      a.back { color:#333; margin:20px; font-size:12px; display:block; }
+    </style>
+  </head>
+
+  <body>
+    <div id="container">
+      <h1>Rack::Raker</h1>
+      <div class="body">
+        <%= yield %>
+      </div>
+      <div class="footer">Powered by <a href="http://rubygems.org/gems/rack-raker">Rack::Raker</a> v<%= Rack::Raker::VERSION %></div>
+    </div>
+  </body>
+</html>

data/lib/rack/raker/views/show.erb

@@ -0,0 +1,11 @@
+<h3><code>$ <a href="<%= @path %>/">rake -T</a></code></h3>
+
+<h3><code>$ rake <%= @task %></code></h3>
+
+<% unless @output.nil? %>
+  <pre><%= @output %></pre>
+<% else %>
+ <pre class="error"><%= @error %></pre>
+<% end %>
+
+<a class="back" href="<%= @path %>/">&lt; Back</a> 

data/rack-raker.gemspec

@@ -1,37 +1,36 @@
-Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+require 'rake'
 
-  s.name = 'rack-raker'
-  s.version = '0.0.1'
-  s.date = '2009-11-02'
-  s.homepage = 'http://oshuma.github.com/rack-raker'
+require File.expand_path("../lib/rack/raker/version", __FILE__)
 
-  s.authors = ['Dale Campbell']
-  s.email = 'oshuma@gmail.com'
+Gem::Specification.new do |s|
+  s.name        = 'rack-raker'
+  s.version     = Rack::Raker::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Dale Campbell','Felipe Oliveira']
+  s.email       = ['oshuma@gmail.com','felipecvo@gmail.com']
+  s.homepage    = 'http://rubygems.org/gems/rack-raker'
+  s.summary     = 'Rack Rake middleware/app.'
+  s.description = s.summary
 
-  s.description = 'Rack Rake middleware/app.'
-  s.summary = 'Rack Rake middleware/app.'
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "rack-raker"
 
   s.add_dependency 'rack', '>= 0.4'
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "test-spec", ">= 0.9.0"
+
   s.require_paths = %w[lib]
 
-  s.files = %w[
-    README
-    Rakefile
-    config.ru
-    rack-raker.gemspec
-    lib/rack/raker.rb
-    lib/rack/raker/app.rb
-    lib/rack/raker/app/views/index.erb
-    lib/rack/raker/app/views/layout.erb
-    lib/rack/raker/app/views/show.erb
-    lib/rack/raker/middleware.rb
-    lib/rack/raker/task_manager.rb
-    test/Rakefile
-    test/test_helper.rb
-    test/task_manager_test.rb
-  ]
+  s.files = FileList[
+    'Gemfile',
+    'README',
+    'Rakefile',
+    'config.ru',
+    'rack-raker.gemspec',
+    'lib/**/*',
+    'test/**/*',
+  ].to_a
 
   s.test_files = s.files.select { |path| path =~ /^test\/.*_test.rb/ }
 

data/test/app_test.rb

@@ -0,0 +1,69 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'App' do
+  include Rack::Test::Methods
+
+  before(:each) do
+    @tasks    = [
+      ['raker:awesome','Namespaced awesome task'],
+      ['raker:util','Do some utility stuff'],
+      ['some_task','Some other task']
+    ]
+    @rakefile = File.join(File.dirname(__FILE__), 'Rakefile')
+  end
+
+  def app(raker_app = nil)
+    raker_app || Rack::Raker::App.new(@rakefile)
+  end
+
+  it 'should respond to the default index path' do
+    get '/rake/'
+    last_response.should.be.ok
+  end
+
+  it 'should list the tasks' do
+    get '/rake/'
+    @tasks.each do |task_name, task_desc|
+      last_response.body.should.include?(task_name)
+      last_response.body.should.include?(task_desc)
+    end
+  end
+
+  it 'should run the given task' do
+    task = @tasks.first.first
+    get "/rake/#{task}/"
+    last_response.should.be.ok
+  end
+
+  it 'should return 404 if task not found' do
+    get "/rake/not_a_real_task/"
+    last_response.should.be.not_found
+  end
+
+  it 'should redirect if not end with slash' do
+    get "/rake/task"
+    last_response.should.be.redirect
+  end
+
+  it 'should respond in different url' do
+    custom_app = Rack::Raker::App.new(@rakefile, '/myapp/rack-rake/')
+    resp = Rack::MockRequest.new(custom_app).get('/myapp/rack-rake/')
+    resp.should.be.ok
+  end
+
+  it 'should link to tasks with new path' do
+    custom_app = Rack::Raker::App.new(@rakefile, '/myapp/rack-rake/')
+    resp = Rack::MockRequest.new(custom_app).get('/myapp/rack-rake/')
+    resp.should.be.ok
+    @tasks.each do |task, desc|
+      resp.body.should.include?("/myapp/rack-rake/#{task}/")
+    end
+  end
+
+  it 'should link to home with new path' do
+    custom_app = Rack::Raker::App.new(@rakefile, '/myapp/rack-rake/')
+    resp = Rack::MockRequest.new(custom_app).get("/myapp/rack-rake/#{@tasks.first.first}/")
+    resp.should.be.ok
+    resp.body.should.include?('"/myapp/rack-rake/"')
+  end
+end

data/test/raker_test.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+describe 'Raker' do
+  before(:each) do
+    @rakefile = File.join(File.dirname(__FILE__), 'Rakefile')
+  end
+
+  it 'should require authentication' do
+    app = Rack::Raker.new(@rakefile, '/rake', { 'user' => 'raker' })
+    res = Rack::MockRequest.new(app).get('/rake/')
+    res.status.should.be 401
+  end
+
+  it 'should authenticate user' do
+    app = Rack::Raker.new(@rakefile, '/rake', { 'user' => 'raker' })
+    @request = Rack::MockRequest.new(app)
+
+    request_with_digest_auth('GET', '/rake/', 'user', 'raker') do |response|
+      response.status.should.be 200
+    end
+  end
+end
+
+def request(method, path, headers = {}, &block)
+  response = @request.request(method, path, headers)
+  block.call(response) if block
+  return response
+end
+
+def request_with_digest_auth(method, path, username, password, options = {}, &block)
+  request_options = {}
+  request_options[:input] = options.delete(:input) if options.include? :input
+
+  response = request(method, path, request_options)
+
+  return response unless response.status == 401
+
+  if wait = options.delete(:wait)
+    sleep wait
+  end
+
+  challenge = response['WWW-Authenticate'].split(' ', 2).last
+
+  params = Rack::Auth::Digest::Params.parse(challenge)
+
+  params['username'] = username
+  params['nc'] = '00000001'
+  params['cnonce'] = 'nonsensenonce'
+  params['uri'] = path
+
+  params['method'] = method
+
+  params.update options
+
+  params['response'] = MockDigestRequest.new(params).response(password)
+
+  request(method, path, request_options.merge('HTTP_AUTHORIZATION' => "Digest #{params}"), &block)
+end
+
+class MockDigestRequest
+  def initialize(params)
+    @params = params
+  end
+  def method_missing(sym)
+    if @params.has_key? k = sym.to_s
+      return @params[k]
+    end
+    super
+  end
+  def method
+    @params['method']
+  end
+  def response(password)
+    Rack::Auth::Digest::MD5.new(nil).send :digest, self, password
+  end
+end

data/test/task_manager_test.rb

@@ -1,8 +1,12 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
-describe TaskManager do
+describe 'TaskManager' do
   before(:each) do
-    @tasks    = ['raker:awesome', 'raker:util', 'some_task']
+    @tasks    = [
+      ['raker:awesome','Namespaced awesome task'],
+      ['raker:util','Do some utility stuff'],
+      ['some_task','Some other task']
+    ]
     @rakefile = File.join(File.dirname(__FILE__), 'Rakefile')
     @manager  = TaskManager.new(@rakefile)
   end
@@ -12,6 +16,20 @@ describe TaskManager do
   end
 
   it 'should run the given task' do
-    @manager.run(@tasks.first).should.not.be false
+    @manager.run(@tasks.first.first).should.not.be false
+  end
+
+  it 'should raise RakefileNotFound' do
+    lambda do
+      TaskManager.new('/not_a_real/Rakefile')
+    end.should.raise TaskManager::RakefileNotFound
+  end
+
+  it 'should return true if the given task exists' do
+    @manager.has?(@tasks.first.first).should.be true
+  end
+
+  it 'should return false if the given task does not exists' do
+    @manager.has?('no_one').should.be false
   end
 end

data/test/test_helper.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'test/spec'
-require File.expand_path("#{File.dirname(__FILE__)}/../lib/rack/raker")
+require 'rack/test'
 
+require File.expand_path("#{File.dirname(__FILE__)}/../lib/rack/raker")
 include Rack::Raker

metadata

@@ -1,29 +1,75 @@
 --- !ruby/object:Gem::Specification 
 name: rack-raker
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Dale Campbell
+- Felipe Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-11-02 00:00:00 -06:00
+date: 2010-12-18 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
         version: "0.4"
-    version: 
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :development
+  version_requirements: *id003
 description: Rack Rake middleware/app.
-email: oshuma@gmail.com
+email: 
+- oshuma@gmail.com
+- felipecvo@gmail.com
 executables: []
 
 extensions: []
@@ -31,22 +77,26 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- Gemfile
 - README
 - Rakefile
 - config.ru
 - rack-raker.gemspec
-- lib/rack/raker.rb
-- lib/rack/raker/app.rb
-- lib/rack/raker/app/views/index.erb
-- lib/rack/raker/app/views/layout.erb
-- lib/rack/raker/app/views/show.erb
+- lib/rack/raker/version.rb
 - lib/rack/raker/middleware.rb
+- lib/rack/raker/app.rb
 - lib/rack/raker/task_manager.rb
-- test/Rakefile
-- test/test_helper.rb
+- lib/rack/raker/views/show.erb
+- lib/rack/raker/views/index.erb
+- lib/rack/raker/views/layout.erb
+- lib/rack/raker.rb
 - test/task_manager_test.rb
+- test/app_test.rb
+- test/test_helper.rb
+- test/raker_test.rb
+- test/Rakefile
 has_rdoc: true
-homepage: http://oshuma.github.com/rack-raker
+homepage: http://rubygems.org/gems/rack-raker
 licenses: []
 
 post_install_message: 
@@ -60,23 +110,33 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: rack-raker
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Rack Rake middleware/app.
 test_files: 
 - test/task_manager_test.rb
+- test/app_test.rb
+- test/raker_test.rb

data/lib/rack/raker/app/views/index.erb

@@ -1,7 +0,0 @@
-<h3><code>$ rake -T</code></h3>
-
-<ul>
-  <% @tasks.each do |task| %>
-    <li><a href="/rake/<%= task %>"><%= task %></a></li>
-  <% end %>
-</ul>

data/lib/rack/raker/app/views/layout.erb

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Rack::Raker</title>
-    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-  </head>
-
-  <body>
-    <h1>Rack::Raker</h1>
-    <%= yield %>
-  </body>
-</html>

data/lib/rack/raker/app/views/show.erb

@@ -1,7 +0,0 @@
-<h3><code>$ <a href="/rake">rake -T</a></code></h3>
-
-<h3><code>$ rake <%= @task %></code></h3>
-
-<pre>
-  <%= @output %>
-</pre>