backtastic 0.0.3 → 0.4.0

data/README.md

@@ -16,29 +16,31 @@ Usage
 To get started, add it to your Gemfile:
 
     gem "backtastic"
-    
+
 Then, somewhere in your manifest, require it:
 
     #= require "backtastic"
-    
+
 Next, you'll create a view that is a subclass of Backtastic.Views.FormView
 
     class EditPersonView extends Backtastic.Views.FormView
-      
+
       template: JST["edit_person_view_tempate"]
 
 Backtastic provides a render method that will invoke your template with the view itself as the template context.  This means methods from the FormView are available for use in your templates, and this is how the form field helpers work.
 
     %form
       = @textField(label: "Name", field: "Name")
-      
+
 The field helper method (`@textField()` in this example) creates a subview of the appropriate type which renders a label and form input using twitter bootstrap friendly markup.  They also listen to the model for validation errors and display appropriate styling and error messages.
 
 Validation
 ----------
 
-Rails validation on the server side will be handled appropriately by the form element views. You can also add client side validation. So far we support presence and format, checkout the Person backbone model in the example app to see how it works. We'll be adding support for reflecting on the rails model adding client side validations to the backbone model "real soon now".
-      
+Backtastic supports both client side and server side validation. If you send back an error response with errors represented as jon, backtastic will decode the json and match up the error messages with fields.
+
+As of 0.4, backtastic gives you a way to reflect (some) validations from rails models onto your backbone models. There is a rake task, backtastic:validations:build, which generates a coffeescript file that puts validation data from rails onto a Backtastic.Rails.validations. Then some where in your client side code, you can require this file and call Backtastic.applyValidations. See the example app code to understand better how all this fits together.
+
 Example App
 -----------
 
@@ -47,7 +49,7 @@ The best way to learn how to use backtastic is to spend some time checking out t
     bundle install
     rake db:migrate
     bundle exec rails s
-    
+
 Point your browser at localhost:3000. But then you probably knew that already
 
 Running specs
@@ -56,21 +58,21 @@ Running specs
 The specs for backtastic are in the example as well so I can take advantage of the asset pipeline in my specs.  To run them, do:
 
     rake jasminerice:run
-    
+
 Future plans
 ------------
 
 I'd like to have some metadata generated form rails and available to backbone so you could do something more formtasticy like:
 
     @form fields["first_name", "last_name"]
-    
+
 
 Shameless self-promotion
 ------------------------
 
 If in-person training in all this is something that could help you or someone you know, we've [got you covered](http://training.gaslightsoftware.com).  Should you need help building a backbone rails app, we can [do that too](http://gaslightsoftware.com).
 
-    
+
 
 
 

data/example/app/assets/javascripts/backbone/example.js.coffee

@@ -3,14 +3,15 @@
 #= require_tree ./models
 #= require_tree ./views
 #= require_tree ./routers
-#= require ./rails_metadata
+#= require rails_validations
 
 window.Example =
   Models: {}
   Collections: {}
   Routers: {}
   Views: {}
-  
+
 $ ->
   new Example.Routers.PeopleRouter()
-  Backbone.history.start()
+  Backbone.history.start()
+  Backtastic.applyValidations(Example.Models, Backtastic.Rails.validations)

data/example/app/assets/javascripts/backbone/models/people.coffee

@@ -1,11 +1,11 @@
 class Example.Models.Person extends Backbone.Model
   urlRoot: "/people"
-  
-  @validatePresenceOf "first_name"
-  
-  @validateFormatOf "last_name", pattern: /^J.*/
-  
+
+  # @validatePresenceOf "first_name"
+
+  # @validateFormatOf "last_name", with: /^J.*/
+
 class Example.Collections.PeopleCollection extends Backbone.Collection
   model: Example.Models.Person
-  
+
   url: "/people"

data/example/app/assets/javascripts/backbone/routers/people_router.coffee

