big_band 0.2.1

data/LICENSE

@@ -0,0 +1,27 @@
+copyright (c) 2009 Konstantin Haase.  All rights reserved.
+
+Developed by: Konstantin Haase
+              http://github.com/rkh/big_band
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal with 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:
+  1. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimers.
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimers in the
+     documentation and/or other materials provided with the distribution.
+  3. Neither the name of Konstantin Haase, nor the names of other contributors
+     may be used to endorse or promote products derived from this Software without
+     specific prior written permission.
+
+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
+CONTRIBUTORS 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
+WITH THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,303 @@
+= BigBand 0.2.1
+BigBand is a collection of Sinatra extensions and offers better sinatra integration for common tools.
+It is pluggable and each extension can be used in stand alone mode.
+
+The main features are:
+* Routes as first class objects
+* Better handling of #set: Merges hashes, more hooks
+* Better compass integration
+* Rails-like helpers, like content_for
+* Unicorn and Rainbows integration
+* Smart code reloader only reloading changed files and getting rid of old routes
+* Sass extensions
+* Routes for inspection in development mode
+* Helpers and configuration for Bacon, RSpec, Test::Spec and Test::Unit
+* Tasks listing all routes for Monk and Rake.
+* YARD: Add Sinatra routes to generated documentation
+
+Planned features:
+* More template helpers
+* ORM integration
+* Configuration handling
+* MSpec integration
+
+== Usage
+
+Using all BigBand features:
+
+  require "big_band"  
+  class Example < BigBand
+    # Yay, BigBand!
+  end
+
+Or for the lazy folks (read: you would don't subclass Sinatra::Base on your own):
+
+  require "sinatra"
+  require "big_band"
+  # Yay, BigBand!
+
+Using just your favorite BigBand features:
+
+  require "big_band"
+  class Example < Sinatra::Base
+    register BigBand::SomeFeature
+    # Yay, BigBand::SomeFeature!
+  end
+
+Or, if you like a more handy syntax:
+
+  require "big_band"
+  class Example < BigBand :SomeFeature, MyStuff::Extension, :development => :DevelopmentOnlyFeature
+    # Yay, BigBand::SomeFeature!
+    # Yay, MyStuff::Extension!
+    # Yay, BigBand::DevelopmentOnlyFeature, if this is development mode!
+  end
+
+Loading all but one feature:
+
+  require "big_band"
+  class Example < BigBand :except => :SomeFeature
+    # Yay, all but BigBand::SomeFeature!
+  end
+
+Or just your favorite feature without you subclassing Sinatra::Base manually:
+
+  require "sinatra"
+  require "big_band/some_feature"
+  Sinatra::Application.register BigBand::SomeFeature
+  # Yay, BigBand::SomeFeature!
+
+== Extensions
+
+=== AdvancedRoutes
+
+AdvancedRoutes makes routes first class objects in Sinatra:
+
+  require "sinatra"
+  require "big_band"
+
+  admin_route = get "/admin" do
+    administrate_stuff
+  end
+
+  before do
+    # Let's deactivate the route if we have no password file.
+    if File.exists? "admin_password"
+      admin_route.activate
+    else
+      admin_route.deactivate 
+    end
+  end
+
+  first_route = get "/:name" do
+    # stuff
+  end
+
+  other_route = get "/foo_:name" do
+    # other stuff
+  end
+
+  # Unfortunatly first_route will catch all the requests other_route would
+  # have gotten, since it has been defined first. But wait, we can fix this!
+  other_route.promote
+
+=== BasicExtensions
+
+Basic Sinatra extension (mainly extending Sinatra's standard methods, like set or register).
+Also it features a more advanced path guessing than Sinatra::Base.
+Normally you do not have to register this module manually, as the other extensions will do so
+if necessary.
+
+=== Compass
+
+Integrates the Compass stylesheet framework with Sinatra.
+
+Usage without doing something:
+
+  require "big_band"
+  class Foo < BigBand; end
+
+If you create a directory called views/stylesheets and place your
+sass files in there, there you go. Just call stylesheet(name) form
+your view to get the correct stylesheet tag. The URL for your
+stylesheets will be /stylesheets/:name.css.
+
+Of course you can use any other setup. Say, you want to store your
+stylesheets in views/css and want the URL to be /css/:name.css:
+
+  class Foo < BigBand
+    get_compass("css")
+  end
+
+But what about more complex setups?
+
+  class Foo < BigBand
+    set :compass, :sass_dir => "/foo/bar/blah"
+    get_compass("/foo/:name.css") do
+      compass :one_stylesheet
+    end
+  end
+
+Note that already generated routes will be deactivated by calling
+get_compass again.
+
+=== MoreHelpers
+
+Adds more helper methods (more docs coming soon).
+
+=== MoreServer
+
+Adds more servers to Sinatra::Base#run! (currently unicorn and rainbows).
+
+=== Reloader
+
+Advanced reloader for sinatra. Reloads only files that have changed and automatically
+detects orphaned routes that have to be removed. Files defining routes will be added
+to the reload list per default. Avoid reloading with dont_reload. Add other files to
+the reload list with also_reload.
+
+Usage:
+
+  require "big_band"
+  class Foo < Sinatra::Base
+    configure(:development) do
+      register BigBand::Reloader
+      also_reload "app/models/*.rb"
+      dont_reload "lib/**/*.rb"
+    end
+  end
+
+Per default this will only be acitvated in development mode.
+
+=== Sass
+
+BigBand::Sass extends SassScript with more functions like min or max.
+
+Example:
+  .someClass
+    width = max(!default_width - 10px, 200px)
+
+This can be used without BigBand or even Sinatra.
+
+=== WebInspector
+
+The WebInspector allowes you to inspect a running Sinatra app.
+Just browse http://localhost:4567/\_\_inspect\_\_
+
+Per default this will only be activated in development mode.
+
+
+== Tool Integration
+
+=== Bacon
+
+Some Bacon example and description goes here.
+
+=== Monk
+
+In your Thorfile, place:
+
+  require "big_band/integration/monk"
+  class Monk < Thor
+    routes_task :list_routes
+  end
+
+Now, running 'monk list_routes' in you project directory should
+give you a list of all your routes.
+
+=== Rake
+
+In your Rakefile, do the following:
+
+  require "big_band/integration/rake"
+  include BigBand::Integration::Rake
+
+  RoutesTask.new
+
+then you can run 'rake routes' from your
+project directory and it will list all routes
+of your app. Per default it will scan for routes
+defined in ruby files in the directories lib, app,
+routes, models, views, and controllers (ignoring
+non-existant directories, of course). You can change
+that behavior by setting +source+ to another pattern:
+
+  RoutesTask.new { |t| t.source = "**/*.rb" }
+
+However, you may also just pass in a Sinatra app, so it
+will not have to scan through the source files:
+
+  require "my_app"
+  RoutesTask.new { |t| t.source = MyApp }
+
+Keep in mind that a broken my_app in this case would also make
+your Rakefile unusable.
+
+Also, you may set another name for the task either by setting
+the first argument or calling #name=:
+
+  RoutesTask.new(:some_routes) { |t| t.source = SomeApp }
+  RoutesTask.new do |t|
+    t.source = AnotherApp
+    t.name   = :other_routes
+  end
+
+=== RSpec
+
+Some RSpec example and description goes here.
+
+=== Test::Spec
+
+Some TestSpec example and description goes here.
+
+=== Test::Unit
+
+Some TestUnit example and description goes here.
+
+=== YARD
+
+Some YARD example and description goes here.
+
+== Running specs
+
+  rake spec
+
+== Generating documentation
+
+  rake doc
+
+== Known Issues
+* Reloader: Needs some more love, but it should not cause any harm.
+* YARD integration: Routes don't show up in list of all methods. Would prefer a routes list, anyway. Some YARD digging ahead.
+
+== LICENSE
+(MIT/BSD-style license, compatible with Ruby license and GPL)
+
+  copyright (c) 2009 Konstantin Haase.  All rights reserved.
+  
+  Developed by: Konstantin Haase
+                http://github.com/rkh/big_band
+  
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to
+  deal with 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:
+    1. Redistributions of source code must retain the above copyright notice,
+       this list of conditions and the following disclaimers.
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimers in the
+       documentation and/or other materials provided with the distribution.
+    3. Neither the name of Konstantin Haase, nor the names of other contributors
+       may be used to endorse or promote products derived from this Software without
+       specific prior written permission.
+  
+  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
+  CONTRIBUTORS 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
+  WITH THE SOFTWARE.
+  

data/README.rdoc.erb

@@ -0,0 +1,39 @@
+= BigBand <%= version %>
+<%= docstring %>
+
+
+== Extensions
+<% extensions.each do |extension| %>
+
+=== <%= extension.name %>
+
+<%= extension.docstring %>
+
+<% end %>
+
+
+== Tool Integration
+<% integration.each do |tool| %>
+
+=== <%= tool.name %>
+
+<%= tool.docstring %>
+
+<% end %>
+
+== Running specs
+
+  rake spec
+
+== Generating documentation
+
+  rake doc
+
+== Known Issues
+* Reloader: Needs some more love, but it should not cause any harm.
+* YARD integration: Routes don't show up in list of all methods. Would prefer a routes list, anyway. Some YARD digging ahead.
+
+== LICENSE
+(MIT/BSD-style license, compatible with Ruby license and GPL)
+
+  <%= File.read("LICENSE").gsub(/\n/, "\n  ") %>

data/Rakefile

@@ -0,0 +1,129 @@
+require "erb"
+require "spec/rake/spectask"
+require "rake/clean"
+require "rake/rdoctask"
+require "monkey-lib"
+require "yard"
+
+$LOAD_PATH.unshift __FILE__.dirname.expand_path / "lib"
+require "big_band/integration/yard"
+require "big_band/integration/rake"
+require "big_band/version"
+
+include BigBand::Integration::Rake
+RoutesTask.new
+
+task :default => "gems:build"
+task :install => "gems:install"
+task :test    => :spec
+task :clobber => "doc:clobber_rdoc"
+
+CLEAN.include "**/*.rbc"
+CLOBBER.include "*.gem", "README.rdoc"
+
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = %w[--options spec/spec.opts]
+  t.spec_files = Dir.glob 'spec/**/*_spec.rb'
+end
+
+TOOL_NAMES = { :Rspec => :RSpec, :Yard => :YARD, :TestSpec => :"Test::Spec", :TestUnit => :"Test::Unit" }
+
+def yard(files)
+  YARD::Registry.load(Dir[files], true)
+  YARD::Registry.resolve(false, "BigBand")
+end
+
+def yard_children(ydoc, directory, defaults = {}, &block)
+  children = Dir.glob("#{directory}/*.rb").map { |f| f[(directory.size+1)..-4].to_const_string.to_sym }
+  children.select!(&block) if block
+  children.map! do |name|
+    rewritten_name = defaults[name] || name
+    ydoc.child(rewritten_name) or ydoc.child(name).tap { |c| c.name = rewritten_name unless c.nil? }
+  end
+  children.compact
+end
+
+def generate_readme(target = "README.rdoc", template = "README.rdoc.erb")
+  puts "generating #{target} from #{template}"
+  # HACK: loading other libraries later, for some strange heisenbug setting the docstring to an empty string later.
+  docstring   = yard("lib/big_band.rb").docstring
+  ydoc        = yard("lib/big_band/{**/,}*.rb")
+  extensions  = yard_children(ydoc, "lib/big_band") { |n| n != :Integration }
+  integration = yard_children(ydoc.child(:Integration), "lib/big_band/integration", TOOL_NAMES) { |n| n != :Test }
+  version     = BigBand::VERSION
+  File.open(target, "w") { |f| f << ERB.new(File.read(template), nil, "<>").result(binding) }
+end
+
+file "README.rdoc" => ["README.rdoc.erb", "lib/big_band.rb"] do
+  generate_readme
+end
+
+desc "Generate documentation"
+task "doc"    => "doc:yardoc"
+task "yardoc" => "doc:yardoc"
+task "rdoc"   => "doc:yardoc"
+
+namespace :doc do
+
+  task "yardoc" => "readme"
+  task "rdoc"   => "readme"
+  task "rerdoc" => "readme"
+
+  desc "Generate README.rdoc from source files"
+  task "readme" do |t|
+    generate_readme
+  end
+
+  Rake::RDocTask.new("rdoc") do |rdoc|
+    rdoc.rdoc_dir = 'doc'
+    rdoc.options += %w[-a -S -N -m README.rdoc -q -w 2 -t BigBand -c UTF-8]
+    rdoc.rdoc_files.add ['*.{rdoc,rb}', '{config,lib,routes}/**/*.rb']
+  end
+
+  YARD::Rake::YardocTask.new("yardoc") do |t|
+    t.options = %w[--main README.rdoc --backtrace]
+  end
+
+end
+
+task :gems => "gems:build"
+
+namespace :gems do
+
+  desc "Build gems (runs specs first)"
+  task :build => [:clobber, :spec, "doc:readme"] do
+    GEMS = []
+    Dir.glob("*.gemspec") do |file|
+      sh "gem build #{file}"
+      GEMS << "#{file[0..-9]}-#{BigBand::VERSION}.gem"
+    end
+  end
+
+  desc "Install gems"
+  task :install => :build do
+    GEMS.each { |file| sh "gem install #{file}" }
+  end
+
+  desc "Publish gems (gemcutter)"
+  task :push => :build do
+    GEMS.each { |file| sh "gem push #{file}" }
+  end
+
+end
+
+############
+# aliases
+
+task :c => [:clobber, "doc:readme"]
+task :s => :spec
+task :d
+namespace :d do
+  task :r => "doc:readme"
+  task :y => "doc:yardoc"
+end
+task :g => :gems
+namespace :g do
+  task :b => "gems:build"
+  task :i => "gems:install"
+  task :p => "gems:push"
+end

data/big_band.gemspec

@@ -0,0 +1,29 @@
+$LOAD_PATH.unshift "lib"
+require "lib/big_band/version"
+
+SPEC = Gem::Specification.new do |s|
+
+  s.name          = "big_band"
+  s.version       = BigBand::VERSION
+  s.date          = BigBand::DATE
+  s.author        = "Konstantin Haase"
+  s.email         = "konstantin.mailinglists@googlemail.com"
+  s.homepage      = "http://github.com/rkh/big_band"
+  s.platform      = Gem::Platform::RUBY
+  s.summary       = "Collection of Sinatra extensions and sinatra integration for common tools like Rake, YARD and Monk." 
+  s.files         = Dir.glob("**/*").reject { |f| File.basename(f)[0] == ?. }
+  s.require_paths = ['lib']
+  s.has_rdoc      = true
+  s.description   = s.summary + " See README.rdoc for more infos."
+  s.rdoc_options  = %w[-a -S -N -m README.rdoc -q -w 2 -t BigBand -c UTF-8]
+
+  s.add_dependency 'sinatra',    '>= 0.9.4'
+  s.add_dependency 'monkey-lib', '>= 0.3.2'
+  s.add_dependency 'compass',    '>= 0.8.17'
+  s.add_dependency 'yard',       '>= 0.5.2'
+  s.add_dependency 'rack-test',  '>= 0.5.3'
+
+  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=
+
+end

data/example/example.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift File.expand_path(__FILE__ + "/../../lib")
+require "big_band"
+
+class Example < BigBand
+
+  # The index page. You should see this comment in YARD.
+  get "/" do
+    haml :index
+  end
+  
+  run! if run?
+
+end

data/example/views/index.haml

@@ -0,0 +1,8 @@
+index page
+%a{:href => "/", :class => "fancy-button1"} fancy
+%a{:href => "/", :class => "fancy-button2"} fancy
+%a{:href => "/", :class => "fancy-button3"} fancy
+%a{:href => "/", :class => "fancy-button4"} fancy
+%a{:href => "/", :class => "fancy-button5"} fancy
+%a{:href => "/", :class => "fancy-button6"} fancy
+%a{:href => "/", :class => "fancy-button7"} fancy

data/example/views/layout.haml

@@ -0,0 +1,2 @@
+%link{:rel => "stylesheet", :href => "/stylesheets/screen.css", :type => "text/css"}/
+!=yield

data/example/views/stylesheets/_base.sass

@@ -0,0 +1 @@
+@import big_band.sass

data/example/views/stylesheets/screen.sass

@@ -0,0 +1,12 @@
+@import base.sass
+
+body
+  padding: 1em
+  background-color: #eee
+
+@for !i from 1 through 7
+  a.fancy-button#{!i}
+    +fancy-button-link(#800, 10px + 10px * !i)
+
+=attr(!name, !value)
+  #{!name} = !value