Class: Inch::Codebase::ObjectsFilter

Inherits:

Object

Object
Inch::Codebase::ObjectsFilter

Defined in:: lib/inch/codebase/objects_filter.rb

Overview

ObjectsFilter can be used to filter a list of objects by a given set of given options

Instance Attribute Summary collapse

#options ⇒ API::Options::Base readonly

The filter options.

Instance Method Summary collapse

#initialize(list, options) ⇒ ObjectsFilter constructor

A new instance of ObjectsFilter.
#objects ⇒ Array<CodeObject::Proxy>

The filtered list.

Constructor Details

#initialize(list, options) ⇒ `ObjectsFilter`

Returns a new instance of ObjectsFilter.

Parameters:

list (Array<CodeObject::Proxy>) —

the unfiltered list
options (API::Options::Base) —

the filter options

# File 'lib/inch/codebase/objects_filter.rb', line 11

def initialize(list, options)
  @list = list
  @options = options
  filter
end

Instance Attribute Details

#options ⇒ `API::Options::Base` (readonly)

Returns the filter options.

Returns:

(API::Options::Base) —

the filter options



7
8
9

# File 'lib/inch/codebase/objects_filter.rb', line 7

def options
  @options
end

Instance Method Details

#objects ⇒ `Array<CodeObject::Proxy>`

Returns the filtered list.

Returns:

(Array<CodeObject::Proxy>) —

the filtered list



18
19
20

# File 'lib/inch/codebase/objects_filter.rb', line 18

def objects
  @list
end