sumatra-rails 0.0.2 → 0.0.3.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NmFmY2ZmN2IxMWU4NjJkNWQ0ZTExODEzNGZhYTE5NjQ0Mzc2ZWFjZQ==
+  data.tar.gz: !binary |-
+    ZTU2MzU3MmYxMzkzNWE3N2JhM2QxNThlZDA4MjE0YjJiZmQ5ODU2Nw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDc4ZDRkZjdhZjBlYTQ1OTI4NjNmYzUzYjhjMTc3NWJkNWI3ZmY1N2IyNTg1
+    NGFkMWUxM2VmMzBlNGY2YjViMzI0MWQwYjhkNDRjZmY2ZjUxZGJiZmZmYTJj
+    OWU1Nzk2OWZhZGM4NzEyZGM3NTQ2YmY0YjkxODZhOGJlODYyODM=
+  data.tar.gz: !binary |-
+    Mjc4YmQ2MjdmZDU5NDY0NTRmMWE5NDQyZDVjNzU1ZWE0NGRjYjRlYmVkY2Rk
+    ZDJmOGVkNTYyNDlmOTg0MjZjYzM4YTc5YmUyNDBmMTU1OTJmYjZiNzAzYzMy
+    ZDhjOGM0ZjAxZGIyNDY1YTA1NDZjMmYxMjQ5ZDk1ZTA1YjFhMjY=

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+.bowerrc

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in sumatra.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    sumatra-rails (0.0.3.1)
+      coffee-rails
+      jquery-rails
+      rails (~> 3.2.12)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.12)
+      actionpack (= 3.2.12)
+      mail (~> 2.4.4)
+    actionpack (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activerecord (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    coffee-rails (3.2.2)
+      coffee-script (>= 2.2.0)
+      railties (~> 3.2.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.6.1)
+    erubis (2.7.0)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    hike (1.2.1)
+    i18n (0.6.4)
+    journey (1.0.4)
+    jquery-rails (2.2.1)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.7.7)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.21)
+    multi_json (1.6.1)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.12)
+      actionmailer (= 3.2.12)
+      actionpack (= 3.2.12)
+      activerecord (= 3.2.12)
+      activeresource (= 3.2.12)
+      activesupport (= 3.2.12)
+      bundler (~> 1.0)
+      railties (= 3.2.12)
+    railties (3.2.12)
+      actionpack (= 3.2.12)
+      activesupport (= 3.2.12)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.17.0)
+    tilt (1.3.5)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jquery-rails
+  sumatra-rails!

data/lib/sumatra/rails/version.rb

@@ -1,5 +1,5 @@
 module Sumatra
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.0.3.1"
   end
 end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/sumatra/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/sumatra-rails.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "sumatra/rails/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "sumatra-rails"
+  s.version     = Sumatra::Rails::VERSION
+  s.authors     = ["Tom Scott"]
+  s.email       = ["tubbo@psychedeli.ca"]
+  s.homepage    = "http://github.com/tubbo/sumatra-rails"
+  s.summary     = "Sumatra is a CoffeeScript framework for writing beautiful jQuery plugins."
+  s.description = "Sumatra is a CoffeeScript framework for writing beautiful jQuery plugins."
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = Dir["test/**/*"]
+
+  s.add_dependency "rails", "~> 3.2.12"
+  s.add_dependency "jquery-rails"
+  s.add_dependency "coffee-rails"
+end

data/vendor/assets/javascripts/sumatra.js.coffee

