Class: Spidr::Rules

Inherits:
Object
  • Object
show all
Defined in:
lib/spidr/rules.rb

Overview

The Rules class represents collections of acceptance and rejection rules, which are used to filter data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Rules

Creates a new Rules object.

Parameters:

  • options (Hash) (defaults to: {}) —

    Additional options.

Options Hash (options):

  • :accept (Array<String, Regexp, Proc>) —

    The patterns to accept data with.

  • :reject (Array<String, Regexp, Proc>) —

    The patterns to reject data with.



26
27
28
29
30
31
32
 
# File 'lib/spidr/rules.rb', line 26

def initialize(options={})
  @accept = []
  @reject = []

  @accept += options[:accept] if options[:accept]
  @reject += options[:reject] if options[:reject]
end

Instance Attribute Details

#accept ⇒ Object (readonly)

Accept rules



9
10
11
 
# File 'lib/spidr/rules.rb', line 9

def accept
  @accept
end

#reject ⇒ Object (readonly)

Reject rules



12
13
14
 
# File 'lib/spidr/rules.rb', line 12

def reject
  @reject
end

Instance Method Details

#accept?(data) ⇒ Boolean

Determines whether the data should be accepted or rejected.

Returns:

  • (Boolean) —

    Specifies whether the given data was accepted, using the rules acceptance patterns.



41
42
43
44
45
46
47
 
# File 'lib/spidr/rules.rb', line 41

def accept?(data)
  unless @accept.empty?
    @accept.any? { |rule| test_data(data,rule) }
  else
    !@reject.any? { |rule| test_data(data,rule) }
  end
end

#reject?(data) ⇒ Boolean

Determines whether the data should be rejected or accepted.

Returns:

  • (Boolean) —

    Specifies whether the given data was rejected, using the rules rejection patterns.



56
57
58
 
# File 'lib/spidr/rules.rb', line 56

def reject?(data)
  !accept?(data)
end

#test_data(data, rule) ⇒ Boolean (protected)

Tests the given data against a given pattern.

Returns:

  • (Boolean) —

    Specifies whether the given data matched the pattern.



68
69
70
71
72
73
74
75
76
 
# File 'lib/spidr/rules.rb', line 68

def test_data(data,rule)
  if rule.kind_of?(Proc)
    rule.call(data) == true
  elsif rule.kind_of?(Regexp)
    !((data.to_s =~ rule).nil?)
  else
    data == rule
  end
end