ende 0.2.9 → 0.2.10

data/vendor/components/indefinido-indemma/src/lib/record/restfulable.coffee

@@ -0,0 +1,348 @@
+merge      = require('assimilate').withStrategy 'deep'
+type       = require 'type'
+observable = require('observable').mixin
+$          = require 'jquery' # TODO remove jquery dependency and use simple promises implementation
+rest       = require './rest.js'
+
+util =
+  model:
+    map: (models) ->
+      @ model for model in models
+
+
+restful =
+  model:
+    # returns an array of promises
+    create: (params..., callback) ->
+      throw new TypeError("No arguments provided for #{@resource}.create") unless arguments.length
+      unless typeof callback == 'function'
+        params.push callback
+        callback = undefined
+
+      params.unshift {} unless params.length
+
+      savings = []
+      for attributes in params
+        # TODO accept dirty as attribute on record creation
+        record       = @ attributes
+        record.dirty = true
+        savings.push record.save callback
+
+      $.when savings...
+
+    # returns a promise
+    # TODO move to scopable
+    all: (conditions = {}, callback) ->
+      if typeof conditions == 'function'
+        callback   = conditions
+        conditions = {}
+
+      # TODO Consider parent resources
+      # if @parent and not @parent._id
+      #   return callback.call @model, []
+
+
+      $.when(rest.get.call @, conditions)
+       .then(util.model.map             )
+       .done callback
+
+    first: (conditions = {}, callback) ->
+      if typeof conditions == 'function'
+        callback   = conditions
+        conditions = {}
+
+      namespaced       = conditions[@resource] || {}
+      namespaced.limit = 1
+      namespaced.order = 'desc'
+
+      # TODO should fail when server returns more then one record
+      @all conditions, callback
+
+    # TODO better treating of arguments
+    get: (action, data = {}) ->
+      # TODO better way to override route
+      old_route  = @route
+      @route     = "/#{model.pluralize @resource.name}"
+      @route    += "/#{action}" if action
+
+      # TODO not allow resource overriding
+      resource   = data.resource
+      data       = data.json() if data and data.json
+
+      if resource?
+        payload        = data
+        data           = {}
+        data[resource] = payload
+
+      promise = rest.get.call @, data
+
+      route   = old_route
+
+      promise
+
+    put: rest.put
+    delete: rest.delete
+
+  record:
+    reload: (params...) ->
+
+      # TODO better signature implementation
+      data = params.pop()
+      params.push data if type(data) != 'object'
+
+      promise = rest.get.call @, data || {}
+      promise.done @assign_attributes
+      promise.fail @failed
+
+      # Bind one time save callbacks
+      promise.done param for param in params
+
+      promise
+
+    assign_attributes: (attributes) ->
+
+      # TODO only set associations on nested attributes!
+      # First assign has_many associations
+      # TODO implement setter on has_many association and move this code there
+      for association_name in model[@resource.toString()].has_many
+        associations_attributes = attributes[association_name]
+
+        # TODO copy attributes object and don't change it inside the assignment method
+        delete attributes[association_name] # Remove loaded json data
+
+        # Clear current stored cache on this association
+        # TODO implement setter on this association and let user to set
+        # it to an empty array
+        association = @[association_name]
+
+        unless association?
+          message  = "Association '#{association_name}' not found. \n"
+          message += "For record with resource #{@resource}. \n"
+          message += "Probably defined on server side but not on client side.\n"
+          message += "Skipping association assignment!"
+          console.warn message
+          continue
+
+        # TODO implement association.clear
+        Array.prototype.splice.call association, 0 if association.length
+
+        # continue if no associations_attributes were found by the server
+        continue unless associations_attributes? and associations_attributes.length
+
+        singular_resource = model.singularize association_name
+
+        # Normalize json data for building on association
+        for association_attributes in associations_attributes
+
+          # TODO only nest specified nested attributes on model definition
+          # TODO create special deserialization method no plural association
+          # TODO check if we need to nest attributes in other association types
+          for association_name in model[singular_resource].has_many
+            association_attributes["#{association_name}_attributes"] = association_attributes[association_name]
+
+            # TODO copy attributes object and don't change it inside
+            # the assignment method
+            delete association_attributes[association_name]
+
+        # Load new associations_attributes on this association
+        association.add associations_attributes...
+
+
+      # Nested attributes
+      # TODO implement setter on has_one association and move this
+      # code there
+      for association_name in model[@resource.toString()].has_one
+        association_attributes = attributes[association_name]
+
+        # TODO copy attributes object and don't change it inside the
+        # assignment method
+        delete attributes[association_name]
+        delete attributes[association_name + "_attributes"]
+        @[association_name] = @["build_#{association_name}"] association_attributes if association_attributes
+
+
+      # Assign remaining attributes
+      # TODO see if it is a best practice not overriding unchanged attributes
+      for attribute of attributes when attribute isnt @[attribute]
+        @[attribute] = attributes[attribute]
+
+    destroy: (doned, failed, data) ->
+      throw new Error 'Can\'t delete record without id!' unless @id? or @_id?
+
+      promise = rest.delete.call @, data
+      promise.done @destroyed
+      promise.fail @failed
+
+      # Bind one time save callbacks
+      promise.done doned
+      promise.fail failed
+
+      promise
+
+    saving: false
+    salvation: null
+    save: (doned, failed, data) ->
+      return @salvation if @saving
+
+      # TODO better lock generation
+      @lock = JSON.stringify @json()
+
+      # TODO remove jquery dependency
+      # TODO think with wich value makes more sense to resolve the
+      # absence of need to save the model
+      salvation   = $.Deferred().resolveWith @, null unless @dirty
+      salvation ||= rest[if @_id then 'put' else 'post'].call @, data
+      @salvation  = salvation
+      @saving     = true
+
+      salvation.done @saved
+      salvation.fail @failed
+      salvation.always -> @saving = false
+
+      # Bind one time save callbacks
+      salvation.done doned
+      salvation.fail failed
+
+      salvation
+
+    saved: (data) ->
+
+      # TODO better lock generation
+      if @lock == JSON.stringify(@json())
+        @dirty = false
+        delete @lock
+      # Delayed optimistic lock
+      else
+        return @save()
+
+      @assign_attributes data if data?
+
+      throw "Not supported after_save callback: " + callback for callback in @after_save if @after_save
+
+    # Parse error json if any
+    failed: (xhr, error, status) ->
+      payload       = xhr.responseJSON
+      try payload ||= JSON.parse(xhr.responseText) catch e
+      payload     ||= xhr.responseText
+
+
+      # When client fail
+      switch xhr.status
+        # TODO move to validatable
+        when 422
+
+          definition = model[@resource]
+
+          for attribute_name, messages of payload.errors
+
+            # TODO add support for error checking message introspection
+            # Check for association errors
+            if (!definition.associations)
+              # TODO update this attribute when associations are dinamically changed
+              definition.associations = definition.has_one.concat(definition.has_many.concat(definition.belongs_to))
+
+            # Only add errors to existing attributes
+            # TODO shorten this verification
+            unless @hasOwnProperty(attribute_name) or definition.hasOwnProperty(attribute_name) or definition.associations.indexOf(attribute_name) != -1 or attribute_name == 'base'
+
+              message  = "Server returned an validation error message for a attribute that is not defined in your model.\n"
+              message += "The attribute was '#{attribute_name}', the model resource was '#{@resource}'.\n"
+              message += "The model definition keys were '#{JSON.stringify Object.keys definition }'.\n"
+              message += "Please remove server validation, or update your model definition."
+              throw new TypeError message
+
+            for message in messages
+              @errors.add attribute_name, 'server', server_message: message
+
+        # Unknown fail
+        else
+          message  = "Fail in #{@resource}.save:\n"
+          message += "Record: #{@}\n"
+          message += "Status: #{status} (#{payload.status || xhr.status})\n"
+          message += "Error : #{payload.error || payload.message || payload}"
+
+      # Finish saving
+      @saving = false
+
+    toString: ->
+      serialized = {}
+      serialized[@resource] = @json()
+      JSON.stringify serialized
+
+    json: (methods = {}) ->
+      json = {}
+
+      for name, value of @ when type(value) isnt 'function'
+        continue unless value?  # Bypass null, and undefined values
+
+        if type(value) == 'object'
+
+          if value.toJSON?
+
+            json[name] = value.toJSON(methods[name])
+
+          else
+
+            # TODO move nested attributes to model definition
+            # TODO and implement toJSON there
+            for attribute in @nested_attributes when attribute == name
+              json["#{name}_attributes"] = value.json(methods[name])
+
+        else
+
+          json[name] = value
+
+      observable.unobserve json
+
+      # TODO Store reserved words in a array
+      # TODO Use _.omit function
+      # TODO Use object.defineProperty to not need to delete this properties
+      # Remove model reserved words
+      delete json.dirty
+      delete json.resource
+      delete json.route
+      delete json.initial_route # TODO implement better initial_route and remove attribute from here
+      delete json.after_initialize
+      delete json.before_initialize
+      delete json.parent_resource
+      delete json.nested_attributes
+      delete json.saving
+      delete json.salvation
+      delete json.sustained
+      delete json.element
+      delete json.default
+      delete json.lock
+      delete json.validated
+      delete json.validation
+
+      json
+
+# TODO put deprecation warning on json method
+# TODO rename json method to toJSON
+restful.toJSON = restful.json
+
+
+# Extend indemma
+model  = window.model     # TODO better way to get parent
+record = window.record     # TODO better way to get parent
+
+model.restfulable = true
+
+record.mix (recordable) ->
+  merge recordable, restful.record
+
+
+model.mix  (modelable ) ->
+  merge modelable , restful.model
+
+
+model.associable && model.associable.mix (singular_association,  plural_association) ->
+
+  # TODO move route setting to plural_association.after_mix
+  plural_association.get = ->
+    @route ||= "#{@parent.route}/#{@parent._id}/#{model.pluralize @resource.name}" if @parent?
+    rest.get.apply @, arguments
+
+  plural_association.post = ->
+    @route ||= "#{@parent.route}/#{@parent._id}/#{model.pluralize @resource.name}" if @parent?
+    rest.post.apply @, arguments

