rocketjob 6.0.0.rc1 → 6.0.1

data/lib/rocket_job/batch/tabular/input.rb

@@ -1,133 +0,0 @@
-require "active_support/concern"
-
-module RocketJob
-  module Batch
-    class Tabular
-      # @deprecated
-      module Input
-        extend ActiveSupport::Concern
-
-        included do
-          warn "#{name} is using RocketJob::Batch::Tabular::Input which is deprecated"
-
-          field :tabular_input_header, type: Array, class_attribute: true, user_editable: true
-          field :tabular_input_format, type: Mongoid::StringifiedSymbol, default: :csv, class_attribute: true, user_editable: true
-          field :tabular_input_options, type: Hash, class_attribute: true
-
-          # tabular_input_mode: [:line | :array | :hash]
-          #   :line
-          #     Uploads the file a line (String) at a time for processing by workers.
-          #   :array
-          #     Parses each line from the file as an Array and uploads each array for processing by workers.
-          #   :hash
-          #     Parses each line from the file into a Hash and uploads each hash for processing by workers.
-          #   See IOStreams#each.
-          field :tabular_input_mode, type: Mongoid::StringifiedSymbol, default: :line, class_attribute: true, user_editable: true, copy_on_restart: true
-
-          validates_inclusion_of :tabular_input_format, in: IOStreams::Tabular.registered_formats
-          validates_inclusion_of :tabular_input_mode, in: %i[line array hash row record]
-          validate :tabular_input_header_present
-
-          class_attribute :tabular_input_white_list
-          class_attribute :tabular_input_required
-          class_attribute :tabular_input_skip_unknown
-
-          # Cleanse all uploaded data by removing non-printable characters
-          # and any characters that cannot be converted to UTF-8
-          class_attribute :tabular_input_type
-
-          self.tabular_input_white_list   = nil
-          self.tabular_input_required     = nil
-          self.tabular_input_skip_unknown = true
-          self.tabular_input_type         = :text
-
-          before_perform :tabular_input_render
-        end
-
-        # Extract the header line during the upload.
-        #
-        # Overrides: RocketJob::Batch::IO#upload
-        #
-        # Notes:
-        # - When supplying a block the header must be set manually
-        def upload(stream = nil, **args, &block)
-          input_stream = stream.nil? ? nil : IOStreams.new(stream)
-
-          if stream && (tabular_input_type == :text)
-            # Cannot change the length of fixed width lines
-            replace = tabular_input_format == :fixed ? " " : ""
-            input_stream.option_or_stream(:encode, encoding: "UTF-8", cleaner: :printable, replace: replace)
-          end
-
-          # If an input header is not required, then we don't extract it'
-          return super(input_stream, stream_mode: tabular_input_mode, **args, &block) unless tabular_input.header?
-
-          # If the header is already set then it is not expected in the file
-          if tabular_input_header.present?
-            tabular_input_cleanse_header
-            return super(input_stream, stream_mode: tabular_input_mode, **args, &block)
-          end
-
-          case tabular_input_mode
-          when :line
-            parse_header = lambda do |line|
-              tabular_input.parse_header(line)
-              tabular_input_cleanse_header
-              self.tabular_input_header = tabular_input.header.columns
-            end
-            super(input_stream, on_first: parse_header, stream_mode: :line, **args, &block)
-          when :array, :row
-            set_header = lambda do |row|
-              tabular_input.header.columns = row
-              tabular_input_cleanse_header
-              self.tabular_input_header = tabular_input.header.columns
-            end
-            super(input_stream, on_first: set_header, stream_mode: :array, **args, &block)
-          when :hash, :record
-            super(input_stream, stream_mode: :hash, **args, &block)
-          else
-            raise(ArgumentError, "Invalid tabular_input_mode: #{stream_mode.inspect}")
-          end
-        end
-
-        private
-
-        # Shared instance used for this slice, by a single worker (thread)
-        def tabular_input
-          @tabular_input ||= IOStreams::Tabular.new(
-            columns:          tabular_input_header,
-            allowed_columns:  tabular_input_white_list,
-            required_columns: tabular_input_required,
-            skip_unknown:     tabular_input_skip_unknown,
-            format:           tabular_input_format,
-            format_options:   tabular_input_options&.deep_symbolize_keys
-          )
-        end
-
-        def tabular_input_render
-          return if tabular_input_header.blank? && tabular_input.header?
-
-          @rocket_job_input = tabular_input.record_parse(@rocket_job_input)
-        end
-
-        # Cleanse custom input header if supplied.
-        def tabular_input_cleanse_header
-          ignored_columns = tabular_input.header.cleanse!
-          logger.warn("Stripped out invalid columns from custom header", ignored_columns) unless ignored_columns.empty?
-
-          self.tabular_input_header = tabular_input.header.columns
-        end
-
-        def tabular_input_header_present
-          if tabular_input_header.present? ||
-             !tabular_input.header? ||
-             (tabular_input_mode == :hash || tabular_input_mode == :record)
-            return
-          end
-
-          errors.add(:tabular_input_header, "is required when tabular_input_format is #{tabular_input_format.inspect}")
-        end
-      end
-    end
-  end
-end

