sinatra-backbone 0.1.0.rc2 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcedfa3b2d562cb41eb59862c2ec4a6f1b386766
+  data.tar.gz: 354eb0281a8a5a698683fdb5ec0470d83bedff3a
+SHA512:
+  metadata.gz: 32e495b1538b46ff02dfd27a389ea880a511581f8d3f5e0e0754d5cc66e302f3778d0dacfc140339cfd22f5ee10bc2cca1a4a60f98ab5de1d9462510ce493fbf
+  data.tar.gz: da7639ea910d6e761ce0aac430f618a3d7efa4814ae7b75f20d56a1b1aafbd5e4d2dc3aefac6a573e7f4e9c89a900c26a0bb4014e752cf1487ac1c320c24250c

data/.gitignore

@@ -1 +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

@@ -1,3 +1,13 @@
+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
 -------------------------
 

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

@@ -21,10 +21,14 @@ Contents
 __Sinatra-backbone__ is comprised of two Sinatra plugins:
 
  * `Sinatra::JstPages` – Provides support for JavaScript server templates (JST) 
-  for use in Backbone views.
+  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.
+ 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)
 
@@ -35,7 +39,7 @@ Acknowledgements
 License](http://www.opensource.org/licenses/mit-license.php).
 
 Sinatra-Backbone is authored and maintained by [Rico Sta. Cruz][rsc] with help 
-from it's [contributors][c]. It is sponsored by my startup, [Sinefunc, Inc][sf].
+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)

data/Rakefile

@@ -1,9 +1,11 @@
+require 'bundler/gem_tasks'
+
 desc "Invokes the test suite in multiple RVM environments"
 task :'test!' do
-  # Override this by adding RVM_TEST_ENVS=".." in .rvmrc
-  envs = ENV['RVM_TEST_ENVS'] || '1.9.2@sinatra,1.8.7@sinatra'
-  puts "* Testing in the following RVM environments: #{envs.gsub(',', ', ')}"
-  system "rvm #{envs} rake test" or abort
+  %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"
@@ -18,7 +20,8 @@ namespace :doc do
   desc "Builds documentation"
   task :build do
     # github.com/rstacruz/reacco
-    system "reacco -a --api lib --github #{repo}"
+    analytics = "--analytics #{ENV['ANALYTICS_ID']}"  if ENV['ANALYTICS_ID']
+    system "reacco --literate --toc --api lib --github #{repo} #{analytics}"
   end
 
   desc "Uploads documentation"

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

@@ -1,4 +1,4 @@
-$:.unshift File.expand_path('../../lib', __FILE__)
+$:.unshift File.expand_path('../../../lib', __FILE__)
 
 require 'sinatra/base'
 require 'sequel'

data/lib/sinatra/backbone.rb

@@ -1,7 +1,7 @@
 module Sinatra
   module Backbone
     def self.version
-      "0.1.0.rc2"
+      "0.1.1"
     end
   end
 

data/lib/sinatra/jstpages.rb

@@ -1,7 +1,8 @@
-# ## Sinatra::JstPages [module]
+# ## JstPages [module]
 # A Sinatra plugin that adds support for JST (JavaScript Server Templates).
+# See [JstPages example][jstx] for a full example application.
 #
-# #### Basic usage
+# ### 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
@@ -16,15 +17,16 @@
 #
 # 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 written in Jade, placed in `views/editor/edit.jst.jade`:
+# So, if you have a JST view placed in `views/editor/edit.jst.tpl`:
 #
-#     # views/editor/edit.jst.jade
-#     h1= "Edit "+name
-#       form
-#         button Save
+#     # views/editor/edit.jst.tpl
+#     <h1>Edit <%= name %></h1>
+#     <form>
+#       <button>Save</button>
+#     </form>
 #
 # Now in your browser you may invoke `JST['templatename']`:
 #
@@ -42,23 +44,46 @@
 #
 # [sap]: http://ricostacruz.com/sinatra-assetpack
 #
-# #### Supported templates
-# Currently supports the following templates:
+# ### Supported templates
 #
-# * [Jade][jade] (`.jst.jade`) -- Jade templates. This requires
+# __[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].
 #
