pinkman 0.9.9.8 → 0.9.9.9.0

data/lib/generators/pinkman/install_generator.rb

@@ -7,16 +7,31 @@ module Pinkman
     
     def create_directories
       FileUtils.mkdir_p Rails.root.join('app','views','pinkman')
-      FileUtils.mkdir_p Rails.root.join('app','assets','javascripts','pinkman','models')
+      FileUtils.mkdir_p Rails.root.join('app','assets','javascripts','pinkman','app','models')
+      FileUtils.mkdir_p Rails.root.join('app','assets','javascripts','pinkman','app','controllers')
+      FileUtils.mkdir_p Rails.root.join('app','assets','javascripts','pinkman','app','mixins')
+      FileUtils.mkdir_p Rails.root.join('app','assets','javascripts','pinkman','base')
+      FileUtils.mkdir_p Rails.root.join('app','assets','javascripts','pinkman','config')
+      FileUtils.mkdir_p Rails.root.join('app','assets','javascripts','pinkman','test')
       FileUtils.mkdir_p Rails.root.join('app','serializers')
       FileUtils.mkdir_p Rails.root.join('app','controllers','api')
     end
 
     def create_api_routes
       inject_into_file 'config/routes.rb', after: ".routes.draw do" do
-        ["\n \n \t" 'namespace :api do',"\tend"].join("\n")
+        ["\n \n \t" + 'namespace :api do',"\tend"].join("\n")
       end
     end
+    
+    def modify_application_js
+      append_to_file Rails.root.join('app','assets','javascripts','application.js') do
+        "\n//= require my.pinkman.app"
+      end
+    end
+    
+    def copy_my_pinkman_app_js_to_rails
+      copy_file "my.pinkman.app.js", Rails.root.join('app','assets','javascripts','my.pinkman.app.js')
+    end
 
     def create_api_controller_file
       copy_file "api_controller.rb", Rails.root.join('app','controllers','api_controller.rb')
@@ -26,5 +41,17 @@ module Pinkman
       generate 'pinkman:app_base'
     end
     
+    def create_initializer
+      generate 'pinkman:initializer'
+    end
+    
+    def install_hello_world_controller
+      copy_file "hello.controller.coffee.erb", Rails.root.join('app','assets','javascripts','pinkman','app','controllers','hello.coffee')
+    end
+    
+    def install_mixin_example
+      copy_file "example.mixin.coffee.erb", Rails.root.join('app','assets','javascripts','pinkman','app','mixins','example.mixin.coffee')
+    end
+    
   end
 end

data/lib/generators/pinkman/model_generator.rb

@@ -7,8 +7,8 @@ module Pinkman
     argument :class_name, type: :string, default: "nameHere"
 
     def generate_files
-      template "object.coffee.erb", "app/assets/javascripts/pinkman/models/#{directory_name}/#{object_file_name}"
-      template "collection.coffee.erb", "app/assets/javascripts/pinkman/models/#{directory_name}/#{collection_file_name}"
+      template "object.coffee.erb", "app/assets/javascripts/pinkman/app/models/#{directory_name}/#{object_file_name}"
+      template "collection.coffee.erb", "app/assets/javascripts/pinkman/app/models/#{directory_name}/#{collection_file_name}"
     end
 
     private

data/lib/generators/pinkman/page_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/base'
+
+module Pinkman
+  class PageGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    
+    argument :page_name, type: :string, default: "nameHere"
+
+    def exec
+      generate "pinkman:route #{page_name}"
+      generate "pinkman:controller #{page_name}"
+      generate "pinkman:template #{page_name}"
+    end
+  end
+end

data/lib/generators/pinkman/route_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/base'
+
+module Pinkman
+  class RouteGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :route_arg, type: :string
+    
+    def normalize_argument
+      self.route_arg = route_arg.downcase.gsub(' ','_').strip.squeeze('_').gsub(/:/,'/')
+    end
+
+    def generate_route
+      # binding.pry
+      if File.file?(file_path)
+        inject_into_file file_path, after: ".define (routes) ->" do
+          %/
+  
+  routes.match '#{route_path}', controller: '#{controller_name}'/
+        end
+      end
+    end
+    
+    private
+    
+    def route_path
+      '/' + route_arg.sub('/index','')
+    end
+    
+    def controller_name
+      route_arg.split('/').join('-')
+    end
+    
+    def file_path
+      Rails.root.join('app','assets','javascripts','pinkman','config','routes.coffee')
+    end
+
+  end
+end
+

