pinkman 0.9.9.9.11 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 542f0294f57dc31831c1f3edf26e84eff18a8b52c12dc590a5829e4e32947ad5
-  data.tar.gz: bd5f4831742985e4f214d7a67d4863297cacf8ec9065f8254e0e3e3d1acc0863
+  metadata.gz: 99be758a6c0fd2b3b91ded4b49b176b0084daa153008390ce2d7a0301b763339
+  data.tar.gz: 7652fe78dbacada668465d7aa3abc24789439f87b8f9d32b8e861dc9467f3dd9
 SHA512:
-  metadata.gz: f008682f5279f37b1dfc5007cf5bf185c9dc9cac65226ac709cfd506a93e291b5a3fcd6f4c107b321a87662e38d3d33a2e5deb2d07325e0854de3b76ebf779f1
-  data.tar.gz: 12d8a131e75349686ef9168c6290f51c22684c3900d17ce82aa06c3c605eaca36aae37d18ea2ba74f1c9be19b21eae09d07a9af521362b2f3367ac3941f07f29
+  metadata.gz: b200b9dc96f6cdc0ff71a583d16e21dd65d953100f465fef9e2c0716009ffdc67f5226962e4fd52b5be931988bc9834a26f68e6793e8d949a7818a115ee529fb
+  data.tar.gz: dcaca3c9a82cec48a1304ed40d0be1efb1ed480b0ecfeef432c611bfe764c83797a387fea888c10b121699c7a1f5789a2ee428b1f40d0cbff45ea748cc57e83a

data/README.md

@@ -1,6 +1,6 @@
 # Pinkman
 
-Rails js framework.
+Rails js framework. V1 RC.
 
 ## Installation
 

data/app/assets/javascripts/pinkman_base/cache.coffee

@@ -10,9 +10,19 @@ class window.PinkmanCache
   
   @has: (name) ->
     @_caching[name]?
+  
+  @getOrInsert: (name, value) =>
+    if @has(name) 
+      # console.log "has: #{name}"
+      return(@get(name)) 
+    else
+      # console.log "caching: #{name}"
+      return(@cache(name, value))
+    
+  @get: (name, callback) ->
+    callback(@_caching[name]) if $p.isFunction(callback)
+    return(@_caching[name])
     
-  @get: (name) ->
-    @_caching[name]
     
 $(document).ready ->
   window.$c = window.PinkmanCache

data/app/assets/javascripts/pinkman_base/collection.coffee

@@ -1,6 +1,9 @@
 class window.PinkmanCollection extends window.PinkmanCommon
 
   @pinkmanType = 'collection'
+    
+  @objectClass: ->
+    @firstInstanceOrInitialize().config.memberClass
   
   config:
     memberClass: PinkmanObject
@@ -10,7 +13,14 @@ class window.PinkmanCollection extends window.PinkmanCommon
     @isCollection = true
     @pinkmanType = 'collection'
     @collection = []
+    if @constructor.name? and @constructor.name!='PinkmanCollection'
+      if $p.isArray(@constructor.instances)
+        @constructor.instances.push(this)
+      else
+        @constructor.instances = [this]
+      
     Pinkman.collections.push(this)
+    
 
   # Desc: return an array of all members
   # this behaviour makes life easier... trust me
@@ -230,7 +240,7 @@ class window.PinkmanCollection extends window.PinkmanCommon
         i = @collection.indexOf(value)
         @collection.splice(i,1)
     else
-      console.log 'js'
+      # console.log 'js'
       i = @collection.indexOf object
       @collection.splice(i,1)
       value = object
@@ -529,56 +539,40 @@ class window.PinkmanCollection extends window.PinkmanCommon
   #   string: search
   #   obj: select (cache) / where (server)
   #   function: select