data/vendor/components/indefinido-indemma/src/lib/record/scopable.coffee

@@ -0,0 +1,275 @@
+require './restfulable'
+require './resource'
+
+stampit = require '../../vendor/stampit'
+extend  = require 'assimilate'
+merge   = extend.withStrategy 'deep'
+$       = require 'jquery'
+rest    = require './rest'
+
+
+scopable =
+  builder: stampit().enclose ->
+
+    # Builds a given scope
+    # {param} name Scope name also, the name of method used to invoke it
+    # {param} type Default value for scope, or base class to derive default for default type
+
+    stampit.mixIn (name, type) ->
+      if $.type(type) == 'function'
+        @["$#{name}"] = type() || new type
+        type          = $.type @["$#{name}"]
+      else
+        @["$#{name}"] = defaults[type] || type
+
+      type    = $.type type unless $.type(type) == 'string'
+      builder = builders[type]
+
+      throw "Unknown scope type: '#{type}', For model with resource: '#{@resource}'" unless builder?
+
+      @scope.declared.push name
+      @[name] = builder name: name
+    ,
+      data:     {}
+      then:     []
+      fail:     []
+      declared: []
+      fetch: (data, done, fail) ->
+        scope = extend {}, @scope.data
+
+        if scope.noned?
+          deferred = $.Deferred()
+          deferred.resolveWith @, [[]]
+        else
+          deferred = rest.get.call(@, extend scope, data)
+
+        deferred
+          .done(@scope.then.concat done)
+          .fail([@scope.fail, fail])
+
+        @scope.clear()
+
+        deferred
+
+      clear: ->
+        @data      = {}
+        @callbacks = []
+
+  # Shared scope stuff
+  base: stampit().state
+    name: 'unamed_scope'
+
+  record:
+    # Parse error json if any
+    failed: (xhr, error, status) ->
+      payload       = xhr.responseJSON
+      try payload ||= JSON.parse(xhr.responseText) catch e
+      payload     ||= xhr.responseText
+
+      # When client fail
+      switch xhr.status
+        when 422
+          @valid = false
+          return @errors = payload.errors
+        # Unknown fail
+        else
+          message  = "Fail in #{@resource}.save:\n"
+          message += "Record: #{@}\n"
+          message += "Status: #{status} (#{payload.status || xhr.status})\n"
+          message += "Error : #{payload.error || payload.message || payload}"
+
+      console.error message
+  model:
+    # TODO implement getter for none property!
+    none: ->
+      @scope.data.noned = true
+      @
+
+    fetch: (data, done, fail) ->
+      @scope.fetch.call @, data, done, fail
+
+    # TODO optmize this iterations or add support for stampit on associable and merge factories
+    # @ = record instance
+    forward_scopes_to_associations: ->
+      factory = model[@resource.name]
+
+      for association_name in factory.has_many
+        associated_resource = model.singularize association_name
+        associated_factory  = model[associated_resource]
+
+        # TODO change this warn message into a exception when
+        # associations are renamable
+        unless model[associated_resource]
+          console.warn("Associated factory not found for associated resource: #{associated_resource}")
+          continue
+
+        association         = @[association_name]
+        association.scope   = scopable.builder association
+
+
+        for scope in associated_factory.scope.declared
+          association.scope scope, associated_factory["$#{scope}"]
+
+      for associated_resource in factory.has_one
+        # TODO change this warn message into a exception when
+        # associations are renamable
+        unless model[associated_resource]
+          console.warn("Associated factory not found for associated resource: #{associated_resource}")
+          continue
+
+        for scope in model[associated_resource].scope.declared
+          @[associated_resource][scope] = factory[scope]
+
+        # TODO improve associable inner workings to stampit objects
+      if factory.belongs_to.length
+        generate_forwarder = (associated_resource) ->
+          associated_factory = model[associated_resource]
+
+          # TODO change this warn message into a exception when
+          # associations are renamable
+          return console.warn("Associated factory not found for associated resource: #{associated_resource}") unless associated_factory
+
+          declared_scopes    = associated_factory.scope.declared
+
+          ->
+            for scope in declared_scopes
+              @[associated_resource][scope] = associated_factory[scope]
+
+        for associated_resource in factory.belongs_to
+          forwarder = generate_forwarder associated_resource
+          @after "build_#{associated_resource}", forwarder
+
+      true
+  # @ = model instance
+  after_mix: ->
+    @scope = scopable.builder @
+
+    for property, type of @
+      if property.charAt(0) == '$'
+        name = property.substring 1
+        @scope name, type
+
+builders =
+  # Builds a string scope builder
+  string: stampit().enclose ->
+    base = scopable.base @
+
+    stampit.mixIn (value, callbacks...) ->
+      callbacks.length and @scope.then = @scope.then.concat callbacks
+      @scope.data[base.name] ||= value ? @["$#{base.name}"]
+      @
+
+  # Builds a boolean scope builder
+  boolean: stampit().enclose ->
+    base = scopable.base @
+
+    stampit.mixIn (value, callbacks...) ->
+      callbacks.length and @scope.then = @scope.then.concat callbacks
+      @scope.data[base.name] ||= value ? @["$#{base.name}"]
+      @
+
+  # Builds a array scope builder
+  array: stampit().enclose ->
+    base = scopable.base @
+
+    stampit.mixIn (values...) ->
+      @scope.data[base.name] ||= values ? @["$#{base.name}"]
+      @
+
+defaults =
+  boolean: true
+  array: []
+
+# Extend indemma
+model  = window.model     # TODO better way to get parent
+record = window.record     # TODO better way to get parent
+
+model.scopable = true
+
+# TODO use stampit to extend record and model
+#record.mix (recordable) ->
+#  merge recordable, scopable.record
+
+model.mix (modelable) ->
+  merge modelable, scopable.model
+
+  modelable.after_mix.push scopable.after_mix
+
+
+# TODO create a deferred to better mix models
+if model.associable
+  model.mix (modelable) ->
+    modelable.record.after_initialize.push ->
+      scopable.model.forward_scopes_to_associations.call @
+
+  model.associable.mix (singular_association,  plural_association) ->
+
+    # reload (done callbacks...)
+    plural_association.all = plural_association.reload = (data, done, fail) ->
+      # TODO move route discovery to plural_association.after_mix
+      @route ||= "#{@parent.route}/#{@parent._id}/#{model.pluralize @resource}" if @parent?
+      promises = []
+
+      # TODO better calculate fetch settings
+      # dirty    = 0
+      # if more than 5 records are dirty, we reftech all
+      #    if dirty < 5
+      #      for record in @
+      #        promises.push record.reload()
+      # else we reload everthing!
+      #    else
+      #
+      # for record in @
+      #   dirty++ if record.dirty
+
+      if typeof data == 'function'
+        done = data
+        data = undefined
+
+      promises.push @scope.fetch.call @, data, null, scopable.record.failed
+
+      reload = $.when.apply jQuery, promises
+
+      # Update association with data sent from the server
+      # TODO implement setter on this association and let user to set
+      reload.done (records, status) ->
+
+        # Clear current stored cache on this association
+        # it to an empty array
+        Array.prototype.splice.call @, 0
+
+        # return if no records were found by the server
+        return unless records.length
+
+        singular_resource = model.singularize @resource
+
+        # Normalize json data for building on association
+        for record in records
+
+          # TODO only nest specified nested attributes on model definition
+          # TODO create special deserialization method no plural association
+          # TODO check if we need to nest attributes in other association tipes
+          for association_name in model[singular_resource].has_many
+            record["#{association_name}_attributes"] = record[association_name]
+            delete record[association_name]
+
+        # Load new records on this association
+        @add.apply @, records
+
+        # Override the response records object with added to association records
+        records.splice 0
+        records.push.apply records, @
+
+
+      reload.done done
+      reload.fail fail
+
+      reload
+
+    plural_association.each = (callback) ->
+      @route ||= "#{@parent.route}/#{@parent._id}/#{model.pluralize @resource}" if @parent?
+
+      # TODO cache models
+      @get().done (records) =>
+        for record in @
+          callback record

