abstracted 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27795b5e4072282e297becda9681b2485fadc339
-  data.tar.gz: a0b78bef1eb0150fa3ed0fcbd7ff1908476a8641
+  metadata.gz: b3eb85a893fc241b14df9db62dc8e5f7e6bfb070
+  data.tar.gz: a441bb37f0703fd705f4fb369ef97d008fce9713
 SHA512:
-  metadata.gz: 6788211f7da0a881926438a8d5e3049d62697b3b5114b866ca8c43e52e141397e93a96c2b8880f1f926a3dec5d3a0fee96c63d7bd637084746f1f271ca5a7cf3
-  data.tar.gz: c46d3691914e586368cb3b329b2af7dbf4b874dcfed79c7efe0ef69b5fecf7d4e8c2ea659ab97bfeca062a360e770998bf047f8dc3e02304d2931de8265655a5
+  metadata.gz: 550b2dcd201453b90e5bcacdc148f8fc77aeda8db01d249116c81cbb914e021e9409111c51c4305b475bc42e716bb26ab73bd79303405771f4d23fe77f65a09b
+  data.tar.gz: 1f66fc01ffda843425e566df943be521e704eca8d69fe7a0c47d0ea77e5fe98c68ca236f3611eb4ac2e3cbc9ebf3367b2b3e0247e72923032715782ae170be81

data/app/controllers/abstract_resources_controller.rb

@@ -1,4 +1,7 @@
 require "abstracted_responder"
+require "print_control"
+require "resource_control"
+require "parent_control"
 
 class AbstractResourcesController < ApplicationController
   self.responder = ::AbstractedResponder

data/app/controllers/concerns/parent_control.rb

@@ -0,0 +1,127 @@
+require 'active_support/concern'
+
+module ParentControl
+  extend ActiveSupport::Concern
+
+  included do
+    before_filter :set_parents, only: [ :new, :edit, :show ]
+  end
+
+  def parent
+    @parent ||= find_parent
+  end
+
+
+  def parent_class
+    @parent_class ||= @parent.class
+  end
+
+  def parent_class= val
+    @parent_class = val
+  end
+
+  def parent?
+    !(%w{NilClass TrueClass FalseClass}.include? parent.class.to_s)
+  end
+
+  #
+  # parent_url returns the parent url - /employees/1
+  def parent_url options={}
+    parent? ? url_for(@parent) : ""
+    # parent? ? ( "/%s/%s" % [ @parent.class.table_name, @parent.id ] ) : ""
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+
+  #
+  # build an array of the resource - particular to <SELECT>
+  def set_parents
+    @parents = []
+    return @parents unless resource_class.respond_to? :roots #( 'arraying') && resource? )
+    @parents = resource_class.arraying({ order: 'name'}, resource.possible_parents)
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+
+  #
+  #
+  # /employees/1/teams
+  # /employees/1/teams/5
+  # /employees/1/teams/5/attach
+  # /theatres/2/contacts/5/uris.js
+  def find_parent path=nil, parms=nil
+    path ||= request.path
+    parms ||= params
+    if parms[:parent].nil? #or params[:parent_id].nil?
+      paths=path.split("/")
+      paths.pop if %w{new edit show create update delete index}.include? paths[-1]
+      return nil if (paths.size < 3) #or (paths.size==4 and %w{edit new}.include?( parms[:action]))
+      recognise_path paths.join("/")
+    else
+      parms[:parent].classify.constantize.find(parms[:parent_id])
+    end
+  end
+  #
+  # ['theatres','5','contacts','2','uris.js']
+  def recognise_path path
+    path_elements = Rails.application.routes.recognize_path path.gsub /\..*$/,''   # "/admin/users/2/printers/3/attach" => {:controller=>"printers", :action=>"attach", :user_id=>"2", :id=>"3"}
+    recognise_parent( recognise_resource( path_elements ) )
+
+  rescue Exception => e
+    nil
+    # return [ nil, nil, false ] if e.class.to_s == "ActionController::RoutingError"
+
+  end
+
+  # {:controller=>"printers", :action=>"attach", :user_id=>"2", :id=>"3"}
+  def recognise_resource elems
+    resource_class = elems.delete(:controller).singularize.classify.constantize
+    resource = resource_class.find( elems.delete(:id) )
+    elems
+  rescue Exception => e
+    return elems if e.class.to_s == "ActiveRecord::RecordNotFound"
+    resource_class = nil
+    elems
+  end
+
+  # { :action=>"attach", :user_id=>"2" }
+  def recognise_parent elems
+    elems.delete :action
+    arr = elems.keys.first.to_s.split("_")
+    return nil unless arr.include? "id"
+    arr.pop
+    arr.join("_").singularize.classify.constantize.find(elems.values.first)
+  rescue
+    nil
+  end
+
+  #
+  # # /employees/1/teams/new
+  # # /employees/1/teams/1/edit
+  # # /employees/1/teams/1/delete
+  def update_parenthood
+    if params[:parent] and params[:parent_id]
+      # raise "Ups - is this ready for prime time yet?"
+      parent = params[:parent].classify.constantize.find(params[:parent_id])
+      unless parent.blank?
+        case params[:action]
+        when "create"
+          children = eval("parent.#{resource_name}")
+          children << resource unless children.include? resource
+        # when "edit"
+        when "delete"
+          children = eval("parent.#{resource_name}")
+          children >> resource
+        end
+      end
+    end
+    true
+  rescue
+    false
+  end
+  #
+  #
+
+end