data/lib/generators/pinkman/route_resource_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/base'
+
+module Pinkman
+  class RouteResourceGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :route_arg, type: :string
+    
+    def normalize_argument
+      self.route_arg = route_arg.downcase.gsub(' ','_').strip.squeeze('_').gsub(/:/,'/')
+    end
+
+    def generate_route
+      # binding.pry
+      if File.file?(file_path)
+        inject_into_file file_path, after: ".define (routes) ->" do
+          %/
+  
+  routes.resources '#{route_path}'/
+        end
+      end
+    end
+    
+    private
+    
+    def route_path
+      '/' + route_arg.sub('/index','')
+    end
+    
+    def controller_name
+      route_arg.split('/').join('-')
+    end
+    
+    def file_path
+      Rails.root.join('app','assets','javascripts','pinkman','config','routes.coffee')
+    end
+
+  end
+end
+

data/lib/generators/pinkman/template_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/base'
+
+module Pinkman
+  class TemplateGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :pink_template_arg, type: :string
+    
+    def normalize_argument
+      self.pink_template_arg = pink_template_arg.downcase.gsub(' ','_').strip.squeeze('_').gsub(/:/,'/')
+    end
+
+    def generate_pink_template
+      template template_path, file_path
+    end
+
+    private
+    
+    def template_engine_extension
+      begin Rails.configuration.generators.options[:rails][:template_engine].to_s rescue 'erb' end
+    end
+    
+    def template_path
+      "pink_template.html.#{template_engine_extension}.erb"
+    end
+    
+    def file_path
+      path = (pink_template_arg + ".html.#{template_engine_extension}").split('/')
+      path[path.length-1] = '_' + path.last
+      Rails.root.join('app','views','pinkman',*path.map{|p| p})
+    end
+    
+    def path
+      file_path.to_s.sub(Rails.root.to_s,'')
+    end
+    
+    def controller_name
+      pink_template_arg.split('/').join('-').gsub(/[_\/]/,'-')
+    end
+    
+    def pink_template_name
+      controller_name
+    end  
+
+  end
+end
+

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

@@ -6,19 +6,19 @@ class Api::<%= controller_name %> < ApiController
   # get api/<%= api_name %>
   def index
     <%= collection_name %> = <%= active_record_model_name %>.limit(params[:limit]).offset(params[:offset])
-    render json: <%= collection_name %>.json_for(current_scope)
+    render json: <%= collection_name %>.json(current_scope)
   end
 
   # get api/<%= api_name %>/:id
   def show
-    render json: @<%= instance_name %>.json_for(current_scope)
+    render json: @<%= instance_name %>.json(current_scope)
   end
 
   # 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_for(current_scope)
+      render json: <%= collection_name %>.json(current_scope)
     end
   end
 
@@ -26,19 +26,19 @@ class Api::<%= controller_name %> < ApiController
   def create
     @<%= instance_name %>.assign_attributes <%= params_method_name %>
     @<%= instance_name %>.save
-    render json: @<%= instance_name %>.json_for(current_scope)
+    render json: @<%= instance_name %>.json(current_scope)
   end
 
   # put/patch api/<%= api_name %>/:id
   def update
     @<%= instance_name %>.update <%= params_method_name %>
-    render json: @<%= instance_name %>.json_for(current_scope)
+    render json: @<%= instance_name %>.json(current_scope)
   end
 
   # delete api/<%= api_name %>/:id
   def destroy
     @<%= instance_name %>.destroy
-    render json: @<%= instance_name %>.json_for(current_scope)
+    render json: @<%= instance_name %>.json(current_scope)
   end
 
   protected

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

@@ -6,14 +6,25 @@ class ApiController < ApplicationController
     params[:limit] = 20 if params[:limit].blank?
     params[:offset] = 0 if params[:offset].blank?
   end
-
+  
   # TO DO: rewrite the current_scope method the way you want.
+  def current_scope
+    :public
+  end
 
   # You can define it according to the current user and his permissions
   # or through params[:scope] or any other way you want.
   # It's your choice.
   
