pinkman 0.9.9.9.11 → 1.0.0

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

@@ -1,37 +1,50 @@
 class window.PinkmanPath extends Pinkman.object
    
   constructor: (url) ->
-    @levels = new Pinkman.collection
-    @static = new Pinkman.collection
-    @dynamic = new Pinkman.collection
-    @params = new Object
-    super()
-    if Pinkman.isString(url)
-      url = url.replace(window.location.origin,'') if PinkmanPath.isInternal(url)
-      a = url.split('/')
-      a.shift() if a[0] == ''
-      a.pop() if a[a.length-1] == ''
-      i = 0
-      s = 0
-      d = 0
-      for l in a
-        i = i + 1
-        obj = new Pinkman.object({entry: l, index: i})
-        if /:/.test(l[0])
-          d = d + 1
-          obj.set('dynamic',yes)
-          obj.set('static',no)
-          @dynamic.push(obj)
-        else
-          s = s + 1
-          obj.set('dynamic',no)
-          obj.set('static',yes)
-          @static.push(obj)
-        @levels.push(obj)
+    if PinkmanCache.has("p-path-#{url}")
+      return(PinkmanCache.get("p-path-#{url}"))
+    else
+      # setting params
+      paramsRegex = /\?.*/
+      if paramsRegex.test(url)
+        paramsString = /\?(.*)/.exec(url)[1]
+        @query = JSON.parse('{"' + decodeURI(paramsString).replace(/"/g, '\\"').replace(/&/g, '","').replace(/=/g,'":"') + '"}')
+        url = url.replace("?#{paramsString}", '')
+      
       
-      @set('depth',i)
-      @set('staticDepth',s)
-      @set('dynamicDepth',d)
+      @levels = new Pinkman.collection
+      @static = new Pinkman.collection
+      @dynamic = new Pinkman.collection
+      @params = new Object
+      super()
+      if Pinkman.isString(url)
+        url = url.replace(window.location.origin,'') if PinkmanPath.isInternal(url)
+        
+          
+        a = url.split('/')
+        a.shift() if a[0] == ''
+        a.pop() if a[a.length-1] == ''
+        i = 0
+        s = 0
+        d = 0
+        for l in a
+          i = i + 1
+          obj = new Pinkman.object({entry: l, index: i})
+          if /:/.test(l[0])
+            d = d + 1
+            obj.set('dynamic',yes)
+            obj.set('static',no)
+            @dynamic.push(obj)
+          else
+            s = s + 1
+            obj.set('dynamic',no)
+            obj.set('static',yes)
+            @static.push(obj)
+          @levels.push(obj)
+        @set('depth',i)
+        @set('staticDepth',s)
+        @set('dynamicDepth',d)
+        PinkmanCache.cache("p-path-#{url}",this)
       
   @depth: (url) ->
     a = url.split('/')
@@ -54,18 +67,25 @@ class window.PinkmanPath extends Pinkman.object
     @levels.last()
   
   match: (path) ->
+    # console.log "PinkmanPath#match - path arg: #{path}"
     path = new PinkmanPath(path) if Pinkman.isString(path)
     if PinkmanPath.isInstance(path) and path.depth == @depth
+      # console.log 'tentou'
       match = true
       @static.each (level) ->
-        match = false if level.entry != path.level(level.index).entry
+        if level.entry != path.level(level.index).entry
+          # console.log level.entry
+          # console.log path.level(level.index).entry
+          match = false 
       return(match)
     else
       false
   
   matchParams: (path) ->
     @dynamic.each (level) ->
-      path.params[level.entry.replace(/:/g,"")] = path.level(level.index).entry
+      # console.log level
+      # console.log path
+      path.params[level.entry.replace(/:/g,"")] = path.level(level.index).entry.replace(/[#?].*/,'')
   
   deduceControllerName: ->
     @static.extract('entry').join('-').replace(/[\/_]/g,'-').replace(/^-/,'')
@@ -100,13 +120,20 @@ class window.PinkmanRouteMatcher extends Pinkman.object
     
   findRouteFor: (url) ->
     url = url.replace(window.location.origin,'') if PinkmanPath.isInternal(url)
-    return Pinkman.routes
-      .select(depth: PinkmanPath.depth(url))
-      .select((candidate) -> candidate.path.match(url))
-      .sortBy('staticDepth','desc').first()
+    # console.log 'tentando achar route'
+    # console.log(url)
+    if PinkmanCache.has("p-router-#{url}")
+      PinkmanCache.get("p-router-#{url}")
+    else
+      r = Pinkman.routes
+        .select(depth: PinkmanPath.depth(url))
+        .select((candidate) -> candidate.path.match(url))
+        .sortBy('staticDepth','desc').first()
+      return(PinkmanCache.cache("p-router-#{url}", r))
   
   setup: (route,url) ->
     if route? and url?
+      # console.log "PinkmanRouterMatcher#setup - url arg: #{url}"
       urlPath = new PinkmanPath(url) 
       route.path.matchParams(urlPath)
       @set('url',url)
@@ -124,7 +151,7 @@ class window.PinkmanRouteMatcher extends Pinkman.object
   params: ->
     # console.log @path
     # console.log @path.params
-    @path.params if @path and @path.params?
+    Pinkman.mergeObjects(@path.params, @path.query)
     
     
 # every route defined turn into a object of this class: PinkmanRoute
@@ -246,14 +273,19 @@ class window.PinkmanRouter
     if r? and r
       # console.log r
       r.options = options
+      @_config.beforeRender(r) if $p.isFunction(@_config.beforeRender)
       if @_config.transition? and typeof @_config.transition == 'function'
         @_config.transition =>
           @render(r,callback)
       else
         @render(r,callback)
     else
+      # console.log 'route not found'
       false
     
+  @path: ->
+    window.location.pathname
+    
   # Goes to a path
   @visit: (path) ->
     @activate path, ->
@@ -287,12 +319,26 @@ class window.PinkmanRouter
   @back: ->
     window.history.back() if window.history?
     
+  @refresh: ->
+    @go(@path())
+    
+  @reload: ->
+    window.location.reload()
+  
+  @paramsObject: ->
+    regex = /\?(.*)/
+    if regex.test(window.location.href)
+      paramsString = regex.exec(window.location.href)[1]
+      JSON.parse('{"' + decodeURI(paramsString).replace(/"/g, '\\"').replace(/&/g, '","').replace(/=/g,'":"') + '"}')
+    else
+      return new Object
+    
   @start: ->
     Pinkman.ready =>
       Pinkman.router = this
       App.router = this
       window.$r = App.router
-      @activate(window.location.pathname)
+      @activate(window.location.href)
       $('body').on 'click', 'a:not([data-pinkman="false"],[target="blank"],[target="_blank"])', (ev) =>
         ev.preventDefault()
         path = ev.currentTarget.href
@@ -304,6 +350,12 @@ class window.PinkmanRouter
     namespaced._namespace = if @_namespace then ("#{@_namespace}/#{namespace}") else namespace
     rules(namespaced) if typeof rules == 'function'
     
+  scope: (scope, rules) ->
+    scope = scope.replace(/^\//,'')
+    scoped = new @constructor()
+    scoped._scope = if @_scope then ("#{@_scope}/#{scope}") else scope
+    rules(scoped) if typeof rules == 'function'
+    
   resources: (resourceName) ->
     
     # controllerPrefix = if @_namespace then @_namespace.replace(/\//,'-') + '-' else ''
@@ -325,6 +377,7 @@ class window.PinkmanRouter
     if Pinkman.isString(path)
       path = path.replace(/^\//,'')
       path = "/#{@_namespace}/" + path if @_namespace
+      path = "/#{@_scope}/" + path if @_scope
       p = new PinkmanPath(path)
       route = new PinkmanRoute
       route.set('id',path)

data/lib/generators/pinkman/install_generator.rb

@@ -45,9 +45,10 @@ module Pinkman
       generate 'pinkman:initializer'
     end
     
-    def create_pinkman_channel
-      generate 'pinkman:pinkman_channel'
-    end
+    # # TO DO < pinkman channel
+    # def create_pinkman_channel
+    #   generate 'pinkman:pinkman_channel'
+    # end
     
     def install_hello_world_controller
       copy_file "hello.controller.coffee.erb", Rails.root.join('app','assets','javascripts','pinkman','app','controllers','hello.coffee')

data/lib/generators/pinkman/templates/api.rb.erb

@@ -1,23 +1,23 @@
 class Api::<%= controller_name %> < ApiController
 
+  before_action :verify_permissions
   before_action :set_objects
-  before_action :permissions
 
   # get api/<%= api_name %>
   def index
-    <%= collection_name %> = <%= active_record_model_name %>.limit(params[:limit]).offset(params[:offset])
-    render json: <%= collection_name %>.json(current_scope)
+    <%= collection_name %> = <%= active_record_model_name %>.limit(current_limit).offset(current_offset)
+    render json: <%= collection_name %>.json(requested_scope)
   end
 
   # get api/<%= api_name %>/:id
   def show
-    render json: @<%= instance_name %>.json(current_scope)
+    render json: @<%= instance_name %>.json(requested_scope)
   end
   
   # get api/<%= api_name %>/get
   def get
     <%= collection_name %> = <%= active_record_model_name %>.get(handle_query_param)
-    render json: <%= collection_name %>.json(current_scope)
+    render json: <%= collection_name %>.json(requested_scope)
   end
   
   # --- TO DO: Revise this ---
@@ -33,8 +33,8 @@ class Api::<%= controller_name %> < ApiController
   # get api/<%= api_name %>/search/:query
   def search
     if params[:query].present?
-      <%= collection_name %> = <%= active_record_model_name %>.search(params[:query]).limit(params[:limit]).offset(params[:offset])
-      render json: <%= collection_name %>.json(current_scope)
+      <%= collection_name %> = <%= active_record_model_name %>.search(params[:query]).limit(current_limit).offset(current_offset)
+      render json: <%= collection_name %>.json(requested_scope)
     end
   end
 
@@ -42,28 +42,28 @@ class Api::<%= controller_name %> < ApiController
   def create
     @<%= instance_name %>.assign_attributes <%= params_method_name %>
     @<%= instance_name %>.save
-    render json: @<%= instance_name %>.json(current_scope)
+    render json: @<%= instance_name %>.json(requested_scope)
   end
 
   # put/patch api/<%= api_name %>/:id
   def update
     @<%= instance_name %>.update <%= params_method_name %>
-    render json: @<%= instance_name %>.json(current_scope)
+    render json: @<%= instance_name %>.json(requested_scope)
   end
 
   # delete api/<%= api_name %>/:id
   def destroy
     @<%= instance_name %>.destroy
-    render json: @<%= instance_name %>.json(current_scope)
+    render json: @<%= instance_name %>.json(requested_scope)
   end
 
   protected
 
   # --- begin permissions  --- #
 
-  def permissions
-    unless <%= serializer_name %>.scope(current_scope).can_access? action_name
-      render json: {errors: 'You have no permission.'}
+  def verify_permissions
+    unless requested_scope.in?(allowed_scopes) and <%= serializer_name %>.scope(requested_scope).can_access? action_name
+      render json: {error: 'Unauthorized'}, status: :unauthorized
     end
   end
 
@@ -79,7 +79,7 @@ class Api::<%= controller_name %> < ApiController
 
   def <%= params_method_name %>
     if params['pink_obj']
-      params["pink_obj"].keep_if {|k,v| <%= serializer_name %>.scope(current_scope).can_write?(k)}
+      params["pink_obj"].keep_if {|k,v| <%= serializer_name %>.scope(requested_scope).can_write?(k)}
       params["pink_obj"].permit!
     else
       {}

data/lib/generators/pinkman/templates/api_controller.rb

@@ -1,15 +1,23 @@
 class ApiController < ApplicationController
 
-  before_action :default_limit_and_offset
-
-  def default_limit_and_offset
-    params[:limit] = 20 if params[:limit].blank?
-    params[:offset] = 0 if params[:offset].blank?
+  def current_limit
+    # default: 20
+    # max: 200
+    [(params[:limit] || 10).to_i, 100].min
+  end
+  
+  def current_offset
+    params[:offset] || 0
+  end
+  
+  # TO DO: allowed_scopes
+  # This method should return array of allowed scopes based on current user info.
+  def allowed_scopes
+    [:public]
   end
   
-  # TO DO: rewrite the current_scope method the way you want.
-  def current_scope
-    :public
+  def requested_scope
+    begin params[:scope].to_sym rescue :public end
   end
 
   # You can define it according to the current user and his permissions
@@ -20,26 +28,9 @@ class ApiController < ApplicationController
   # *                                                                                       *
   # *     Never pass params[:scope] directly to serializers.                                *
   # *     params[:scope] must to be whitelisted if you are going to allow/use it.           *
-  # *     See examples bellow.                                                              *
   # *                                                                                       *
-  #******************************************************************************************
-  
-  # --- Examples
+  # *****************************************************************************************
   
-  # Example 1:
-  # def current_scope
-  #   current_user.admin? ? :admin : :public
-  # end  
-
-  # Example 2:
-  # def current_scope
-  #   params[:scope].in?(['public','user_allowed','vip']) ? params[:scope].to_sym : :public
-  # end
-
-  # Example 3:
-  # def current_scope
-  #  your_custom_scope_verification_method?(params[:scope]) ? params[:scope].to_sym : :public
-  # end
   
   # --- Settings scope in client
   

data/lib/generators/pinkman/templates/initializer.rb.erb

@@ -1,6 +1,10 @@
 Pinkman.setup do |config|
 
+  # Whenever a given scope is not defined, use this one instead.
+  config.scope_fallback = :public
+  # Comment the line above to raise an error everytime a scope is not found.
+  
   # Choose between: handlebars, hogan, markup
-  config.js_template_engine = 'hogan'
+  config.js_template_engine = :hogan
     
 end

data/lib/pinkman/form_helper/form_helpers.rb

@@ -15,7 +15,11 @@ module Pinkman
       
       define_helper :text do |attr_name,label=nil,html_attributes={}|
         label ||= attr_name.titleize
+        
         error_for_name = html_attributes.delete(:error_for) || attr_name
+        error_prepend = html_attributes.delete(:error_prepend)
+        error_for_name = error_prepend + error_for_name if error_prepend
+        
         render partial: 'pinkman/pinkman/form_textarea', locals: {attr_name: attr_name, label: label, error_for_name: error_for_name, textarea_options: {name: attr_name}.merge(html_attributes) }
       end
       
@@ -40,6 +44,8 @@ module Pinkman
         obligatory = true if obligatory.nil?
         label ||= attr_name.titleize
         error_for_name = html_attributes.delete(:error_for) || attr_name
+        error_prepend = html_attributes.delete(:error_prepend)
+        error_for_name = error_prepend + error_for_name if error_prepend
         render partial: 'pinkman/pinkman/form_select', locals: {attr_name: attr_name, label: label, error_for_name: error_for_name, options_hash: options_hash, html_attributes: html_attributes, placeholder: placeholder, obligatory: obligatory}
       end
       
@@ -52,7 +58,7 @@ module Pinkman
       end
       
       define_helper :money do |attr_name,label=nil,html_attributes={}|
-        p.input_helper attr_name, label, html_attributes.merge(type: 'number', min: '0', step: '0.01')
+        p.input_helper attr_name, label, html_attributes.merge(type: 'number', step: '0.01')
       end
       
     end

data/lib/pinkman/serializer/base.rb

@@ -26,8 +26,10 @@ module Pinkman
         else
           if @scopes[name.to_sym]
             @scopes[name.to_sym]
+          elsif Pinkman.configuration.scope_fallback and @scopes[Pinkman.configuration.scope_fallback]
+            @scopes[Pinkman.configuration.scope_fallback]
           else
-            raise ArgumentError.new("Scope '#{name}' not found/defined for #{self.to_s}.")
+            raise(ArgumentError, (Pinkman.configuration.scope_fallback ? ("Scope '#{name}' and fallback scope '#{Pinkman.configuration.scope_fallback}' were not found in #{self.to_s}.") : ("Scope '#{name}' not found in #{self.to_s}.") ))
           end
         end
       end
@@ -85,6 +87,8 @@ module Pinkman
           model.column_names.each {|attribute| hash[attribute] = object.send(attribute) } if include_all && model && model.methods.include?(:column_names)
           pinkmanscope.read.each {|attribute| hash[attribute] = send(attribute) if self.methods.include?(attribute)}
           pinkmanscope.read.each {|attribute| hash[attribute] ||= object.send(attribute) if object.methods.include?(attribute)}
+          pinkmanscope.read_ghost.each {|attribute| begin hash[attribute] ||= object.send(attribute) rescue nil end }            
+          hash[:destroyed] = true if object.destroyed?
           hash[:errors] = self.class.format_errors(errors) if errors.present? and errors.any?
           hash
         end

data/lib/pinkman/serializer/scope.rb

@@ -7,12 +7,26 @@ module Pinkman
       end
 
       attr_accessor :read, :write, :access, :serializer
+      
+      def read_ghost
+        @read_ghost || []
+      end
+      
+      def read_ghost= value
+        @read_ghost = value
+      end
 
       def read_attributes *args
         self.read = args
         self.read = [] unless args.first
         read
       end
+      
+      def read_ghost_attributes *args
+        self.read_ghost = args
+        self.read_ghost = [] unless args.first
+        read_ghost
+      end
 
       def write_attributes *args
         self.write = args
@@ -27,7 +41,7 @@ module Pinkman
       end
 
       def can_read? attribute
-        read.include?(:all) or read.include?(attribute.to_sym) or attribute.to_sym == :error or attribute.to_sym == :errors
+        read.include?(:all) or read.include?(attribute.to_sym) or attribute.to_sym == :error or attribute.to_sym == :errors or read_ghost.include?(attribute.to_sym)
       end
 
       def can_write? attribute
@@ -39,7 +53,7 @@ module Pinkman
       end
 
       def can_read
-        read
+        read + read_ghost
       end
 
       def can_write

data/lib/pinkman/version.rb

@@ -1,3 +1,3 @@
 module Pinkman
-  VERSION = "0.9.9.9.11"
+  VERSION = "1.0.0"
 end

data/lib/pinkman/views_helpers/form_helper.rb

@@ -9,6 +9,10 @@ module Pinkman
       define_helper :input_helper do |attr_name,label=nil,options={}|
         label ||= attr_name.titleize
         error_for_name = options.delete(:error_for) || attr_name
+        
+        error_prepend = options.delete(:error_prepend)
+        error_for_name = error_prepend + error_for_name if error_prepend
+        
         render partial: 'pinkman/pinkman/form_input', locals: {attr_name: attr_name, label: label, error_for_name: error_for_name, html_attributes: options.merge(name: attr_name)}
       end
       
@@ -28,8 +32,8 @@ module Pinkman
       end
     
       define_helper :textarea do |hash|
-        content_tag('textarea',hash.merge(data: {pinkey: p.pinkey, action: hash[:name]}, value: p._w(hash[:name]))) do 
-          p._w(hash[:name])
+        content_tag('textarea',hash.merge(data: {pinkey: p.pinkey, action: hash[:name]}, value: p.w(hash[:name]))) do 
+          p.w(hash[:name])
         end
       end
       
@@ -61,7 +65,7 @@ module Pinkman
       end
       
       define_helper :first_error do
-        p._w('firstError')
+        p.w('firstError')
       end
       
     end

data/lib/pinkman/views_helpers/template_helper.rb

@@ -32,17 +32,25 @@ module Pinkman
         end
       end
        
-      define_helper :partial do |path, block=nil|
+      define_helper :partial do |path, opts_or_block=nil|
         # definition mode
         name = path.to_s
         id = (/(?:-template)$/ =~ name) ? name : (name + '-template')
-        if block.is_a?(Proc)
-          content_tag('script',{id: id, type: 'text/p-partial', class: 'p'},&block)
+        if opts_or_block.is_a?(Proc)
+          block = opts_or_block
+          content_tag('script',{id: id, type: 'text/p-partial', class: 'p'}, &block)
         # rendering template partial mode
         else
-          content_tag 'div', {id: name} do 
-            raw("{{ partial(#{id}) }}")
-          end
+          opts = opts_or_block if opts_or_block.is_a?(Hash)
+          div = opts && opts[:div]
+          div ? raw("<div id='#{id.sub(/(-template)$/,'')}'>{{ partial(#{id}) }}</div>") : raw("{{ partial(#{id}) }}")
+        end
+      end
+      
+      # wrap and insert partial = imprint
+      define_helper :imprint do |path|
+        p.wrap_in path do
+          p.partial path
         end
       end
       

data/lib/pinkman/views_helpers/writer_helper.rb

@@ -7,12 +7,13 @@ module Pinkman
       extend Pinkman::BaseHelper
       
       define_helper :write do |string|
-        raw "{{ #{string} }}"
+        raw "{{. #{string} }}"
       end
       define_helper_alias :w, :write
       
       define_helper :write_and_escape_sync do |string|
-        raw("{{. #{string} }}")
+        ActiveSupport::Deprecation.warn('"p._w" deprecated. Use "p.w" instead.')
+        p.write(string)
       end
       define_helper_alias :_w, :write_and_escape_sync
       

data/lib/pinkman/views_helpers.rb

@@ -64,8 +64,8 @@ end
 # as procs. So...
 
 # Use:
-#   define_method :method_name do |one, two, block=nil|
+#   define_helper :method_name do |one, two, block=nil|
 
 # DONT't use:
-#   define_method :method_name do |one, two, &block| 
+#   define_helper :method_name do |one, two, &block| 
 #   (this won't work)

data/lib/pinkman.rb

@@ -9,7 +9,7 @@ require 'pinkman/broadcaster'
 
 module Pinkman
 
-  @@configuration = OpenStruct.new js_template_engine: 'handlebars'
+  @@configuration = OpenStruct.new(js_template_engine: 'handlebars')
 
   def self.root
     Pathname.new(File.dirname(__FILE__)).join('..')
@@ -26,7 +26,7 @@ module Pinkman
   class Engine < ::Rails::Engine
     config.after_initialize do
       Rails.application.routes.append do
-        mount Pinkman::Engine => '/'
+        mount(Pinkman::Engine => '/')
       end
       
       module ApplicationHelper
@@ -34,7 +34,7 @@ module Pinkman
       end
       
       if defined? Slim
-        Slim::Engine.set_options attr_list_delims: {'(' => ')', '[' => ']'}
+        Slim::Engine.set_options(attr_list_delims: {'(' => ')', '[' => ']'})
       end
       
       # Extending ActiveRecord
@@ -68,13 +68,13 @@ module Pinkman
 
       # Active Record Relation: json
       ActiveRecord::Relation.class_eval do 
-        def json scope_name, params_hash = {}
-          serialize_for(scope_name,params_hash).to_json
+        def json scope_name=:public, params_hash = {}
+          serialize_for(scope_name, params_hash).to_json
         end
         
         def json_for *args, &block
           ActiveSupport::Deprecation.warn('"json_for" deprecated. Use "json" instead.')
-          json(*args,&block)
+          json(*args, &block)
         end
         
         def serialize_for scope_name, params_hash = {}
@@ -85,13 +85,13 @@ module Pinkman
       end
 
       Array.class_eval do
-        def json scope_name, params_hash = {}
-          serialize_for(scope_name,params_hash).to_json
+        def json scope_name=:public, params_hash = {}
+          serialize_for(scope_name, params_hash).to_json
         end
         
         def json_for *args, &block
           ActiveSupport::Deprecation.warn('"json_for" deprecated. Use "json" instead.')
-          json(*args,&block)
+          json(*args, &block)
         end
         
         def serialize_for scope_name, params_hash = {}
@@ -108,24 +108,28 @@ module Pinkman
           self.class.serializer.new(self,options)
         end
 
-        def json scope_name, params_hash={}
-          serialize_for(scope_name,params_hash).to_json
+        def json scope_name=:public, params_hash={}
+          serialize_for(scope_name, params_hash).to_json
         end
         
         def json_for *args, &block
           ActiveSupport::Deprecation.warn('"json_for" deprecated. Use "json" instead.')
-          json(*args,&block)
+          json(*args, &block)
         end
         
-        def has_json_key? key, scope
-          json_version = JSON.parse(json(scope))
-          json_version.has_key?(key.to_s) and json_version[key.to_s].present?
+        def has_json_key? key, scope=:public, options={}
+          json_version(scope, options).has_key?(key.to_s) and json_version(scope, options)[key.to_s].present?
         end
         
-        def json_hash scope
-          JSON.parse(json(scope))
+        def json_version *args
+          JSON.parse(json(*args))
         end
-
+        alias json_hash json_version
+        
+        def json_key key, scope=:public, options={}
+          json_version(scope, options)[key.to_s]
+        end
+        
       end
     end