joosy 0.1.0.RC1 → 0.1.0.RC2

data/app/assets/javascripts/joosy/core/resource/rest_collection.js.coffee

@@ -1,48 +1,116 @@
-class Joosy.Resource.RESTCollection extends Joosy.Module
+#
+# Collection of Resources with REST-fetching capabilities
+#
+# Generally you should not use RESTCollection directly. It will be
+# automatically created by Joosy.Resource.REST#find.
+#
+# Example:
+#   class R extends Joosy.Resource.REST
+#     @entity 'r'
+#
+#   collection = new Joosy.Resource.RESTCollection(R, {color: 'green'})
+#
+#   collection.fetch()
+#   collection.page 2
+#
+#   collection.params = {color: 'red', sort: 'date'}
+#   collection.fetch()
+#
+class Joosy.Resource.RESTCollection extends Joosy.Resource.Collection
   @include Joosy.Modules.Log
   @include Joosy.Modules.Events
 
-  data:  []
+  #
+  # Hash containing the cache for pages of raw data
+  # Keys are pages numbers, values are stored AJAX response
+  #
   pages: Object.extended()
 
+  #
+  # @param [Class] model      Resource class this collection will handle
+  # @param [Object] params    Additional GET-parameters to supply when fetching
+  #
   constructor: (@model, params={}) ->
-    @params = Object.extended(params)
+    @params = Object.extended params
 
+  #
   # Clears the storage and attempts to import given JSON
-  reset: (entities) ->
-    @data  = @modelize entities
-    @pages = Object.extended().merge { 1: @data }
-
+  #
+  # @param [Object] entities    Entities to import
+  #
+  reset: (entities, notify=true) ->
+    super entities, false
+    if notify
+      @trigger 'changed'
     this
 
+  #
   # Clears the storage and gets new data from server
-  fetch: (callback, options) ->
-    @model.__ajax 'get', @model.__buildSource(params: @params), options, (data) =>
-      @reset(data)
-      callback?(this)
-
+  #
+  # @param [Function|Object] options                AJAX options.
+  #   Will be considered as a success callback if function given
+  #
+  fetch: (options) ->
+    if Object.isFunction options
+      callback = options
+    else
+      callback = options?.success
+      delete options?.success
+    
+    @__fetch @params, options, (data) =>
+      @reset data, false
+      callback? this
+      @trigger 'changed'
     this
 
+  #
   # Returns the subset for requested page. Requests with &page=x if not found localy.
-  page: (number, callback=false) ->
-    if @pages[number]?
-      callback?(@pages[number])
-      return this
-
-    @model.__ajax 'get', @model.__buildSource(params: @params.merge(page: number)), {}, (data) =>
-      @pages[number] = @modelize data
-
-      @data = []
-      @pages.keys().sort().each (x) =>
-        @data.add @pages[x]
-
-      callback?(@pages[number])
-
+  #
+  # @param [Integer] number               Index of page
+  # @param [Function|Object] options      AJAX options.
+  #   Will be considered as a success callback if function given
+  #
+  page: (number, options) ->
+    if Object.isFunction options
+      callback = options
+    else
+      callback = options?.success
+      delete options?.success
+    
+    @__fetch Joosy.Module.merge({page: number}, @params), options, (data) =>
+      @reset data, false
+      callback? @data
+      @trigger 'changed'
     this
-
-  modelize: (collection) ->
-    if collection instanceof Array
-      collection.map (x) =>
-        @model.create x
+    
+  #
+  # Requests the REST collection URL with POST or any method given in options.type
+  #
+  # @param [String] ending            Collection url (like 'foo' or 'foo/bar')
+  # @param [Function|Object] options  AJAX options.
+  #   Will be considered as a success callback if function given
+  #
+  request: (ending, options) ->
+    if Object.isFunction options
+      callback = options
+    else
+      callback = options?.success
+      delete options?.success
+      
+    if options.method || options.type
+      type = options.method || options.type
     else
-      []
+      type = 'post'
+    
+    @model.__ajax type, @model.__buildSource(extension: ending), options, callback
+    
+  #
+  # Does AJAX request
+  #
+  # @param [Object] urlOptions      GET-params for request
+  # @param [Object] ajaxOptions     AJAX options to pass with request
+  # @param [Function] callback
+  #
+  __fetch: (urlOptions, ajaxOptions, callback) ->
+    @model.__ajax 'get', @model.__buildSource(params: @params.merge(urlOptions)), ajaxOptions, (data) ->
+      callback(data)

