active_scaffold_batch 3.2.0

data/lib/active_scaffold/config/batch_destroy.rb

@@ -0,0 +1,54 @@
+module ActiveScaffold::Config
+  class BatchDestroy < ActiveScaffold::Config::Base
+    self.crud_type = :delete
+    
+    def initialize(core_config)
+      @core = core_config
+
+      # start with the ActionLink defined globally
+      @link = self.class.link.map(&:clone) unless self.class.link.nil?
+      @action_group = self.class.action_group.clone if self.class.action_group
+      @action_group ||= 'collection.batch.destroy'
+      @process_mode = self.class.process_mode
+    end
+
+    # global level configuration
+    # --------------------------
+    # the ActionLink for this action
+    def self.link
+      @@link
+    end
+    def self.link=(val)
+      @@link = val
+    end
+    @@link = [ ActiveScaffold::DataStructures::ActionLink.new('batch_destroy', :label => :listed, :type => :collection, :method => :delete, :position => false, :crud_type => :delete, :confirm => :are_you_sure_to_delete, :parameters => {:batch_scope => 'LISTED'},:security_method => :batch_destroy_authorized?),
+               ActiveScaffold::DataStructures::ActionLink.new('batch_destroy', :label => :marked, :type => :collection, :method => :delete, :position => false, :crud_type => :delete, :confirm => :are_you_sure_to_delete, :parameters => {:batch_scope => 'MARKED'}, :security_method => :batch_destroy_authorized?, :ignore_method => :batch_destroy_marked_ignore?)]
+
+    # configures where the plugin itself is located. there is no instance version of this.
+    cattr_accessor :plugin_directory
+    @@plugin_directory = File.expand_path(__FILE__).match(%{(^.*)/lib/active_scaffold/config/batch_destroy.rb})[1]
+
+    # configures how batch updates should be processed
+    # :delete => standard activerecord delete including validations
+    # :delete_all => updating in one sql call without activerecord instantiation and validation
+    cattr_accessor :process_mode
+    @@process_mode = :delete
+
+
+    # instance-level configuration
+    # ----------------------------
+
+    # see class accessor
+    attr_accessor :process_mode
+
+    # the ActionLink for this action
+    attr_accessor :link
+
+    # the label= method already exists in the Form base class
+    def label(model = nil)
+      model ||= @core.label(:count => 2)
+      @label ? as_(@label) : as_(:delete_model, :model => model)
+    end
+
+  end
+end

data/lib/active_scaffold/config/batch_update.rb

@@ -0,0 +1,52 @@
+module ActiveScaffold::Config
+  class BatchUpdate < ActiveScaffold::Config::Form
+    self.crud_type = :update
+    def initialize(*args)
+      super
+      @process_mode = self.class.process_mode
+      @action_group ||= 'collection.batch'
+      @list_mode_enabled = self.class.list_mode_enabled
+    end
+
+    # global level configuration
+    # --------------------------
+    # the ActionLink for this action
+    def self.link
+      @@link
+    end
+    def self.link=(val)
+      @@link = val
+    end
+    @@link = ActiveScaffold::DataStructures::ActionLink.new('batch_edit', :label => :edit, :type => :collection, :security_method => :batch_update_authorized?, :ignore_method => :batch_update_ignore?)
+
+    # configures where the plugin itself is located. there is no instance version of this.
+    cattr_accessor :plugin_directory
+    @@plugin_directory = File.expand_path(__FILE__).match(%{(^.*)/lib/active_scaffold/config/batch_update.rb})[1]
+
+    # configures how batch updates should be processed
+    # :update => standard activerecord update including validations
+    # :update_all => updating in one sql call without activerecord instantiation and validation
+    cattr_accessor :process_mode
+    @@process_mode = :update
+
+    # you may update all records in list view or all marked records
+    # you might disable list mode with this switch if you think it is
+    # too "dangerous"
+    cattr_accessor :list_mode_enabled
+    @@list_mode_enabled = true
+    # instance-level configuration
+    # ----------------------------
+
+    # see class accessor
+    attr_accessor :process_mode
+
+    attr_accessor :list_mode_enabled
+
+
+    # the label= method already exists in the Form base class
+    def label(model = nil)
+      model ||= @core.label(:count => 2)
+      @label ? as_(@label) : as_(:update_model, :model => model)
+    end
+  end
+end