@@ -4,26 +4,24 @@ class Example.Routers.PeopleRouter extends Backbone.Router
     @people = new Example.Collections.PeopleCollection(peopleJson)
     @occupations = new Example.Collections.OccupationsCollection(occupationsJson)
     @people.on "sync", @showPeople, @
-    @people.off null, null, @
-    => @navigate "people/list", trigger: true
+    @people.on "add", @showPeople, @
     @peopleView = new Example.Views.PeopleView(collection: @people, el: $("#people_view"))
     @editPersonView = new Example.Views.EditPersonView(el: $("#edit_person"), occupations: @occupations)
     @showPeople()
-    
+
   routes:
     "people/new": "newPerson"
     "people/list": "showPeople"
     "people/:id/edit": "editPerson"
-    
+
   showPeople: ->
     @peopleView.render()
     @editPersonView.close()
-    
+
   newPerson: ->
     person = new Example.Models.Person
-    @people.add person, silent: true
+    person.on "sync", => @people.add(person)
     @editPersonView.edit(person)
-  
+
   editPerson: (id)->
     @editPersonView.edit @people.get(id)
-    

data/example/app/models/person.rb

@@ -1,5 +1,5 @@
 class Person < ActiveRecord::Base
   validates_presence_of :first_name
-  
+  validates_format_of :last_name, with: /^J.*/
   belongs_to :occupation
 end

data/example/app/views/layouts/application.html.erb

@@ -43,20 +43,10 @@
     <div class="container">
       <div class="content">
         <div class="row">
-           <div class="span9">
+           <div class="span12">
               <%= yield %>
             </div>
-            <div class="span3">
-              <div class="well sidebar-nav">
-                <h3>Sidebar</h3>
-                <ul class="nav nav-list">
-                  <li class="nav-header">Sidebar</li>
-                  <li><%= link_to "Link1", "/path1"  %></li>
-                  <li><%= link_to "Link2", "/path2"  %></li>
-                  <li><%= link_to "Link3", "/path3"  %></li>
-                </ul>
-              </div><!--/.well -->
-            </div><!--/span-->
+
         </div><!--/row-->
       </div><!--/content-->
 

data/example/spec/backtastic_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
-describe "schema_for" do
-  Given(:person_schema) { Backtastic.schema_for(Person) }
-  Then { person_schema["first_name"]["type"].should == :string }
+describe "rails_validations" do
+	Given(:validations) { Backtastic.validations_for(Person) }
+  Then { validations[:first_name].should_not be_empty }
+  Then { validations[:first_name]["presence"].should == {} }
+  Then { binding.pry; validations[:last_name]["format"][:with].should == "/^S.*/"}
 end

data/example/spec/javascripts/models/person_spec.coffee

@@ -27,6 +27,5 @@ describe "Person", ->
         expect(@person.isValid()).toTruthy
       it "should have no errors", ->
         expect(@validationErrors.first_name?).toBeFalsy()
-    
-      
-    
+
+

data/example/spec/javascripts/models/validation_spec.coffee

@@ -0,0 +1,38 @@
+class BoringModel extends Backbone.Model
+
+describe "validation", ->
+  beforeEach ->
+    BoringModel.validate
+      first_name:
+        presence: {}
+      last_name:
+        format:
+          with: "/^S.*/"
+    @model = new BoringModel
+    @validationErrors = {}
+    @model.on "error", (model, errors) =>
+      @validationErrors = errors
+  describe "presence", ->
+    describe "when not matching", ->
+      beforeEach ->
+        @model.set first_name: ""
+      it "should validate presence of", ->
+        expect(@validationErrors.first_name.length).toEqual 1
+    describe "when matching", ->
+      beforeEach ->
+        @model.set first_name: "Bill"
+      it "should validate presence of", ->
+        expect(@validationErrors.first_name).not.toBeDefined()
+  describe "format", ->
+    describe "when not matching", ->
+      beforeEach ->
+        @model.set last_name: "Not smith"
+      it "should validate format", ->
+        expect(@validationErrors.last_name.length).toEqual 1
+    describe "when matching", ->
+      beforeEach ->
+        @model.set last_name: "Smith"
+      it "should validate format", ->
+        expect(@validationErrors.last_name).not.toBeDefined()
+
+