data/app/assets/javascripts/joosy/core/router.js.coffee

@@ -9,61 +9,59 @@ Joosy.Router =
     @routes = Object.extended()
 
   map: (routes) ->
-    @rawRoutes.merge routes
+    Joosy.Module.merge @rawRoutes, routes
 
   setupRoutes: ->
     @prepareRoutes @rawRoutes
-
-    @respondRoute(location.hash)
-    $(window).hashchange => @respondRoute(location.hash)
+    @respondRoute location.hash
+    $(window).hashchange =>
+      @respondRoute location.hash
 
   prepareRoutes: (routes, namespace='') ->
     if !namespace && routes[404]
       @wildcardAction = routes[404]
       delete routes[404]
 
-    routes.each (path, response) =>
-      path = (namespace + path).replace(/\/{2,}/, '/')
-      if response && (typeof(response) == 'function' || response.prototype?)
-        @routes.merge @prepareRoute path,response
+    Object.each routes, (path, response) =>
+      path = (namespace + path).replace /\/{2,}/, '/'
+      if response && (Object.isFunction(response) || response.prototype?)
+        Joosy.Module.merge @routes, @prepareRoute(path, response)
       else
-        @prepareRoutes Object.extended(response), path
+        @prepareRoutes response, path
 
   prepareRoute: (path, response) ->
     matchPath = path.replace(/\/:([^\/]+)/g, '/([^/]+)').replace(/^\/?/, '^/?').replace(/\/?$/, '/?$')
     result    = Object.extended()
 
     result[matchPath] =
-      capture: (path.match(/\/:[^\/]+/g) || []).map((str) -> str.substr(2))
+      capture: (path.match(/\/:[^\/]+/g) || []).map (str) ->
+        str.substr 2
       action: response
     result
 
   respondRoute: (hash) ->
     Joosy.Modules.Log.debug "Router> Answering '#{hash}'"
