pinkman 0.9.0

data/app/helpers/pinkman_helper.rb

@@ -0,0 +1,48 @@
+module PinkmanHelper
+
+  def input hash, *args, &block
+    name = hash[:name]
+    tag('input',hash.merge(data: {pinkey: pinkey, action: name}, value: write(name)), *args, &block)
+  end
+  
+  def template path
+    render partial: "pinkman/#{path}"
+  end
+
+  def wrap_in tag, &block
+    raw "\n{{# #{tag} }}\n \t #{capture(&block)} \n{{/ #{tag} }}\n" if block_given?    
+  end
+
+  def collection &block
+    wrap_in('collection',&block)
+  end
+
+  def write string
+    raw("{{ #{string} }}")
+  end
+
+  def w *args
+    write(*args)
+  end
+
+  def pinkey 
+    w('pinkey')
+  end
+
+  def p_if condition, &block
+    raw "\n{{#if #{condition}}}\n \t #{capture(&block)} \n{{/if}}\n" if block_given?    
+  end
+
+  def p_then &block
+    capture(&block)
+  end
+
+  def p_else &block
+    raw "\n{{else}}\n \t #{capture(&block)}" if block_given?    
+  end
+
+  def p_unless
+  end
+
+
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pinkman"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/pinkman/USAGE

@@ -0,0 +1,16 @@
+Description:
+    pinkman generators
+
+Api:
+    rails generate pinkman:api name
+
+    This will create an api controller and its routes.
+        app/controllers/api/pluralized_name_controller.rb
+
+Model
+  rails generate pinkman:model name
+      Pinkman model: app/assets/javascripts/pinkman/models/name/name.js
+      Pinkman collection: app/assets/javascripts/pinkman/models/name/pluralized_name.js
+
+Install
+  This creates common pinkman directories

data/lib/generators/pinkman/api_generator.rb

@@ -0,0 +1,60 @@
+require 'rails/generators/base'
+
+module Pinkman
+  class ApiGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :class_name, type: :string, default: "nameHere"
+
+    def generate_api_file
+      template "api.rb.erb", "app/controllers/api/#{controller_file_name}"
+    end
+
+    def insert_a_resource_in_routes      
+      inject_into_file 'config/routes.rb', after: "namespace :api do" do
+        %/
+    resources :#{api_name} do
+      collection do 
+        get 'search(\/:query)', action: 'search'
+      end
+    end 
+    /
+      end
+    end
+
+    private
+
+    def api_name
+      class_name.pluralize.underscore
+    end
+
+    def collection_name
+      api_name
+    end
+
+    def instance_name
+      class_name.underscore
+    end
+
+    def controller_name
+      api_name.camelize + "Controller"
+    end
+
+    def serializer_name
+      active_record_model_name + "Serializer"
+    end
+
+    def controller_file_name
+      api_name.underscore + "_controller.rb"
+    end
+
+    def params_method_name
+      instance_name + "_params"
+    end
+
+    def active_record_model_name
+      class_name.camelize
+    end
+
+  end
+end

data/lib/generators/pinkman/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/base'
+
+module Pinkman
+  class InstallGenerator < ::Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+    
+    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','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")
+      end
+    end
+
+    def create_api_controller_file
+      copy_file "api_controller.rb", Rails.root.join('app','controllers','api_controller.rb')
+    end
+  end
+end

data/lib/generators/pinkman/model_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators/base'
+
+module Pinkman
+  class ModelGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :class_name, type: :string, default: "nameHere"
+
+    def generate_files
+      template "object.js.erb", "app/assets/javascripts/pinkman/models/#{directory_name}/#{object_file_name}"
+      template "collection.js.erb", "app/assets/javascripts/pinkman/models/#{directory_name}/#{collection_file_name}"
+    end
+
+    private
+
+    def directory_name
+      class_name.pluralize.underscore
+    end
+
+    def object_class_name
+      class_name.camelize
+    end
+
+    def object_file_name
+      class_name.underscore + ".coffee"
+    end
+
+    def collection_class_name
+      class_name.pluralize.camelize
+    end
+
+    def collection_file_name
+      class_name.pluralize.underscore + ".coffee"
+    end 
+
+    def guess_api_url
+      "api/#{class_name.pluralize.underscore}"
+    end
+
+  end
+end

data/lib/generators/pinkman/resource_generator.rb

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