data/lib/active_scaffold/helpers/batch_create_column_helpers.rb

@@ -0,0 +1,38 @@
+module ActiveScaffold
+  module Helpers
+    # Helpers that assist with the rendering of a Form Column
+    module BatchCreateColumnHelpers
+      # This method decides which input to use for the given column.
+      # It does not do any rendering. It only decides which method is responsible for rendering.
+      def active_scaffold_batch_create_by_column(column, scope = nil, options = {})
+        options = active_scaffold_input_options(column, scope, options)
+
+        if column.form_ui == :record_select
+          active_scaffold_record_select(column, options, batch_create_by_records, true)
+        else
+          active_scaffold_batch_create_singular_association(column, options)
+        end
+
+      end
+
+      def active_scaffold_batch_create_singular_association(column, html_options)
+        associated_options = batch_create_by_records.collect {|r| r.id}
+        select_options = options_for_association(column.association)
+        html_options.update(column.options[:html_options] || {})
+        options = {}
+        options.update(column.options)
+        html_options[:name] = "#{html_options[:name]}[]" 
+        html_options[:multiple] = true
+        select_tag(column.name, options_for_select(select_options.uniq, associated_options), html_options)
+      end
+
+      def batch_create_multiple_remove_link
+        link_to as_(:remove), '#', :class => 'remove'
+      end
+
+      def batch_create_multiple_layout
+        "batch_create_form_#{active_scaffold_config.batch_create.layout}"
+      end
+    end
+  end
+end

data/lib/active_scaffold/helpers/calendar_date_select_update_column_helpers.rb

@@ -0,0 +1,33 @@
+module ActiveScaffold
+  module Helpers
+    module CalendarDateSelectUpdateColumnHelpers
+      def active_scaffold_update_calendar_date_select(column, options)
+        current_params = {:value => nil, :number => nil, :unit => nil, :operator => 'NO_UPDATE'}
+        current_params.merge!(batch_update_values[column.name][:value].symbolize_keys) if batch_update_values[column.name] && batch_update_values[column.name][:value]
+        Rails.logger.info("update_date column: #{column.name}: #{current_params[:value].inspect}, class: #{current_params[:value].class}")
+        Rails.logger.info("update_date column: #{column.name}: options #{options.inspect}")
+        current_params[:value] = nil if current_params[:value].is_a?(String)
+        Rails.logger.info("update_date2 column: #{column.name}: #{current_params[:value].inspect}, class: #{current_params[:value].class}")
+        operator_options = active_scaffold_update_generic_operators(column)
+        operator_options.concat(ActiveScaffold::Actions::BatchUpdate::DateOperators.collect {|comp| [as_(comp.downcase.to_sym), comp]}) if active_scaffold_config.batch_update.process_mode == :update
+        options = options.merge(:show => ['PLUS', 'MINUS'].exclude?(current_params[:operator]))
+        tags = []
+        tags << select_tag("[record][#{column.name}][operator]",
+                options_for_select(operator_options, current_params[:operator]),
+                  :id => "#{options[:id]}_operator",
+                  :class => "text-input as_update_date_operator")
+        tags << active_scaffold_search_date_bridge_calendar_control(column, options, current_params[:value], 'value')
+        tags << active_scaffold_update_date_bridge_trend_tag(column, current_params, options)
+        tags.join("&nbsp;").html_safe
+      end
+
+      def active_scaffold_update_date_bridge_trend_tag(column, current_params, options)
+        active_scaffold_date_bridge_trend_tag(column, options,
+                                             {:name_prefix => '[record]',
+                                              :number_value => current_params[:number],
+                                              :unit_value => current_params[:unit],
+                                              :show => ['PLUS','MINUS'].include?(current_params[:operator])})
+      end
+    end
+  end
+end

data/lib/active_scaffold/helpers/datepicker_update_column_helpers.rb

