Contents

module ATP
  module Processors
    # Modifies the AST by performing some basic clean up, mainly to sanitize
    # user input. For example it will ensure that all IDs and references are underscored
    # and lower cased.
    class PreCleaner < Processor
      def initialize
        @group_ids = []
      end

      # Make all IDs lower cased symbols
      def on_id(node)
        id = node.to_a[0]
        node.updated(nil, [clean(id)])
      end

      # Make all ID references use the lower case symbols
      def on_if_failed(node)
        id, *children = *node
        node.updated(nil, [clean(id)] + process_all(children))
      end
      alias_method :on_if_passed, :on_if_failed
      alias_method :on_if_any_failed, :on_if_failed
      alias_method :on_if_all_failed, :on_if_failed
      alias_method :on_if_any_passed, :on_if_failed
      alias_method :on_if_all_passed, :on_if_failed
      alias_method :on_if_ran, :on_if_failed
      alias_method :on_unless_ran, :on_if_failed

      def on_group(node)
        if id = node.children.find { |n| n.type == :id }
          @group_ids << process(id).value
        else
          @group_ids << nil
        end
        group = node.updated(nil, process_all(node.children))
        @group_ids.pop
        group
      end

      def on_test(node)
        # Remove IDs nodes from test nodes if they refer to the ID of a parent group
        if @group_ids.last
          children = node.children.reject do |n|
            if n.type == :id
              @group_ids.last == process(n).value
            end
          end
        else
          children = node.children
        end
        node.updated(nil, process_all(children))
      end

      def clean(id)
        if id.is_a?(Array)
          id.map { |i| clean(i) }
        else
          id.to_s.symbolize.to_s
        end
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
atp-1.1.3	lib/atp/processors/pre_cleaner.rb
atp-1.1.2	lib/atp/processors/pre_cleaner.rb
atp-1.1.1	lib/atp/processors/pre_cleaner.rb
atp-1.1.0	lib/atp/processors/pre_cleaner.rb
atp-1.0.0	lib/atp/processors/pre_cleaner.rb