data/example/spec/javascripts/views/check_box_view_spec.coffee

@@ -24,4 +24,21 @@ describe "check box view", ->
       @checkBoxFieldView.render()
     it "render an unchecked check box if the value is false", ->
       expect(@checkBoxFieldView.$("input[type=checkbox]").attr("checked")).toBeFalsy()
+      
+  describe "updating model", ->
+    describe "when checking", ->
+      beforeEach ->
+        @checkBoxFieldView.render()
+        @checkBoxFieldView.$("input").attr("checked", true)
+        @checkBoxFieldView.updateModel()
+      it "should update the model", ->
+        expect(@model.get("awesome")).toBeTruthy()
+    describe "when unchecking", ->
+      beforeEach ->
+        @model.set awesome: true
+        @checkBoxFieldView.render()
+        @checkBoxFieldView.$("input").attr("checked", false)
+        @checkBoxFieldView.updateModel()
+      it "should update the model", ->
+        expect(@model.get("awesome")).toBeFalsy()
 

data/example/spec/javascripts/views/select_field_view_spec.coffee

@@ -26,3 +26,9 @@ describe "select field view", ->
   it "puts a label on it", ->
     expect(@selectFieldView.$("label[for=occupation_id]")).toExist()
     expect(@selectFieldView.$("label[for=occupation_id]")).toHaveText /Occupation/
+  describe "updating model", ->
+    beforeEach ->
+      @selectFieldView.$("select").val("1")
+      @selectFieldView.updateModel()
+    it "updates the model", ->
+      expect(@person.get("occupation_id")).toEqual "1"

data/example/spec/javascripts/views/text_field_view_spec.coffee

@@ -15,7 +15,13 @@ describe "text field view", ->
   it "puts a label on it", ->
     expect(@textFieldView.$("label[for=name]")).toExist()
     expect(@textFieldView.$("label[for=name]")).toHaveText /Name/
-    
+
+  describe "updating model", ->
+    beforeEach ->
+      @textFieldView.$("input").val("Not bob")
+      @textFieldView.updateModel()
+    it "should update the model", ->
+      expect(@model.get("name")).toEqual "Not bob"
   describe "displaying errors", ->
     beforeEach ->
       @textFieldView.displayErrors
@@ -24,11 +30,19 @@ describe "text field view", ->
       expect(@textFieldView.$el).toHaveClass "error"
     it "should add the error message", ->
       expect(@textFieldView.$("span.help-inline")).toHaveText "totally borked"
+    describe "and then setting model attribute to something valid", ->
+      beforeEach ->
+        @model.set name: "Wut"
+      it "should remove error class", ->
+        expect(@textFieldView.$el).not.toHaveClass "error"
+      it "should remove the error message", ->
+        expect(@textFieldView.$("span.help-inline")).not.toExist()
+
     describe "again", ->
       beforeEach ->
         @textFieldView.displayErrors
           name: ["totally borked"]
       it "should only display it once", ->
         expect(@textFieldView.$("span.help-inline").size()).toEqual 1
-        
-      
+
+

data/lib/assets/javascripts/util/validation.coffee

@@ -1,15 +1,18 @@
 Backtastic.Validators =
-  
+
   presence: (options) ->
     (field, value) -> "is required" unless value?.length > 0
-   
+
   format: (options) ->