-    
-  @get: (query, callback) ->
-    @startCaching()
-    
-    # query md5
-    query_md5 = md5(JSON.stringify(query) + @_name_md5)
-    
-    if $c.has(query_md5)
-      @handleGetCollection($c.get(query_md5),callback)
-    else
-      # TRYING TO FIND IN CACHE
-      $c.get(@_name_md5).select query, (cache) =>
-        # CACHED FOUND
-        if cache.any()
-          # console.log 'cached'
-          @handleGetCollection(cache,callback)
-        
-        # CACHED VERSION NOT FOUND -> ASK SERVER
-        else
-          # console.log 'server'
-          col = new this
-          obj = new col.config.memberClass
-          params = new Object
-          params.scope = Pinkman.scope(obj)
-          params.query = query
-          Pinkman.ajax.get
-            url: obj.api('get')
-            data: params
-            complete: (response) =>
-              col.fetchFromArray(response)
-              # PERFOMING INSTANCES CACHE
-              col.each (obj) =>
-                $c.get(@_name_md5).push(obj)
-              
-              # CACHING THIS QUERY
-              $c.cache(query_md5,col)
-              
-              callback(col) if $p.isFunction(callback)
-          return(col)
   
-  @handleGetCollection: (fetchedCollection,callback) ->
-    col = new this
-    col.collection = fetchedCollection.collection
-    callback(col) if $p.isFunction(callback)
-    return(col)
-  
-  @one: (query,callback) ->
-    @get(query, (col) ->
-      callback(col.first()) if col.any() and $p.isFunction(callback)
-    ).first()
+  @get: (options) ->
+    if $p.isObject(options) and (options.query? or options.params?) and $p.isFunction(options.callback)
+      @startCaching()
+      options.cache = yes unless options.cache?
+      query = Pinkman.mergeObjects(options.scope, Pinkman.mergeObjects(options.query, options.params))
+      query_md5 = md5(JSON.stringify(query) + @_name_md5)
+      if options.cache and $c.has(query_md5)
+        $c.get(query_md5, options.callback)
+      else
+        col = new this
+        obj = new col.config.memberClass
+        params = new Object
+        params.scope = options.scope || Pinkman.scope(obj)
+        params.query = options.query
+        params = Pinkman.mergeObjects(params, options.params)
+        Pinkman.ajax.get
+          url: options.url || obj.api('get')
+          data: params
+          complete: (response) =>
+            col.fetchFromArray(response)
+            $c.cache(query_md5, col)
+            options.callback(col)
+    else
+      throw "Pinkman Error: collection.get invalid options #{options.toString()}"
+
+  @one: (options) ->
+    if $p.isObject(options) and $p.isFunction(options.callback)
+      args = Pinkman.dup(options)
+      args.callback = (col) ->
+        return(options.callback(col.first()))
+      @get(args)
+    else
+      return(throw("Pinkman Error: #{this.toString()}.one called with wrong arguments."))
   
   @single: (args...) ->
     @one(args...)
@@ -592,9 +586,21 @@ class window.PinkmanCollection extends window.PinkmanCommon
   # Desc: Fetch records from API_URL
   # request:  get /api/API_URL/
   # in rails: api::controller#index
-  fetch: (callback = '') ->
-    @fetchFromUrl url: @api(), callback: callback      
-  
+  fetch: (args...) ->
+    switch args.length
+      when 1
+        if $p.isFunction(args[0])
+          callback = args[0]
+          @fetchFromUrl url: @api(), callback: callback, scope: 'public'
+        
+        else if $p.isObject(args[0])
+          options = args[0]
+          @fetchFromUrl url: (options.url || @api()), callback: options.callback, scope: options.scope    
+      when 2
+        scope = args[0]
+        callback = args[1]
+        @fetchFromUrl url: @api(), callback: callback, scope: scope
+    
   # Desc: Fetch records from another action of this model api
   # request:  get /api/API_URL/:action/#id
   # in rails: api::controller#action
@@ -615,21 +621,21 @@ class window.PinkmanCollection extends window.PinkmanCommon
   fetchFromUrl: (options) ->
     if options? and typeof options == 'object' and options.url?
       options_md5 = md5(JSON.stringify(options) + @className())
