sinatra-backbone-2 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b298438993e405f71dbfc8505c9a13ad08c2d602
+  data.tar.gz: bf4f06c3d7025a750daf0ed27b12b9bb225103c4
+SHA512:
+  metadata.gz: 5436faf91a0139869f3d43e1c7cd0e8786529c24a61253e8314766bbc13ec7739da3d289d06d97f56e0092ce012dd1acf589608323b274cf2e2ad9f7ae0a461f
+  data.tar.gz: 2de609aa39dd72b0771f388942f35c5460ff0fb67f29e8a566d7b29cec84da81db1c8a0176739be276d58be991b5a2e4c3c7d5e2c710f3d0e843a6349a8a5289

data/.gitignore

@@ -0,0 +1,2 @@
+/doc
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 2.0.0
+matrix:
+  include:
+    - { rvm: 2.0.0, env: sinatra=1.3 }
+    - { rvm: 2.0.0, env: sinatra=1.4 }
+    - { rvm: 2.0.0, env: sinatra=master }

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+gemspec
+
+case ENV['sinatra']
+  when '1.3'    then gem 'sinatra', '~> 1.3.0'
+  when '1.4'    then gem 'sinatra', '~> 1.4.0'
+  when 'master' then gem 'sinatra', :github => 'sinatra/sinatra', :branch => 'master'
+end

data/HISTORY.md

@@ -0,0 +1,23 @@
+v0.1.1 - Apr 17, 2013
+---------------------
+
+  * Allow `.jst` file extensions. (in addition to `.jst.eco` and similar)
+  * Check for validity of models on the server.
+  * Documentation updates.
+  * Make the error message helpful if you forget #to_hash.
+  * Refactor rest_resource to split up into rest_edit, rest_delete and rest_get.
+  * Support multiple args in routes.
+
+v0.1.0.rc2 - Sep 12, 2011
+-------------------------
+
+### Changed:
+  * Check for validity of models on the server, and add an example.
+  * Added examples in the documentation.
+  * Support multiple args in routes.
+  * Added more tests.
+
+v0.1.0.rc1 - Sept 12, 2011
+--------------------------
+
+Initial version.

data/NOTES.md

@@ -0,0 +1,18 @@
+Development notes
+=================
+
+### Multiple Sinatra version testing
+
+    $ rake test!
+
+Or a certain version:
+
+    $ sinatra=1.3 bundle exec rake test
+
+### Documentation
+
+Install [reacco], then:
+
+    $ rake doc:build
+
+[reacco]: https://github.com/rstacruz/reacco

data/README.md

