Class: ROM::Files::Relation

Inherits:

Relation

• Object
• Relation
• ROM::Files::Relation

Extended by:

Forwardable

Includes:

Enumerable, ROM::Files

Defined in:

lib/rom/files/relation.rb

Direct Known Subclasses

Extensions::Gem::Relations::Documentations, Extensions::Gem::Relations::Executables, Extensions::Gem::Relations::Implementations, Extensions::Gem::Relations::Specifications

Constant Summary

Constants included from ROM::Files

ALL, DATA, HERE, ID, RECURSIVE_EXPRESSION, RECURSIVE_PATTERN, VERSION

Instance Attribute Summary

• #dataset ⇒ Files::Dataset readonly
• #schema ⇒ Files::Schema readonly

Reading

• #count ⇒ Integer

  Return relation count.

• #inside(*prefixes) ⇒ Relation
• #join(*args) ⇒ Relation
• #mime_type ⇒ MIME::Type^?
• #pluck ⇒ Array
• #project(*names) ⇒ Relation

  Project a relation with provided attribute names.

• #recursive ⇒ Relation
• #recursive? ⇒ Boolean
• #reject(*patterns) ⇒ Relation
• #reject_append(*patterns) ⇒ Relation
• #restrict(criteria = nil) ⇒ Relation
• #select(*patterns) ⇒ Relation
• #select_append(*patterns) ⇒ Relation
• #sort(sorting = :to_s) ⇒ Relation

Writing

• #contents_for(tuple) ⇒ Object
• #create(tuple) ⇒ Object (also: #<<)
• #delete(tuple) ⇒ Object
• #identify(tuple) ⇒ Object
• #update(tuple, attributes = {}) ⇒ Object

Instance Method Summary

• #initialize ⇒ Relation constructor

  :nodoc:.

Constructor Details

#initialize ⇒ Relation

:nodoc:

# File 'lib/rom/files/relation.rb', line 21

def initialize(*) # :nodoc:
  super
  @dataset = @dataset.with(row_proc: schema.row_proc) if schema
end

Instance Attribute Details

#dataset ⇒ Files::Dataset (readonly)

Returns:

• (Files::Dataset)

# File 'lib/rom/files/relation.rb', line 26

#schema ⇒ Files::Schema (readonly)

Returns:

• (Files::Schema)

# File 'lib/rom/files/relation.rb', line 26

Instance Method Details

#contents_for(tuple) ⇒ Object

See Also:

• Schema#contents_for

# File 'lib/rom/files/relation.rb', line 140

def_instance_delegators :schema, :identify, :contents_for

#count ⇒ Integer

Return relation count

Examples:

users.count
# => 12

Returns:

• (Integer)

# File 'lib/rom/files/relation.rb', line 106

def count
  dataset.count
end

#create(tuple) ⇒ Object Also known as: <<

# File 'lib/rom/files/relation.rb', line 112

def create(tuple)
  dataset.write(
    identify(tuple),
    contents_for(tuple)
  )
end

#delete(tuple) ⇒ Object

# File 'lib/rom/files/relation.rb', line 127

def delete(tuple)
  dataset.delete(identify(tuple))
end

#identify(tuple) ⇒ Object

See Also:

• Schema#identify

# File 'lib/rom/files/relation.rb', line 140

def_instance_delegators :schema, :identify, :contents_for

#inside(*prefixes) ⇒ Relation

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 67

forward :select, :select_append, :reject, :reject_append,
:inside, :recursive, :sort, :restrict, :join

#join(*args) ⇒ Relation

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 67

forward :select, :select_append, :reject, :reject_append,
:inside, :recursive, :sort, :restrict, :join

#mime_type ⇒ MIME::Type^?

Returns:

• (MIME::Type, nil)

See Also:

• Dataset::MimeType#mime_type

# File 'lib/rom/files/relation.rb', line 84

def_instance_delegators :dataset, :mime_type, :recursive?, :pluck

#pluck ⇒ Array

Returns:

• (Array)

See Also:

• Dataset::Paths#pluck

# File 'lib/rom/files/relation.rb', line 84

def_instance_delegators :dataset, :mime_type, :recursive?, :pluck

#project(*names) ⇒ Relation

Project a relation with provided attribute names

Parameters:

• names (Array<Symbol>) —

  A list with attribute names

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 93

def project(*names)
  schema.project(*names).(self)
end

#recursive ⇒ Relation

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 67

forward :select, :select_append, :reject, :reject_append,
:inside, :recursive, :sort, :restrict, :join

#recursive? ⇒ Boolean

Returns:

• (Boolean)

See Also:

• Dataset::Filtering#recursive?

# File 'lib/rom/files/relation.rb', line 84

def_instance_delegators :dataset, :mime_type, :recursive?, :pluck

#reject(*patterns) ⇒ Relation

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 67

forward :select, :select_append, :reject, :reject_append,
:inside, :recursive, :sort, :restrict, :join

#reject_append(*patterns) ⇒ Relation

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 67

forward :select, :select_append, :reject, :reject_append,
:inside, :recursive, :sort, :restrict, :join

#restrict(criteria = nil) ⇒ Relation

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 67

forward :select, :select_append, :reject, :reject_append,
:inside, :recursive, :sort, :restrict, :join

#select(*patterns) ⇒ Relation

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 67

forward :select, :select_append, :reject, :reject_append,
:inside, :recursive, :sort, :restrict, :join

#select_append(*patterns) ⇒ Relation

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 67

forward :select, :select_append, :reject, :reject_append,
:inside, :recursive, :sort, :restrict, :join

#sort(sorting = :to_s) ⇒ Relation

Returns:

• (Relation)

# File 'lib/rom/files/relation.rb', line 67

forward :select, :select_append, :reject, :reject_append,
:inside, :recursive, :sort, :restrict, :join

#update(tuple, attributes = {}) ⇒ Object

# File 'lib/rom/files/relation.rb', line 120

def update(tuple, attributes = {})
  dataset.write(
    identify(tuple),
    contents_for(tuple.merge(attributes))
  )
end