-      if $c.has(options_md5)
-        response = $c.get(options_md5)
-        @handleFetchResponse(response,options)
-      else      
-        if Pinkman.hasScope(this)
-          options.params = new Object unless options.params?
-          options.params.scope = Pinkman.scope(this)
-        @doneFetching = null
-        @fetchingFrom = options.url
-        Pinkman.ajax.get
-          url: Pinkman.json2url(options.url,options.params) 
-          complete: (response) =>
-            $c.cache(options_md5,response)
-            @handleFetchResponse(response,options)
-        return(this)
+      options.params = new Object unless options.params?
+      options.cache = yes unless options.cache?
+      if options.scope?
+        options.params.scope = options.scope
+      else
+        throw 'Pinkman Error: Trying to fetch without a specified scope'
+      
+      @doneFetching = null
+      @fetchingFrom = options.url
+      Pinkman.ajax.get
+        url: Pinkman.json2url(options.url, options.params) 
+        complete: (response) =>
+          $c.cache(options_md5, response) if options.cache
+          @handleFetchResponse(response, options)
+      return(this)
       
   handleFetchResponse: (response,options) ->
     @constructor.startCaching()
@@ -685,8 +691,17 @@ class window.PinkmanCollection extends window.PinkmanCommon
   # request:  get /api/API_URL/search?query=YOUR_QUERY
   # in rails: api::controller#search
   # assume models to have a Model.search("YOUR_QUERY") method.
-  search: (query,callback='') ->
+  search: (args...) ->
     @removeAll()
-    @fetchFromUrl { url: @api() + 'search', params: {query: query}, callback: callback }
+    if args.length == 2
+      [query, callback] = args
+    else if args.length == 1 and $p.isObject(args[0])
+      options = args[0]
+      query = options.query
+      callback = options.callback
+      scope = options.scope || 'public'
+    return(@fetchFromUrl { url: @api() + 'search', params: {query: query}, callback: callback, scope: (scope || 'public') })
+      
+      
 
 window.Pinkman.collection = window.PinkmanCollection

data/app/assets/javascripts/pinkman_base/common.coffee

@@ -22,11 +22,18 @@ class window.PinkmanCommon
   @isInstance: (object) ->
     object.constructor is this
     
+  @firstInstanceOrInitialize: ->
+    obj = if $p.isArray(@instances) and @instances.length >= 1 then @instances[0] else new this
+        
+  @api: (args...) ->
+    @firstInstanceOrInitialize().api(args...)
+  
   initialize: (attributesObject) ->
     if typeof attributesObject == 'object'
       for key, value of attributesObject
         @set(key,value) if PinkmanObject.privateAttributes.indexOf(key) is -1
-
+    
+  
   # Desc: return api url path
   api: (paths...) ->
     if @config? and @config.api?
@@ -145,6 +152,28 @@ class window.PinkmanCommon
       @append
         template: options + '-template'
         target: options
+        
+  prepend: (options) ->
+    if options? and typeof options == 'object' and options.target?
+      options.template = options.target + '-template' unless options.template? and options.template != ''
+      newOptions = new Object
+      for k,v of options
+        newOptions[k] = v if k != 'target' and k != 'callback'
+      newOptions.reRender = no
+      target = options.target
+      wrapIn = options.wrapIn
+      newOptions.object = this
+      newOptions.callback = (object,content) ->
+        if wrapIn?
+          $('#'+target).prepend("<div class='#{wrapIn}'>#{content}</div>")
+        else
+          $('#'+target).prepend(content)
+        options.callback(object,content) if options.callback? and typeof options.callback == 'function'
+      Pinkman.render(newOptions)
+    else if options? and Pinkman.isString(options)
+      @prepend
+        template: options + '-template'
+        target: options
 
   _queue: (options) ->
     options.id = options.template
@@ -152,7 +181,7 @@ class window.PinkmanCommon
     @renderQueue.directPush(options)
 
   hasError: ->
-    @errors?
+    return(this) if @errors?
   
   hasErrors: ->
     @hasError()

data/app/assets/javascripts/pinkman_base/controller.coffee

@@ -32,11 +32,8 @@ class window.PinkmanController extends window.PinkmanObject
     '#' + @id
 
   setParams: (params) ->