-  # See some common examples and important securities notes below.
+  # ***** IMPORTANT *************************************************************************
+  # *                                                                                       *
+  # *     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
@@ -22,35 +33,28 @@ class ApiController < ApplicationController
 
   # Example 2:
   # def current_scope
-  #   params[:scope] == 'public' ? :public : (current_user.admin? ? :admin : :public)
+  #   params[:scope].in?(['public','user_allowed','vip']) ? params[:scope].to_sym : :public
   # end
 
   # Example 3:
   # def current_scope
-  #  your_scope_verification_method?(params[:scope]) ? params[:scope].to_sym : :public
+  #  your_custom_scope_verification_method?(params[:scope]) ? params[:scope].to_sym : :public
   # end
   
-  # ***** IMPORTANT **********************************************************************************
-  # *                                                                                                *
-  # *     params[:scope] must to be whitelisted if you are going to allow/use it.                    *
-  # *                                                                                                *
-  # **************************************************************************************************
+  # --- Settings scope in client
   
-  # You can set params[:scope] value in the client (js/coffee). 
+  # You can set params[:scope] value directly in the client (js/coffee). 
+  # By default, every pinkman requests is made with the 'public' scope. See bellow how to change this behaviour.
 
   # 1. In a single object/collection
-  # obj = new Pinkman.object; obj.set('scope','public')
+  # obj = new Pinkman.object; obj.set('scope','your_scope')
 
   # 2. In all instances of a given model (object or collection)
   # class YourModel extends Pinkman.object
-  # YourModel.scope = 'public'
+  # YourModel.scope = 'your_scope'
 
   # 3. In all instances through AppObject and AppCollection
-  # AppObject.scope = 'public'
-  # AppCollection.scope = 'public'
-
-  def current_scope
-    :public
-  end
+  # AppObject.scope = 'your_scope'
+  # AppCollection.scope = 'your_scope'
   
 end

data/lib/generators/pinkman/templates/app.coffee.erb

@@ -0,0 +1 @@
+class window.App extends Pinkman

data/lib/generators/pinkman/templates/app_app.coffee.erb

@@ -0,0 +1 @@
+class window.App extends Pinkman

data/lib/generators/pinkman/templates/app_collection.coffee.erb

@@ -1 +1 @@
-class window.<%= app_collection_name %> extends Pinkman.collection
+class window.<%= app_collection_name %> extends App.collection

data/lib/generators/pinkman/templates/app_object.coffee.erb

@@ -1 +1 @@
-class window.<%= app_object_name %> extends Pinkman.object
+class window.<%= app_object_name %> extends App.object

data/lib/generators/pinkman/templates/app_router.coffee.erb

@@ -0,0 +1 @@
+class window.AppRouter extends App.router

data/lib/generators/pinkman/templates/app_routes.coffee.erb

@@ -0,0 +1,34 @@
+AppRouter.config
+
+  # --- Valid Options
+  # yield: Inform a valid css selector where Pinkman should yield content.
+  # analytics: insert your id (UA-YOURNUMBER)
+  # transition: any function that runs a animation and accepts a callback function as param.
+  
+  yield: 'body'
+  
+        
+AppRouter.define (routes) ->
+  
+  # AppRouter maps url paths to Pinkman controllers.
+  
+  # routes.match "url"
+  # Associates "/url" path to "url" controller
+  
+  # routes.match 'url', controller: 'abc'
+  # Associates "/url" path to "abc" controller
+  
+  # Namespace:
+  # You can use namespace to group routes
+  #
+  # namespace 'anything', (routes) -> 
+  #
+  #   routes.root 'controller'
+  #   Associates "/anything /url" path to "abc" controller
+  # 
+  #   routes.match 'page'
+  #   Associates "/anything/page" path to "page" controller
+
+
+# Start the router. Obrigatory, else AppRouter does nothing.
+AppRouter.start()

data/lib/generators/pinkman/templates/controller.coffee.erb

@@ -0,0 +1,4 @@
+App.controller '<%= controller_name %>', ->
+  
+  @main = ->
+    @render('<%= controller_name %>')

data/lib/generators/pinkman/templates/example.mixin.coffee.erb

