knockout-rails 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+*.swp
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/public/assets/

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'coffee-script'
+group :development, :test do
+  gem 'pry'
+
+  gem 'jasminerice'
+end
+
+gem 'jquery-rails' # For the dummy app

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    knockout-rails (0.0.1)
+      execjs
+      jquery-rails
+      sprockets (>= 2.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.1)
+      actionpack (= 3.1.1)
+      mail (~> 2.3.0)
+    actionpack (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.2)
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    coderay (0.9.8)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.1.3)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    execjs (1.2.9)
+      multi_json (~> 1.0)
+    haml (3.1.3)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jasminerice (0.0.8)
+      haml
+    jquery-rails (1.0.16)
+      railties (~> 3.0)
+      thor (~> 0.14)
+    json (1.6.1)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.6.7)
+      ruby_parser (>= 2.3.1)
+    mime-types (1.17.2)
+    multi_json (1.0.3)
+    polyglot (0.3.3)
+    pry (0.9.7.4)
+      coderay (~> 0.9.8)
+      method_source (~> 0.6.7)
+      ruby_parser (>= 2.3.1)
+      slop (~> 2.1.0)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.1)
+      actionmailer (= 3.1.1)
+      actionpack (= 3.1.1)
+      activerecord (= 3.1.1)
+      activeresource (= 3.1.1)
+      activesupport (= 3.1.1)
+      bundler (~> 1.0)
+      railties (= 3.1.1)
+    railties (3.1.1)
+      actionpack (= 3.1.1)
+      activesupport (= 3.1.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.11)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.8)
+    slop (2.1.0)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-script
+  jasminerice
+  jquery-rails
+  knockout-rails!
+  pry
+  rails (>= 3.1.1)
+  rspec

data/HISTORY.md

@@ -0,0 +1,12 @@
+# 0.0.2 - in progress
+
+- Support collections (fetch multiple records)
+- Client side validation
+
+# 0.0.1 - 17 November 2011
+Initial release. Bare bones moved over from other project. Includes:
+
+- persist view models RESTfully
+- compliant with Rails inherited_resources response
+- built in, bindable server side validation support (errors accessible vie `model.errors.attribute_name()`)
+

data/README.md