data/lib/generators/pinkman/serializer_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators/base'
+
+module Pinkman
+  class SerializerGenerator < ::Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :class_name, type: :string, default: "nameHere"
+
+    def generate_file
+      template "serializer.rb.erb", "app/serializers/#{serializer_file_name}"
+    end
+
+    private
+
+    def api_name
+      class_name.pluralize.underscore
+    end
+
+    def serializer_name
+      active_record_model_name + "Serializer"
+    end
+
+    def serializer_file_name
+      active_record_model_name.underscore + "_serializer.rb"
+    end
+
+
+    def active_record_model_name
+      class_name.camelize
+    end
+
+  end
+end

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

@@ -0,0 +1,87 @@
+class Api::<%= controller_name %> < ApiController
+
+  before_action :current_scope
+  before_action :permissions
+  before_action :set_objects
+
+  # To do: define the current scope the way you want
+  def current_scope
+    :all
+  end
+
+  # 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)
+  end
+
+  # get api/<%= api_name %>/:id
+  def show
+    render json: @<%= instance_name %>.json_for(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)
+    end
+  end
+
+  # post api/<%= api_name %>
+  def create
+    @<%= instance_name %>.assign_attributes <%= params_method_name %>
+    if @<%= instance_name %>.save
+      render json: @<%= instance_name %>.json_for(current_scope)
+    else
+      render json: {errors: @<%= instance_name %>.errors}
+    end
+  end
+
+  # put/patch api/<%= api_name %>/:id
+  def update
+    @<%= instance_name %>.assign_attributes <%= params_method_name %>
+    if @<%= instance_name %>.save
+      render json: @<%= instance_name %>.json_for(current_scope)
+    else
+      render json: {errors: @<%= instance_name %>.errors}
+    end
+  end
+
+
+  # delete api/<%= api_name %>/:id
+  def destroy
+    @<%= instance_name %>.destroy
+    render json: @<%= instance_name %>.json_for(current_scope)
+  end
+
+  protected
+
+  # --- begin permissions  --- #
+
+  def permissions
+    unless <%= serializer_name %>.scope(current_scope).can_access? action_name
+      render json: {errors: 'You have no permission.'}
+    end
+  end
+
+  # --- end permissions  --- #
+
+  def set_objects
+    if params[:id].present?
+      @<%= instance_name %> = <%= active_record_model_name %>.find params[:id]
+    else
+      @<%= instance_name %> = <%= active_record_model_name %>.new
+    end
+  end
+
+  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"].permit!
+    else
+      {}
+    end
+  end
+
+end

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

@@ -0,0 +1,2 @@
+class ApiController < ApplicationController
+end

data/lib/generators/pinkman/templates/collection.js.erb

@@ -0,0 +1,5 @@
+class window.<%= collection_class_name %> extends Pinkman.collection
+  config:
+    api: '<%= guess_api_url %>' # you should confirm this
+    memberClass: ->
+      return (new <%= object_class_name %>)

data/lib/generators/pinkman/templates/object.js.erb

@@ -0,0 +1,3 @@
+class window.<%= object_class_name %> extends Pinkman.object
+  config:
+    api: '<%= guess_api_url %>' # you should confirm this

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

@@ -0,0 +1,15 @@
+class <%= serializer_name %> < Pinkman::Serializer::Base
+
+  scope :all 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
+
+end

data/lib/pinkman.rb

@@ -0,0 +1,57 @@
+require 'pathname'
+require 'rails'
+require 'pinkman/serializer'
+require 'pinkman/version'
+
+module Pinkman
+
+  @@configuration = OpenStruct.new js_template_engine: 'handlebars'
+
+  def self.root
+    Pathname.new(File.dirname(__FILE__)).join('..')
+  end 
+
+  def self.configuration
+    @@configuration
+  end
+
+  def self.setup
+    yield @@configuration
+  end
+  
+  class Engine < ::Rails::Engine
+    config.after_initialize do
+      if defined? Slim
+        Slim::Engine.set_options attr_list_delims: {'(' => ')', '[' => ']'}
+      end
+      
+      # Class method: serializer
+      ActiveRecord::Base.singleton_class.class_eval do 
+        def serializer= value
+          @serializer = value
+        end
+
+        def serializer
+          @serializer || (begin eval(self.to_s + 'Serializer') rescue nil end)
+        end
+      end
+
+      # Active Record Relation: json_for
+      ActiveRecord::Relation.class_eval do 
+        def json_for scope_name
+          a = ActiveModel::ArraySerializer.new(self, each_serializer: model.serializer, scope: scope_name)
+          a.to_json
+        end
+      end
+
+      # Instance method: json_for
+      ActiveRecord::Base.class_eval do
+        def json_for scope_name
+          s = self.class.serializer.new(self,scope: scope_name)
+          s.to_json
+        end
+      end
+    end
+  end
+  
+end