big_band 0.2.1

data/lib/big_band/advanced_routes.rb

@@ -0,0 +1,184 @@
+require "sinatra/base"
+
+class BigBand < Sinatra::Base
+
+  # 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
+  module AdvancedRoutes
+
+    module ArrayMethods
+      ::Array.send :include, self
+
+      def to_route(verb, args = {})
+        dup.to_route! verb, args
+      end
+
+      def to_route!(verb, args = {})
+        extend BigBand::AdvancedRoutes::Route
+        self.verb = verb
+        args.each do |key, value|
+          send "#{key}=", value
+        end
+        self
+      end
+
+      def signature
+        self
+      end
+
+    end
+
+    module Route
+
+      attr_accessor :app, :verb, :file, :line, :path
+
+      def pattern;    self[0]; end
+      def keys;       self[1]; end
+      def conditions; self[2]; end
+      def block;      self[3]; end
+      alias to_proc block
+
+      def pattern=(value);    self[0] = value; end
+      def keys=(value);       self[1] = value; end
+      def conditions=(value); self[2] = value; end
+      def block=(value);      self[3] = value; end
+
+      def signature
+        [pattern, keys, conditions, block]
+      end
+
+      def active?
+        app.routes[verb].include? self
+      end
+
+      def activate(at_top = false)
+        also_change.each { |r| r.activate }
+        return if active?
+        meth = at_top ? :unshift : :push
+        (app.routes[verb] ||= []).send(meth, self)
+        invoke_hook :route_added, verb, path, block
+        invoke_hook :advanced_root_activated, self
+        self
+      end
+
+      def deactivate
+        also_change.each { |r| r.deactivate }
+        return unless active?
+        (app.routes[verb] ||= []).delete(signature)
+        invoke_hook :route_removed, verb, path, block
+        invoke_hook :advanced_root_deactivated, self
+        self
+      end
+
+      def promote(upwards = true)
+        also_change.each { |r| r.promote(upwards) }
+        deactivate
+        activate(upwards)
+      end
+
+      def file?
+        !!@file
+      end
+
+      def inspect
+        "#<BigBand::AdvancedRoutes::Route #{ivar_inspect.join ", "}>"
+      end
+
+      def to_route(verb, args = {})
+        args = args.dup
+        [:app, :verb, :file, :line, :path].each { |key| args[key] ||= send(key) }
+        super(verb, args)
+      end
+
+      def also_change(*other_routes)
+        (@also_change ||= []).push(*other_routes)
+      end
+
+      private
+
+      def ivar_inspect
+        [:signature, :verb, :app, :file, :line].map do |var|
+          value = send(var)
+          "@#{var}=#{value.inspect}" unless value.nil?
+        end.compact
+      end
+
+      def invoke_hook(*args)
+        app.send(:invoke_hook, *args)
+      end
+
+    end
+
+    module ClassMethods
+
+      def get(path, opts={}, &block)
+        first_route, *other_routes = capture_routes { super }
+        first_route.also_change(*other_routes)
+        first_route
+      end
+
+      def route(verb, path, options={}, &block)
+        file, line = block.source_location if block.respond_to? :source_location
+        file ||= caller_files.first
+        route = super(verb, path, options, &block)
+        route.to_route! verb, :app => self, :file => file.expand_path, :line => line, :path => path
+        invoke_hook :advanced_root_added, route
+        @capture_routes << route if @capture_routes
+        route
+      end
+
+      def each_route(&block)
+        return enum_for(:each_route) if respond_to? :enum_for and not block
+        routes.inject([]) { |result, (verb, list)| result.push *list.each(&block) }
+      end
+
+      private
+
+      def capture_routes
+        capture_routes_was, @capture_routes = @capture_routes, []
+        yield
+        captured, @capture_routes = @capture_routes, capture_routes_was
+        captured
+      end
+
+    end
+
+    def self.registered(klass)
+      klass.extend ClassMethods
+      klass.routes.each do |verb, routes|
+        routes.each do |route|
+          route.to_route! verb, :app => klass
+          klass.send :invoke_hook, :advanced_root_added, route
+        end
+      end
+    end
+
+  end
+end

