para 0.6.3 → 0.6.7

data/lib/para/cache/database_store.rb

@@ -0,0 +1,71 @@
+# This is a simple ActiveSupport::Cache::Store implementation, borrowed from
+# activesupport-db-cache gem (https://github.com/sergio-fry/activesupport-db-cache),
+# simplified.
+#
+# It also adds RequestStore.store caching, avoiding same key reads to hit
+# ActiveRecord multiple times in a single request
+#
+# This is primarily meant to manage jobs status storing in Para::Job::Base
+# through the ActiveJob::Status gem. It allows not to add external storage
+# systems dependency (redis, memcache) to the app when not needed (when using
+# default ActiveJob 5 AsyncAdapter or SuckerPunchAdapter).
+#
+# Since it's quite slow, it's advised to replace it with faster cache stores
+# like Redis or Memcache when used in large production systems.
+#
+module Para
+  module Cache
+    class DatabaseStore < ActiveSupport::Cache::Store
+      def clear
+        Item.delete_all
+      end
+
+      def delete_entry(key, options)
+        Item.delete_all(key: key)
+      end
+
+      def read_entry(key, options={})
+        RequestStore.store[cache_key_for(key)] ||= Item.find_by(key: key)
+      end
+
+      def write_entry(key, entry, options)
+        RequestStore.store[cache_key_for(key)] ||= Item.where(key: key).first_or_initialize
+        item = RequestStore.store[cache_key_for(key)]
+
+        options = options.clone.symbolize_keys
+
+        item.value = entry.value
+        item.expires_at = options[:expires_in].try(:since)
+        item.save!
+
+        # Ensure cached item in RequestStore is up to date
+        RequestStore.store[cache_key_for(key)] = item
+      rescue ActiveRecord::RecordNotUnique
+      ensure
+        clear_expired_keys
+      end
+
+      private
+
+      def clear_expired_keys
+        if Item.count > Para.config.database_cache_store_max_items
+          remove_expired_items
+          remove_old_items
+        end
+      end
+
+      def remove_expired_items
+        Item.where("expires_at < ?", Time.now).delete_all
+      end
+
+      def remove_old_items
+        count = (Item.count - Para.config.database_cache_store_max_items)
+        Item.order('updated_at ASC').limit(count).delete_all if count > 0
+      end
+
+      def cache_key_for(key)
+        ['para.cache.database_store', key].join('.')
+      end
+    end
+  end
+end

data/lib/para/cache.rb

@@ -0,0 +1,11 @@
+module Para
+  module Cache
+    extend ActiveSupport::Autoload
+
+    autoload :DatabaseStore
+
+    def self.table_name_prefix
+      'para_cache_'
+    end
+  end
+end

data/lib/para/config.rb

@@ -18,8 +18,13 @@ module Para
     mattr_accessor :resource_name_methods
     @@resource_name_methods = [:admin_name, :admin_title, :name, :title]
 
-    mattr_accessor :plugins
-    @@plugins = []
+    mattr_reader :plugins
+    @@plugins = Para::Plugins::Set.new
+
+    def self.plugins=(array)
+      # Add each item in array to the existing plugins set
+      array.each(&plugins.method(:<<))
+    end
 
     # Hidden from initializer on purpose.
     #
@@ -31,6 +36,27 @@ module Para
     mattr_accessor :page_actions
     @@page_actions = {}
 
+    # Allows changing default cache store used by Para to store jobs through
+    # the ActiveJob::Status gem
+    #
+    def self.jobs_store=(store)
+      @@jobs_store = store
+      ActiveJob::Status.store = store
+    end
+
+    # Default to use Para::Cache::DatabaseStore, allowing cross process and
+    # app instances job status sharing
+    #
+    def self.jobs_store
+      @@jobs_store ||= Para::Cache::DatabaseStore.new
+    end
+
+    # The DatabaseStore cache system tries to clean up old keys when reaching
+    # that limit after writing new keys
+    #
+    mattr_accessor :database_cache_store_max_items
+    @@database_cache_store_max_items = 10000
+
     # Allows accessing plugins root module to configure them through a method
     # from the Para::Config class.
     #

data/lib/para/engine.rb

@@ -48,12 +48,11 @@ module Para
       end
     end
 