data/app/controllers/concerns/print_control.rb

@@ -0,0 +1,190 @@
+require 'active_support/concern'
+#
+#
+# ARGS                            # first value is default
+#
+#   collation                     # 'list' | 'record'
+#   paper                         # 'A4' | 'label' | ...
+#   template                      # '' | 'slip' | 'quote'
+#   cmd                           # '' | 'print_label' - a particular method on the printing_class
+#
+# PRINTPROMPT
+#   print[medium]                 # 'display' | 'email' | 'printer' | 'download'
+#   print[output_type]            # 'html' | 'pdf' | 'text'
+#   print[printer]                # what printer to send output to
+#   print[email_to]               # email address
+#   print[message]                # body of email
+#   print[range]                  # which pages should print
+#   print[copies]                 # number of copies
+#
+# PRINTJOB
+#   id,
+#   account_id,                   # what 'system' / customer
+#   printer_id,                   # on what printer
+#   printed_by_id,                # what id has the printed_by entity
+#   printed_by_type,              # what entity - like user
+#   view_template_path,           # what template
+#   name,                         # label the job
+#   printing_class,               # what entity provides the data
+#   print_driver,                 # what 'driver' - like :pdf, :cab, :zebra, :csv, :html, etc
+#   print_format,                 # data collation - like 'record', 'list'
+#   state,                        # record the progress
+#   paper,                        # what material - like 'label32x42', 'A4', etc
+#   copies,                       # number of identical prints
+#   print_sql,                    # how to find what will be printed
+#   created_at,
+#   updated_at
+#
+# TEMPLATE
+#   id
+#   account_id,                   # what 'system' / customer
+#   template_key,                 # a key to search the template by
+#   template_path,                # where the template is stored - like stock_items/print/zebra.html.haml
+#   template_content,             # or what the template contains - all HTML, CSS etc.
+#   template_print_driver         # identification of a particular driver -if necessary - like the :zebra
+#   template_paper                # identification of a particular paper -if necessary - like the :label10x32
+#   created_at
+#   updated_at
+
+
+module PrintControl
+  extend ActiveSupport::Concern
+
+  included do
+
+    PRINTSUCCESS = 1
+    NOQUEUE = -1
+    NOUSER = -2
+    PRINTRECERROR = -3
+    PRINTCMDERROR = -4
+    PRINTLISTERROR = -5
+    PRINTEXCEPTION = -99
+
+  end
+  #
+  # print this view - let the Class handle everything
+  # returning either the ID to a print_job or false (in which case something went terribly wrong)
+  #
+  # always an Ajax call - hence will always update the print_jobs link with 'yellow'-blink
+  # POST /printers/print.js
+  # params[:id] holds records to be printed
+  #
+  # from the print-dialog:
+  #
+  # from a link tag
+  def print
+    authorize resource, :print?
+    if resources.any?
+      params[:printed_by]                 = current_user || User.first
+      params[:print]                      ||= {}
+      params[:print][:collation]          ||= 'list'
+      params[:print_job]                  ||= {}
+      # params[:print_job][:view_template]  ||= current_user.account.find_print_template(params[:print][:template]) || Template.new( template_path: 'list.html.haml')
+      # params[:print_job][:print_driver]   = params[:print][:print_driver] || params[:print_job][:view_template].template_print_driver
+      # params[:print_job][:paper]          = params[:print_job][:view_template].template_paper || params[:print][:paper] || "A4"
+      params[:print_job][:paper]          = params[:print][:paper] || "A4"
+      #
+      # ok so we have items to print!
+      status = case params[:print][:medium]
+      when "display"  ; display_print_result and return
+      when "email"    ; email_print_result
+      when "printer"  ; print_print_result
+      when "download" ; download_print_result and return
+      else
+        flash[:error] = t('output.medium.no_medium_found');
+        301
+      end
+    end
+    render :print, layout: false, status: status and return
+
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+  #
+  # send HTML or PDF down the wire
+  #
+  def display_print_result
+    params[:print][:output_type] ||= 'html'
+    case params[:print][:output_type].downcase
+    when 'html'; render params[:print][:view_template_path], layout: 'print'
+    when 'pdf'; render action: :new, status: :unprocessable_entity
+    end
+  end
+
+  #
+  # send PDF down the wire
+  #
+  def download_print_result
+    params[:print][:output_type] ||= 'pdf'
+  end
+
+  #
+  # send PDF via email
+  #
+  def email_print_result
+    params[:print][:output_type] ||= 'pdf'
+    if params[:print][:email_to].blank?
+      flash[:error] = t('output.email.email_address_missing')
+      return 301
+    else
+      flash[:info] = t('output.email.email_sent')
+      return 200
+    end
+  end
+
+  def print_print_result
+    params[:print][:output_type] ||= 'pdf'
+    if (result = print_resources) > 0
+      flash[:info] = t(:resources_printed_correct)
+      status = 200
+    else
+      case result
+      when NOQUEUE; flash[:error] = t(:noqueue_created)
+      when NOUSER; flash[:error] = t(:no_user_present)
+      when PRINTRECERROR; flash[:error] = t(:printing_record_error)
+      when PRINTCMDERROR; flash[:error] = t(:print_command_error)
+      when PRINTLISTERROR; flash[:error] = t(:printing_list_error)
+      when PRINTEXCEPTION ; flash[:error] = t(:exception_in_print_engine)
+      end
+      status = 301
+    end
+    status
+  end
+
+
+  #
+  # print_resources will try to add a print_job
+  # return error code
+  def print_resources
+    if resource_class == PrintJob
+      resources.each do |res|
+        return NOQUEUE unless Delayed::Job.enqueue res, :queue => 'printing'
+      end
+      return PRINTSUCCESS
+    else
+      return NOUSER if params[:printed_by].nil?
+      case params[:print][:collation]
+        when 'record'
+          if params[:print][:cmd].blank?
+            resources.each do |res|
+              return PRINTRECERROR unless res.print_record params.merge context: self
+            end
+          else
+            resources.each do |res|
+              return PRINTCMDERROR unless res.send(params[:print][:cmd],params)
+            end
+          end
+
+        when 'list'
+          params[:resources] = resources
+          return PRINTLISTERROR unless resource_class.print_list( params )
+
+      end
+    end
+
+    return PRINTSUCCESS
+
+  end
+
+end