@@ -0,0 +1,29 @@
+module ActiveScaffold
+  module Helpers
+    module DatepickerUpdateColumnHelpers
+      def active_scaffold_update_date_picker(column, options)
+        current_params = {:value => nil, :number => nil, :unit => nil, :operator => 'NO_UPDATE'}
+        current_params.merge!(batch_update_values[column.name][:value].symbolize_keys) if batch_update_values[column.name] && batch_update_values[column.name][:value]
+        operator_options = active_scaffold_update_generic_operators(column)
+        operator_options.concat(ActiveScaffold::Actions::BatchUpdate::DateOperators.collect {|comp| [as_(comp.downcase.to_sym), comp]}) if active_scaffold_config.batch_update.process_mode == :update
+        options = options.merge(:show => ['PLUS', 'MINUS'].exclude?(current_params[:operator]))
+        tags = []
+        tags << select_tag("[record][#{column.name}][operator]",
+                options_for_select(operator_options, current_params[:operator]),
+                  :id => "#{options[:id]}_operator",
+                  :class => "text-input as_update_date_operator")
+        tags << active_scaffold_search_date_bridge_calendar_control(column, options, current_params[:value], 'value')
+        tags << active_scaffold_update_date_bridge_trend_tag(column, current_params, options)
+        tags.join("&nbsp;").html_safe
+      end
+
+      def active_scaffold_update_date_bridge_trend_tag(column, current_params, options)
+        active_scaffold_date_bridge_trend_tag(column, options,
+                                             {:name_prefix => '[record]',
+                                              :number_value => current_params[:number],
+                                              :unit_value => current_params[:unit],
+                                              :show => ['PLUS','MINUS'].include?(current_params[:operator])})
+      end
+    end
+  end
+end

data/lib/active_scaffold/helpers/update_column_helpers.rb

@@ -0,0 +1,93 @@
+module ActiveScaffold
+  module Helpers
+    # Helpers that assist with the rendering of a Form Column
+    module UpdateColumnHelpers
+      # This method decides which input to use for the given column.
+      # It does not do any rendering. It only decides which method is responsible for rendering.
+      def active_scaffold_update_for(column, scope = nil, options = {})
+        options = active_scaffold_input_options(column, scope, options)
+
+        # first, check if the dev has created an override for this specific field for search
+        if (method = override_update_field(column))
+          send(method, @record, options)
+        # second, check if the dev has specified a valid form_ui for this column, using specific ui for searches
+        elsif column.form_ui and (method = override_update(column.form_ui))
+          send(method, column, options)
+       elsif column.column and column.form_ui.nil? and (method = override_update(column.column.type))
+          send(method, column, options)
+        else
+          active_scaffold_update_generic_operators_select(column, options)<< ' ' << active_scaffold_render_input(column, options.merge(:name => "record[#{column.name}][value]"))
+        end
+      end
+
+      def active_scaffold_update_generic_operators(column)
+        operators = ActiveScaffold::Actions::BatchUpdate::GenericOperators.collect {|comp| [as_(comp.downcase.to_sym), comp]}
+        if column.column.nil? || column.column.null
+          operators << [as_(:null), 'NULL']
+        end
+        operators
+      end
+
+      def active_scaffold_update_generic_operators_select(column, options)
+        current = {:operator => 'NO_UPDATE'}
+        current.merge!(batch_update_values[column.name][:value].symbolize_keys) if batch_update_values[column.name] && batch_update_values[column.name][:value]
+        select_tag("[record][#{column.name}][operator]",
+              options_for_select(active_scaffold_update_generic_operators(column), current[:operator]),
+              :id => "#{options[:id]}_operator",
+              :class => "as_batch_update_operator text_input")
+      end
+
+      def active_scaffold_update_numeric(column, options)
+        current = {:value => nil, :opt => 'ABSOLUTE', :operator => 'NO_UPDATE'}
+        current.merge!(batch_update_values[column.name][:value].symbolize_keys) if batch_update_values[column.name] && batch_update_values[column.name][:value]
+        operator_options = active_scaffold_update_generic_operators(column) + ActiveScaffold::Actions::BatchUpdate::NumericOperators.collect {|comp| [as_(comp.downcase.to_sym), comp]}
+        select_options = ActiveScaffold::Actions::BatchUpdate::NumericOptions.collect {|comp| [as_(comp.downcase.to_sym), comp]}
+        html = select_tag("[record][#{column.name}][operator]",
+              options_for_select(operator_options, current[:operator]),
+              :id => "#{options[:id]}_operator",
+              :class => "as_update_numeric_option")
+        html << ' ' << text_field_tag("[record][#{column.name}][value]", current[:value], active_scaffold_input_text_options)
+        html << ' ' << select_tag("[record][#{column.name}][opt]",
+              options_for_select(select_options, current[:opt]),
+              :id => "#{options[:id]}_opt",
+              :class => "as_update_numeric_option")
+        html
+      end
+      alias_method :active_scaffold_update_integer, :active_scaffold_update_numeric
+      alias_method :active_scaffold_update_decimal, :active_scaffold_update_numeric
+      alias_method :active_scaffold_update_float, :active_scaffold_update_numeric
+
+      def active_scaffold_update_scope_select(select_options = active_scaffold_update_scope_select_options)
+        if select_options.length > 1
+          select_tag("batch_scope",
+                     options_for_select(select_options, batch_scope || select_options.last[1]),
+                     :class => "text_input")
+        else
+          hidden_field_tag("batch_scope", select_options.first[1]) unless select_options.empty?
+        end
+      end
+
+      def active_scaffold_update_scope_select_options
+        select_options = []
+        select_options << [as_(:listed), 'LISTED'] if active_scaffold_config.batch_update.list_mode_enabled
+        select_options << [as_(:marked), 'MARKED'] if active_scaffold_config.actions.include?(:mark)
+        select_options
+      end
+
+      ##
+      ## Search column override signatures
+      ##
+
+      # the naming convention for overriding form fields with helpers
+      def override_update_field(column)
+        override_helper column, 'update_column'
+      end
+
+      # the naming convention for overriding search input types with helpers
+      def override_update(update_ui)
+        method = "active_scaffold_update_#{update_ui}"
+        method if respond_to? method
+      end
+    end
+  end
+end