-    initializer 'Extend simple form extension selectize input' do
-      ActiveSupport.on_load(:active_record) do
-        ::SimpleFormExtension::Inputs::SelectizeInput.send(
-          :include, Para::Ext::SimpleFormExtension::SelectizeInput
-        )
-      end
+    initializer 'Add resource name methods to simple form extension' do
+      ::SimpleFormExtension.resource_name_methods = (
+        Para.config.resource_name_methods + 
+          ::SimpleFormExtension.resource_name_methods
+      ).uniq
     end
 
     initializer 'Extend active job status\' status class' do
@@ -72,19 +71,15 @@ module Para
       end
     end
 
-    initializer 'Load page sections' do |app|
-      app.config.to_prepare do
-        Para::Page::Section.eager_load!
-      end
-    end
-
     initializer 'Check for extensions installation' do
       Para::PostgresExtensionsChecker.check_all
     end
 
     initializer 'Configure ActiveJob' do
-      if ActiveSupport::Cache::NullStore === ActiveJob::Status.store
-        ActiveJob::Status.store = :memory_store
+      if ActiveSupport::Cache::NullStore === ActiveJob::Status.store ||
+         ActiveSupport::Cache::MemoryStore === ActiveJob::Status.store
+      then
+        ActiveJob::Status.store = Para.config.jobs_store
       end
 
       Para::Logging::ActiveJobLogSubscriber.attach_to :active_job

data/lib/para/exporter/base.rb

@@ -25,6 +25,28 @@ module Para
 
       private
 
+      def render
+        Tempfile.new([name, extension]).tap do |file|
+          file.binmode if binary?
+          file.write(generate)
+          file.rewind
+        end
+      end
+
+      def generate
+        fail NotImplementedError
+      end
+
+      # Default to writing string data to the exported file, allowing
+      # subclasses to write binary data if needed
+      def binary?
+        false
+      end
+
+      def total_progress
+        resources.length
+      end
+
       # Allow passing a `:resources` option or a ransack search hash to filter
       # exported resources
       #
@@ -37,6 +59,10 @@ module Para
           model.all
         end
       end
+
+      def encode(string)
+        string.presence && string.to_s.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?')
+      end
     end
   end
 end

data/lib/para/exporter/csv.rb

@@ -2,43 +2,23 @@ require 'csv'
 
 module Para
   module Exporter
-    class Csv < Base
-      def render
-        data = CSV.generate do |csv|
+    class Csv < Table
+      protected
+
+      def generate
+        CSV.generate do |csv|
           csv << headers
 
           resources.each do |resource|
             csv << row_for(resource)
+            progress!
           end
         end
-
-        Tempfile.new([name, extension]).tap do |file|
-          file.write(data)
-          file.rewind
-        end
       end
 
-      private
-
       def extension
         '.csv'
       end
-
-      def headers
-        fields.map do |field|
-          encode(model.human_attribute_name(field))
-        end
-      end
-
-      def row_for(resource)
-        fields.map do |field|
-          encode(resource.send(field))
-        end
-      end
-
-      def encode(string)
-        string.presence && string.to_s.encode('UTF-8')
-      end
     end
   end
 end

data/lib/para/exporter/table.rb

@@ -0,0 +1,23 @@
+# This class serves as a basic superclass for tabular data specific exports,
+# which are organized as tables : a header row and several rows of data.
+#
+# This allows to only define the `#fields` method in the subclass and let the
+# exporter work alone
+#
+module Para
+  module Exporter
+    class Table < Para::Exporter::Base
+      def headers
+        fields.map do |field|
+          encode(model.human_attribute_name(field))
+        end
+      end
+
+      def row_for(resource)
+        fields.map do |field|
+          encode(resource.send(field))
+        end
+      end
+    end
+  end
+end

data/lib/para/exporter/xls.rb

@@ -0,0 +1,59 @@
+require 'stringio'
+require 'spreadsheet'
+
+module Para
+  module Exporter
+    class Xls < Table
+      protected
+
+      def extension
+        '.xls'
+      end
+
+      def name
+        'export'
+      end
+
+      def mime_type
+        'application/vnd.ms-excel'
+      end
+
+      def binary?
+        true
+      end
+
+      def generate
+        generate_workbook do |workbook|
+          sheet = workbook.create_worksheet
+
+          # Add headers
+          sheet.row(0).concat headers
+
+          # Add content rows
+          resources.each_with_index do |resource , index|
+            sheet.row(index + 1).concat row_for(resource)
+          end
+        end
+      end
+
+      def generate_workbook(&block)
+        workbook = Spreadsheet::Workbook.new
+
+        block.call(workbook)
+
+        buffer = StringIO.new
+        workbook.write(buffer)
+        buffer.rewind
+        buffer.read
+      end
+
+      def fields
+        fail NotImplementedError
+      end
+
+      def encode(string)
+        string.presence && string.to_s.encode('UTF-8', invalid: :replace, undef: :replace, replace: '?')
+      end
+    end
+  end
+end