data/lib/big_band/basic_extensions.rb

@@ -0,0 +1,176 @@
+require "sinatra/base"
+require "monkey-lib"
+
+class BigBand < Sinatra::Base
+
+  CALLERS_TO_IGNORE = (class << Sinatra::Base; CALLERS_TO_IGNORE; end) unless defined? CALLERS_TO_IGNORE
+  Dir.chdir __FILE__.dirname.dirname do
+    Dir.glob("**/*.rb") { |file| CALLERS_TO_IGNORE << Regexp.new(Regexp.escape(file)) }
+  end
+
+  # 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.
+  module BasicExtensions
+    module ClassMethods
+
+      attr_writer :root, :guessed_root
+
+      # More advanced set:
+      # - Adds set_#{key} and set_value hooks to set.
+      # - Merges the old value with the new one, if both are hashes:
+      #     set :haml, :format => :html5, :escape_html => true
+      #     set :haml, :excape_html => false
+      #     haml # => { :format => :html5, :escape_html => false }
+      # - Allowes passing a block:
+      #     set(:foo) { Time.now }
+      # - Defines a helper to access #{key} and #{key}? unless a helper/method with that name already exists.
+      def set(key, value = self, &block)
+        # FIXME: refactor, refactor, refactor
+        if block_given?
+          raise ArgumentError, "both a value and a block given" if value != self
+          value = block
+        end
+        symbolized = (key.to_sym if key.respond_to? :to_sym)
+        old_value = (send(symbolized) if symbolized and respond_to? symbolized)
+        value = old_value.merge value if value.is_a? Hash and old_value.is_a? Hash
+        super(key, value)
+        if symbolized
+          method_names = instance_methods.map { |m| m.to_s }
+          define_method(key)       { self.class.send(key)       } unless method_names.include? key.to_s
+          define_method("#{key}?") { self.class.send("#{key}?") } unless method_names.include? "#{key}?"
+        end
+        # HACK: Sinatra::Base.set uses recursion and in the final step value always
+        # is a Proc. Also, if value is a Proc no step ever follows. I abuse this to
+        # invoke the hooks only once per set.
+        if value.is_a? Proc
+          invoke_hook "set_#{key}", self
+          invoke_hook :set_value, self, key
+        end
+        self
+      end
+
+      # More advacend register:
+      # - If an exntesion is registered twice, the registered hook will only be called once.
+      def register(*extensions, &block)
+        extensions.reject! { |e| self.extensions.include? e }
+        super(*extensions, &block)
+      end
+
+      # Short hand so you can skip those ugly File.expand_path(File.join(File.dirname(__FILE__), ...))
+      # lines.
+      def root_path(*args)
+        relative = File.join(*args)
+        return relative if relative.expand_path == relative
+        root.expand_path / relative
+      end
+
+      # Like root_path, but does return an array instead of a string. Optionally takes a block that will
+      # be called for each entry once.
+      #
+      # Example:
+      #   class Foo < BigBand
+      #     root_glob("app", "{models,views,controllers}", "*.rb") { |file| load file }
+      #   end
+      def root_glob(*args, &block)
+        Dir.glob(root_path(*args), &block)
+      end
+
+      # Whether or not to start a webserver.
+      def run?
+        @run ||= true
+        @run and !@running and app_file? and $0.expand_path == app_file.expand_path
+      end
+
+      # Disable automatically running this class as soon it is subclassed.
+      def inherited
+        super
+        @run = false
+      end
+
+      # The application's root directory. BigBand will guess if missing.
+      def root
+        return ".".expand_path unless app_file?
+        return @root if @root
+        @guessed_root ||= begin
+          dir = app_file.expand_path.dirname
+          if dir.basename == "lib" and not (dir / "lib").directory?
+            dir.dirname
+          else
+            dir
+          end
+        end
+      end
+
+      # Returns true if the #root is known.
+      def root?
+        !!@root || app_file?
+      end
+
+      # Option parser for #run!
+      def run_option_parser
+        @run_option_parser ||= begin
+          require 'optparse'
+          OptionParser.new do |op|
+            op.on('-x')        {       set :lock, true }
+            op.on('-e env')    { |val| set :environment, val.to_sym }
+            op.on('-s server') { |val| set :server, val }
+            op.on('-p port')   { |val| set :port, val.to_i }
+          end 
+        end
+      end
+
+      # Extended #run!, offers an extandable option parser for
+      # BigBand with the same standard options as the one of
+      # Sinatra#Default (see #run_option_parser).
+      def run!(options = {})
+        run_option_parser.parse!(ARGV.dup) unless ARGV.empty?
+        @running = true
+        super(options)
+      end
+
+    end
+
+    module InstanceMethods
+
+      # See BigBand::BasicExtentions::ClassMethods#root_path
+      def root_path(*args)
+        self.class.root_path(*args)
+      end
+
+      # See BigBand::BasicExtentions::ClassMethods#root_path
+      def root_glob(*args, &block)
+        self.class.root_glob(*args, &block)
+      end
+
+      # See BigBand::BasicExtentions::ClassMethods#root
+      def root
+        self.class.root
+      end
+
+      # See BigBand::BasicExtentions::ClassMethods#root?
+      def root?
+        self.class.root
+      end
+
+    end
+
+    def self.registered(klass)
+      klass.set :app_file, klass.caller_files.first.expand_path unless klass.app_file?
+      klass.extend ClassMethods
+      klass.send :include, InstanceMethods
+      klass.set :haml, :format => :html5, :escape_html => true
+      klass.use Rack::Session::Cookie
+      klass.enable :sessions
+      klass.get %r{/__big_band__/([^\.]+(\.[^\.]+)?)} do
+        send_file(__FILE__.expand_path.dirname / :files / params[:captures].first)
+      end
+    end
+
+    def self.set_app_file(klass)
+      klass.guessed_root = nil
+    end
+
+  end
+end