-    query = location.search.substring(1);
-    if query? and query!=''
-      @params = JSON.parse('{"' + decodeURI(query).replace(/"/g, '\\"').replace(/&/g, '","').replace(/=/g,'":"') + '"}')
-    else
-      @params = new Object
+    # console.log params
+    @params = new Object
       
     (@params[k] = v) for k,v of params if params? and typeof params == 'object'
     @params
@@ -98,7 +95,7 @@ class window.PinkmanController extends window.PinkmanObject
   # but... in a few ocasions, the developer must have the capability to exclude certain attributes from this binding.
   # thats when the "except" option comes in
   # maybe a "only" option is going to be implemented in the near future
-  bindAllSelector: (id,options) ->
+  bindAllSelector: (id, options) ->
     except = options.except if $p.isObject(options) and options.except?
     selector = "##{@id} form [data-action], ##{@id} .form [data-action]"
     
@@ -130,7 +127,7 @@ class window.PinkmanController extends window.PinkmanObject
       
     PinkmanAction.define
       id: "#{@pinkey}-bindAll"
-      selector: @bindAllSelector(@id,options)
+      selector: @bindAllSelector(@id, options)
       eventName: ['change','keyup']
       controller: this
       callback: (obj,$j) ->
@@ -162,7 +159,7 @@ class window.PinkmanController extends window.PinkmanObject
       
   # === Autocomplete ===
 
-  # -- Usage: autocomplete(input_name,options)
+  # -- Usage: autocomplete(input_name, options)
 
   # -- Overview
   # 1: User types something
@@ -171,7 +168,7 @@ class window.PinkmanController extends window.PinkmanObject
   # 4: Pinkman sends the selected record to callback function
 
   # -- Parameters & Options
-  # @autocomplete(attribute,options)
+  # @autocomplete(attribute, options)
   # options:
     # with: [collection] 
     # pinkman collection responsible for filtering/searching the results
@@ -179,9 +176,19 @@ class window.PinkmanController extends window.PinkmanObject
     # method: [search|yourCustomMethod] 
     # Search is the default. Anythings that filters by a 'query'.
     # You can define a yourCustomMethod inside the collection model like this:
-    # yourCustomMethod: (user_query, callback) ->
-      # -- perform a selection based on user_query
-      # callback(this) if $p.isFunction(callback)
+    # yourCustomMethod: (options) ->
+      
+      # 1. perfom some filter on the collection based on options.query
+      
+      # 2. don't forget to verify if user can access the requested scope in case of api comunications
+      
+      # 3. call options.callback whenever the collection is ready
+      
+      # options object explanation:
+      #   options.query: what user is trying to find/search
+      #   options.scope: scope user is trying to access (in case of api comunications)
+      #   options.callback: call this function with the filtered collection when it's ready
+      
     
     # template: [template-id] (optional)
     # Any template that has a 'select-attribute' action
@@ -205,6 +212,7 @@ class window.PinkmanController extends window.PinkmanObject
     # variables // user options // default options
     collection = options.with
     callback = options.call
+    scope = if options.scope? then options.scope else 'public'
     template = if options.template? then options.template else "#{attr_name}-autocomplete"
     target = if options.target? then options.target else "#{attr_name}-autocomplete"
     method = if options.method? then options.method else 'search'
@@ -214,6 +222,9 @@ class window.PinkmanController extends window.PinkmanObject
     wait = if options.wait? then options.wait else 0.75
     waitTimerName = "#{attr_name}AutocompleteTimer"
     
+    
+    # collection.set('_autocompleting', attr_name)
+    
     # hide initially
     $("##{target}").hide() if autoHide
     
@@ -236,23 +247,26 @@ class window.PinkmanController extends window.PinkmanObject
       window[waitTimerName] = $p.sleep wait, =>
         
         # calls the filter method (search)
-        collection[method] obj[attr_name], (collection) ->
+        collection[method] 
+          query: obj[attr_name]
+          scope: scope
+          callback: (collection) ->
           
-          # render results
-          collection.render
-            template: template
-            target: target
-            callback: ->
-              # Hide or show autocomplete
-              if autoHide
-                if obj[attr_name]? and obj[attr_name] != ''
-                  $("##{target}").fadeIn()
-                else
-                  $("##{target}").fadeOut()
-              
-              # Set the autocomplete target width to same as the input
-              if autoWidth
-                $("##{target}").width($("input[name='#{attr_name}']").innerWidth() - ($("##{target}").innerWidth() - $("##{target}").width()))
+            # render results
+            collection.render
+              template: template
+              target: target
+              callback: ->
+                # Hide or show autocomplete
+                if autoHide
+                  if obj[attr_name]? and obj[attr_name] != ''
+                    $("##{target}").fadeIn()
+                  else
+                    $("##{target}").fadeOut()
+                
+                # Set the autocomplete target width to same as the input
+                if autoWidth
+                  $("##{target}").width($("input[name='#{attr_name}']").innerWidth() - ($("##{target}").innerWidth() - $("##{target}").width()))
     
     # user chooses something and click
     @action "select-#{attr_name}", 'click', (args...) =>

data/app/assets/javascripts/pinkman_base/object.coffee.erb

@@ -13,6 +13,9 @@ class window.PinkmanObject extends window.PinkmanCommon
       @constructor.instances = [this]
     Pinkman.objects.push(this)
     
+  @alias: (newFunc, existingFunc) ->
+    @prototype[newFunc] = @prototype[existingFunc]
+
   @sync: (obj,callback,each) ->
     if $p.isArray(@instances) and $p.isObject(obj) and obj.id?
       length = @instances.length
@@ -23,10 +26,10 @@ class window.PinkmanObject extends window.PinkmanCommon
           if obj.isPink then instance.assign(obj.attributes()) else instance.assign(obj)
           each(instance) if $p.isFunction(each) and obj.pinkey != instance.pinkey
           callback() if (length == i) and $p.isFunction(callback)
-            
     else
       true
-
+    
+    
   # Desc: assign attributes from a pure javascript object
   # Usage: a.assign( {attribute: value} )
   assign: (obj) ->
@@ -42,7 +45,7 @@ class window.PinkmanObject extends window.PinkmanCommon
 
   # Desc: returns a javascript object version of this
   # Usage: a.attributes() #-> {key: value, key: value, ...}
-  attributes: () ->
+  attributes: ->
     a = new Object
     for k,v of this
       if PinkmanObject.privateAttributes.indexOf(k) == -1 and typeof v != 'function'
@@ -54,16 +57,22 @@ class window.PinkmanObject extends window.PinkmanCommon
 
   # Desc: json version of this
   # desc: used in api comunications
-  json: () ->
+  json: ->
+    (@pack(toBePacked) for toBePacked in @_pack_list) if $p.isArray(@_pack_list)
     a = new Object
     for k,v of this
-      if PinkmanObject.privateAttributes.indexOf(k) == -1 and typeof v != 'function'
-        if (v? and typeof v == 'object' and v.isPink)
-          # do not include collections in json format since they are supposed to have their own model/api
-          a[k] = v.json() unless v.isCollection
-        else
-          a[k] = v
+      a[k] = v if PinkmanObject.privateAttributes.indexOf(k) == -1 and not $p.isFunction(v) and not $p.isObject(v)
     return a
+    
+  # Desc: prepare for rails accept nested attributes
+  pack: (attr) ->
+    @_pack_list = [] unless @_pack_list?
+    @_pack_list.push(attr) if @_pack_list.indexOf(attr) == -1
+    if $p.isPink(this[attr])
+      pack = this[attr]
+      attrs = pack.json()
+      @set("#{attr}_attributes[#{k}]", v) for k,v of attrs
+    attrs
 
   # Desc: returns a array of attributes keys
   # Usage:
@@ -73,7 +82,7 @@ class window.PinkmanObject extends window.PinkmanCommon
     Object.keys(@attributes())
 
   # Desc: Alias for attributesKeys
-  keys: () ->
+  keys: ->
     @attributesKeys()
 
   extract: (args...) ->
@@ -82,7 +91,7 @@ class window.PinkmanObject extends window.PinkmanCommon
     return(a)
       
 
-  toString: () ->
+  toString: ->
     array = []
     array.push("(#{@className()})")
     for a in @attributesKeys()

data/app/assets/javascripts/pinkman_base/pinkman.coffee

@@ -14,6 +14,9 @@ class window.Pinkman
 
   # --- predicate
 
+  @isPink: (obj) ->
+    @isObject(obj) && obj.isPink
+    
   @isNumber: (n) ->
     !isNaN(parseFloat(n)) && isFinite(n)
 
@@ -38,8 +41,25 @@ class window.Pinkman
   @sleep = (s,callback) -> 
     ms = s*1000
     window['_sleeping'] = setTimeout(callback,ms)
-
-
+  
+  
+  @mergeObjects: (a, b) ->
+    if a? and @isObject(a)
+      clone = @dup(a)
+    else
+      clone = new Object
+    if b? and @isObject(b)
+      for k,v of b
+        clone[k] = v
+    return(clone)
+  
+  @dup: (a) ->
+    if @isFunction(Object.assign)
+      if @isObject(a) then Object.assign({}, a) else throw("Pinkman Error: can't dup #{a.toString()}. It is not an object.")
+    else
+      if @isObject(a) then jQuery.extend({}, a) else throw("Pinkman Error: can't dup #{a.toString()}. It is not an object.")
+    
+    
   # --- tools and facilities
   
   @top: ->
@@ -100,6 +120,12 @@ class window.Pinkman
     else
       ''
 
+  @padNum: (number, size=2) ->
+    output = number.toString()
+    output = '0' + output while (output.length < size)
+    output
+
+    
   @objToArray: (obj) ->
     i = 0
     a = []
@@ -123,6 +149,28 @@ class window.Pinkman
   
   @calledFunctions = []
 
+
+  @each: (array, exec, callback) ->
+    if @isArray(array) and @isFunction(exec)
+      l = array.length
+      i = 0
+      for item in array
+        exec(item)
+        i++
+        callback(array) if i == l and @isFunction(callback)
+
+    else
+      throw "Pinkman.each: wrong args: expect a array, apply function and a callback function. Got #{arguments}."
+  
+  @map: (array, exec, callback) ->
+    if @isArray(array) and @isFunction(exec)
+      outputArray = []
+      @each array, (item) =>
+        outputArray.push(exec(item))
+      , =>
+        callback(outputArray) if @isFunction(callback)
+      return(outputArray)
+  
   # --- Scope
 
   @scope: (obj) ->

data/app/assets/javascripts/pinkman_base/render.coffee.erb

@@ -80,7 +80,12 @@ Pinkman.template_engines =
   partialAdapter: (templateBody) ->
     if templateBody? and templateBody != ''
       partialRegex = /{{(?:\s)*partial\((?:\s)*((?:\w|-)*)(?:\s)*\)(?:\s)*}}/gm
-      templateBody.replace(partialRegex,@partialInception)
+      i = 0
+      while partialRegex.test(templateBody)
+        # i++
+        # console.log("partial-inception level: #{i}")
+        templateBody = templateBody.replace(partialRegex, @partialInception)
+      return(templateBody)
     else
       ''
   
@@ -92,7 +97,7 @@ Pinkman.template_engines =
     if p.length
       p.html()
     else
-      match
+      throw "Pinkman: Partial Error - Could not find partial named #{id}."
 
   context: (options) ->
     options.object = options.context if options.context?
@@ -110,10 +115,28 @@ Pinkman.template_engines =
       $('#' + options.target).html(content)
       $('#' + options.target).attr('data-pinkey',options.object.pinkey) if options.object? and typeof options.object == 'object' and options.object.isPink
 
-      # checks and sync select options with the pinkman object
+      # checks and sync select, checkboxes and radiobuttons options with the pinkman object
+      # select
       $("##{options.target} select").each (i,el) ->
         obj = Pinkman.get($(el).data('pinkey'))
         $(el).find("option[value='#{obj[$(el).attr('name')]}']").attr('selected','selected')
+      
+      # checkboxes and radios
+      $("##{options.target} input[type='checkbox'], ##{options.target} input[type='radio']").each (i,el) ->
+        obj = Pinkman.get($(el).data('pinkey'))
+        $el = $(el)
+        attr = $el.attr('name')
+        value = $el.attr('value')
+        # console.log attr
+        # console.log value.toString()
+        # console.log obj[attr].toString()
+        
+        if attr? and value? and obj? and obj[attr]? and obj[attr] and obj[attr].toString() == value.toString()
+          $el.attr('checked', yes) 
+        else
+          $el.attr('checked', no)
+      
+      
 
   render: (options) ->