chicago 0.3.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Justin Knowlden, Gabriel Gironda, Dan Hodos, Thumble Monks
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,44 @@
+# Chicago
+
+    It's my kind of town!
+    - Sinatra
+
+Yeah, we're real clever. We're also from ["The city in mid-west best city in the whole wide wide world"](http://www.azlyrics.com/lyrics/lupefiasco/gogogadgetflow.html) ... which makes us double the clever.
+
+## What what?
+
+### Sinatra runtime app
+
+In your Sinatra app, do this:
+
+    require 'chicago'
+
+And you'll get some helpful Sinatra extensions and helpers.
+
+If you're Sinatra app is considered modular - as in, you are not using the `Sinatra::Default` app - you will want to add the following in your app:
+
+    YourApp < Sinatra::Base
+      register Sinatra::Chicago            # for some DSL helpers
+      helpers Sinatra::Chicago::Helpers    # for standard helpers
+      helpers Sinatra::Chicago::Responders # for JSON assistance
+    end
+
+You don't necessarily need all of them. You just need to "include" the statements that mix-in the functionality you want.
+
+### Sinatra testing
+
+Assuming you have required 'rack/test', like so:
+
+    require 'rack/test'
+
+This is because these macros use last_request defined by the Rack/Test library. If you're using [Protest](http://github.com/thumblemonks/protest) in your tests of your Sinatra app, do this:
+
+    require 'chicago/protest'
+
+... and you'll get a bunch of cool Protest macros for testing specific Sinatra stuff.
+
+If you're using Shoulda in your tests of your Sinatra app, do this:
+
+    require 'chicago/shoulda'
+
+... and you'll get a bunch of cool Shoulda macros for testing specific Sinatra stuff.

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default task: run all tests'
+task :default => [:test]
+
+task(:set_test_env) { ENV['RACK_ENV'] ||= 'test' }
+
+desc "Run all tests"
+task :test => [:set_test_env] do
+  require 'protest'
+  $:.concat ['./lib', './test']
+  Dir.glob("./test/*_test.rb").each { |test| require test }
+  Protest.report
+end
+
+task "test:shoulda" => [:set_test_env]
+desc "Run all Shoulda based tests"
+Rake::TestTask.new("test:shoulda") do |t|
+  t.libs << "test/shoulda_tests"
+  t.test_files = FileList['test/shoulda_tests/*_test.rb']
+  t.verbose = true
+end
+
+# task :test => [:set_test_env] do
+#   $:.concat ['./lib', './test/shoulda_tests']
+#   Dir.glob("./test/shoulda_tests/*_test.rb").each { |test| require test }
+# end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  exec "irb -rubygems"
+end

data/chicago.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name     = "chicago"
+  s.version  = "0.3.4"
+  s.date     = "2009-10-02"
+  s.summary  = "Sinatra runtime and testing extensions used commonly by Thumblemonks"
+  s.email    = %w[gus@gusg.us gabriel.gironda@gmail.com]
+  s.homepage = "http://github.com/thumblemonks/chicago/tree/master"
+  s.description = "Sinatra runtime and testing extensions used commonly by Thumblemonks. For example, :json_response, which turns an object into JSON and sets the content-type appropriately."
+  s.authors  = %w[Justin\ Knowlden Gabriel\ Gironda]
+
+  s.has_rdoc = false
+  s.rdoc_options = ["--main", "README.markdown"]
+  s.extra_rdoc_files = ["README.markdown"]
+
+  # run git ls-files to get an updated list
+  s.files = %w[
+    MIT-LICENSE
+    README.markdown
+    chicago.gemspec
+    lib/chicago.rb
+    lib/chicago/application.rb
+    lib/chicago/helpers.rb
+    lib/chicago/protest.rb
+    lib/chicago/protest/macros.rb
+    lib/chicago/responders.rb
+    lib/chicago/shoulda.rb
+    lib/chicago/shoulda/sinatra.rb
+  ]
+  
+  s.test_files = %w[
+    Rakefile
+    test/application_test.rb
+    test/helpers_test.rb
+    test/protest_macros_test.rb
+    test/responders_test.rb
+    test/test_helper.rb
+  ]
+end

data/lib/chicago.rb

@@ -0,0 +1,4 @@
+require 'sinatra/base'
+require 'chicago/application'
+require 'chicago/responders'
+require 'chicago/helpers'

data/lib/chicago/application.rb

@@ -0,0 +1,28 @@
+module Sinatra
+  module Chicago
+
+      # Assumes all CSS is SASS and is referenced as being in a directory named stylesheets
+      # If SASS file is not defined, the route will passed on to - theoretically - the real
+      # CSS in the public directory.
+      def catch_all_css(path='/stylesheets')
+        get("#{path}/*.css") do
+          begin
+            content_type 'text/css'
+            sass params["splat"].first.to_sym
+          rescue Errno::ENOENT
+            pass
+          end
+        end
+      end
+
+      # When you don't want anything special, but to load a named view as HAML.
+      def get_obvious(name)
+        get "/#{name}" do
+          haml name.to_sym
+        end
+      end
+
+  end # Chicago
+
+  register Chicago
+end # Sinatra

data/lib/chicago/helpers.rb

@@ -0,0 +1,77 @@
+module Sinatra
+  module Chicago
+    module Helpers
+      # A basic anchor (link_to) tag
+      #
+      # Exmaples:
+      #
+      #   anchor('GusGus', 'http://gusg.us')
+      #   => <a href="http://gusg.us">GusG.us</a>
+      #
+      #   anchor('GusGus', 'http://gusg.us', :title => 'You know who!')
+      #   => <a href="http://gusg.us" title="You know who!">GusG.us</a>
+      def anchor(name, url, options={})
+        defaults = {:href => url}
+        options_str = hash_to_attributes(defaults.merge(options))
+        %Q[<a #{options_str}>#{name}</a>]
+      end
+
+      # A helper to include stylesheet links. Currently defaults everything to
+      # load from a /stylesheets directory.
+      #
+      # Exmaples:
+      #
+      #   stylesheet_include('foo')
+      #   => <link href="/stylsheets/foo.css" media="screen" rel="stylesheet" type="text/css" />
+      #
+      #   stylesheet_include('foo/bar')
+      #   => <link href="/stylsheets/foo/bar.css" media="screen" rel="stylesheet" type="text/css" />
+      #
+      #   stylesheet_include('foo', :media => "print")
+      #   => <link href="/stylsheets/foo.css" media="print" rel="stylesheet" type="text/css" />
+      #
+      #   stylesheet_include('http://example.com/foo.css')
+      #   => <link href="http://example.com/foo.css" media="print" rel="stylesheet" type="text/css" />
+      def stylesheet_include(name, options={})
+        name = "/stylesheets/#{name}.css" unless remote_asset?(name)
+        defaults = {:href => name, :media => "screen",
+          :rel => "stylesheet", :type => "text/css"}
+        options_str = hash_to_attributes(defaults.merge(options))
+        %Q[<link #{options_str}/>]
+      end
+
+      # A helper to include javascript source tags. Currently defaults everything
+      # to load from a /javascripts directory.
+      #
+      # Exmaples:
+      #
+      #   javascript_include('foo')
+      #   => <javascript src="/javascripts/foo.js" type="text/javascript"></script>
+      #
+      #   javascript_include('foo/bar')
+      #   => <javascript src="/javascripts/foo/bar.js" type="text/javascript"></script>
+      #
+      #   javascript_include('foo', :something => "great")
+      #   => <javascript src="/javascripts/foo.js" type="text/javascript" something="great"></script>
+      #
+      #   javascript_include('http://example.com/foo.js')
+      #   => <javascript src="http://example.com/foo.js" type="text/javascript"></script>
+      def javascript_include(name, options={})
+        name = "/javascripts/#{name}.js" unless remote_asset?(name)
+        defaults = {:src => name, :type => "text/javascript"}
+        options_str = hash_to_attributes(defaults.merge(options))
+        %Q[<script #{options_str}></script>]
+      end
+    private
+      def remote_asset?(uri)
+        uri =~ %r[^\w+://.+]
+      end
+
+      def hash_to_attributes(options)
+        options.map {|k,v| "#{k}=\"#{v}\""}.join(' ')
+      end
+    end # Helpers
+  end # Chicago
+
+  helpers Chicago::Helpers
+end # Sinatra

data/lib/chicago/protest.rb

@@ -0,0 +1 @@
+require 'chicago/protest/macros'

data/lib/chicago/protest/macros.rb

@@ -0,0 +1,45 @@
+require 'json'
+
+module Chicago
+  module Protest
+    module Macros
+      def asserts_response_status(expected)
+        asserts("response status is #{expected}") { last_response.status }.equals(expected)
+      end
+      
+      def asserts_content_type(expected)
+        asserts("content type is #{expected}") { last_response.headers['Content-type'] }.equals(expected)
+      end
+
+      def asserts_response_body(expected)
+        asserts("response body matches #{expected.inspect}") { last_response.body }.matches(expected)
+      end
+
+      def asserts_location(expected_path)
+        asserts("location matches #{expected_path}") do
+          last_response.headers["Location"]
+        end.matches(expected_path)
+      end
+
+      def asserts_json_response(json, &block)
+        asserts_content_type 'application/json'
+        asserts("response body has JSON") do
+          json = json.to_json unless json.instance_of?(String)
+          json
+        end.equals(situation.last_response.body)
+        # Calling situation is kind of yucky, but maybe not. The maybe not is because of how explicit it is
+        # to say "situation" (gus)
+      end
+
+      # Usage:
+      #   assert_redirected_to '/foo/bar'
+      #   assert_redirected_to %r[foo/bar]
+      def asserts_redirected_to(expected_path)
+        asserts_response_status 302
+        asserts_location expected_path
+      end
+    end # Macros
+  end # Protest
+end # Chicago
+
+Protest::Context.instance_eval { include Chicago::Protest::Macros }

data/lib/chicago/responders.rb

@@ -0,0 +1,15 @@
+module Sinatra
+  module Chicago
+    module Responders
+
+      # Returns a JSON response for an object. Will return an empty string if the provided object is nil.
+      def json_response(object)
+        content_type 'application/json'
+        object ? object.to_json : ""
+      end
+
+    end # Responders
+  end # Chicago
+
+  helpers Chicago::Responders
+end # Sinatra

data/lib/chicago/shoulda.rb

@@ -0,0 +1 @@
+require 'chicago/shoulda/sinatra'

data/lib/chicago/shoulda/sinatra.rb

@@ -0,0 +1,83 @@
+require 'json'
+require 'ostruct'
+
+module ThumbleMonks
+  module Chicago
+    module Shoulda
+
+      def self.included(klass)
+        klass.extend(Macros)
+        klass.send(:include, Helpers)
+      end
+
+      module Macros
+        def should_have_response_status(expected)
+          should("have response status") { assert_response expected }
+        end
+      
+        def should_have_response_body(expected)
+          name = expected.is_a?(String) ? expected[0...15] : expected.to_s
+          should("have response body like #{name}") { assert_response_body expected }
+        end
+
+        def should_have_content_type(expected)
+          should("have content_type") { assert_content_type expected }
+        end
+
+        def should_have_json_response(json={}, &block)
+          should_have_content_type 'application/json'
+          should "have JSON response in the body" do
+            json = self.instance_eval(&block) if block_given?
+            json = json.to_json unless json.instance_of?(String) || json.instance_of?(Regexp)
+            assert_response_body json
+          end
+        end
+
+        # Checks to see if there is a redirect in play and the path the redirect goes to
+        #
+        # Example:
+        #   should_be_redirected_to { "/users/@user.id" }
+        #   should_be_redirected_to "/home"
+        def should_be_redirected_to(expected_path=nil, &block)
+          should "be redirected to #{expected_path || 'a url'}" do
+            expected_path = self.instance_eval(&block) if block_given?
+            assert_redirected_to expected_path
+          end
+        end
+      end # Macros
+
+      module Helpers
+        def deny(check, message=nil)
+          assert(!check, message)
+        end
+
+        def assert_response(status)
+          assert_equal status, last_response.status
+        end
+
+        def assert_response_body(body)
+          assert_match body, last_response.body
+        end
+
+        def assert_content_type(expected)
+          assert_equal expected, last_response.headers['Content-type']
+        end
+
+        # Usage:
+        #
+        # assert_redirected_to '/foo/bar'
+        #   or
+        # assert_redirected_to %r[foo.bar]
+        def assert_redirected_to(expected_path)
+          yield if block_given?
+          assert_response 302
+          action = expected_path.kind_of?(Regexp) ? 'match' : 'equal'
+          send("assert_#{action}", expected_path, last_response.headers["Location"])
+        end
+      end # Helpers
+
+    end # Shoulda
+  end # Chicago
+end # ThumbleMonks
+
+Test::Unit::TestCase.instance_eval { include ThumbleMonks::Chicago::Shoulda }

data/test/application_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+context "Application Test:" do
+
+  setup do
+    mock_app {
+      register Sinatra::Chicago
+
+      template(:foo) { ".bar\n  :display none" }
+      template(:goo) { ".car\n  :display some" }
+      template(:baz) { "Whatever man. That's just like, your opinion." }
+
+      catch_all_css
+      catch_all_css('/css')
+
+      get_obvious 'baz'
+    }
+  end
+
+  # TODO: change to namespace
+  context "catching all css" do
+    context "with default path" do
+      setup { get '/stylesheets/foo.css' }
+      asserts_response_status 200
+      asserts_content_type 'text/css'
+      asserts_response_body %r[.bar \{\s+display: none; \}\s]
+    end
+
+    context "with specified path" do
+      setup { get '/css/goo.css' }
+      asserts_response_status 200
+      asserts_content_type 'text/css'
+      asserts_response_body %r[.car \{\s+display: some; \}\s]
+    end
+
+    context "with path that's not a defined a sass file" do
+      setup { get '/stylesheets/zoo.css' }
+      asserts_response_status 404
+      asserts_content_type 'text/css'
+    end
+  end # catching all css
+
+  context "getting obvious views" do
+    setup { get '/baz' }
+    asserts_response_body "Whatever man. That's just like, your opinion."
+  end # getting obvious views
+
+end

data/test/helpers_test.rb

@@ -0,0 +1,125 @@
+require 'test_helper'
+
+context "Helpers Test:" do
+  setup do
+    mock_app {
+      helpers Sinatra::Chicago::Helpers
+    }
+  end
+
+  context "including stylesheet" do
+    context "for plain old foo" do
+      setup do
+        extend_mock_app {
+          template(:foo) { "= stylesheet_include('foo')" }
+          get('/foo') { haml :foo }
+        }
+        get '/foo'
+      end
+
+      asserts_response_body %r[^<link( \w+=".+"){4}/>$]
+      asserts_response_body %r[href="/stylesheets/foo\.css"]
+      asserts_response_body %r[media="screen"]
+      asserts_response_body %r[rel="stylesheet"]
+      asserts_response_body %r[type="text/css"]
+    end # for plain old foo
+
+    context "for bar with options" do
+      setup do
+        extend_mock_app {
+          template(:foo) { "= stylesheet_include('bar', :media => 'print', :baz => 'boo')" }
+          get('/foo') { haml :foo }
+        }
+        get '/foo'
+      end
+
+      asserts_response_body %r[^<link( \w+=".+"){5}/>$]
+      asserts_response_body %r[href="/stylesheets/bar\.css"]
+      asserts_response_body %r[media="print"]
+      asserts_response_body %r[rel="stylesheet"]
+      asserts_response_body %r[type="text/css"]
+      asserts_response_body %r[baz="boo"]
+    end # for bar with options
+
+    context "with a specific href" do
+      setup do
+        extend_mock_app {
+          template(:foo) { "= stylesheet_include('http://example.com')" }
+          get('/foo') { haml :foo }
+        }
+        get '/foo'
+      end
+      asserts_response_body %r[href="http://example.com"]
+    end # with a specific href
+  end # including stylesheets
+
+  context "including javascript" do
+    context "for plain old foo" do
+      setup do
+        extend_mock_app {
+          template(:foo) { "= javascript_include('foo')" }
+          get('/foo') { haml :foo }
+        }
+        get '/foo'
+      end
+
+      asserts_response_body %r[^<script( \w+=".+"){2}></script>$]
+      asserts_response_body %r[src="/javascripts/foo\.js"]
+      asserts_response_body %r[type="text/javascript"]
+    end # for plain old foo
+
+    context "for foo with options" do
+      setup do
+        extend_mock_app {
+          template(:foo) { "= javascript_include('foo', :type => 'text/blarg', :gus => 'nice')" }
+          get('/foo') { haml :foo }
+        }
+        get '/foo'
+      end
+
+      asserts_response_body %r[^<script( \w+=".+"){3}></script>$]
+      asserts_response_body %r[src="/javascripts/foo\.js"]
+      asserts_response_body %r[type="text/blarg"]
+      asserts_response_body %r[gus="nice"]
+    end # for foo with options
+
+    context "with a specific src" do
+      setup do
+        extend_mock_app {
+          template(:foo) { "= javascript_include('http://example.com')" }
+          get('/foo') { haml :foo }
+        }
+        get '/foo'
+      end
+      asserts_response_body %r[src="http://example.com"]
+    end # with a specific src
+  end # including javascript
+
+  context "using an anchor" do
+    context "for plain old foo" do
+      setup do
+        extend_mock_app {
+          template(:foo) { "= anchor('foo', '/bar')" }
+          get('/foo') { haml :foo }
+        }
+        get '/foo'
+      end
+
+      asserts_response_body %Q[<a href="/bar">foo</a>]
+    end # for plain old foo
+
+    context "with options" do
+      setup do
+        extend_mock_app {
+          template(:foo) { "= anchor('foo bear', '/bar/ler', :title => 'gus is nice')" }
+          get('/foo') { haml :foo }
+        }
+        get '/foo'
+      end
+
+      asserts_response_body %r[^<a( \w+=".+"){2}>foo bear</a>$]
+      asserts_response_body %r[href="/bar/ler"]
+      asserts_response_body %r[title="gus is nice"]
+    end # with options
+  end # using an anchor
+end

data/test/protest_macros_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+context "Protest Macros Test:" do
+  setup do
+    mock_app {
+      helpers Sinatra::Chicago::Responders
+      get("/redirecter") { redirect '/foo/bar' }
+    }
+  end
+
+  context "asserts redirected to" do
+    setup { get('/redirecter') }
+    asserts_redirected_to('/foo/bar')
+  end # asserts redirected to
+end

data/test/responders_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+context "Responders Test:" do
+  setup do
+    mock_app {
+      helpers Sinatra::Chicago::Responders
+      get "/json_bait" do
+        status(201)
+        json_response({:foo => "bar"})
+      end
+    }
+  end
+
+  context "json response" do
+    setup { get "/json_bait" }
+    asserts_response_status 201
+    asserts_json_response({:foo => :bar})
+  end # json response
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+%w[ rubygems protest haml sass chicago rack/test chicago/protest ].each do |lib|
+  require lib
+end
+
+module Rack::Test::Methods
+  # Sets up a Sinatra::Base subclass defined with the block
+  # given. Used in setup or individual spec methods to establish
+  # the application.
+  def mock_app(base=Sinatra::Base, &block)
+    @app = Sinatra.new(base, &block)
+  end
+
+  def extend_mock_app(&block)
+    @_rack_test_session ||= Rack::Test::Session.new(app)
+    @app.instance_eval(&block)
+  end
+
+  def app
+    @app
+  end
+end
+
+class Protest::Situation
+  include Rack::Test::Methods
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: chicago
+version: !ruby/object:Gem::Version 
+  version: 0.3.4
+platform: ruby
+authors: 
+- Justin Knowlden
+- Gabriel Gironda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-02 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Sinatra runtime and testing extensions used commonly by Thumblemonks. For example, :json_response, which turns an object into JSON and sets the content-type appropriately.
+email: 
+- gus@gusg.us
+- gabriel.gironda@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- MIT-LICENSE
+- README.markdown
+- chicago.gemspec
+- lib/chicago.rb
+- lib/chicago/application.rb
+- lib/chicago/helpers.rb
+- lib/chicago/protest.rb
+- lib/chicago/protest/macros.rb
+- lib/chicago/responders.rb
+- lib/chicago/shoulda.rb
+- lib/chicago/shoulda/sinatra.rb
+has_rdoc: true
+homepage: http://github.com/thumblemonks/chicago/tree/master
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Sinatra runtime and testing extensions used commonly by Thumblemonks
+test_files: 
+- Rakefile
+- test/application_test.rb
+- test/helpers_test.rb
+- test/protest_macros_test.rb
+- test/responders_test.rb
+- test/test_helper.rb