data/lib/active_scaffold_batch/config/core.rb

@@ -0,0 +1,13 @@
+# Need to open the AS module carefully due to Rails 2.3 lazy loading
+ActiveScaffold::Config::Core.class_eval do
+  ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:batch_edit] = :get
+  ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:batch_update] = :post
+  ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:batch_new] = :get
+  ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:batch_create] = :post
+  ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:batch_add] = :get
+  #not working because routing picks show route instead
+  #ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:batch_destroy] = :get
+  #you may define a route for your controller before resource routes
+  #match 'players/batch_destroy' => 'players#batch_destroy', :via => [:get]
+  ActionDispatch::Routing::ACTIVE_SCAFFOLD_CORE_ROUTING[:collection][:batch_destroy] = :delete
+end

data/lib/active_scaffold_batch/engine.rb

@@ -0,0 +1,23 @@
+module ActiveScaffoldBatch
+  class Engine < ::Rails::Engine
+    initializer("initialize_active_scaffold_batch", :after => "initialize_active_scaffold") do
+      ActiveSupport.on_load(:action_controller) do
+        require "active_scaffold_batch/config/core.rb"
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        begin
+          include ActiveScaffold::Helpers::UpdateColumnHelpers
+          if ActiveScaffold.js_framework == :jquery
+            include ActiveScaffold::Helpers::DatepickerUpdateColumnHelpers
+          elsif ActiveScaffold.js_framework == :prototype
+            include ActiveScaffold::Helpers::CalendarDateSelectUpdateColumnHelpers if defined? CalendarDateSelect
+          end
+          include ActiveScaffold::Helpers::BatchCreateColumnHelpers
+        rescue
+          raise $! unless Rails.env == 'production'
+        end
+      end
+    end
+  end
+end

data/lib/active_scaffold_batch/version.rb

@@ -0,0 +1,9 @@
+module ActiveScaffoldBatch
+  module Version
+    MAJOR = 3
+    MINOR = 2
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

data/lib/active_scaffold_batch.rb