@@ -0,0 +1,106 @@
+# Knockout - easily use Knockout.js from the Rails app
+
+If you have any questions please contact me [@dnagir](http://www.ApproachE.com).
+
+This provides a set of conveniences for you to use more like Backbone or Spine, but still fully leveraging KnockoutJS.
+
+# Install
+
+Add it to your Rails application's `Gemfile`:
+
+```ruby
+gem 'knockout'
+```
+
+Then `bundle install`.
+
+Reference `knockout` from your JavaScript as you normally do.
+
+
+# Usage
+
+## Model
+
+After you've referenced the `knockout` you can create your first persistent Model.
+
+```coffee
+class Page extends ko.Model
+  @configure 'page' # This is enough to save the model RESTfully to `/pages/{id}` URL
+```
+
+Too simple. This model conforms to the response of [inherited_resources](https://github.com/josevalim/inherited_resources) Gem.
+
+
+Now you can create the model in your HTML.
+*Note* that we don't do a roundtrip to fetch the data as we already have it when rendering the view.
+
+```haml
+= content_for :script do
+  :javascript
+    jQuery(function(){
+      // Create the viewModel with prefilled data
+      window.page = new Page(#{@page.to_json});
+      ko.applyBindings(window.page); // And bind everything
+    });
+```
+
+Of course you can manipulate the object as you wish:
+
+```coffee
+page.name 'Updated page'
+page.save() # saves it to the server using PUT: /pages/123
+page.name '' # Assign an invalid value that is validated on the server
+request = page.save() # returns the jQuery Deferred, so you can chain into it when necessary
+request.always (xhr, status) ->
+  # The response is 422 with JSON: {name: ["invalid name", "should not be blank"]}
+  # And now we have the errors set automatically!
+  page.errors.name() # "invalid name, should not be blank"
+  # even more than that, errors are already bound and shown in the HTML (see the view below)
+```
+
+Now let's see how we can show the validation errors on the page and bind everything together.
+
+```haml
+
+%form.page.formtastic{:data => {:bind =>'submit: save'}}
+  %fieldset
+    %ol
+      %li.input.string
+        %label.label{:for=>:page_name} Name
+        %input#page_name{:type=>:text, :data=>{:bind=>'value: name'}}
+        %span.inline-error{:data=>{:bind=>'visible: errors.name, text: errors.name'}}
+```
+
+
+# Development
+
+## Help
+
+- Source hosted at [GitHub](https://github.com/dnagir/knockout-rails)
+- Report issues and feature requests to [GitHub Issues](https://github.com/dnagir/knockout-rails/issues)
+- Ping me on Twitter for quickly thing [@dnagir](https://twitter.com/#!/dnagir)
+- Look at the `HISTORY.md` file for current TODO list and other details.
+
+
+## Setup
+
+Assuming you already cloned the repo in cd-d into it:
+
+```bash
+bundle install
+# Now run the Ruby specs
+bundle exec rspec spec/
+# Now start JavaScript server for specs:
+cd spec/dummy
+bundle exec rails s
+# go to http://localhost:3000/jasmine to see the results
+```
+
+Now you can go to `spec/javascripts` and start writing your specs and then modify stuff in `lib/assets/javascripts` to pass those.
+
+
+Pull requests are very welcome, but please include the specs! It's extremely easy to write those!
+
+# License
+
+[MIT] (http://www.opensource.org/licenses/mit-license.php)

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'KnockoutRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/knockout-rails.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "knockout-rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "knockout-rails"
+  s.version     = KnockoutRails::VERSION
+  s.authors     = ["Dmytrii Nagirniak"]
+  s.email       = ["dnagir@gmail.com"]
+  s.homepage    = "http://github.com/dnagir/knockout-rails"
+  s.summary     = %q{Knockout.JS library for Rails Assets Pipeline with convenient Backbone/Spine-like Rails extensions.}
+  s.description = %q{Include the knockout.js and some of its extensions so you can pick what you need. Adds the support for models and interation with the Rails backend.}
+
+  s.rubyforge_project = "knockout-rails"
+
+  s.add_dependency             'sprockets', '>= 2.0.0'
+  s.add_dependency             'execjs'
+  s.add_dependency             'jquery-rails'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rails', '>= 3.1.1'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/assets/javascripts/knockout/bindings.js.coffee

@@ -0,0 +1 @@
+#TODO: Add additional bindings

data/lib/assets/javascripts/knockout/model.js.coffee

@@ -0,0 +1,112 @@
+
+# Module is taken from Spine.js
+moduleKeywords = ['included', 'extended']
+class Module
+  @include: (obj) ->
+    throw('include(obj) requires obj') unless obj
+    for key, value of obj when key not in moduleKeywords
+      @::[key] = value
+    obj.included?.apply(@)
+    @
+
+  @extend: (obj) ->
+    throw('extend(obj) requires obj') unless obj
+    for key, value of obj when key not in moduleKeywords
+      @[key] = value
+    obj.extended?.apply(@)
+    @
+    
+
+Ajax =
+  ClassMethods:
+    configure: (@className) ->
+      @getUrl ||= (model) ->
+        return model.getUrl(model) if model and model.getUrl
+        collectionUrl = "/#{className.toLowerCase()}s"
+        collectionUrl += "/#{model.id()}" if model?.id()
+        collectionUrl
+    extended: -> @include Ajax.InstanceMethods
+
+
+  InstanceMethods:
+    ignore:  -> []
+    mapping: ->
+      return @__ko_mapping__ if @__ko_mapping__
+      mappable =
+        ignore: @ignore()
+      for k, v of this
+        mappable.ignore.push k unless ko.isObservable(v)
+      @__ko_mapping__ = mappable
+
+    toJSON: -> ko.mapping.toJS @, @mapping()
+
+    save: ->
+      data = {}
+      data[@constructor.className] =@toJSON()
+      params =
+        type: if @persisted() then 'PUT' else 'POST'
+        dataType: 'json'
+        beforeSend: (xhr)->
+          token = $('meta[name="csrf-token"]').attr('content')
+          xhr.setRequestHeader('X-CSRF-Token', token) if token
+        url: @constructor.getUrl(@)
+        contentType: 'application/json'
+        context: this
+        processData: false # jQuery tries to serialize to much, including constructor data
+        data: JSON.stringify data
+        statusCode:
+          422: (xhr, status, errorThrown)->
+            errorData = JSON.parse xhr.responseText
+            console.debug("Validation error: ", errorData) if console?.debug?
+            @updateErrors(errorData)
+
+      $.ajax(params)
+        #.fail (xhr, status, errorThrown)-> console.error "fail: ", this
+        .done (resp, status, xhr)-> @updateErrors {}
+        #.always (xhr, status) -> console.info "always: ", this
+
+
+
+class Model extends Module
+  @extend Ajax.ClassMethods
+
+  constructor: (json) ->
+    me = this
+    @set json
+    @id ||= ko.observable()
+    @mapping().ignore.exclude('constructor').filter (v)->
+        not v.startsWith('_') and Object.isFunction me[v]
+      .forEach (fn) ->
+        original = me[fn]
+        me[fn] = original.bind me
+        me._originals ||= {}
+        me._originals[fn] = original
+
+    @persisted = ko.dependentObservable -> !!me.id()
+
+  proxy: -> @mapping().ignore
+
+  set: (json) ->
+    ko.mapping.fromJS json, @mapping(), @
+    me = this
+    @errors ||= {}
+    ignores = @mapping().ignore
+    for key, value of this
+      @errors[key] ||= ko.observable() unless ignores.indexOf(key) >= 0
+    @
+
+  updateErrors: (errorData) ->
+    for key, setter of @errors
+      field = @errors[key]
+      error = errorData[key]
+      message = if error and error.join
+          error.join(", ")
+        else
+          error
+      setter( message ) if field
+    @
+
+  
+# Export it all:
+ko.Module = Module
+ko.Model = Model