fannypack 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec77acdd5b07e0af9a1dafea7e729073fdd183f9
+  data.tar.gz: aebeed7dbbef0d2161fbfc386a61449c69955c22
+SHA512:
+  metadata.gz: 973bab2d78627bad9f42bf97745eb1c7ee4ed68db4c15355bfc2084a3ddc5872e210b6a6db2383de621f5fc698be5f43e29e7c572b024144ba3c980ca5117bb1
+  data.tar.gz: 96efa165e8112e7c9f8df0a3a9be59e1d07c03e0be8435243c3d370b420f9a2f9fb99ee026c02dc50b70ad4708cab248b212ecfd5e73b2fcedd9cfb29ae24671

data/.gitignore

@@ -0,0 +1,14 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+# git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the build directory
+/build
+
+# Ignore Sass' cache
+/.sass-cache

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p451

data/Gemfile

@@ -0,0 +1,8 @@
+# If you have OpenSSL installed, we recommend updating
+# the following line to use "https"
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'jasmine', '~> 2.0.0'
+gem 'middleman-jasmine'

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    fannypack (0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    chunky_png (1.3.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.7.0)
+    compass (0.12.6)
+      chunky_png (~> 1.2)
+      fssm (>= 0.2.7)
+      sass (~> 3.2.19)
+    compass-import-once (1.0.4)
+      sass (>= 3.2, < 3.5)
+    erubis (2.7.0)
+    execjs (2.0.2)
+    ffi (1.9.3)
+    fssm (0.2.10)
+    growl (1.0.3)
+    haml (4.0.5)
+      tilt
+    hike (1.2.3)
+    hooks (0.4.0)
+      uber (~> 0.0.4)
+    i18n (0.6.9)
+    jasmine (2.0.1)
+      jasmine-core (~> 2.0.0)
+      phantomjs
+      rack (>= 1.2.1)
+      rake
+    jasmine-core (2.0.0)
+    json (1.8.1)
+    kramdown (1.3.3)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    middleman (3.3.2)
+      coffee-script (~> 2.2.0)
+      compass (>= 0.12.4)
+      compass-import-once (~> 1.0.4)
+      execjs (~> 2.0)
+      haml (>= 4.0.5)
+      kramdown (~> 1.2)
+      middleman-core (= 3.3.2)
+      middleman-sprockets (>= 3.1.2)
+      sass (>= 3.2.17, < 4.0)
+      uglifier (~> 2.5)
+    middleman-core (3.3.2)
+      activesupport (~> 4.0.1)
+      bundler (~> 1.1)
+      erubis
+      hooks (~> 0.3)
+      i18n (~> 0.6.9)
+      listen (~> 1.1)
+      padrino-helpers (~> 0.12.1)
+      rack (>= 1.4.5, < 2.0)
+      rack-test (~> 0.6.2)
+      thor (>= 0.15.2, < 2.0)
+      tilt (~> 1.4.1, < 2.0)
+    middleman-jasmine (0.5.0)
+      jasmine (~> 2.0.0)
+      middleman (~> 3.3.2)
+    middleman-sprockets (3.3.3)
+      middleman-core (>= 3.2)
+      sprockets (~> 2.2)
+      sprockets-helpers (~> 1.1.0)
+      sprockets-sass (~> 1.1.0)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    padrino-helpers (0.12.1)
+      i18n (~> 0.6, >= 0.6.7)
+      padrino-support (= 0.12.1)
+      tilt (~> 1.4.1)
+    padrino-support (0.12.1)
+      activesupport (>= 3.1)
+    phantomjs (1.9.7.0)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.1)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.3)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.2)
+      ffi (>= 0.5.0)
+    sass (3.2.19)
+    sprockets (2.12.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-helpers (1.1.0)
+      sprockets (~> 2.0)
+    sprockets-sass (1.1.0)
+      sprockets (~> 2.0)
+      tilt (~> 1.1)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tilt (1.4.1)
+    tzinfo (0.3.39)
+    uber (0.0.4)
+    uglifier (2.5.0)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fannypack!
+  growl
+  jasmine (~> 2.0.0)
+  middleman (~> 3.3)
+  middleman-jasmine
+  rb-fsevent

data/Guardfile

@@ -0,0 +1,6 @@
+spec_location = "spec/javascripts/%s_spec"
+
+guard 'jasmine-headless-webkit', :all_on_start => false do
+  watch(%r{^source/javascripts/(.*)\.(js|coffee)$}) { |m| newest_js_file(spec_location % m[1]) }
+  watch(%r{^spec/javascripts/(.*)_spec\..*}) { |m| newest_js_file(spec_location % m[1]) }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Poll Everywhere
+
+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/Procfile

@@ -0,0 +1 @@
+web: bundle exec middleman server -p $PORT

data/README.md

@@ -0,0 +1,166 @@
+# fanny-pack
+
+Base classes for building Backbone applications that you shouldn't leave home without.
+
+## Documentation
+
+**Namespacing**: JavaScript doesn’t have a native namespace language feature. We use a simple function to do our namespacing. We even put it on our PollEv object to avoid with other possible namespace implementations.
+
+```coffee
+FannyPack.namespace 'MyApp.View', (View) ->
+  class View.PollWidget extends FannyPack.View.Base
+    show: ->
+    hide: ->
+```
+**Router/Application/EventBus**: FannyPack applications are Backbone routers and use the router as an eventBus. Your application should consist of 1 router that lives at ```FannyPack.app```. All FannyPack base views are aware of the application at ```FannyPack.app```. FannyPack also comes with its own base view which takes care of rendering views. You can override the default behavior to introduce transitions.
+
+```coffee
+# A sample FannyPack application router
+class MyApp extends FannyPack.Router.Base
+  routes:
+    "": "index"
+
+  index: =>
+    view = new View.Index
+
+    # @view view is the routers own view. Call `activate` to replace the existing rendered view with the new view
+    @view.activate view
+
+# This goes in your application.html
+$ ->
+  FannyPack.app = new MyApp().start
+    pushState: true # Enable if you want to start Backbone.history with pushState
+    el: $('body') # The is the element the router will attach its application view to
+```
+
+**Base Class**: The base class can’t infer the current application you’re working on, so you need to define a base class for your application that all your views will inherit from.
+
+```coffee
+FannyPack.namespace 'MyApp.View', (View) ->
+  # set up an application specific base view that
+  # inherits from our FannyPack base view
+  class View.Base extends FannyPack.View.Base
+```
+
+**Templates**: We use [haml\_coffee\_assets](https://github.com/netzpirat/haml_coffee_assets) for our templating.
+
+`FannyPack.Base#template` resolves the path to your templates relative to your application. First create a .hamlc file in your templates directory (eg. in viz: lib/assets/javascripts/my_app/templates/header.hamlc)
+
+Then, make sure to require it with sprockets.
+
+```coffee
+# FannyPack.Base#renderTemplate usage
+
+#= require my_app/templates/view
+
+FannyPack.namespace "MyApp.View", (View) ->
+  class View.Header extends View.Base
+    render: =>
+      {
+        headerLogoPlacement
+        headerLogoUrl
+      } = @model.flashOptions().attributes
+
+      @$el.html @renderTemplate 'chart_header',
+        title: @model.get('title')
+        headerPlacement: headerLogoPlacement
+        headerLogoUrl: headerLogoUrl
+
+      return @
+```
+
+Note: Since launching HTML charts we've decided to start practicing 'logic-less' templates. That is, we aren't going to pass variables into to templates or use any control flow inside them. They will simply be used to insert markup into the DOM. Any dynamic hiding, or updating text will occur in view methods (this makes re-rendering individual pieces much easier and makes it easier to optimize performance in slow browsers).
+
+**Events**: In addition to the standard event bindings that Backbone sets up for views, we use an eventBus pattern that allows any view to trigger an application specific custom event that other views can listen to. This is better for testing and refactoring than passing hard dependencies into each view’s constructor. You should try to keep all interaction within the appropriate view but sometimes outside or coordinating views need to respond to things happening within subviews.
+
+```coffee
+# FannyPack.Base#triggerEvent usage
+
+FannyPack.namespace 'MyApp.View', (View) ->
+  class View.Header extends View.Base
+    toggle: =>
+      @$el.toggle()
+
+      # send the 'header:toggle' event to any view that is listening
+      # passing them a boolean of whether the current view is hidden
+      @app.trigger 'header:toggle', @$el.hasClass('hidden')
+
+  class View.Body extends View.Base
+    appEvents:
+      'header:toggle': 'resize'
+
+    # this is called whenever ChartHeader or any other view
+    # triggers 'header:toggle'
+    resize: =>
+      @measureBars()
+      @render()
+```
+
+**Modules**: Use modules to break up large classes that have repeated behaviors or just to isolate related behavior. Call include in the class declaration to include other modules.
+
+```coffee
+# FannyPack.Base#include usage
+
+FannyPack.namespace 'MyApp.View' (View) ->
+  View.MyModule = (self) ->
+    eat: ->
+      'mmm'
+
+    sleep: ->
+      'zzz'
+
+    breathe: ->
+      '*silent*'
+
+    getModel: ->
+      self.model
+
+FannyPack.namespace 'MyApp.View', (View) ->
+  class View.Person extends View.Base
+    initialize: ->
+      @include View.MyModule
+
+view = new MyApp.View.Person
+  model: new Backbone.Model
+
+# view now has all these methods
+view.eat() # => 'mmm'
+view.sleep() # => 'zzz'
+view.breathe() # => '*silent*'
+
+view.getModel() # => Backbone.Model
+```
+
+**Memory Management and listening to model events**: Usually Backbone Views are a huge pain to manage in terms of leaking events and memory. FannyPack deals with memory management for you.
+
+```coffee
+# FannyPack.Base#include usage
+
+FannyPack.namespace 'MyApp.View' (View) ->
+  class View.DontLeak extends View.Base
+    appEvents:
+      'otherView:update': 'render'
+
+    events:
+      'click': 'respondToClick'
+
+    initialize: ->
+      # set up your view to listen on change events
+      # emitted from the passed in @model
+      @listenTo @model, 'change', (model, attributes) =>
+        # Do stuff
+
+    render: =>
+      # ...
+
+    respondToClick: (e) ->
+      # ...
+
+  view = new View.DontLeak
+    model: new Backbone.Model
+
+  # FannyPack unbinds all model events set up with listenOn,
+  # all jQuery events, all external events and removes the
+  # view element from the DOM
+  view.remove()
+```

data/Rakefile

@@ -0,0 +1,50 @@
+require "bundler/gem_tasks"
+
+namespace :jasmine do
+  task :configure do
+    require 'jasmine/config'
+
+    begin
+      Jasmine.load_configuration_from_yaml(ENV['JASMINE_CONFIG_PATH'])
+    rescue Jasmine::ConfigNotFound => e
+      puts e.message
+      exit 1
+    end
+  end
+
+  task :require do
+    require 'jasmine'
+  end
+
+  task :require_json do
+    begin
+      require 'json'
+    rescue LoadError
+      puts "You must have a JSON library installed to run jasmine:ci. Try \"gem install json\""
+      exit
+    end
+  end
+
+  desc 'Run continuous integration tests'
+  task :ci => %w(jasmine:require_json jasmine:require jasmine:configure) do
+    config = Jasmine.config
+
+    pid = spawn "foreman start -p #{config.port(:ci)}"
+
+    sleep 5
+
+    formatters = config.formatters.map { |formatter_class| formatter_class.new }
+
+    exit_code_formatter = Jasmine::Formatters::ExitCode.new
+    formatters << exit_code_formatter
+
+    url = "#{config.host}:#{config.port(:ci)}/specs/jasmine"
+    runner = config.runner.call(Jasmine::Formatters::Multi.new(formatters), url)
+    runner.run
+
+    break unless exit_code_formatter.succeeded?
+
+    Process.kill "TERM", pid
+    exit
+  end
+end

data/config.rb

@@ -0,0 +1,74 @@
+###
+# Compass
+###
+
+# Susy grids in Compass
+# First: gem install susy
+# require 'susy'
+
+# Change Compass configuration
+# compass_config do |config|
+#   config.output_style = :compact
+# end
+
+###
+# Page options, layouts, aliases and proxies
+###
+
+# Per-page layout changes:
+#
+# With no layout
+# page "/path/to/file.html", :layout => false
+#
+# With alternative layout
+# page "/path/to/file.html", :layout => :otherlayout
+#
+# A path which all have the same layout
+# with_layout :admin do
+#   page "/admin/*"
+# end
+
+# Proxy (fake) files
+# page "/this-page-has-no-template.html", :proxy => "/template-file.html" do
+#   @which_fake_page = "Rendering a fake page with a variable"
+# end
+
+###
+# Helpers
+###
+
+# Automatic image dimensions on image_tag helper
+# activate :automatic_image_sizes
+
+# Methods defined in the helpers block are available in templates
+# helpers do
+#   def some_helper
+#     "Helping"
+#   end
+# end
+
+set :css_dir, 'stylesheets'
+
+set :js_dir, 'javascripts'
+
+set :images_dir, 'images'
+
+activate :jasmine, jasmine_url: "/specs/jasmine"
+
+# Build-specific configuration
+configure :build do
+  ignore 'images/*.psd'
+  ignore 'stylesheets/lib/*'
+  ignore 'stylesheets/vendor/*'
+  ignore 'javascripts/lib/*'
+  ignore 'javascripts/vendor/*'
+
+  # For example, change the Compass output style for deployment
+  activate :minify_css
+
+  # Minify Javascript on build
+  activate :minify_javascript
+
+  # Fingerprint assets
+  activate :asset_hash, :exts => %w(.jpg .jpeg .png .gif .js .css .hamljs .hamlc .eot .svg .ttf .woff)
+end