jellyfish-contrib 1.1.0

data/task/README.md

@@ -0,0 +1,54 @@
+# Gemgem
+
+## DESCRIPTION:
+
+Provided tasks:
+
+    rake clean        # Remove ignored files
+    rake gem:build    # Build gem
+    rake gem:install  # Install gem
+    rake gem:release  # Release gem
+    rake gem:spec     # Generate gemspec
+    rake test         # Run tests in memory
+
+## REQUIREMENTS:
+
+* Tested with MRI (official CRuby) 1.9.3, 2.0.0, Rubinius and JRuby.
+
+## INSTALLATION:
+
+    git submodule add git://github.com/godfat/gemgem.git task
+
+And in Rakefile:
+
+``` ruby
+begin
+  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+rescue LoadError
+  sh 'git submodule update --init'
+  exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
+end
+
+Gemgem.init(dir) do |s|
+  s.name    = 'your-gem'
+  s.version = '0.1.0'
+end
+```
+
+## LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2011-2013, Lin Jen-Shin (godfat)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/task/gemgem.rb

@@ -0,0 +1,316 @@
+
+module Gemgem
+  class << self
+    attr_accessor :dir, :spec, :spec_create
+  end
+
+  module_function
+  def gem_tag    ; "#{spec.name}-#{spec.version}"     ; end
+  def gem_path   ; "#{pkg_dir}/#{gem_tag}.gem"        ; end
+  def spec_path  ; "#{dir}/#{spec.name}.gemspec"      ; end
+  def pkg_dir    ; "#{dir}/pkg"                       ; end
+  def escaped_dir; @escaped_dir ||= Regexp.escape(dir); end
+
+  def init dir, &block
+    self.dir = dir
+    $LOAD_PATH.unshift("#{dir}/lib")
+    ENV['RUBYLIB'] = "#{dir}/lib:#{ENV['RUBYLIB']}"
+    ENV['PATH']    = "#{dir}/bin:#{ENV['PATH']}"
+    self.spec_create = block
+  end
+
+  def create
+    spec = Gem::Specification.new do |s|
+      s.authors     = ['Lin Jen-Shin (godfat)']
+      s.email       = ['godfat (XD) godfat.org']
+
+      s.description = description.join
+      s.summary     = description.first
+      s.license     = readme['LICENSE'].sub(/.+\n\n/, '').lines.first.strip
+
+      s.date        = Time.now.strftime('%Y-%m-%d')
+      s.files       = gem_files
+      s.test_files  = test_files
+      s.executables = bin_files
+    end
+    spec_create.call(spec)
+    spec.homepage ||= "https://github.com/godfat/#{spec.name}"
+    self.spec = spec
+  end
+
+  def gem_install
+    require 'rubygems/commands/install_command'
+    # read ~/.gemrc
+    Gem.use_paths(Gem.configuration[:gemhome], Gem.configuration[:gempath])
+    Gem::Command.extra_args = Gem.configuration[:gem]
+
+    # setup install options
+    cmd = Gem::Commands::InstallCommand.new
+    cmd.handle_options([])
+
+    # install
+    install = Gem::Installer.new(gem_path, cmd.options)
+    install.install
+    puts "\e[35mGem installed: \e[33m#{strip_path(install.gem_dir)}\e[0m"
+  end
+
+  def gem_spec
+    create
+    write
+  end
+
+  def gem_build
+    require 'fileutils'
+    require 'rubygems/package'
+    gem = nil
+    Dir.chdir(dir) do
+      gem = Gem::Package.build(Gem::Specification.load(spec_path))
+      FileUtils.mkdir_p(pkg_dir)
+      FileUtils.mv(gem, pkg_dir) # gem is relative path, but might be ok
+    end
+    puts "\e[35mGem built: \e[33m#{strip_path("#{pkg_dir}/#{gem}")}\e[0m"
+  end
+
+  def gem_release
+    sh_git('tag', gem_tag)
+    sh_git('push')
+    sh_git('push', '--tags')
+    sh_gem('push', gem_path)
+  end
+
+  def gem_check
+    unless git('status', '--porcelain').empty?
+      puts("\e[35mWorking copy is not clean.\e[0m")
+      exit(3)
+    end
+
+    ver = spec.version.to_s
+
+    if ENV['VERSION'].nil?
+      puts("\e[35mExpected "                                  \
+           "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
+      exit(1)
+
+    elsif ENV['VERSION'] != ver
+      puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
+           "\e[35mbut got\n         "                         \
+           "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
+      exit(2)
+    end
+  end
+
+  def test
+    return if test_files.empty?
+
+    if ENV['COV'] || ENV['CI']
+      require 'simplecov'
+      if ENV['CI']
+        begin
+          require 'coveralls'
+          SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+        rescue LoadError => e
+          puts "Cannot load coveralls, skip: #{e}"
+        end
+      end
+      SimpleCov.start do
+        add_filter('test/')
+        add_filter('test.rb')
+      end
+    end
+
+    test_files.each{ |file| require "#{dir}/#{file[0..-4]}" }
+  end
+
+  def clean
+    return if ignored_files.empty?
+
+    require 'fileutils'
+    trash = File.expand_path("~/.Trash/#{spec.name}")
+    puts "Move the following files into: \e[35m#{strip_path(trash)}\e[33m"
+
+    ignored_files.each do |file|
+      from = "#{dir}/#{file}"
+      to   = "#{trash}/#{File.dirname(file)}"
+      puts strip_path(from)
+
+      FileUtils.mkdir_p(to)
+      FileUtils.mv(from, to)
+    end
+
+    print "\e[0m"
+  end
+
+  def write
+    File.open(spec_path, 'w'){ |f| f << split_lines(spec.to_ruby) }
+  end
+
+  def split_lines ruby
+    ruby.gsub(/(.+?)\s*=\s*\[(.+?)\]/){ |s|
+      if $2.index(',')
+        "#{$1} = [\n  #{$2.split(',').map(&:strip).join(",\n  ")}]"
+      else
+        s
+      end
+    }
+  end
+
+  def strip_path path
+    strip_home_path(strip_cwd_path(path))
+  end
+
+  def strip_home_path path
+    path.sub(ENV['HOME'], '~')
+  end
+
+  def strip_cwd_path path
+    path.sub(Dir.pwd, '.')
+  end
+
+  def git *args
+    `git --git-dir=#{dir}/.git #{args.join(' ')}`
+  end
+
+  def sh_git *args
+    Rake.sh('git', "--git-dir=#{dir}/.git", *args)
+  end
+
+  def sh_gem *args
+    Rake.sh(Gem.ruby, '-S', 'gem', *args)
+  end
+
+  def glob path=dir
+    Dir.glob("#{path}/**/*", File::FNM_DOTMATCH)
+  end
+
+  def readme
+    @readme ||=
+      if (path = "#{Gemgem.dir}/README.md") && File.exist?(path)
+        ps = "##{File.read(path)}".
+             scan(/((#+)[^\n]+\n\n.+?(?=(\n\n\2[^#\n]+\n)|\Z))/m).map(&:first)
+        ps.inject('HEADER' => ps.first){ |r, s, i|
+          r[s[/\w+/]] = s
+          r
+        }
+      else
+        {}
+      end
+  end
+
+  def description
+    # JRuby String#lines is returning an enumerator
+    @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines.to_a
+  end
+
+  def all_files
+    @all_files ||= fold_files(glob).sort
+  end
+
+  def fold_files files
+    files.inject([]){ |r, path|
+      if File.file?(path) && path !~ %r{/\.git(/|$)}  &&
+         (rpath = path[%r{^#{escaped_dir}/(.*$)}, 1])
+        r << rpath
+      elsif File.symlink?(path) # walk into symlinks...
+        r.concat(fold_files(glob(File.expand_path(path,
+                                                  File.readlink(path)))))
+      else
+        r
+      end
+    }
+  end
+
+  def gem_files
+    @gem_files ||= all_files.reject{ |f|
+      f =~ ignored_pattern && !git_files.include?(f)
+    }
+  end
+
+  def test_files
+    @test_files ||= gem_files.grep(%r{^test/(.+?/)*test_.+?\.rb$})
+  end
+
+  def bin_files
+    @bin_files ||= gem_files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  end
+
+  def git_files
+    @git_files ||= if File.exist?("#{dir}/.git")
+                     git('ls-files').split("\n")
+                   else
+                     []
+                   end
+  end
+
+  def ignored_files
+    @ignored_files ||= all_files.grep(ignored_pattern)
+  end
+
+  def ignored_pattern
+    @ignored_pattern ||= if gitignore.empty?
+                           /^$/
+                         else
+                           Regexp.new(expand_patterns(gitignore).join('|'))
+                         end
+  end
+
+  def expand_patterns pathes
+    # http://git-scm.com/docs/gitignore
+    pathes.flat_map{ |path|
+      # we didn't implement negative pattern for now
+      Regexp.escape(path).sub(%r{^/}, '^').gsub(/\\\*/, '[^/]*')
+    }
+  end
+
+  def gitignore
+    @gitignore ||= if File.exist?(path = "#{dir}/.gitignore")
+                     File.read(path).lines.
+                       reject{ |l| l == /^\s*(#|\s+$)/ }.map(&:strip)
+                   else
+                     []
+                   end
+  end
+end
+
+namespace :gem do
+
+desc 'Install gem'
+task :install => [:build] do
+  Gemgem.gem_install
+end
+
+desc 'Build gem'
+task :build => [:spec] do
+  Gemgem.gem_build
+end
+
+desc 'Generate gemspec'
+task :spec do
+  Gemgem.gem_spec
+end
+
+desc 'Release gem'
+task :release => [:spec, :check, :build] do
+  Gemgem.gem_release
+end
+
+task :check do
+  Gemgem.gem_check
+end
+
+end # of gem namespace
+
+desc 'Run tests'
+task :test do
+  Gemgem.test
+end
+
+desc 'Trash ignored files'
+task :clean => ['gem:spec'] do
+  Gemgem.clean
+end
+
+task :default do
+  # Is there a reliable way to do this in the current process?
+  # It failed miserably before between Rake versions...
+  exec "#{Gem.ruby} -S #{$PROGRAM_NAME} -f #{Rake.application.rakefile} -T"
+end

data/test/test_from_readme.rb

@@ -0,0 +1,57 @@
+
+require 'jellyfish/test'
+require 'uri'
+require 'stringio'
+
+describe 'from README.md' do
+  after do
+    [:Tank, :Heater, :Protector].each do |const|
+      Object.send(:remove_const, const) if Object.const_defined?(const)
+    end
+    Muack.verify
+  end
+
+  readme = File.read(
+             "#{File.dirname(File.expand_path(__FILE__))}/../README.md")
+  codes  = readme.scan(
+    /### ([^\n]+).+?``` ruby\n(.+?)\n```\n\n<!---(.+?)-->/m)
+
+  codes.each.with_index do |(title, code, test), index|
+    next if title =~ /NewRelic/i
+
+    would "pass from README.md #%02d #{title}" % index do
+      app = Rack::Builder.app{ eval(code) }
+
+      test.split("\n\n").each do |t|
+        method_path, expect = t.strip.split("\n", 2)
+        method, path        = method_path.split(' ')
+        uri                 = URI.parse(path)
+        pinfo, query        = uri.path, uri.query
+
+        sock = nil
+        status, headers, body = File.open(File::NULL) do |input|
+          app.call(
+            'HTTP_VERSION'   => 'HTTP/1.1',
+            'REQUEST_METHOD' => method, 'PATH_INFO'  => pinfo,
+            'QUERY_STRING'   => query , 'SCRIPT_NAME'=> ''   ,
+            'rack.input'     => input ,
+            'rack.hijack'    => lambda{
+              sock = StringIO.new
+              # or TypeError: no implicit conversion of StringIO into IO
+              mock(IO).select([sock]){ [[sock], [], []] }
+              sock
+            })
+        end
+
+        if hijack = headers.delete('rack.hijack')
+          sock = StringIO.new
+          hijack.call(sock)
+          body = sock.string.each_line("\n\n")
+        end
+
+        body.extend(Enumerable)
+        [status, headers, body.to_a].should.eq eval(expect, binding, __FILE__)
+      end
+    end
+  end
+end

data/test/test_multi_actions.rb

@@ -0,0 +1,277 @@
+
+require 'jellyfish/test'
+
+# stolen from sinatra
+describe 'Sinatra filter_test.rb' do
+  paste :jellyfish
+
+  def new_app base=Object, &block
+    Class.new(base){
+      include Jellyfish
+      controller_include(Jellyfish::MultiActions)
+      instance_eval(&block)
+    }.new
+  end
+
+  would 'executes filters in the order defined' do
+    count = 0
+    app = new_app{
+      get     { count.should.eq 0; count = 1 }
+      get     { count.should.eq 1; count = 2 }
+      get('/'){ 'Hello World' }
+    }
+
+    status, _, body = get('/', app)
+    status.should.eq 200
+    count .should.eq 2
+    body  .should.eq ['Hello World']
+  end
+
+  would 'modify env' do
+    app = new_app{
+      get{ env['BOO'] = 'MOO' }
+      get('/foo'){ env['BOO'] }
+    }
+
+    status, _, body = get('/foo', app)
+    status.should.eq 200
+    body  .should.eq ['MOO']
+  end
+
+  would 'modify instance variables available to routes' do
+    app = new_app{
+      get{ @foo = 'bar' }
+      get('/foo') { @foo }
+    }
+
+    status, _, body = get('/foo', app)
+    status.should.eq 200
+    body  .should.eq ['bar']
+  end
+
+  would 'allows redirects' do
+    app = new_app{
+      get{ found '/bar' }
+      get('/foo') do
+        fail 'before block should have halted processing'
+        'ORLY?!'
+      end
+    }
+
+    status, headers, body = get('/foo', app)
+    status             .should.eq 302
+    headers['Location'].should.eq '/bar'
+    body.join          .should =~ %r{<h1>Jellyfish found: /bar</h1>}
+  end
+
+  would 'not modify the response with its return value' do
+    app = new_app{
+      get{ 'Hello World!' }
+      get '/foo' do
+        body.should.eq nil
+        'cool'
+      end
+    }
+
+    status, _, body = get('/foo', app)
+    status.should.eq 200
+    body  .should.eq ['cool']
+  end
+
+  would 'modify the response with halt' do
+    app = new_app{
+      get('/foo'){ halt [302, {}, ['Hi']] }
+      get('/foo'){ 'should not happen' }
+      get('/bar'){ status 402; body 'Ho'; halt }
+      get('/bar'){ 'should not happen' }
+    }
+
+    get('/foo', app).should.eq [302, {}, ['Hi']]
+    get('/bar', app).should.eq [402, {}, ['Ho']]
+  end
+
+  would 'give you access to params' do
+    app = new_app{
+      get{ @foo = Rack::Request.new(env).params['foo'] }
+      get('/foo'){ @foo.reverse }
+    }
+
+    status, _, body = get('/foo', app, 'QUERY_STRING' => 'foo=cool')
+    status.should.eq 200
+    body  .should.eq ['looc']
+  end
+
+  would 'run filters defined in superclasses' do
+    sup = new_app{ get{ @foo = 'hello from superclass' } }.class
+    app = new_app(sup){ get('/foo'){ @foo } }
+
+    _, _, body = get('/foo', app)
+    body.should.eq ['hello from superclass']
+
+    sup      .routes['get'].size.should.eq 1
+    app.class.routes['get'].size.should.eq 2
+  end
+
+  would 'take an optional route pattern' do
+    ran_filter = false
+    app = new_app{
+      get(%r{^/b}){ ran_filter = true }
+      get('/foo') {}
+      get('/bar') {}
+    }
+    get('/foo', app)
+    ran_filter.should.eq false
+    get('/bar', app)
+    ran_filter.should.eq true
+  end
+
+  would 'generate block arguments from route pattern' do
+    subpath = nil
+    app = new_app{
+      get(%r{^/foo/(\w+)}){ |m| subpath = m[1] }
+    }
+    get('/foo/bar', app)
+    subpath.should.eq 'bar'
+  end
+
+  would 'execute before and after filters in correct order' do
+    invoked = 0
+    app = new_app{
+      get     { invoked  = 2 }
+      get('/'){ invoked += 2; body 'hello' }
+      get     { invoked *= 2 }
+    }
+
+    status, _, body = get('/', app)
+    status .should.eq 200
+    body   .should.eq ['hello']
+    invoked.should.eq 8
+  end
+
+  would 'execute filters in the order defined' do
+    count = 0
+    app = new_app{
+      get('/'){ body 'Hello World' }
+      get{
+        count.should.eq 0
+        count = 1
+      }
+      get{
+        count.should.eq 1
+        count = 2
+      }
+    }
+
+    status, _, body = get('/', app)
+    status.should.eq 200
+    count .should.eq 2
+    body  .should.eq ['Hello World']
+  end
+
+  would 'allow redirects' do
+    app = new_app{
+      get('/foo'){ 'ORLY' }
+      get        { found '/bar' }
+    }
+
+    status, headers, body = get('/foo', app)
+    status             .should.eq 302
+    headers['Location'].should.eq '/bar'
+    body.join          .should =~ %r{<h1>Jellyfish found: /bar</h1>}
+  end
+
+  would 'not modify the response with its return value' do
+    app = new_app{
+      get('/foo'){ body 'cool' }
+      get        { 'Hello World!' }
+    }
+
+    status, _, body = get('/foo', app)
+    status.should.eq 200
+    body  .should.eq ['cool']
+  end
+
+  would 'modify the response with halt' do
+    app = new_app{
+      get('/foo'){ 'should not be returned' }
+      get{ halt [302, {}, ['Hi']] }
+    }
+
+    status, _, body = get('/foo', app)
+    status.should.eq 302
+    body  .should.eq ['Hi']
+  end
+
+  would 'take an optional route pattern' do
+    ran_filter = false
+    app = new_app{
+      get('/foo') {}
+      get('/bar') {}
+      get(%r{^/b}){ ran_filter = true }
+    }
+    get('/foo', app)
+    ran_filter.should.eq false
+    get('/bar', app)
+    ran_filter.should.eq true
+  end
+
+  would 'return response immediately on next or halt' do
+    app = Class.new{
+      include Jellyfish
+      controller_include Jellyfish::MultiActions
+
+      get '/next' do
+        body 'Hello World'
+        next
+      end
+
+      get '/halt' do
+        body 'Hello World'
+        halt
+        'Boo-hoo World'
+      end
+    }.new
+
+    %w[/next /halt].each do |path|
+      status, _, body = get(path, app)
+      status.should.eq 200
+      body  .should.eq ['Hello World']
+    end
+  end
+
+  would 'halt with a response tuple' do
+    app = Class.new{
+      include Jellyfish
+      controller_include Jellyfish::MultiActions
+
+      get '/' do
+        halt [295, {'Content-Type' => 'text/plain'}, ['Hello World']]
+      end
+    }.new
+
+    status, headers, body = get('/', app)
+    status                 .should.eq 295
+    headers['Content-Type'].should.eq 'text/plain'
+    body                   .should.eq ['Hello World']
+  end
+
+  would 'transition to the next matching route on next' do
+    app = Class.new{
+      include Jellyfish
+      controller_include Jellyfish::MultiActions, Jellyfish::NormalizedParams
+      get %r{^/(?<foo>\w+)} do
+        params['foo'].should.eq 'bar'
+        next
+      end
+
+      get do
+        params.should.not.include?('foo')
+        'Hello World'
+      end
+    }.new
+
+    status, _, body = get('/bar', app)
+    status.should.eq 200
+    body  .should.eq ['Hello World']
+  end
+end