-    (field, value) -> "must match specified format." unless value?.match(options?.pattern)
-    
+    toRegExp = (str) ->
+      new RegExp(str.replace(/^\//, "").replace(/\/$/, ""))
+    pattern = if _.isRegExp(options?.with) then options?.with else toRegExp(options?.with)
+    (field, value) -> "must match specified format." unless value?.match(pattern)
+
 Backtastic.Validation =
-  
+
   classMethods:
-    
+
     addValidator: (validator, field, options) ->
       @validations or = {}
       @validations[field] or= []
@@ -17,26 +20,35 @@ Backtastic.Validation =
 
     validatePresenceOf: (field) ->
       @addValidator("presence", field)
-      
+
     validateFormatOf: (field, options) ->
       @addValidator("format", field, options)
-      
+
+    validate: (validations) ->
+      @validations = {}
+      for field, fieldValidations of validations
+        for validationType, options of fieldValidations
+          @addValidator(validationType, field, options)
+
   addError: (field, error) ->
     @errors[field] or= []
     @errors[field].push error
-    
+
   clearErrors: -> @errors = {}
-  
+
   validateAttribute: (attribute, value) ->
     return unless @constructor.validations[attribute]
     for validator in @constructor.validations[attribute]
       error = validator(attribute, value)
       @addError(attribute, error) if error
-      
+
   validate: (attributes) ->
     @clearErrors()
     return unless @constructor.validations
     @validateAttribute(attr, value) for attr, value of attributes
     @errors if _.keys(@errors).length > 0
-    
+
 Backtastic.include Backbone.Model, Backtastic.Validation
+
+Backtastic.applyValidations = (models, validations) ->
+  model.validate(validations[name]) for name, model of models

data/lib/assets/javascripts/views/check_box_view.coffee

@@ -5,4 +5,7 @@ class Backtastic.Views.CheckBoxView extends Backtastic.Views.FormFieldView
   
   render: ->
     super
-    @$('input').prop("checked", "checked") if @model.get(@field)
+    @$('input').prop("checked", "checked") if @model.get(@field)
+    
+  updateModel: ->
+    @model.set @field, @$("input").attr("checked") == "checked"

data/lib/assets/javascripts/views/form_field_view.coffee

@@ -1,5 +1,5 @@
 class Backtastic.Views.FormFieldView extends Backtastic.View
-  
+
   constructor: (options)->
     super
     @field = options.field
@@ -7,15 +7,23 @@ class Backtastic.Views.FormFieldView extends Backtastic.View
     @parentView = options.parentView
     @parentView.on "rendered", => @afterParentRender()
     @model.on "error", (model, errors) => @displayErrors(errors)
-  
+    @model.on "change:#{@field}", @clearErrors, @
+
+  events:
+    "blur input": "updateModel"
+    "keyup input": "updateModel"
+
+  updateModel: ->
+    @model.set @field, @$("input").val()
+
   afterParentRender: ->
     @setElement(@parentView.$("[data-view-id=#{@cid}]"))
     @render()
-    
+
   render: ->
     super
     @$el.addClass "control-group"
-    
+
   displayErrors: (errors) ->
     errors = errors.errors if errors.errors
     if errors?[@field]
@@ -23,6 +31,8 @@ class Backtastic.Views.FormFieldView extends Backtastic.View
       @$el.addClass "error"
       @$("span.help-inline").remove()
       @$el.append "<span class='help-inline'>#{message}</span>" for message in messages
-  
+
   clearErrors: ->
     @$el.removeClass "error"
+    @$("span.help-inline").remove()
+

data/lib/assets/javascripts/views/select_field_view.coffee

@@ -5,4 +5,7 @@ class Backtastic.Views.SelectFieldView extends Backtastic.Views.FormFieldView
   render: ->
     super
     @$("select").val @model.get(@field)
+    
+  updateModel: ->
+    @model.set @field, @$("select").val()
   

data/lib/backtastic.rb

@@ -7,12 +7,24 @@ require "active_support/inflections"
 module Backtastic
   class BacktasticEngine < Rails::Engine
   end
-  
-  def self.schema_for(model)
-    schema = {}
-    model.to_s.constantize.columns.each do |col|
-      schema[col.name] = {"type" => col.type }
+
+  def self.validations_for(model)
+    validations = {}
+  	model.validators.each do |validator|
+      attribute = validator.attributes.first
+      validator_type = validator.class.to_s.gsub(/^ActiveModel::Validations::/, "").gsub(/Validator$/, "").downcase
+      validations[attribute] ||= {}
+      validations[attribute][validator_type] = options_from(validator)
     end
-    schema
+    validations
   end
+
+  def self.options_from(validator)
+    options = validator.options.dup
+    options.each do |option, value|
+      options[option] = value.is_a?(Regexp) ? value.inspect : value
+    end
+    options
+  end
+
 end

data/lib/backtastic/version.rb

@@ -1,3 +1,3 @@
 module Backtastic
-  VERSION = "0.0.3"
+  VERSION = "0.4.0"
 end

data/lib/tasks/validations.rake

@@ -0,0 +1,17 @@
+namespace :backtastic do
+  namespace :validations do
+    desc "Build put validation metadata in app/assets/javascripts"
+    task :build => :environment do
+      output = ENV["VALIDATIONS_FILE"] || Rails.root.join("app", "assets", "javascripts", "rails_validations.coffee")
+      Dir[Rails.root.join "app", "models", '**', '*.rb'].each do |file|
+        begin
+          require file
+        rescue
+        end
+      end
+
+      erb = ERB.new File.read(File.join(File.dirname(__FILE__), "..", "templates", "rails_validations.coffee.erb"))
+      File.open(output, "w") { |f| f.puts(erb.result) }
+    end
+  end
+end

data/lib/templates/rails_validations.coffee.erb

@@ -0,0 +1,6 @@
+Backtastic.Rails =
+  validations: {}
+
+<% ActiveRecord::Base.descendants.each do |model| %>
+Backtastic.Rails.validations.<%= model %> = <%= Backtastic.validations_for(model).to_json %>
+<% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: backtastic
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-17 00:00:00.000000000 Z
+date: 2012-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70353452602400 !ruby/object:Gem::Requirement
+  requirement: &70250067046740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70353452602400
+  version_requirements: *70250067046740
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &70353452601920 !ruby/object:Gem::Requirement
+  requirement: &70250067046320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70353452601920
+  version_requirements: *70250067046320
 - !ruby/object:Gem::Dependency
   name: haml_coffee_assets
-  requirement: &70353452601460 !ruby/object:Gem::Requirement
+  requirement: &70250067045800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70353452601460
+  version_requirements: *70250067045800
 - !ruby/object:Gem::Dependency
   name: rails-backbone
-  requirement: &70353452601000 !ruby/object:Gem::Requirement
+  requirement: &70250067045360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70353452601000
+  version_requirements: *70250067045360
 - !ruby/object:Gem::Dependency
   name: inflection-js-rails
-  requirement: &70353452600580 !ruby/object:Gem::Requirement
+  requirement: &70250067044620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70353452600580
+  version_requirements: *70250067044620
 - !ruby/object:Gem::Dependency
   name: twitter-bootstrap-rails
-  requirement: &70353452600020 !ruby/object:Gem::Requirement
+  requirement: &70250067043440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70353452600020
+  version_requirements: *70250067043440
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70353452598880 !ruby/object:Gem::Requirement
+  requirement: &70250067042920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70353452598880
+  version_requirements: *70250067042920
 description: ! "Create backbone twitter bootstrap form views easily using helpers.
   Handle and display\n    validation failures from rails.\n  "
 email:
@@ -172,6 +172,7 @@ files:
 - example/script/rails
 - example/spec/backtastic_spec.rb
 - example/spec/javascripts/models/person_spec.coffee
+- example/spec/javascripts/models/validation_spec.coffee
 - example/spec/javascripts/spec.js.coffee
 - example/spec/javascripts/util/module_spec.coffee
 - example/spec/javascripts/views/check_box_view_spec.coffee
@@ -200,6 +201,8 @@ files:
 - lib/assets/javascripts/views/text_field_view.coffee
 - lib/backtastic.rb
 - lib/backtastic/version.rb
+- lib/tasks/validations.rake
+- lib/templates/rails_validations.coffee.erb
 - spec/spec_helper.rb
 - vendor/assets/javascripts/bootstrap-datepicker.js
 - vendor/assets/javascripts/jquery.serializeObject.js.coffee
@@ -216,18 +219,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -824130021871109077
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -824130021871109077
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17