data/lib/big_band/compass/big_band.rb

@@ -0,0 +1,4 @@
+require "compass"
+require "big_band/compass"
+
+Compass::Frameworks.register 'big_band', File.expand_path(File.dirname(__FILE__))

data/lib/big_band/compass/stylesheets/_big_band.sass

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

data/lib/big_band/compass/stylesheets/big_band/_blueprint.sass

@@ -0,0 +1 @@
+@import blueprint/html5.sass 

data/lib/big_band/compass/stylesheets/big_band/_utilities.sass

@@ -0,0 +1,6 @@
+@import compass/reset.sass
+@import compass/utilities.sass
+@import utilities/border_radius.sass
+@import utilities/css3_prefix.sass
+@import utilities/fancy_buttons.sass
+@import utilities/html5.sass 

data/lib/big_band/compass/stylesheets/big_band/blueprint/_html5.sass

@@ -0,0 +1,4 @@
+@import ../utilities/html5.sass
+
+=blueprint_html5
+  +html5

data/lib/big_band/compass/stylesheets/big_band/layouts/_inspector.sass

@@ -0,0 +1,103 @@
+@import ../utilities.sass
+@import blueprint.sass
+@import blueprint/screen.sass 
+@import blueprint/modules/fancy_type.sass
+@import blueprint/modules/scaffolding.sass
+@import blueprint/modules/typography.sass
+
+=layout_inspector
+  +html5
+  +blueprint-typography
+  +fancy-paragraphs
+  body
+    padding: 5em 1em
+    background-color: #ddd
+    color
+  header
+    +box-shadow(0 2px 15px rgba(0, 0, 0, 0.8))
+    padding: 0px 10px
+    text-align: right
+    font-size: 80%
+    background:
+      color: rgba(0, 0, 0, 0.5)
+      image: url(/__big_band__/overlay-button.png)
+      repeat: repeat-x
+    border-bottom: solid 2px #333
+    color: #333
+    position: fixed
+    top: 0
+    right: 0
+    width: 100%
+    nav
+      a
+        +fancy-button-link(#040, 20px, 100px)
+        margin: 5px
+    h1
+      font:
+        weight: 500
+        size: 40px
+      margin: 0px
+      float: left
+      padding-left: 20px
+      color: #333
+      text-shadow: 0px 1px 2px rgba(0,0,0,0.8), -1px -1px 3px #eee, 0px 0px 8px rgba(0,0,0,0.7)
+  h2
+    font:
+      weight: bold
+      size: 130%
+    border-bottom: dotted 1px #bbb
+    width: 500px
+  table
+    +box-shadow(0px 3px 10px rgba(0,0,0,0.7))
+    border: solid 1px #555
+    background:
+      color: #fff
+      image: url(/__big_band__/overlay-button.png)
+    padding: 0px
+    width: 80%
+    margin: 0px 10%
+    tr
+      th, td
+        padding:
+          bottom: 0
+          top: 0
+          left: 5px
+          right: 20px
+      th
+        background-color: #555
+        color: #fff
+        font:
+          weight: bold
+          size: 90%
+      td
+        border:
+          color: #ddd
+          style: solid
+          width: 0px
+          left-width: 1px
+        min-width: 80px
+  footer
+    margin-top: 20px
+    +alt
+  a
+    color: #040
+    text-decoration: none
+    &:hover, &:visited
+      color: #040
+    &:hover
+      text-decoration: underline
+  .note
+    +box-shadow(0px 3px 10px rgba(0,0,0,0.7))
+    +border-radius
+    margin:
+      top: 5px
+      left: 10%
+      right: 10%
+      bottom: 20px
+    padding: 2px
+    background-color: #eee
+    text-align: center
+    font-size: 110%
+    a
+      font-weight: bold
+  

data/lib/big_band/compass/stylesheets/big_band/utilities/_border_radius.sass

@@ -0,0 +1,27 @@
+@import "css3_prefix.sass"
+
+!default_border_radius = 10px
+
+=border-radius(!lt = "auto", !rt = "auto", !rb = "auto", !lb = "auto")
+  @if !lt == "auto"
+    !lt = !default_border_radius
+  @if !rt == "auto"
+    !rt = !lt
+  @if !rb == "auto"
+    !rb = !lt
+  @if !lb == "auto"
+    !lb = !rt
+  min-width = max(!lt + !rt, !lb + !rb)
+  min-height = max(!lt + !lb, !rt + !rb)
+  +border-radius-no-min-size(!lt, !rt, !rb, !lb)
+
+=border-radius-no-min-size(!lt, !rt, !rb, !lb)
+  +prefixed("border-top-left-radius",     !lt)
+  +prefixed("border-top-right-radius",    !rt)
+  +prefixed("border-bottom-left-radius",  !lb)
+  +prefixed("border-bottom-right-radius", !rb)
+  -moz-border-radius:
+    topleft = !lt
+    topright = !rt
+    bottomright = !rb
+    bottomleft = !lb

data/lib/big_band/compass/stylesheets/big_band/utilities/_css3_prefix.sass

@@ -0,0 +1,14 @@
+=prefixed(!attribute, !value)
+  -moz-#{!attribute}    = !value
+  -webkit-#{!attribute} = !value
+  -khtml-#{!attribute}  = !value
+  -ms-#{!attribute}     = !value
+  -o-#{!attribute}      = !value
+  #{!attribute}         = !value
+
+=box-shadow(!parameters)
+  +prefixed(box-shadow, !parameters)
+
+=transition(!property, !duration)
+  +prefixed("transition-property", !property)
+  +prefixed("transition-duration", !duration)

data/lib/big_band/compass/stylesheets/big_band/utilities/_fancy_buttons.sass

@@ -0,0 +1,62 @@
+@import border_radius.sass
+@import css3_prefix.sass
+
+!fancy_button_color     = #222
+!fancy_button_height    = 30px
+!fancy_button_width     = "auto"
+!fancy_button_radius    = "auto"
+!fancy_button_darkening = 0.3
+
+=fancy-button(!color = !fancy_button_color, !height = !fancy_button_height, !width = !fancy_button_width, !radius = !fancy_button_radius)
+  @if !radius == "auto"
+    !radius = !height
+  @if !height < !radius * 2
+    !radius = !height / 2
+  +border-radius(!radius)
+  +box-shadow(0 1px 10px rgba(0, 0, 0, 0.6))
+  text-shadow = 0 -1px (!height * 0.1) rgba(0,0,0,0.7)
+  border-bottom: 1px solid rgba(0, 0, 0, 0.25)
+  background:
+    color = !color
+    image: url(/__big_band__/overlay-button.png)
+    repeat: repeat-x
+    attachment: scroll
+    position:
+      top: 0
+      left: 0
+  display: inline-block
+  padding = (!height * 0.1 - 1px) (!height * 0.5)
+  color: #fff !important
+  text:
+    decoration: none
+    align: center
+  -moz-background:
+    clip: border
+    inline-policy: continuous
+  font:
+    family: Arial,Helvetica,Helvetica Neue,Verdana,sans-serif
+    weight: bold
+    size = !height * 0.8
+  height = !height !important
+  width = !width
+  line-height: 1.2
+
+=fancy-button-link(!color = !fancy_button_color, !height = !fancy_button_height, !width = !fancy_button_width, !radius = !fancy_button_radius, !darkening = !fancy_button_darkening)
+  !offset = !height * 0.1 + 3px
+  +fancy-button(!color, !height, !width, !radius)
+  +prefixed("transition-property", "background, left, top, box-shadow, -moz-box-shadow, -webkit-box-shadow")
+  +prefixed("transition-duration", "0.5s")
+  position: relative
+  top: 0
+  left: 0
+  cursor: pointer
+  margin = !offset
+  &:hover
+    +fancy-button(!color * !darkening, !height, !width, !radius)
+    +box-shadow(!offset !offset + 1px !offset + 10px rgba(0, 0, 0, 0.5))
+    left = -!offset
+    top  = -!offset
+  &:visited, &:hover
+    color = !color
+    text-decoration: none
+

data/lib/big_band/compass/stylesheets/big_band/utilities/_html5.sass

@@ -0,0 +1,3 @@
+=html5
+  header, footer, nav
+    display: block

data/lib/big_band/compass.rb

@@ -0,0 +1,94 @@
+require "sinatra/base"
+require "big_band/basic_extensions"
+require "big_band/advanced_routes"
+require "big_band/compass/big_band"
+require "big_band/sass"
+
+class BigBand < Sinatra::Base
+  
+  # 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.
+  module Compass
+
+    module ClassMethods
+      attr_reader :compass_route
+      def get_compass(path, &block)
+        block ||= Proc.new do |file|
+          content_type 'text/css', :charset => 'utf-8'
+          compass :"#{path}/#{params[:name]}"
+        end
+        set :compass, :sass_dir => klass.views / path unless compass[:sass_dir] && compass[:sass_dir].directory?
+        @compass_route.deactivate if @compass_route
+        @compass_route = get("/#{path}" / ":name.css", &block)
+      end
+    end
+    
+    module InstanceMethods
+      def compass(file, options = {})
+        options.merge! ::Compass.sass_engine_options
+        sass file, options
+      end
+      def stylesheet(*args)
+        raise NotImplementedError, "yet to be implemented"
+      end
+    end
+    
+    def self.registered(klass)
+      klass.register BasicExtensions
+      klass.register AdvancedRoutes
+      klass.extend ClassMethods
+      klass.send :include, InstanceMethods
+      klass.set :compass,
+        :project_path => klass.root_path, :output_style => (klass.development? ? :expanded : :compressed),
+        :sass_dir => klass.views / "stylesheets", :line_comments => klass.development?
+      set_app_file(klass) if klass.app_file?
+    end
+    
+    def self.set_app_file(klass)
+      klass.set :compass, :root_path => klass.root_path
+      klass.get_compass("stylesheets") if (klass.views / "stylesheets").directory?
+    end
+    
+    def self.set_compass(klass)
+      ::Compass.configuration do |config|
+        config.sass_options ||= {}
+        klass.compass.each do |option, value|
+          if config.respond_to? option
+            config.send "#{option}=", value
+          else
+            config.sass_options.merge! option.to_sym => value
+          end
+        end
+      end
+    end
+    
+  end
+end