data/lib/para/exporter.rb

@@ -1,7 +1,10 @@
 module Para
   module Exporter
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Table
+    autoload :Csv
+    autoload :Xls
   end
 end
-
-require 'para/exporter/base'
-require 'para/exporter/csv'

data/lib/para/ext.rb

@@ -11,5 +11,4 @@ end
 
 require 'para/ext/cancan'
 require 'para/ext/paperclip'
-require 'para/ext/simple_form_extension'
 require 'para/ext/active_job_status'

data/lib/para/form_builder/containers.rb

@@ -49,7 +49,20 @@ module Para
       end
 
       def para_submit_and_edit_button
-        button(:submit, ::I18n.t('para.shared.save_and_edit'), name: '_save_and_edit', class: 'btn-primary')
+        # Create a hidden field that will hold the last tab used by the user,
+        # allowing redirection and re-rendering to display it directly
+        current_anchor_tag = template.hidden_field_tag(
+          :_current_anchor, template.params[:_current_anchor],
+          data: { :'current-anchor' => true }
+        )
+
+        button_tag = button(
+          :submit,
+          ::I18n.t('para.shared.save_and_edit'),
+          name: '_save_and_edit', class: 'btn-primary'
+        )
+
+        current_anchor_tag + button_tag
       end
 
       def para_submit_and_add_another_button

data/lib/para/form_builder.rb

@@ -21,4 +21,5 @@ SimpleForm::FormBuilder.class_eval do
   include Para::FormBuilder::Tabs
 end
 
+# Map IP Address fields to string
 SimpleForm::FormBuilder.map_type(:inet, to: SimpleForm::Inputs::StringInput)

data/lib/para/importer/base.rb

@@ -1,8 +1,6 @@
 module Para
   module Importer
     class Base < Para::Job::Base
-      rescue_from Exception, with: :rescue_exception
-
       class_attribute :allows_import_errors
 
       attr_reader :file, :sheet
@@ -29,9 +27,9 @@ module Para
         save_errors!
       end
 
-      private
+      protected
 
-      def progress_total
+      def total_progress
         sheet.last_row - 1
       end
 
@@ -68,30 +66,6 @@ module Para
       def headers
         @headers ||= sheet.row(1)
       end
-
-      def rescue_exception(exception)
-        status.update(status: :failed)
-
-        tag_logger(self.class.name, self.job_id) do
-          ActiveSupport::Notifications.instrument "failed.active_job",
-              adapter: self.class.queue_adapter, job: self, exception: exception
-        end
-
-        if defined?(ExceptionNotifier)
-          ExceptionNotifier.notify_exception(
-            exception, data: {
-              importer: self.class.name,
-              payload: {
-                file_type: file.class,
-                file_id: file.id,
-                file_name: file.attachment_file_name
-              }
-            }
-          )
-        end
-
-        raise exception
-      end
     end
   end
 end

data/lib/para/inputs/nested_many_input.rb

@@ -26,7 +26,8 @@ module Para
             dom_identifier: dom_identifier,
             resources: resources,
             nested_locals: locals,
-            subclass: subclass
+            subclass: subclass,
+            subclasses: subclasses
           }
         )
       end
@@ -49,9 +50,13 @@ module Para
       end
 
       def subclass
