appetizer-ui 0.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# Appetizer UI
+
+An painfully under-documented and opinionated Appetizer add-on for
+writing webapps using Sinatra, Sass, CoffeeScript, Eco, Backbone.js,
+and Sprockets.
+
+## License (MIT)
+
+Copyright 2011 Audiosocket (tech@audiosocket.com)
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/appetizer-ui.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |gem|
+  gem.authors       = ["Audiosocket"]
+  gem.email         = ["tech@audiosocket.com"]
+  gem.description   = "A painfully opinionated Appetizer extension for web apps."
+  gem.summary       = "Helpers for rich clients using Sinatra, Sass, and CoffeeScript."
+  gem.homepage      = "https://github.com/audiosocket/appetizer-ui"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- test/*`.split("\n")
+  gem.name          = "appetizer-ui"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.0"
+
+  gem.required_ruby_version = ">= 1.9.2"
+
+  gem.add_dependency "appetizer",      "~> 0.0"
+  gem.add_dependency "coffee-script",  "~> 2.2"
+  gem.add_dependency "eco",            "~> 1.0"
+  gem.add_dependency "rack-ssl",       "~> 1.3"
+  gem.add_dependency "sass",           "~> 3.1"
+  gem.add_dependency "sinatra",        "~> 1.3"
+  gem.add_dependency "sprockets",      "~> 2.1"
+  gem.add_dependency "uglifier",       "~> 1.0"
+  gem.add_dependency "yajl-ruby",      "~> 1.0"
+  gem.add_dependency "yui-compressor", "~> 0.9"
+end

data/lib/appetizer/ui.rb

@@ -0,0 +1,83 @@
+require "appetizer/init"
+require "appetizer/ui/assets"
+require "sass"
+require "securerandom"
+require "sinatra/base"
+require "yajl"
+
+module Appetizer
+  module UI
+    def self.registered app
+
+      # Make sure that exception handling works the same in
+      # development and production.
+
+      app.set :show_exceptions, false
+
+      # All production apps better be using SSL.
+
+      app.configure :production do
+        require "rack/ssl"
+        app.use Rack::SSL
+      end
+
+      # This stack in primarily intended for deployment on Heroku, so
+      # only bother to log requests in development mode. Heroku's
+      # logging is more than enough in production.
+
+      app.configure :development do
+        app.use Rack::CommonLogger, App.log
+      end
+
+      # Build CSS under tmp, not in the project root.
+
+      app.set :scss, cache_location: "tmp/sass-cache", style: :compact
+
+      # Set up cookie sessions and authenticity token checking. Add
+      # some basic defaults, but allow them to be overridden.
+
+      app.use Rack::Session::Cookie,
+        key:    (ENV["APPETIZER_COOKIE_NAME"] || "app-session"),
+        secret: (ENV["APPETIZER_SESSION_SECRET"] || "app-session-secret")
+
+      app.use Rack::Protection::AuthenticityToken
+
+      app.helpers do
+
+        # JSONify `thing` and respond with a `201`.
+
+        def created thing
+          halt 201, json(thing)
+        end
+
+        # The current CSRF token.
+
+        def csrf
+          session[:csrf] ||= SecureRandom.hex 32
+        end
+
+        # Set a `:json` content-type and run `thing` through the Yajl
+        # JSON encoder.
+
+        def json thing
+          content_type :json, charset: "utf-8"
+          jsonify thing
+        end
+
+        # Encode `thing` as JSON.
+
+        def jsonify thing
+          Yajl::Encoder.encode thing
+        end
+
+        # The asset manifest.
+
+        def manifest
+          Appetizer::UI::Assets.manifest
+        end
+      end
+    end
+  end
+end
+
+Sinatra.register Appetizer::UI

data/lib/appetizer/ui/app/js/appetizer.coffee

@@ -0,0 +1,9 @@
+#= require json2
+#= require jquery
+#= require underscore
+#= require underscore.string
+#= require backbone
+
+#= require appetizer/core
+#= require appetizer/model
+#= require appetizer/view

data/lib/appetizer/ui/app/js/appetizer/core.coffee

@@ -0,0 +1 @@
+window.Appetizer ||= {}

data/lib/appetizer/ui/app/js/appetizer/model.coffee

@@ -0,0 +1 @@
+class Appetizer.Model extends Backbone.Model

data/lib/appetizer/ui/app/js/appetizer/view.coffee

@@ -0,0 +1,138 @@
+# Shockingly enough, a superclass for views. Provides hooks and
+# abstractions for incoming and outgoing bindings, parent and child
+# views, default template rendering, async actions before show, and
+# show()/hide()/makeVisible() helpers on top of render() and remove().
+
+class Appetizer.View extends Backbone.View
+
+  # Subclasses must always call `super` in their initializers:
+  # Important binding, parent, and child relationships get created.
+
+  initialize: (options) ->
+    @bindings = []
+    @children = []
+    @parent   = options.parent if options?.parent?
+    
+    @bind "ancestor:shown", ->
+      child.trigger "ancestor:shown" for child in @children
+      @shown = true
+
+  # true if the element or its ancestor have already been shown.
+  # Can be used at rendering time to execute operations that
+  # need the element to be hooked-up in the DOM, such as computing
+  # its height.
+
+  shown: false
+
+  # Add a child `view`. Its `parent` will be set to `this`, and it
+  # will be dismissed when this view is dismissed.
+
+  addChild: (view) ->
+    view.parent = this
+    @children.push view
+    this
+
+  # Hook to allow async processes to occur before and after showing
+  # the view. A bound callback `fn` is passed to this method by
+  # `show`, and should be called when the view is ready to be shown.
+
+  aroundShow: (fn) -> fn()
+
+  # Bind `fn` to an `event` on `src`, remembering that we've bound it
+  # for future unbinding. Use this instead of calling `bind` directly
+  # on other sources. Returns `this`.
+
+  bindTo: (src, event, fn) ->
+    src.bind event, fn, this
+    @bindings.push evt: event, fn: fn, src: src
+    this
+
+  # Create and return a new instance of `kind`, passing along
+  # `options` to the constructor. Add it as a child view.
+
+  createChild: (kind, options) ->
+    child = new kind options
+    @addChild child
+    child
+
+  # Indicate that this view is no longer necessary. Optionally takes a
+  # DOM event `e` and calls `preventDefault` on it to make wiring
+  # easier. Unbinds all incoming and outgoing events, calls `dismiss`
+  # on all children, and removes this view from any parent it might
+  # have. Returns `this`.
+
+  hide: (e) ->
+    e.preventDefault() if e?.preventDefault?
+
+    @trigger "hiding"
+    @remove()
+
+    @trigger "hidden"
+    @unbind()
+
+    _(@children).chain().clone().each (c) -> c.hide() if c.hide?
+    @parent.removeChild this if @parent?.removeChild
+
+    this
+
+  # Hook to provide actual DOM insertion/manipulation for the
+  # view. The default implementation logs an error message to the
+  # console.
+
+  makeVisible: ->
+    console.log "Can't make #{this.constructor.name} visible."
+
+  # Remove `view` from this view's list of children. Returns `this`.
+
+  removeChild: (view) ->
+    @children.splice _.indexOf(@children, view), 1
+    this
+
+  # Render the contents of the view. Updates the view element's
+  # contents, but doesn't do any other manipulation. Uses a JST based
+  # on either the view class' `template` default value or a `template`
+  # key passed in to the constructor. Triggers a "rendered" event
+  # after the element's contents are in place. Returns `this`.
+  #
+  # Assumes that views are under a "client/" prefix and that their
+  # template functions are available on a "JST" global.
+
+  render: =>
+    template = @options.template || @template || "appetizer/missing"
+    renderer = JST["client/#{template}"] or JST["client/appetizer/missing"]
+
+    @trigger "rendering"
+    $(@el).html renderer this
+    @trigger "rendered"
+
+    this
+
+  # Display this view. Possibly asynchronous: Passes a bound callback
+  # to `beforeShow` that will call `makeVisible` when the view is
+  # ready for display. The default implementation of `makeVisible`
+  # calls the callback immediately. Returns `this`.
+
+  show: ->
+    @aroundShow =>
+      @trigger "showing"
+      @makeVisible()
+      @trigger "shown"
+
+      @shown = true
+      child.trigger "ancestor:shown" for child in @children
+
+    this
+
+  # Unbind any listeners who have bound themselves to us, and unbind
+  # any listeners we've bound to others. Returns `this`.
+
+  unbind: ->
+    super # from Backbone.Events
+    b.src.unbind b.evt, b.fn for b in @bindings
+    this
+
+  # Unbind all events we may have bound on `src`. Returns `this`.
+
+  unbindFrom: (src) ->
+    b.src.unbind b.evt, b.fn for b in @bindings when b.src is src
+    this

data/lib/appetizer/ui/app/js/appetizer/xdr.coffee

@@ -0,0 +1,46 @@
+# IE XDomainRequest support. Oh how I hate it.
+
+statii =
+  200: "OK"
+  201: "CREATED"
+  202: "ACCEPTED"
+  204: "NO CONTENT"
+  401: "UNAUTHORIZED"
+  403: "FORBIDDEN"
+  404: "NOT FOUND"
+  409: "CONFLICT"
+  422: "PRECONDITION FAILED"
+  500: "INTERNAL SERVER ERROR"
+
+Appetizer.transportXDR = (settings, original, xhr) ->
+  xdr   = new XDomainRequest
+  sep   = if settings.url.indexOf("?") is -1 then "?" else "&"
+  url   = [settings.url, "xdr"].join sep
+
+  xdr.open "POST", url
+
+  abort: ->
+    xdr.abort()
+
+  send: (headers, complete) ->
+    xdr.onerror = ->
+      console.log "FIX: xdr onerror"
+
+    xdr.onload = ->
+      [status, headers, body] = $.parseJSON xdr.responseText
+
+      description = statii[status] or "UNKNOWN"
+      responses   = text: body
+
+      complete status, description, responses, headers
+
+    xdr.onprogress = ->
+
+      # HACK: I wasn't able to get multiple requests to work (only
+      # the first one would ever trigger `onload`) until I assigned
+      # this empty handler to `onprogress`. What the actual fuck.
+
+    xdr.ontimeout = ->
+      console.log "FIX: xdr ontimeout"
+
+    xdr.send JSON.stringify [settings.type, headers, settings.data]

data/lib/appetizer/ui/app/views/client/appetizer/missing.jst.eco

@@ -0,0 +1,3 @@
+<div style="background-color:pink;border:1px solid red">
+  Missing template for <%= @constructor.name %>.
+</div>

data/lib/appetizer/ui/assets.rb

@@ -0,0 +1,91 @@
+require "coffee-script"
+require "eco"
+require "fileutils"
+require "sass"
+require "securerandom"
+require "sinatra/base"
+require "sprockets"
+require "uglifier"
+require "yui/compressor"
+
+module App
+  def self.assets
+    @sprockets ||= Sprockets::Environment.new.tap do |s|
+      if App.production? || ENV["APPETIZER_MINIFY_ASSETS"]
+        s.register_bundle_processor "application/javascript", :uglifier do |ctx, data|
+          Uglifier.compile data
+        end
+
+        s.register_bundle_processor "text/css", :yui do |ctx, data|
+          YUI::CssCompressor.new.compress data
+        end
+      end
+
+      # NOTE: Seems like Sprockets' built-in FileStore is kinda busted
+      # in the way it creates directories or processes key names (or I
+      # don't understand it yet), so we're manually creating the
+      # over-nested directory for the moment.
+
+      unless App.production?
+        FileUtils.mkdir_p "tmp/sprockets/sprockets"
+        s.cache = Sprockets::Cache::FileStore.new "tmp/sprockets"
+      end
+
+      %w(css img js views).each do |d|
+        s.append_path "./app/#{d}"
+        s.append_path "./vendor/#{d}"
+        s.append_path File.expand_path("../app/#{d}", __FILE__)
+        s.append_path File.expand_path("../vendor/#{d}", __FILE__)
+      end
+    end
+  end
+end
+
+module Appetizer
+  module UI
+    module Assets
+      def self.manifest
+        return @manifest if defined? @manifest
+
+        @manifest = Hash.new { |h, k| k }
+
+        if File.file? file = "public/assets/manifest.yml"
+          require "yaml"
+          @manifest.merge! YAML.load File.read file
+        end
+
+        @manifest
+      end
+
+      def self.registered app
+        app.helpers do
+          def asset name
+            if App.production?
+              return cdnify "/assets/#{Appetizer::UI::Assets.manifest[name]}"
+            end
+
+            cdnify "/assets/#{App.assets[name].logical_path}"
+          end
+
+          def assets *names
+            names.flat_map do |name|
+              next asset name if App.production?
+
+              asset = App.assets[name]
+
+              [asset.dependencies, asset].flatten.map do |dep|
+                "/assets/#{dep.logical_path}?body=true&buster=#{SecureRandom.hex 10}"
+              end
+            end
+          end
+
+          def cdnify path
+            File.join [ENV["APPETIZER_CDN_URL"], path].compact
+          end
+        end
+      end
+    end
+  end
+end
+
+Sinatra.register Appetizer::UI::Assets