@@ -0,0 +1,25 @@
+require 'active_scaffold_batch/engine'
+require 'active_scaffold_batch/version'
+
+module ActiveScaffoldBatch
+  def self.root
+    File.dirname(__FILE__) + "/.."
+  end
+end
+
+module ActiveScaffold
+  module Actions
+    ActiveScaffold.autoload_subdir('actions', self, File.dirname(__FILE__))
+  end
+
+  module Config
+    ActiveScaffold.autoload_subdir('config', self, File.dirname(__FILE__))
+  end
+
+  module Helpers
+    ActiveScaffold.autoload_subdir('helpers', self, File.dirname(__FILE__))
+  end
+end
+
+ActiveScaffold.stylesheets << 'active_scaffold_batch'
+ActiveScaffold.javascripts << "#{ActiveScaffold.js_framework}/active_scaffold_batch"

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: active_scaffold_batch
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 3
+  - 2
+  - 0
+  version: 3.2.0
+platform: ruby
+authors: 
+- Sergio Cambra
+- Volker Hochstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 864871169
+        segments: 
+        - 3
+        - 3
+        - 0
+        - rc
+        version: 3.3.0.rc
+  version_requirements: *id001
+  prerelease: false
+  name: active_scaffold
+description: You want to destroy/update many records at once with activescaffold?
+email: activescaffold@googlegroups.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- app/assets/javascripts/jquery/active_scaffold_batch.js
+- app/assets/javascripts/prototype/active_scaffold_batch.js
+- app/assets/stylesshets/active_scaffold_batch.css
+- app/views/active_scaffold_overrides/_batch_create_form.html.erb
+- app/views/active_scaffold_overrides/_batch_create_form_attribute.html.erb
+- app/views/active_scaffold_overrides/_batch_create_form_body.html.erb
+- app/views/active_scaffold_overrides/_batch_create_form_footer.html.erb
+- app/views/active_scaffold_overrides/_batch_create_form_horizontal.html.erb
+- app/views/active_scaffold_overrides/_batch_create_form_horizontal_header.html.erb
+- app/views/active_scaffold_overrides/_batch_create_form_horizontal_record.html.erb
+- app/views/active_scaffold_overrides/_batch_create_form_multiple.html.erb
+- app/views/active_scaffold_overrides/_batch_create_form_vertical.html.erb
+- app/views/active_scaffold_overrides/_batch_create_form_vertical_record.html.erb
+- app/views/active_scaffold_overrides/_batch_update_form.html.erb
+- app/views/active_scaffold_overrides/_batch_update_form_attribute.html.erb
+- app/views/active_scaffold_overrides/_batch_update_form_attribute_scope.html.erb
+- app/views/active_scaffold_overrides/_batch_update_form_body.html.erb
+- app/views/active_scaffold_overrides/_form_messages.html.erb
+- app/views/active_scaffold_overrides/batch_add.js.erb
+- app/views/active_scaffold_overrides/batch_create.html.erb
+- app/views/active_scaffold_overrides/batch_update.html.erb
+- app/views/active_scaffold_overrides/on_batch_base.js.erb
+- app/views/active_scaffold_overrides/on_batch_create.js.erb
+- app/views/active_scaffold_overrides/on_batch_update.js.erb
+- config/locales/de.yml
+- config/locales/en.yml
+- config/locales/es.yml
+- lib/active_scaffold/actions/batch_base.rb
+- lib/active_scaffold/actions/batch_create.rb
+- lib/active_scaffold/actions/batch_destroy.rb
+- lib/active_scaffold/actions/batch_update.rb
+- lib/active_scaffold/config/batch_create.rb
+- lib/active_scaffold/config/batch_destroy.rb
+- lib/active_scaffold/config/batch_update.rb
+- lib/active_scaffold/helpers/batch_create_column_helpers.rb
+- lib/active_scaffold/helpers/calendar_date_select_update_column_helpers.rb
+- lib/active_scaffold/helpers/datepicker_update_column_helpers.rb
+- lib/active_scaffold/helpers/update_column_helpers.rb
+- lib/active_scaffold_batch.rb
+- lib/active_scaffold_batch/config/core.rb
+- lib/active_scaffold_batch/engine.rb
+- lib/active_scaffold_batch/version.rb
+- LICENSE.txt
+- README
+homepage: http://github.com/scambra/active_scaffold_batch
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Batch Processing for ActiveScaffold
+test_files: []
+