@@ -0,0 +1,32 @@
+# --- Mixins 
+# Mixins act like Ruby modules. 
+# You can share its functions among any classes/models you wish.
+
+# --- Usage
+
+# 1. Define a mixin:
+
+# App.mixin 'hello',
+#   sayHello: (name) ->
+#     "Hello, #{name}."
+
+
+# 2. Use it
+
+# class window.Foo
+#   App.mix this, 'hello'
+
+# class window.Bar extends AppObject
+#   @mix 'hello'
+
+# class window.Baz extends AppCollection
+#   @mix 'hello'
+
+# f = new Foo
+# f.sayHello('John Doe') => 'Hello, John Doe.'
+
+# b = new Bar
+# b.sayHello('John Doe') => 'Hello, John Doe.'
+
+# baz = new Baz
+# baz.sayHello('John Doe') => 'Hello, John Doe.'

data/lib/generators/pinkman/templates/hello.controller.coffee.erb

@@ -0,0 +1,98 @@
+# Yo!
+# This is a nice overview of Pinkman Controllers.
+# If you have the time, read it. :)
+# Cheers,
+# Unfair (Agilso),
+# Pinkman.js creator.
+
+# ------ Global Controller
+
+# Yo! This is a global controller :)
+# It runs once the document is ready.
+App.ready ->
+  console.log "Yo World from Pinkman.js!"
+
+# You can use it as many times as you want.
+App.ready ->
+  console.log "Let's party rock! ;)"
+  console.log 'Find me in:'
+  console.log 'assets/javascripts/pinkman/app/controllers/hello.coffee'
+
+
+# ------ Pinkman Controllers
+
+# A Pinkman Controller looks a lot like a Rails Controller/Action.
+
+# You get data and other complicated stuff from the models
+# so you can render them with a view after that.
+
+# This is the 'pinkman-hello' controller
+App.controller 'pinkman-hello', ->
+
+  # It will be in effect in every page that
+  # has a html element with the 'pinkman-hello' id.
+
+  # The main function gets called everytime the controller initiates.
+  @main = ->
+
+    console.log "I am the Pinkman Hello controller!"
+
+    # ... your code ...
+
+    # Here you could load things from db, etc.
+
+    # ... your code ...
+
+    # This is the render function
+    # You can use it like this
+    # @render
+    #   template: 'template-id'
+    #   target:   'element-target-id'
+    #   object:   anyJsObject
+
+    # Or like this
+
+    # @render 'pinkman-hello'
+
+    # This last form is equivalent to
+    # @render
+    #   template: 'pinkman-hello-template'
+    #   target: 'pinkman-hello'
+
+    # A PinkmanObject is just a like a javascript object. But it's packed with a few more functionalities.
+
+    obj = new AppObject(title: 'Yo!', hint: 'You saw me here')
+
+    # Every Pinkman Object and Collection has a own render function.
+    # And it works like @render function.
+    obj.render('pinkman-hello')
+
+    # Pinkman binds every attribute in the template with the 'obj' object.
+    # So if you change them later... the template gets updated automatically.
+    # As long as you use the 'set' function.
+
+    # After 5 seconds, update the title
+    $p.sleep 5, ->
+      obj.set('title','Up & Running')
+
+    # Don't be scared of $p. It's just an alias of the Pinkman global variable.
+    # It has a few helper functions in it. Like the sleep function.
+
+    # Just one more thing about rendering.
+    # If a lot of things in 'obj' change, you can call "obj.render()" without any arguments. This will get this object to render itself again.
+    # obj.render()
+
+
+  # ------ Pinkman Actions
+
+  # Pinkman Controller also have actions.
+  # Pinkman Actions are associated to JS events.
+  # An action has the power to create a event listener and respond to it later, when it gets triggered.
+  # And its magic is that it always remember who is the object associated with the action and the dom element that triggered it.
+
+  @action 'you-are-over-me', 'mouseenter', (guessWhoIAm,jQueryEl) ->
+    console.log "Who am I? I have a hint: #{guessWhoIAm.hint}"
+    jQueryEl.html('Get off')
+
+  @action 'you-are-over-me', 'mouseleave', (obj,j) ->
+    j.html('Come here')

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

@@ -0,0 +1,6 @@
+Pinkman.setup do |config|
+
+  # Choose between: handlebars, hogan, markup
+  config.js_template_engine = 'hogan'
+    
+end