data/vendor/components/indefinido-indemma/src/lib/record/storable.coffee

@@ -0,0 +1,46 @@
+extend  = require 'assimilate'
+merge   = extend.withStrategy 'deep'
+stampit = require '../../vendor/stampit'
+
+storable = stampit
+  store: (keypath, value, options) ->
+    collection = @database
+    keypath = keypath.toString().split '.'
+    key     = keypath.pop()
+
+    for entry in keypath
+      collection[entry] ||= {}
+      collection = collection[entry]
+
+    if arguments.length == 1
+      @reads++
+      collection[key]
+    else
+      @writes++
+
+      # TODO use object.defineProperty
+      value.sustained = true
+      collection[key] = value
+
+  values: ->
+    Object.values @database
+  ,
+    type: 'object'
+    writes: 0
+    reads: 0
+  , ->
+    @database ||= {}
+    @
+
+
+# Extend indemma
+# TODO use stampit to extend record and model
+model  = window.model     # TODO better way to get parent
+record = window.record     # TODO better way to get parent
+
+model.storable = true
+module.exports = storable
+#model.mix (modelable) ->
+#  merge modelable, storable.model
+
+

data/vendor/components/indefinido-indemma/src/lib/record/translationable.coffee

@@ -0,0 +1,18 @@
+root       = exports ? window
+
+# TODO better way to get core model definition
+# model = require ...
+
+# TODO implement method
+# model[resource].validators_on 'field' # Get all validators related to this field
+
+extend      = require('assimilate')
+
+extensions =
+  model:
+    human_attribute_name: (attribute_name) ->
+      @translation?.attributes?[attribute_name] or attribute_name
+
+model.mix (modelable) ->
+  extend modelable, extensions.model
+