-
-    fullPath = hash.replace(/^#!?/, '')
-
+    fullPath = hash.replace /^#!?/, ''
     @currentPath = fullPath
     found = false
-
-    queryArray = fullPath.split('&')
+    queryArray = fullPath.split '&'
     path       = queryArray.shift()
-    urlParams  = @paramsFromQueryArray(queryArray)
+    urlParams  = @paramsFromQueryArray queryArray
 
-    for regex, route of @routes when @routes.hasOwnProperty(regex)
-      if vals = path.match(new RegExp(regex))
+    for regex, route of @routes when @routes.hasOwnProperty regex
+      if vals = path.match new RegExp(regex)
         params = @paramsFromRouteMatch(vals, route).merge urlParams
 
-        if !Joosy.Module.hasAncestor(route.action, Joosy.Page)
-          route.action.call(this, params)
+        if Joosy.Module.hasAncestor route.action, Joosy.Page
+          Joosy.Application.setCurrentPage route.action, params
         else
-          Joosy.Application.setCurrentPage(route.action, params)
+          route.action.call this, params
 
         found = true
         break
 
-    if !found && @wildcardAction
-      @wildcardAction(path, urlParams)
+    if !found && @wildcardAction?
+      @wildcardAction path, urlParams
 
   paramsFromRouteMatch: (vals, route) ->
     params = Object.extended()
@@ -78,8 +76,8 @@ Joosy.Router =
     params = Object.extended()
 
     if queryArray
-      $.each queryArray, () ->
-        if this != ''
+      $.each queryArray, ->
+        unless @isBlank()
           pair = @split '='
           params[pair[0]] = pair[1]
 

data/app/assets/javascripts/joosy/core/templaters/rails_jst.js.coffee

@@ -1,8 +1,16 @@
 #= require joosy/core/joosy
 
+#
+# Rails JST template precompilation binding
+#
 class Joosy.Templaters.RailsJST
   constructor: (@applicationName) ->
 
+  #
+  # Gets template lambda by its full name
+  #
+  # @param [String] name      Template name 'foo/bar'
+  #
   buildView: (name) ->
     template = JST[location = "#{@applicationName}/templates/#{name}"]
 
@@ -11,10 +19,18 @@ class Joosy.Templaters.RailsJST
 
     template
 
+  #
+  # Gets full name of template by several params
+  #
+  # @param [String] section     Section of templates like pages/layouts/...
+  # @param [String] template    Internal template path
+  # @param [String] entity      Entity to lookup template path by its namespace
+  #
   resolveTemplate: (section, template, entity) ->
-    return template.substr 1 if template.startsWith '/'
+    if template.startsWith '/'
+      return template.substr 1
 
     path = entity.constructor?.__namespace__?.map('underscore') || []
-    path.unshift(section)
+    path.unshift section
 
-    "#{path.join('/')}/#{template}"
+    "#{path.join '/'}/#{template}"

data/app/assets/javascripts/joosy/core/widget.js.coffee

@@ -12,24 +12,21 @@ class Joosy.Widget extends Joosy.Module
   @include Joosy.Modules.Container
   @include Joosy.Modules.Renderer
   @include Joosy.Modules.Filters
+  @include Joosy.Modules.TimeManager
 
   __renderer: false
-
-  setInterval: (args...) ->
-    @parent.setInterval(args...)
-
-  setTimeout: (args...) ->
-    @parent.setTimeout(args...)
+  
+  data: false
 
   navigate: (args...) ->
-    Joosy.Router.navigate(args...)
+    Joosy.Router.navigate args...
 
   __renderSection: ->
     'widgets'
 
   __load: (@parent, @container) ->
     if @__renderer
-      @container.html @__renderer()
+      @container.html @__renderer(@data || {})
     @refreshElements()
     @__delegateEvents()
     @__runAfterLoads()
@@ -37,5 +34,6 @@ class Joosy.Widget extends Joosy.Module
     this
 
   __unload: ->
+    @__clearTime()
     @__removeMetamorphs()
-    @__runAfterUnloads()
+    @__runAfterUnloads()

data/app/assets/javascripts/joosy/preloaders/caching.js.coffee

@@ -1,52 +1,83 @@
 #= require base64
 
-window.globalEval = (src) ->
-  if window.execScript
-    window.execScript src
-  else
-    fn = ->
-      window.eval.call window,src
-    fn()
-
+#
+# Preloader for libraries with localStorage cache
+#
+# Example:
+#   libraries = [['/test1.js', 100], ['/test2.js', 500]] #100, 500 - size in bytes
+#   CachingPreloader.load libraries,
+#     start:    -> console.log 'preloading started'
+#     progress: (percent) -> console.log "#{percent}% loaded"
+#     complete: -> console.log 'preloading finished'
+#
+# @class CachingPreloader
+#
 @Preloader = @CachingPreloader =
+  #
+  # If set to true, localStorage cache will be avoided
+  #
   force: false
+  
+  #
+  # Prefix for localStorage keys
+  #
   prefix: "cache:"
-
-  libraries: []
+  
+  #
+  # Number of libraries have been loaded (increases after lib was loaded)
+  #
   counter: 0
+  
+  #
+  # Loads (or takes from cache) set of libraries using xhr and caches them in localStorage
+  # See class description for example of usage
+  #
+  # @param [Array] 2-levels array of libraries URLs i.e. [['/test1.js', 10],['/test2.js', 20]]
+  #   Second param of inner level is a size of script in bytes. Can be undefined.
+  # @param [Hash] Available options:
+  #   * start: `() -> null` to call before load starts
+  #   * progress: `(int percents) -> null` to call each 100ms of load in progress
+  #   * complete: `() -> null` to call after load completes
+  #
+  load: (libraries, options={}) ->
+    @[key] = val for key, val of options
+    @libraries = libraries.slice()
 
-  complete: false
+    for lib, i in @libraries
+      @libraries[i] = @prefix+lib[0]
 
-  ajax: (url, size, callback) ->
-    if window.XMLHttpRequest
-      x = new XMLHttpRequest
+    if !@force && @check()
+      @restore()
     else
-      x = new ActiveXObject 'Microsoft.XMLHTTP'
-
-    x.open 'GET', url, 1
-
-    x.onreadystatechange = () =>
-      if x.readyState > 3
-        clearInterval(@interval)
-        callback?(x)
-
-    if @progress
-      poller = =>
-        try
-          @progress.call window, Math.round((x.responseText.length / size) * (@counter / @libraries.length) * 100)
-        catch e
-          # ... IE?
-
-      @interval = setInterval poller, 100
-
-    x.send()
+      @start?.call window
+      @download libraries
 
+  #
+  # Checks if we can load libraries or have to download them over
+  #
+  check: ->
+    flag = true
+    for name, i in @libraries
+      flag &&= window.localStorage.getItem(name)?
+    flag
+  
+  #
+  # Gets sources of scripts from localStorage and evals them
+  #
   restore: ->
     for name, i in @libraries
-      code = window.localStorage.getItem(name)
-      window.globalEval if window.navigator.appName == "Microsoft Internet Explorer" then Base64.decode(code) else code
+      code = window.localStorage.getItem name
+      if window.navigator.appName == "Microsoft Internet Explorer"
+        code = Base64.decode code
+      @evalGlobaly code
     @complete?.call window, true
 
+  #
+  # Loads set of libraries using xhr and caches them in localStorage
+  #
+  # @param [Array] 2-levels array of libraries URLs i.e. [['/test1.js', 100],['/test2.js', 500]]
+  #   Second param of inner level is a size of script in bytes. Can be undefined.
+  #
   download: (libraries) ->
     if libraries.length > 0
       @counter += 1
@@ -57,38 +88,67 @@ window.globalEval = (src) ->
 
       @ajax url, size, (xhr) =>
         code = xhr.responseText
-        window.localStorage.setItem @prefix+url, (if window.navigator.appName == "Microsoft Internet Explorer" then Base64.encode(code) else code)
-        window.globalEval xhr.responseText
+        if window.navigator.appName == "Microsoft Internet Explorer"
+          code = Base64.encode code
+        window.localStorage.setItem @prefix+url, code
+        @evalGlobaly xhr.responseText
         @download libraries
     else
       @clean()
       @complete?.call window
 
-  load: (libraries, options={}) ->
-    @[key] = val for key, val of options
-    @libraries = libraries.slice()
+  #
+  # Runs XHR request to get single script body
+  # Binds poller to call @progress each 100ms if possible (not IE *doh*)
+  #
+  # @param [String] URL to download from
+  # @param [Float] Expected size of download (to calculate percents)
+  #   Size can not be taken from headers since we are supposed to get gziped content
+  # @param [Function] `(xhr) -> null` to call after script was loaded
+  #
+  ajax: (url, size, callback) ->
+    if window.XMLHttpRequest
+      x = new XMLHttpRequest
+    else
+      x = new ActiveXObject 'Microsoft.XMLHTTP'
 
-    for lib, i in @libraries
-      @libraries[i] = @prefix+lib[0]
+    x.open 'GET', url, 1
 
-    if !@force && @check()
-      @restore()
-    else
-      @start?.call window
-      @download libraries
+    x.onreadystatechange = () =>
+      if x.readyState > 3
+        clearInterval @interval
+        callback? x
 
-  check: ->
-    flag = true
-    for name, i in @libraries
-      flag &&= window.localStorage.getItem(name)?
-    flag
+    if @progress
+      poller = =>
+        try
+          @progress.call window, Math.round((x.responseText.length / size) * (@counter / @libraries.length) * 100)
+        catch e
+          # ... IE?
 
-  clean: ->
-    removed = 0
+      @interval = setInterval poller, 100
 
-    for element, i in window.localStorage
-      key = window.localStorage.key(i-removed)
+    x.send()
+
+  #
+  # Searches through localStorage for outdated entries with our prefix and removes them
+  #
+  clean: ->
+    i = 0
 
+    while i < window.localStorage.length && key = window.localStorage.key(i)
       if key.indexOf(@prefix) == 0 && @libraries.indexOf(key) < 0
         window.localStorage.removeItem key
-        removed += 1
+      else
+        i += 1
+
+  #
+  # Evals source at a global scope
+  #
+  # @param [String] JS source to execute
+  #
+  evalGlobaly: (src) ->
+    if window.execScript
+      window.execScript src
+    else
+      window.eval src

data/app/assets/javascripts/joosy/preloaders/inline.js.coffee

@@ -11,6 +11,24 @@
 #
 @Preloader = @InlinePreloader =
 
+  #
+  # Loads set of libraries by adding <script src> to DOM head 
+  # See class description for example of usage
+  #
+  # @param [Array] 2-levels array of libraries URLs i.e. [['/test1.js'],['/test2.js']]
+  # @param [Hash] Available options:
+  #   * start: `() -> null` to call before load starts: 
+  #   * complete: `() -> null` to call after load completes
+  #
+  load: (libraries, options) ->    
+    @[key] = val for key, val of options
+    @start?()
+
+    if libraries.length > 0
+      @receive libraries.shift()[0], => @load(libraries)
+    else
+      @complete?()
+
   #
   # Loads one script by adding <script src> to DOM head
   #
@@ -19,37 +37,18 @@
   #
   receive: (url, callback) ->
     head   = document.getElementsByTagName("head")[0]
-    script = document.createElement("script")
+    script = document.createElement "script"
     script.src = url
 
     done = false
 
     proceed = ->
-      if ( !done && (!this.readyState ||
-            this.readyState == "loaded" || this.readyState == "complete") )
-
-        done = true and callback() if callback
+      if !done && (!@readyState? || @readyState == "loaded" || @readyState == "complete")
+        done = true
+        callback?()
         script.onload = script.onreadystatechange = null
 
     script.onload = script.onreadystatechange = proceed
 
-    head.appendChild(script)
+    head.appendChild script
     return undefined
-
-  #
-  # Loads set of libraries by adding <script src> to DOM head 
-  # See class description for example of usage
-  #
-  # @param [Array] 2-levels array of libraries URLs i.e. [['/test1.js'],['/test2.js']]
-  # @param [Hash] Available options:
-  #   * start: `() -> null` to call before load starts: 
-  #   * complete: `() -> null` to call after load completes
-  #
-  load: (libraries, options) ->    
-    @[key] = val for key, val of options
-    @start?.call window
-
-    if libraries.length > 0
-      @receive libraries.shift()[0], => @load(libraries)
-    else
-      @complete?.call window

data/app/helpers/joosy/sprockets_helper.rb

@@ -17,7 +17,7 @@ module Joosy::SprocketsHelper
     if force_preloader
       require_asset preloader_asset
     else
-      require_asset Rails.env == 'production' ? preloader_asset  : app_asset
+      require_asset Rails.env == 'development' ? app_asset : preloader_asset
     end
   end
 end

data/lib/joosy/forms.rb

@@ -9,23 +9,13 @@ module Joosy
         if entity.save
           joosy_succeed(data, entity, &block)
         else
-          joosy_fail(entity.errors.messages, entity.class.name)
+          joosy_fail(entity.errors, entity.class.name)
         end
       end
 
       def joosy_fail(errors, entity=false)
         errors = Hash[*errors.map {|x| [x, nil]}.flatten] if errors.is_a?(Array)
-
-        if !entity
-          notifications = errors
-        else
-          notifications = {}
-          errors.each do |k, v|
-            notifications["#{entity.underscore}[#{k}]"] = v
-          end
-        end
-
-        joosy_respond notifications, :unprocessable_entity
+        joosy_respond errors, :unprocessable_entity
       end
 
       def joosy_succeed(data, entity=nil, &block)

data/lib/joosy/rails/version.rb

@@ -1,5 +1,5 @@
 module Joosy
   module Rails
-    VERSION = "0.1.0.RC1"
+    VERSION = "0.1.0.RC2"
   end
 end

data/lib/rails/generators/joosy/templates/app/pages/template.js.coffee

@@ -1,5 +1,5 @@
 Joosy.namespace '<%= namespace_name %>', ->
 
   class @<%= file_name.camelize %>Page extends ApplicationPage
-    @layout <%= layout_name.camelize %>Layout
+    @layout ApplicationLayout
     @view   '<%= file_name %>'

data/lib/rails/generators/joosy/templates/app/resources/template.js.coffee

@@ -1,2 +1,2 @@
-class @<%= file_name.camelize %>Resource extends Joosy.Resource.REST
+class @<%= file_name.camelize %> extends Joosy.Resource.REST
   @entity '<%= file_name %>'