-        @subclass ||= options.fetch(
-          :subclass,
-          model.respond_to?(:descendants) && model.descendants.length > 0
+        @subclass ||= options.fetch(:subclass, subclasses.presence)
+      end
+
+      def subclasses
+        options.fetch(
+          :subclasses,
+          (model.try(:descendants) || []).sort_by { |m| m.model_name.human }
         )
       end
     end

data/lib/para/job/base.rb

@@ -2,11 +2,13 @@ module Para
   module Job
     class Base < ActiveJob::Base
       include ActiveJob::Status
-      # Used to store import errors on the object
+      # Used to store job errors on the object
       include ActiveModel::Validations
-      # Used to translate importer name with rails default `activemodel` i18n keys
+      # Used to translate job name with rails default `activemodel` i18n keys
       extend  ActiveModel::Translation
 
+      rescue_from Exception, with: :rescue_exception
+
       before_perform :store_job_type
 
       protected
@@ -33,8 +35,8 @@ module Para
       def ensure_total_progress
         return if @total_progress
 
-        @total_progress ||= if respond_to?(:progress_total)
-          progress.total = progress_total
+        @total_progress ||= if respond_to?(:total_progress, true)
+          progress.total = total_progress
         else
           progress[:total]
         end
@@ -47,6 +49,23 @@ module Para
           status[key]
         end
       end
+
+      def rescue_exception(exception)
+        status.update(status: :failed)
+
+        tag_logger(self.class.name, job_id) do
+          ActiveSupport::Notifications.instrument "failed.active_job",
+              adapter: self.class.queue_adapter, job: self, exception: exception
+        end
+
+        if defined?(ExceptionNotifier)
+          ExceptionNotifier.notify_exception(
+            exception, data: { job: self.class.name, payload: arguments }
+          )
+        end
+
+        raise exception
+      end
     end
   end
 end

data/lib/para/logging/active_job_log_subscriber.rb

@@ -23,6 +23,8 @@ module Para
         if job.arguments.any?
           ' with arguments: ' +
             job.arguments.map { |arg| format(arg).inspect }.join(', ')
+        else
+          ''
         end
       end
 

data/lib/para/orderable.rb

@@ -3,7 +3,7 @@ module Para
     extend ActiveSupport::Concern
 
     included do
-      scope :ordered, -> { order('position ASC') }
+      scope :ordered, -> { order("#{ table_name }.position ASC") }
       before_create :orderable_assign_position
     end
 
@@ -11,7 +11,7 @@ module Para
       return if attribute_present?(:position)
 
       last_resource = self.class.unscoped
-        .order('position DESC')
+        .ordered
         .where.not(position: nil)
         .select(:position)
         .first

data/lib/para/plugins/set.rb

@@ -0,0 +1,34 @@
+module Para
+  module Plugins
+    class Set
+      include Enumerable
+
+      attr_accessor :items
+
+      delegate :+, :<<, :each, to: :items
+
+      def initialize
+        @items = []
+      end
+
+      def javascript_includes
+        each_with_object([]) do |plugin, collection|
+          collection.concat(includes_for(:javascript, plugin))
+        end
+      end
+
+      def stylesheet_includes
+        each_with_object([]) do |plugin, collection|
+          collection.concat(includes_for(:stylesheet, plugin))
+        end
+      end
+
+      private
+
+      def includes_for(type, plugin)
+        mod = Para::Plugins.module_name_for(plugin).constantize
+        mod.try(:config).try(:"#{ type }_includes") || []
+      end
+    end
+  end
+end

data/lib/para/plugins.rb

@@ -2,10 +2,11 @@ module Para
   module Plugins
     extend ActiveSupport::Autoload
 
-    autoload :Routes
-
     def self.module_name_for(identifier)
       ['Para', identifier.to_s.camelize].join('::')
     end
   end
 end
+
+require 'para/plugins/set'
+require 'para/plugins/routes'

data/lib/para/routing/component_controller_constraint.rb

@@ -16,7 +16,7 @@ module Para
 
       def matches?(request)
         component = component_for(request.params[:component_id])
-        return false unless component
+        return false unless component && component.controller
         component.controller.to_sym == controller
       end
 

data/lib/para/routing/component_name_constraint.rb

@@ -0,0 +1,22 @@
+# Allows constraining routing to components that explicitly declares to use a
+# given component to manage their resources.
+#
+# It's mainly used to allow users to override the default component for the
+# resources of a given Crud or Form components without having to
+# subclass the component and declare all the routes again
+#
+module Para
+  module Routing
+    class ComponentNameConstraint
+      attr_reader :component
+
+      def initialize(component)
+        @component = component.to_s
+      end
+
+      def matches?(request)
+        component == request.params[:component]
+      end
+    end
+  end
+end

data/lib/para/routing.rb

@@ -3,5 +3,6 @@ module Para
     extend ActiveSupport::Autoload
 
     autoload :ComponentControllerConstraint
+    autoload :ComponentNameConstraint
   end
 end