@@ -0,0 +1,121 @@
+# SumatraPlugin
+# -------------
+#
+# A prototype object for common actions when defining jQuery plugins
+# in the Sumatra framework. It is designed so that you never have to
+# override the constructor. Instead, the constructor sets up a common
+# method interface for both initialization (which would happen after
+# construction) and the binding of events, a common task in jQuery
+# plugins. This prototype even handles some of that for you, with
+# the default `bindEvents()` being bound to call the `perform()`
+# method (which must be defined by the object extending `SumatraPlugin`)
+# whenever the element it was constructed with triggers the event
+# defined by `action`.
+#
+# So essentially, you can define almost any jQuery plugin using this
+# interface, even though the only thing binding it to the `sumatra`
+# function is its constructor that takes 3 parameters.
+#
+# `SumatraPlugin` also has facilities for dealing with an options hash
+# and merging said options with defaults. You can define the default
+# options for your plugin like so:
+#
+#     sumatra 'clickToGo', ->
+#       class ClickToGo extends SumatraPlugin
+#         action: 'click'
+#         defaults: { to: 'http://google.com' }
+#         perform: (event) =>
+#           if confirm "Are you sure you want to go to #{@options.goTo}?"
+#             window.location = @options.goTo
+#
+# Then, when instantiating, just override them.
+#
+#     $('a').clickToGo(to: 'http://yahoo.com');
+#
+# This removes the need for writing that boilerplate options hash extend
+# code every time you write a jQuery plugin that takes options. All
+# plugins defined with `sumatra()` take an optional options hash, which is
+# `{}` by default, in case your plugin doesn't require options.
+class @SumatraPlugin
+  # The event to bind to if `perform()` is defined.
+  action: 'one'
+
+  # A hash of attributes that are extended with an options hash passed
+  # into the jQuery plugin upon instantiation. Useful for setting up
+  # data that is required.
+  defaults: {}
+
+  # Instantiate a `SumatraPlugin` and bind it to the current element
+  # with options. This also initiates the workflow.
+  #
+  # **DO NOT OVERRIDE!!**
+  constructor: (current_element, index_of_query, init_options) ->
+    @element = $(current_element)
+    @index = index_of_query
+    @options = @mergeDefaultsWith init_options
+    @initialize() and @bindEvents()
+
+  # Merge `options` hash with the `defaults` as set in the definition
+  # of this object.
+  mergeDefaultsWith: (options) ->
+    _.extend @defaults, @options
+
+  # Run custom constructor code, but blocks instantiation if this method
+  # returns `false`. This method was pretty much designed to be overridden.
+  initialize: ->
+    true
+
+  # Bind the `perform()` method to the `action` as set in the definition
+  # of this plugin. Overriding this method removes the guarantee that
+  # perform() will be called at all...
+  bindEvents: ->
+    if @action?
+      @element.on @action, @perform
+
+  # The event binding that handles `action`. Override this with your own
+  # method. You must override this method or the `bindEvents` method to
+  # get this plugin to do anything. It takes a single argument, `event`,
+  # which represents the given DOMEvent represented by `action` as passed
+  # in by `jQuery.on`.
+  perform: null
+
+# SumatraRuntime
+# --------------
+#
+# Defines a jQuery plugin using a service object with a nice,
+# consistent, CoffeeScript-style interface. Plugins can extend
+# `SumatraPlugin`, a prototype that makes defining plugins with
+# Sumatra easier.
+#
+# The runtime function returns the generated jQuery plugin to the
+# global scope so it can be used in your application code.
+#
+# Arguments:
+#
+# - **plugin_name:** The jQuery plugin name, called like `$('div').myPlugin();`
+# - **plugin_code:** A function that will be executed immediately and must return
+# a single object that takes 3 parameters in its constructor. These parameters
+# are the `element` being targeted by jQuery, the `index` at which it appears
+# in the query, and the `options` hash passed during the instantiation of the
+# jQuery plugin.
+#
+# Example:
+#
+#     sumatra 'myPlugin', ->
+#       class MyPlugin extends SumatraPlugin
+#         action: null
+#         initialize:
+#           alert 'loaded'
+#
+@sumatra = (plugin_name, plugin_code) ->
+  # Instantiate a PluginHelper and apply the current scope. This can
+  # be any object that responds to 3 parameters in its constructor
+  # and will be set to whatever is returned by `plugin_code()`.
+  PluginHelper = plugin_code.apply this
+
+  jQuery.fn[plugin_name] = (options={}) ->
+    @each (index, element) ->
+      # For each element, create a `PluginHelper` instance
+      # of the passed-in `plugin_code` and apply the jQuery
+      # plugin parameters to the constructor. 
+      new PluginHelper(element, index, options)

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sumatra-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3.1
 platform: ruby
 authors:
 - Tom Scott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-15 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -66,19 +59,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
 - config/routes.rb
+- lib/sumatra-rails.rb
 - lib/sumatra/rails/engine.rb
 - lib/sumatra/rails/version.rb
-- lib/sumatra-rails.rb
 - lib/tasks/sumatra_tasks.rake
-- LICENSE.md
-- Rakefile
-- README.md
+- script/rails
+- sumatra-rails.gemspec
+- test/dummy/README.rdoc
+- test/dummy/Rakefile
 - test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/.gitkeep
+- test/dummy/app/models/.gitkeep
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
 - test/dummy/config/database.yml
@@ -94,46 +97,39 @@ files:
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
-- test/dummy/config.ru
+- test/dummy/lib/assets/.gitkeep
+- test/dummy/log/.gitkeep
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
 - test/dummy/script/rails
 - test/integration/navigation_test.rb
 - test/sumatra_test.rb
 - test/test_helper.rb
+- vendor/assets/javascripts/sumatra.js.coffee
 homepage: http://github.com/tubbo/sumatra-rails
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4448772707311110201
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4448772707311110201
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Sumatra is a CoffeeScript framework for writing beautiful jQuery plugins.
 test_files:
 - test/dummy/app/assets/javascripts/application.js