data/lib/generators/pinkman/templates/my.pinkman.app.js

@@ -0,0 +1,70 @@
+// This file will load Pinkman and all of your Pinkman App files: models, controllers, routes, etc.
+// You are free to customize it 
+// as long as you stick to the loading ordering rules described at the bottom.
+
+// **** IMPORTANT: this file need to be required after jquery. 
+// Yes. Pinkman depends on jquery.
+
+
+// ------ 1. Pinkman & Template Engine
+//= require pinkman_with_hogan
+
+// This will load Pinkman.js packed together with a js template engine. (Hogan default)
+
+// **** IMPORTANT: 
+// You need to make sure that config/initializers/pinkman.rb 
+// matches this template engine. 
+// And if you change it, run a 'rake tmp:clear' 
+// and restart the server just to make sure.
+
+//   Valid Options: 
+//   1. "pinkman_with_hogan"
+//   2. "pinkman_with_handlebars"
+//   3. "pinkman_with_markup"
+//   4. "pinkman" (No template engine. Just Pinkman. See bellow.)
+
+// Use the fourth option if you already have one of handlebars, hogan or markup template engine loaded. And don't forget to setup config/initializers/pinkman properly.
+
+
+// ------ 2. App (must be after pinkman and before the rest)
+//= require pinkman/base/app
+
+
+// ------ 3. Collections
+//= require pinkman/base/collection
+
+
+// ------ 4. Objects
+//= require pinkman/base/object
+
+
+// ------ 5. Router
+//= require pinkman/base/router
+
+
+// ------ 6. Mixins (must be before models)
+//= require_tree ./pinkman/app/mixins/
+
+
+// ------ 7. Models (must be before controllers)
+//= require_tree ./pinkman/app/models/
+
+
+// ------ 8. Controllers
+//= require_tree ./pinkman/app/controllers/
+
+
+// ------ 9. Routes (must be last)
+//= require ./pinkman/config/routes
+
+
+// ------ Loading Order Rules:
+// Follow these rules and you'll be fine. :)
+
+// 1. "pinkman" or "pinkman_with_xxx" - must be first.
+// 2. "pinkman/base/app" - must be second.
+// 3. "pinkman/base/{colecction,object,router}" - each must be placed in this portion. 
+// 4. "pinkman/app/mixins" - mixins can be required here as they need to be available to models. 
+// 5. "pinkman/app/models" - your app models can be required here. 
+// 6. "pinkman/app/controllers" - your app controllers must be after your models.
+// 7. "pinkman/config/routes" - routes needs to be last.

data/lib/generators/pinkman/templates/pink_template.html.erb.erb

@@ -0,0 +1,4 @@
+<%= p.template '<%= controller_name %>' do %>
+  <h1><%= pink_template_name %></h1>
+  <p>Find me in <b><%= path %></b></p>
+<% end %>

data/lib/generators/pinkman/templates/pink_template.html.haml.erb

@@ -0,0 +1,3 @@
+!= p.template '<%= controller_name %>'
+  %h1 <%= pink_template_name %>
+  %p Find me in <b><%= path %></b>

data/lib/generators/pinkman/templates/pink_template.html.slim.erb

@@ -0,0 +1,3 @@
+= p.template '<%= controller_name %>'
+  h1 <%= pink_template_name %>
+  p Find me in <b><%= path %></b>

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

@@ -1,15 +1,15 @@
 class <%= serializer_name %> < Pinkman::Serializer::Base
-
+  
   scope :public do |can|
     can.read_attributes :all
     can.write_attributes false
     can.access_actions :index, :show
   end
 
-  # scope :admin do |can|
-  #   can.read_attributes :all
-  #   can.write_attributes :all
-  #   can.access_actions :all
-  # end
+  scope :admin do |can|
+    can.read_attributes :all
+    can.write_attributes :all
+    can.access_actions :all
+  end
 
 end

data/lib/pinkman/base_helper.rb

@@ -0,0 +1,15 @@
+module Pinkman
+  module BaseHelper
+  
+    def define_helper m, &block
+      define_method m do
+        Proc.new(&block)
+      end
+    end
+    
+    def define_helper_alias n, o 
+      send :alias_method, n, o
+    end
+  end
+
+end