-# * [Underscore templates][under_tpl] (`.jst.tpl`) -- Simple templates by
+#     # 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.
 #
-# * [Haml.js][haml] (`.jst.haml`) -- A JavaScript implementation of Haml.
+#     # 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].
 #
-# * [Eco][eco] (`.jst.eco`) -- Embedded CoffeeScript templates. Requires
+#     # 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
@@ -67,6 +92,7 @@
 # [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
@@ -86,15 +112,16 @@ module Sinatra
 
     module Helpers
       # Returns a list of JST files.
-      def jst_files
+      def jst_files(options = {})
         # Tuples of [ name, Engine instance ]
-        tuples = Dir.chdir(settings.views) {
-          Dir["**/*.jst.*"].map { |fn|
-            fn       =~ %r{^(.*)\.jst\.([^\.]+)$}
-            name, ext = $1, $2
-            engine    = JstPages.mappings[ext]
+        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(File.join(settings.views, fn)) ]  if engine
+            [ name, engine.new(File.join(root, fn)) ] if engine
           }.compact
         }
 
@@ -109,7 +136,7 @@ module Sinatra
       def serve_jst(path, options={})
         get path do
           content_type :js
-          jsts = jst_files.map { |(name, engine)|
+          jsts = jst_files(options).map { |(name, engine)|
             %{
               JST[#{name.inspect}] = function() {
                 if (!c[#{name.inspect}]) c[#{name.inspect}] = (#{engine.function});
@@ -132,7 +159,7 @@ module Sinatra
 end
 
 
-# ## Sinatra::JstPages::Engine [class]
+# ## JstPages::Engine [class]
 # A template engine.
 #
 # #### Adding support for new template engines
@@ -176,7 +203,7 @@ module Sinatra::JstPages
   end
 
   class HamlEngine < Engine
-    def function() "Haml.compile(#{contents.inspect})"; end
+    def function() "Haml(#{contents.inspect})"; end
   end
 
   class JadeEngine < Engine
@@ -190,6 +217,7 @@ module Sinatra::JstPages
   end
 
   register 'tpl', Engine
+  register 'jst', Engine
   register 'jade', JadeEngine
   register 'haml', HamlEngine
   register 'eco', EcoEngine

data/lib/sinatra/restapi.rb

@@ -1,6 +1,6 @@
 require 'json'
 
-# ## Sinatra::RestAPI [module]
+# ## RestAPI [module]
 # A plugin for providing rest API to models. Great for Backbone.js.
 #
 # To use this, simply `register` it to your Sinatra Application.  You can then
@@ -223,7 +223,16 @@ module Sinatra::RestAPI
   # attempts to convert your model instances to JSON by first trying
   # `object.to_json` on it, then trying `object.to_hash.to_json`.
   #
-  # It's recommended you implement `#to_hash` in your models.
+  # You will need to implement `#to_hash` or `#to_json` in your models.
+  #
+  #     class Album < Sequel::Model
+  #       def to_hash
+  #         { :id     => id,
+  #           :title  => title,
+  #           :artist => artist,
+  #           :year   => year }
+  #       end
+  #     end
 
   # ### Helper methods
   # There are some helper methods that are used internally be `RestAPI`,
@@ -284,7 +293,7 @@ module Sinatra::RestAPI
       # Let's hope they redefined to_hash.
       return obj.to_hash.to_json  if obj.respond_to?(:to_hash)
 
-      raise "Can't convert object to JSON"
+      raise "Can't convert object to JSON. Consider implementing #to_hash to #{obj.class.name}."
     end
   end
 end

data/sinatra-backbone.gemspec

@@ -11,9 +11,10 @@ Gem::Specification.new do |s|
   s.executables = Dir["bin/*"].map { |f| File.basename(f) }
 
   s.add_dependency "sinatra"
+  s.add_development_dependency "rake"
   s.add_development_dependency "sequel", ">= 3.25.0"
-  s.add_development_dependency "sqlite3", ">= 1.3.4"
-  s.add_development_dependency "contest"
-  s.add_development_dependency "mocha"
-  s.add_development_dependency "rack-test"
+  s.add_development_dependency "sqlite3", "~> 1.3.4"
+  s.add_development_dependency "contest", "~> 0.1.3"
+  s.add_development_dependency "mocha", "~> 0.13.3"
+  s.add_development_dependency "rack-test", "~> 0.6.2"
 end

data/test/app_test.rb

@@ -50,7 +50,7 @@ class AppTest < UnitTest
     test "validation fail" do
       hash = { :name => "The Claiming of Sleeping Beauty" }
       post "/book", :model => hash.to_json
-      p last_response
+      assert last_response.status != 200
     end
 
     test "should 404" do

data/test/arity_test.rb

@@ -31,6 +31,7 @@ class ArityTest < UnitTest
 
     test "put/post" do
       FauxModel.any_instance.expects(:x=).times(1).returns(true)
+      FauxModel.any_instance.expects(:valid?).times(1).returns(true)
       FauxModel.any_instance.expects(:save).times(1).returns(true)
 
       header 'Accept', 'application/json, */*'

data/test/emulate_test.rb

@@ -1,4 +1,5 @@
 require File.expand_path('../test_helper', __FILE__)
+require 'ostruct'
 
 class EmulateTest < UnitTest
   class App < Sinatra::Base
@@ -6,7 +7,7 @@ class EmulateTest < UnitTest
     disable :show_exceptions
     enable :raise_errors
 
-    rest_resource("/api/:id") { |id| FauxModel.new id }
+    rest_resource("/api/:id") { |id| FauxModel.new }
   end
 
   def app() App; end
@@ -18,6 +19,7 @@ class EmulateTest < UnitTest
   test "emulate json and emulate http" do
     FauxModel.any_instance.expects(:two=).times(1).returns(true)
     FauxModel.any_instance.expects(:save).times(1).returns(true)
+    FauxModel.any_instance.expects(:valid?).times(1).returns(true)
     FauxModel.any_instance.expects(:to_hash).times(1).returns('a' => 'b')
 
     post "/api/2", :model => { :two => 2 }.to_json

data/test/test_helper.rb

@@ -16,3 +16,5 @@ class UnitTest < Test::Unit::TestCase
 end
 
 DB = Sequel.connect('sqlite::memory:')
+
+puts "==> Environment: Sinatra #{Sinatra::VERSION}, Ruby #{RUBY_VERSION}"

metadata

@@ -1,83 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-backbone
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc2
-  prerelease: 6
+  version: 0.1.1
 platform: ruby
 authors:
 - Rico Sta. Cruz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-12 00:00:00.000000000 +08:00
-default_executable: 
+date: 2013-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2165346540 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165346540
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sequel
-  requirement: &2165345800 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.25.0
   type: :development
   prerelease: false
-  version_requirements: *2165345800
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.25.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2165345140 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.4
   type: :development
   prerelease: false
-  version_requirements: *2165345140
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: contest
-  requirement: &2165344580 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.3
   type: :development
   prerelease: false
-  version_requirements: *2165344580
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2165343740 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.3
   type: :development
   prerelease: false
-  version_requirements: *2165343740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2165343140 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.2
   type: :development
   prerelease: false
-  version_requirements: *2165343140
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.2
 description: Provides Rest API access to your models and serves JST pages.
 email:
 - rico@sinefunc.com
@@ -86,9 +116,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- Gemfile
 - HISTORY.md
+- NOTES.md
 - README.md
 - Rakefile
+- examples/jstpages/app.rb
+- examples/jstpages/config.ru
+- examples/jstpages/public/app.js
+- examples/jstpages/views/hello.jst.tpl
+- examples/jstpages/views/home.erb
 - examples/restapi/app.rb
 - examples/restapi/config.ru
 - examples/restapi/home.erb
@@ -105,29 +143,27 @@ files:
 - test/jst_test.rb
 - test/test_helper.rb
 - test/to_json_test.rb
-has_rdoc: true
 homepage: http://github.com/rstacruz/sinatra-backbone
 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'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Helpful stuff using Sinatra with Backbone.
 test_files: []