data/app/controllers/concerns/resource_control.rb

@@ -0,0 +1,220 @@
+require 'active_support/concern'
+
+module ResourceControl
+  extend ActiveSupport::Concern
+
+  included do
+
+    before_action :set_resource #, except: :index
+    before_action :set_resources, only: [:index, :print]
+
+  end
+
+  def resource_params
+    raise 'You need to "def resource_params" on the %sController! (see: http://blog.trackets.com/2013/08/17/strong-parameters-by-example.html)' % params[:controller].capitalize
+  end
+
+  def set_resource
+    parent
+    resource
+  end
+
+  def set_resources
+    resources
+  end
+
+  def resource?
+    !(%w{NilClass TrueClass FalseClass}.include? @resource.class.to_s)
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+  def resource
+    @resource ||= (_id.nil? ? new_resource : resource_class.find(_id) )
+    return @resource if @resource.nil?
+    @resource.current_user = (current_user || nil) if @resource.respond_to? :current_user
+    @resource
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+  # def resource=val
+  #   @resource=val
+  # end
+
+  def new_resource
+    return nil if resource_class.nil?
+    return resource_class.new if resource_class.ancestors.include?( ActiveRecord::Base ) and !(params.include? resource_class.to_s.underscore) #[ 'create', 'update' ].include? params[:action]
+    p = resource_params
+    p=p.compact.first if p.class==Array
+    return resource_class.new(p.merge(current_user: current_user)) if resource_class.ancestors.include? ActiveRecord::Base
+    nil
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+  def _id
+    return nil if !params[:id] || params[:id]=="0"
+    params[:id] || params["#{resource_class.to_s.downcase}_id".to_sym]
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+  def resource_name options={}
+    resource_class.table_name
+  rescue Exception => e
+    scoop_from_error e
+    # resource_class.to_s.underscore.pluralize
+  end
+
+  def resource_class
+    return @resource_class if resource?
+    @resource_class ||= params[:controller].singularize.classify.constantize
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+  def resource_class= val
+    @resource_class = val
+  end
+
+  #
+  #
+  # return the resources collection - preferably from the cache
+  def resources options={}
+    @resources ||= find_resources options
+  end
+
+
+  #
+  # returns the url for the resource - like /users/1
+  def resource_url options={}
+    r=request.path
+    id=params[:id]
+    options = case params[:action]
+      when 'create','update','delete','destroy'; ""
+      else resource_options(options)
+    end
+    return "%s%s" % [r,options] if r.match "#{resource.class.to_s.tableize}\/#{id}$"
+    "%s%s" % [ r.split("/#{params[:action]}")[0], options]
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+
+  #
+  # returns the url for the resources - /employees or /employees/1/events
+  def resources_url options={}
+    r=request.path
+    options = case params[:action]
+      when 'create','update','delete','destroy'; ""
+      else resource_options(options)
+    end
+    return "%s%s" % [r,options] if r.match "#{resource.class.to_s.tableize}$"
+    "%s%s%s" % [ r.split( resource.class.to_s.tableize)[0],resource.class.to_s.tableize, options]
+  rescue Exception => e
+    scoop_from_error e
+  end
+
+  def resource_options options
+    options.merge! params.except( "id", "controller", "action", "utf8", "_method", "authenticity_token" )
+    options = (options.empty? ? "" : "?" + options.collect{ |k,v| "#{k}=#{v}" }.join("&"))
+  end
+
+  #
+  # find the resources collection
+  def find_resources options
+
+    # return [] unless resource_class.ancestors.include? ActiveRecord::Base
+    params[:ids] ||= []
+    params[:ids] << params[:id] unless params[:id].nil?
+
+    if params[:ids].compact.any?
+      policy_scope(resource_class).where(id: params[:ids].compact.split(",").flatten)
+    else
+      # search
+      r = _search options
+      # sort
+      r = _sort r, options
+
+      # paginate
+      r = _paginate r
+
+      # (params[:format].nil? or params[:format]=='html') ? r.page(params[:page]).per(params[:perpage]) : r
+    end
+  end
+
+  #
+  # search - it at all
+  #
+  def _search options
+    if params[:q].blank? #or params[:q]=="undefined"
+      parent? ? parent.send(resource_name) : (resource_class.nil? ? nil : find_all_resources(options))
+    else
+      find_resources_queried options
+    end
+  end
+
+  #
+  # sort - it at all
+  #
+  # %th{ role:"sort", data{ field: "*barcode", direction: "DESC"} }
+  # $('th[role="sort"]')
+  def _sort r, options
+    r.order "%s %s" % [ (params[:s] || "id"), sorting_direction(params[:d]) ]
+  end
+
+  def sorting_direction val=nil
+    _flip(val || @sorting_direction)
+  end
+
+  def _flip val
+    @sorting_direction = (val == "ASC" ? "DESC" : "ASC")
+    val
+  rescue
+    @sorting_direction = "ASC"
+  end
+
+  #
+  # paginate - it at all
+  #
+  def _paginate r
+    return r if params[:action]=='print'
+    # will it obey the #page call?
+    # is it without format or html or scrolling or with search?
+    if (r.respond_to?( :page)) && (params[:format].nil? or params[:format]=='html' or params[:scrolling] or params[:s])
+      params[:perpage] ||= 20
+      params[:page] ||= 1
+      return r.page(params[:page]).per(params[:perpage])
+    else
+      return r
+    end
+  end
+
+  #
+  # find queried resources collection - implement on each controller to customize
+  # raise an exception
+  def find_all_resources options
+    policy_scope(resource_class)
+  end
+
+  #
+  # find queried resources collection - implement on each controller to customize
+  # raise an exception
+  def find_resources_queried options
+    case params[:f]
+    when nil
+      if parent?
+        policy_scope(resource_class).tags_included?( params[:q].split(" ") ).where( options )
+      else
+        policy_scope(resource_class).tags_included?( params[:q].split(" ") )
+      end
+    else
+      policy_scope(resource_class)
+    end
+  end
+
+  class_methods do
+  end
+
+end

data/lib/abstracted/version.rb

@@ -1,3 +1,3 @@
 module Abstracted
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abstracted
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Walther H Diechmann
@@ -288,6 +288,9 @@ files:
 - app/controllers/.keep
 - app/controllers/abstract_resources_controller.rb
 - app/controllers/application_controller.rb
+- app/controllers/concerns/parent_control.rb
+- app/controllers/concerns/print_control.rb
+- app/controllers/concerns/resource_control.rb
 - app/helpers/.keep
 - app/helpers/abstract_resources_helper.rb
 - app/helpers/fab_button_helper.rb