data/lib/rocket_job/batch/tabular/output.rb

@@ -1,67 +0,0 @@
-require "active_support/concern"
-
-module RocketJob
-  module Batch
-    class Tabular
-      # For the simple case where all `output_categories` have the same format,
-      # If multiple output categories are used with different formats, then use IOStreams::Tabular directly
-      # instead of this plugin.
-      module Output
-        extend ActiveSupport::Concern
-
-        included do
-          warn "#{name} is using RocketJob::Batch::Tabular::Output which is deprecated"
-
-          field :tabular_output_header, type: Array, class_attribute: true, user_editable: true, copy_on_restart: true
-          field :tabular_output_format, type: Mongoid::StringifiedSymbol, default: :csv, class_attribute: true, user_editable: true, copy_on_restart: true
-          field :tabular_output_options, type: Hash, class_attribute: true
-
-          validates_inclusion_of :tabular_output_format, in: IOStreams::Tabular.registered_formats
-
-          after_perform :tabular_output_render
-        end
-
-        # Clear out cached tabular_output any time header or format is changed.
-        def tabular_output_header=(tabular_output_header)
-          super(tabular_output_header)
-          @tabular_output = nil
-        end
-
-        def tabular_output_format=(tabular_output_format)
-          super(tabular_output_format)
-          @tabular_output = nil
-        end
-
-        # Overrides: `RocketJob::Batch::IO#download` to add the `tabular_output_header`.
-        def download(file_name_or_io = nil, category: :main, **args, &block)
-          unless tabular_output.requires_header?(category)
-            return super(file_name_or_io, category: category, **args, &block)
-          end
-
-          header = tabular_output.render_header(category)
-          super(file_name_or_io, header_line: header, category: category, **args, &block)
-        end
-
-        private
-
-        # Delimited instance used for this slice, by a single worker (thread)
-        def tabular_output
-          @tabular_output ||= Tabular.new(
-            main: IOStreams::Tabular.new(
-              columns:        tabular_output_header,
-              format:         tabular_output_format,
-              format_options: tabular_output_options&.deep_symbolize_keys
-            )
-          )
-        end
-
-        # Render the output from the perform.
-        def tabular_output_render
-          return unless output_categories.present?
-
-          @rocket_job_output = tabular_output.render(@rocket_job_output)
-        end
-      end
-    end
-  end
-end

data/lib/rocket_job/batch/tabular.rb

@@ -1,58 +0,0 @@
-module RocketJob
-  module Batch
-    # Format output results.
-    #
-    # Takes Batch::Results, Batch::Result, Hash, Array, or String and renders it for output.
-    #
-    # Example:
-    #
-    # tabular = Tabular.new(
-    #   main:       IOStreams::Tabular.new(columns: main_file_headers, format: tabular_output_format),
-    #   exceptions: IOStreams::Tabular.new(columns: exception_file_headers, format: tabular_output_format)
-    # )
-    #
-    # tabular.render(row)
-    #
-    # @deprecated
-    class Tabular
-      autoload :Input, "rocket_job/batch/tabular/input"
-      autoload :Output, "rocket_job/batch/tabular/output"
-
-      def initialize(map)
-        @map = map
-      end
-
-      def [](category = :main)
-        @map[category] || raise("No tabular map defined for category: #{category.inspect}")
-      end
-
-      # Iterate over responses and format using Tabular
-      def render(row, category = :main)
-        if row.is_a?(Batch::Results)
-          results = Batch::Results.new
-          row.each { |result| results << render(result) }
-          results
-        elsif row.is_a?(Batch::Result)
-          row.value = self[row.category].render(row.value)
-          row
-        elsif row.blank?
-          nil
-        else
-          self[category].render(row)
-        end
-      end
-
-      def render_header(category = :main)
-        self[category].render_header
-      end
-
-      def requires_header?(category = :main)
-        self[category].requires_header?
-      end
-
-      def header?(category = :main)
-        self[category].header?
-      end
-    end
-  end
-end