@@ -0,0 +1,51 @@
+# Sinatra-backbone
+#### Neat integration of Backbone.js with Sinatra
+
+Do you like [Backbone.js][bb]? Do you like [Sinatra][sn]? Did you ever wish you 
+can use them together? Well now you can, with the new Sinatra Backbone!
+
+[bb]: http://documentcloud.github.com/backbone/
+[sn]: http://sinatrarb.com
+
+#### Usage
+
+This is a Ruby gem.  
+`$ gem install sinatra-backbone --pre`
+
+Or do you use Bundler?  
+`gem 'sinatra-backbone', :require => 'sinatra/backbone'`
+
+Contents
+--------
+
+__Sinatra-backbone__ is comprised of two Sinatra plugins:
+
+ * `Sinatra::JstPages` – Provides support for JavaScript server templates (JST) 
+  for use in Backbone views. See [JstPages example][jstx] for a full example 
+  application.
+
+ * `Sinatra::RestAPI` – Provides restful API for your models for use in Backbone 
+ models. See [RestAPI example][restx] for a full example application.
+
+[jstx]: https://github.com/rstacruz/sinatra-backbone/tree/master/examples/jstpages
+[restx]: https://github.com/rstacruz/sinatra-backbone/tree/master/examples/restapi
+
+For usage and API reference, please see http://ricostacruz.com/sinatra-backbone. [](#api_reference)
+
+Acknowledgements
+----------------
+
+© 2011, Rico Sta. Cruz. Released under the [MIT 
+License](http://www.opensource.org/licenses/mit-license.php).
+
+Sinatra-Backbone is authored and maintained by [Rico Sta. Cruz][rsc] with help 
+from its [contributors][c]. It is sponsored by my startup, [Sinefunc, Inc][sf].
+
+ * [My website](http://ricostacruz.com) (ricostacruz.com)
+ * [Sinefunc, Inc.](http://sinefunc.com) (sinefunc.com)
+ * [Github](http://github.com/rstacruz) (@rstacruz)
+ * [Twitter](http://twitter.com/rstacruz) (@rstacruz)
+
+[rsc]: http://ricostacruz.com
+[c]:   http://github.com/rstacruz/xxxxx
+[sf]:  http://sinefunc.com

data/Rakefile

@@ -0,0 +1,34 @@
+require 'bundler/gem_tasks'
+
+desc "Invokes the test suite in multiple RVM environments"
+task :'test!' do
+  %w[1.3 1.4 master].each do |version|
+    env = "env sinatra=#{version}"
+    system("rm -f Gemfile.lock; #{env} bundle && #{env} bundle exec rake test") or abort
+  end
+end
+
+desc "Runs tests"
+task :test do
+  Dir['test/*_test.rb'].each { |f| load f }
+end
+
+task :default => :test
+
+repo = ENV['GITHUB_REPO'] || 'rstacruz/sinatra-backbone'
+namespace :doc do
+  desc "Builds documentation"
+  task :build do
+    # github.com/rstacruz/reacco
+    analytics = "--analytics #{ENV['ANALYTICS_ID']}"  if ENV['ANALYTICS_ID']
+    system "reacco --literate --toc --api lib --github #{repo} #{analytics}"
+  end
+
+  desc "Uploads documentation"
+  task :deploy => :build do
+    # github.com/rstacruz/git-update-ghpages
+    system "git update-ghpages -i doc #{repo}"
+  end
+end
+
+task :doc => :'doc:build'

data/examples/jstpages/app.rb

@@ -0,0 +1,21 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+
+require 'sinatra/base'
+require 'sequel'
+require 'sinatra/backbone'
+
+class App < Sinatra::Base
+  enable   :raise_errors, :logging
+  enable   :show_exceptions  if development?
+
+  register Sinatra::JstPages
+  serve_jst '/jst.js'
+
+  set :root,   File.expand_path('../', __FILE__)
+  set :views,  File.expand_path('../views', __FILE__)
+  set :public, File.expand_path('../public', __FILE__)
+
+  get '/' do
+    erb :home
+  end
+end

data/examples/jstpages/config.ru

@@ -0,0 +1,3 @@
+require './app'
+App.set :run, false
+run App

data/examples/jstpages/public/app.js

@@ -0,0 +1,20 @@
+// Here is our Backbone model!
+$(function() {
+  do_test();
+});
+
+function do_test() {
+  echo("<h3>Rendering from template:</h3>");
+  echo(JST['hello']({name: "Julie Kitzinger", age: "33"}));
+  echo("<h3>Success!</h3>");
+}
+
+// Helper functions
+function echo(html) {
+  $("#messages").append(html);
+};
+
+function onerror() {
+  echo("<p class='error'>Oops... an error occured.</p>");
+};
+

data/examples/jstpages/views/hello.jst.tpl

@@ -0,0 +1,6 @@
+<p>Hello, this is me:</p>
+
+<dl>
+<dt>Name:</dt><dd><%= name %></dd>
+<dt>Age:</dt><dd><%= age %></dd>
+</dl>

data/examples/jstpages/views/home.erb

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8" />
+    <title></title>
+    <script src='http://cdnjs.cloudflare.com/ajax/libs/jquery/1.6.2/jquery.min.js'></script>
+    <script src='http://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.1.7/underscore-min.js'></script>
+    <script src='http://cdnjs.cloudflare.com/ajax/libs/backbone.js/0.5.3/backbone-min.js'></script>
+    <style>
+      body { font-family: sans-serif; font-size: 13px; line-height: 1.5; background: #d0d0da; }
+      #messages { width: 400px; margin: 20px auto; background: white; padding: 20px; border: solid 10px #c0c0ca; }
+      h3 { border-top: dotted 1px #ccc; padding: 20px 20px 0 20px; margin: 20px -20px 0 -20px; color: #46a; }
+      h3:first-child { border-top: 0; margin-top: 0; padding-top: 0; }
+      dl { overflow: hidden; }
+      dt { float: left; width: 120px; margin-right: 10px; text-align: right; color: #aaa; }
+      h3 { font-family: palatino; font-size: 1.3em; }
+    </style>
+</head>
+<body>
+    <div id="messages">
+    </div>
+    <script src='jst.js'></script>
+    <script src='app.js'></script>
+</body>
+</html>

data/examples/restapi/app.rb

@@ -0,0 +1,40 @@
+$:.unshift File.expand_path('../../../lib', __FILE__)
+
+require 'sinatra/base'
+require 'sequel'
+require 'sinatra/backbone'
+
+DB = Sequel.connect("sqlite::memory:")
+DB.create_table :books do
+  primary_key :id
+  String :title
+  String :author
+end
+
+class Book < Sequel::Model
+  def to_hash
+    { :id => id, :title => title, :author => author }
+  end
+
+  def validate
+    errors.add :author, "can't be empty"  if author.to_s.size == 0
+  end
+end
+
+class App < Sinatra::Base
+  enable   :raise_errors, :logging
+  enable   :show_exceptions  if development?
+
+  register Sinatra::RestAPI
+
+  rest_create("/book") { Book.new }
+  rest_resource("/book/:id") { |id| Book[id] }
+
+  set :root,   File.expand_path('../', __FILE__)
+  set :views,  File.expand_path('../', __FILE__)
+  set :public, File.expand_path('../public', __FILE__)
+
+  get '/' do
+    erb :home
+  end
+end

data/examples/restapi/config.ru

@@ -0,0 +1,3 @@
+require './app'
+App.set :run, false
+run App

data/examples/restapi/home.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8" />
+    <title></title>
+    <script src='http://cdnjs.cloudflare.com/ajax/libs/jquery/1.6.2/jquery.min.js'></script>
+    <script src='http://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.1.7/underscore-min.js'></script>
+    <script src='http://cdnjs.cloudflare.com/ajax/libs/backbone.js/0.5.3/backbone-min.js'></script>
+    <style>
+      body { font-family: sans-serif; font-size: 13px; line-height: 1.5; background: #d0d0da; }
+      #messages { width: 400px; margin: 20px auto; background: white; padding: 20px; border: solid 10px #c0c0ca; }
+      h3 { border-top: dotted 1px #ccc; padding: 20px 20px 0 20px; margin: 20px -20px 0 -20px; color: #46a; }
+      h3:first-child { border-top: 0; margin-top: 0; padding-top: 0; }
+      dl { overflow: hidden; }
+      dt { float: left; width: 120px; margin-right: 10px; text-align: right; color: #aaa; }
+      h3 { font-family: palatino; font-size: 1.3em; }
+    </style>
+</head>
+<body>
+    <div id="messages">
+    </div>
+    <script src='app.js'></script>
+</body>
+</html>

data/examples/restapi/public/app.js

@@ -0,0 +1,105 @@
+// Here is our Backbone model!
+Book = Backbone.Model.extend({
+  urlRoot: '/book'
+});
+
+$(function() {
+  do_create();
+});
+
+function do_create() {
+  echo("<h3>Creating a book:</h3>");
+
+  var book = new Book;
+  book.set({ title: "Darkly Dreaming Dexter", author: "Jeff Lindsay" });
+  book.save({}, {
+    error: onerror,
+    success: function() {
+      print_book(book);
+      echo("<h3>Retrieving the same book:</h3>");
+      do_retrieve(book);
+    }
+  });
+}
+
+function do_retrieve(_book) {
+  var book = new Book({ id: _book.id });
+  book.fetch({
+    error: onerror,
+    success: function() {
+      print_book(book);
+      do_edit_error(book);
+    }
+  });
+}
+
+function do_edit_error(book) {
+  echo("<h3>Editing book with an error:</h3>");
+  console.log("(You should see an HTTP error right about here:)");
+  book.set({ author: '' });
+  book.save({}, {
+    success: onerror,
+    error: function() {
+      console.log("(...yep.)");
+      echo("...yes, it occured.");
+      do_edit(book);
+    }
+  });
+}
+
+function do_edit(book) {
+  echo("<h3>Editing book:</h3>");
+  book.set({ author: 'Anne Rice', title: 'The Claiming of Sleeping Beauty' });
+  book.save({}, {
+    error: onerror,
+    success: function() {
+      print_book(book);
+      do_delete(book);
+    }
+  });
+}
+
+function do_delete(book) {
+  echo("<h3>Deleting book:</h3>");
+  book.destroy({
+    error: onerror,
+    success: function() {
+      echo("Success.");
+      do_verify_delete(book.id);
+    }
+  });
+}
+
+function do_verify_delete(id) {
+  echo("<h3>Checking if book "+id+" still exists:</h3>");
+  console.log("(You should see an HTTP error right about here:)");
+  var book = new Book({ id: id });
+  book.fetch({
+    success: onerror,
+    error: function() {
+      console.log("(...yep.)");
+      echo("No, it doesn't.");
+      do_success();
+    }
+  });
+}
+
+function do_success() {
+  echo("<h3>Success!</h3>");
+}
+
+function print_book(book) {
+  echo("<dl><dt>Title:</dt><dd>"+book.get('title')+"</dd></dl>");
+  echo("<dl><dt>Author:</dt><dd>"+book.get('author')+"</dd></dl>");
+  echo("<dl><dt>ID:</dt><dd>"+book.get('id')+"</dd></dl>");
+}
+
+// Helper functions
+function echo(html) {
+  $("#messages").append(html);
+};
+
+function onerror() {
+  echo("<p class='error'>Oops... an error occured.</p>");
+};
+

data/lib/sinatra/backbone.rb

@@ -0,0 +1,10 @@
+module Sinatra
+  module Backbone
+    def self.version
+      "0.1.1"
+    end
+  end
+
+  autoload :RestAPI,  "sinatra/restapi"
+  autoload :JstPages, "sinatra/jstpages"
+end

data/lib/sinatra/jstpages.rb

@@ -0,0 +1,261 @@
+# ## JstPages [module]
+# A Sinatra plugin that adds support for JST (JavaScript Server Templates).
+# See [JstPages example][jstx] for a full example application.
+#
+# ### Basic usage
+# Register the `Sinatra::JstPages` plugin in your application, and use
+# `serve_jst`.  This example serves all JST files found in `/views/**/*.jst.*`
+# (where `/views` is your views directory as defined in Sinatra's
+# `settings.views`) as `http://localhost:4567/jst.js`.
+#
+#     require 'sinatra/jstpages'
+#
+#     class App < Sinatra::Base
+#       register Sinatra::JstPages
+#       serve_jst '/jst.js'
+#     end
+#
+# You will need to link to the JST route in your layout. Make a `<script>` tag
+# where the `src='...'` attribute is the same path you provide to `serve_jst`.
+#
+#     <script type='text/javascript' src='/jst.js'></script>
+#
+# So, if you have a JST view placed in `views/editor/edit.jst.tpl`:
+#
+#     # views/editor/edit.jst.tpl
+#     <h1>Edit <%= name %></h1>
+#     <form>
+#       <button>Save</button>
+#     </form>
+#
+# Now in your browser you may invoke `JST['templatename']`:
+#
+#     // Renders the editor/edit template
+#     JST['editor/edit']();
+#
+#     // Renders the editor/edit template with template parameters
+#     JST['editor/edit']({name: 'Item Name'});
+#
+# #### Using Sinatra-AssetPack?
+#
+# __TIP:__ If you're using the [sinatra-assetpack][sap] gem, just add `/jst.js`
+# to a package.  (If you're not using Sinatra AssetPack yet, you probably
+# should.)
+#
+# [sap]: http://ricostacruz.com/sinatra-assetpack
+#
+# ### Supported templates
+#
+# __[Jade][jade]__ (`.jst.jade`) -- Jade templates. This requires
+# [jade.js][jade]. For older browsers, you will also need [json2.js][json2],
+# and an implementation of [String.prototype.trim][trim].
+#
+#     # views/editor/edit.jst.jade
+#     h1= "Edit "+name
+#       form
+#         button Save
+#
+# __[Underscore templates][under_tpl]__ (`.jst.tpl`) -- Simple templates by
+# underscore. This requires [underscore.js][under], which Backbone also
+# requires.
+#
+#     # views/editor/edit.jst.tpl
+#     <h1>Edit <%= name %></h1>
+#     <form>
+#       <button>Save</button>
+#     </form>
+#
+# __[Haml.js][haml]__ (`.jst.haml`) -- A JavaScript implementation of Haml.
+# Requires [haml.js][haml].
+#
+#     # views/editor/edit.jst.haml
+#     %h1= "Edit "+name
+#       %form
+#         %button Save
+#
+# __[Eco][eco]__ (`.jst.eco`) -- Embedded CoffeeScript templates. Requires
+# [eco.js][eco] and [coffee-script.js][cs].
+#
+#     # views/editor/edit.jst.eco
+#     <h1>Edit <%= name %></h1>
+#     <form>
+#       <button>Save</button>
+#     </form>
+#
+# You can add support for more templates by subclassing the `Engine` class.
+#
+# [jade]: http://github.com/visionmedia/jade
+# [json2]: https://github.com/douglascrockford/JSON-js
+# [trim]: http://snippets.dzone.com/posts/show/701
+# [under_tpl]: http://documentcloud.github.com/underscore/#template
+# [under]: http://documentcloud.github.com/underscore
+# [haml]: https://github.com/creationix/haml-js
+# [eco]: https://github.com/sstephenson/eco
+# [cs]: http://coffeescript.org
+# [jstx]: https://github.com/rstacruz/sinatra-backbone/tree/master/examples/jstpages
+#
+module Sinatra
+  module JstPages
+    def self.registered(app)
+      app.extend ClassMethods
+      app.helpers Helpers
+    end
+
+    # Returns a hash to determine which engine is mapped onto a given extension.
+    def self.mappings
+      @mappings ||= Hash.new
+    end
+
+    def self.register(ext, engine)
+      mappings[ext] = engine
+    end
+
+    module Helpers
+      # Returns a list of JST files.
+      def jst_files(options = {})
+        # Tuples of [ name, Engine instance ]
+        root = options[:root] || settings.views
+        tuples = Dir.chdir(root) {
+          Dir["**/*.jst*"].map { |fn|
+            name   = fn.match(%r{^(.*)\.jst})[1]
+            ext    = fn.match(%r{\.([^\.]*)$})[1]
+            engine = JstPages.mappings[ext]
+
+            [ name, engine.new(name, File.join(root, fn)) ] if engine
+          }.compact
+        }
+
+        Hash[*tuples.flatten]
+      end
+    end
+
+    module ClassMethods
+      # ### serve_jst(path, [options]) [class method]
+      # Serves JST files in given `path`.
+      #
+      def serve_jst(path, options={})
+        get path do
+          content_type :js
+          jsts = jst_files(options).map do |(name, engine)|
+            engine.compile!
+          end
+
+          %{
+            (function(){
+              var c = {};
+              if (!window.JST) window.JST = {};
+              #{jsts.join("\n  ")}
+            })();
+          }.strip.gsub(/^ {12}/, '')
+        end
+      end
+    end
+  end
+end
+
+
+# ## JstPages::Engine [class]
+# A template engine.
+#
+# #### Adding support for new template engines
+# You will need to subclass `Engine`, override at least the `function` method,
+# then use `JstPages.register`.
+#
+# This example will register `.jst.my` files to a new engine that uses
+# `My.compile`.
+#
+#     module Sinatra::JstPages
+#       class MyEngine < Engine
+#         def compile!() "My.compile(#{contents.inspect})"; end
+#       end
+#
+#       register 'my', MyEngine
+#     end
+#
+module Sinatra::JstPages
+  class Engine
+    # ### name [attribute]
+    # The name of the template.
+    attr_reader :name
+
+    # ### file [attribute]
+    # The string path of the template file.
+    attr_reader :file
+
+    def initialize(name, file)
+      @name = name
+      @file = file
+    end
+
+    # ### contents [method]
+    # Returns the contents of the template file as a string.
+    def contents
+      File.read(@file)
+    end
+
+    def wrap_jst(name)
+      compiled_contents = contents
+      compiled_contents = yield if block_given?
+
+      <<JS.strip.gsub(/^ {12}/, '')
+JST[#{name.inspect}] = function() {
+    if (!c[#{name.inspect}]) c[#{name.inspect}] = (#{compiled_contents});
+    return c[#{name.inspect}].apply(this, arguments);
+  };
+JS
+    end
+
+    # ### function [method]
+    # The JavaScript function to invoke on the precompile'd object.
+    #
+    # What this returns should, in JavaScript, return a function that can be
+    # called with an object hash of the params to be passed onto the template.
+    def compile!
+      wrap_jst(name) do
+        "_.template(#{contents.inspect})"
+      end
+    end
+  end
+
+  class HamlEngine < Engine
+    def compile!
+      wrap_jst(name) do
+        "Haml(#{contents.inspect})";
+      end
+    end
+  end
+
+  class JadeEngine < Engine
+    def compile!
+      wrap_jst(name) do
+        "require('jade').compile(#{contents.inspect})"
+      end
+    end
+  end
+
+  class EcoEngine < Engine
+    def compile!
+      wrap_jst(name) do
+        "function() { var a = arguments.slice(); a.unshift(#{contents.inspect}); return eco.compile.apply(eco, a); }"
+      end
+    end
+  end
+
+  class HamlCoffeeEngine < Engine
+    def compile!
+      HamlCoffeeAssets.config.context = false
+      HamlCoffeeAssets::Compiler.compile(name, contents, true).
+        match(/^  window.JST(.*)\n  };$/m)[0].gsub(/^  window.JST/, 'JST')
+    end
+  end
+
+  register 'tpl', Engine
+  register 'jst', Engine
+  register 'jade', JadeEngine
+  register 'haml', HamlEngine
+  register 'eco', EcoEngine
+
+  if defined?(HamlCoffeeAssets)
+    register 'hamlc', HamlCoffeeEngine
+  end
+end