Class: Card::Content

Inherits:
SimpleDelegator
  • Object
show all
Extended by:
Clean
Defined in:
card/lib/card/content.rb,
card/lib/card/content/all.rb,
card/lib/card/content/diff.rb,
card/lib/card/content/chunk.rb,
card/lib/card/content/clean.rb,
card/lib/card/content/parser.rb,
card/lib/card/content/diff/l_c_s.rb,
card/lib/card/content/diff/result.rb,
card/lib/card/content/diff/summary.rb,
card/lib/card/content/chunk/abstract.rb,
mod/content/lib/card/content/chunk/uri.rb,
mod/content/lib/card/content/chunk/link.rb,
mod/content/lib/card/content/chunk/nest.rb,
card/lib/card/content/diff/l_c_s/processor.rb,
mod/content/lib/card/content/chunk/reference.rb,
mod/content/lib/card/content/chunk/view_stub.rb,
mod/content/lib/card/content/chunk/escaped_literal.rb,
mod/content/lib/card/content/chunk/query_reference.rb

Overview

Content objects support the parsing of content strings into arrays that contain semantically meaningful “chunks” like nests, links, urls, etc.

Each chunk has an object whose class inherits from Chunk::Abstract

Defined Under Namespace

Modules: All, Chunk, Clean Classes: Diff, Parser

Constant Summary

Constants included from Clean

Clean::ALLOWED_TAGS, Clean::ATTR_VALUE_RE

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Clean

clean!

Constructor Details

#initialize(content, format_or_card, opts = {}) ⇒ Content

initialization parses String, detects chunks classes to be used in parsing

Parameters:

  • content (String)
  • format_or_card (Card::Format or Card)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :chunk_list (Symbol) —
    • name of registered list of chunk


22
23
24
25
26
27
28
 
# File 'card/lib/card/content.rb', line 22

def initialize content, format_or_card, opts={}
  @format = resolve_format format_or_card
  opts ||= {}
  chunk_list = opts[:chunk_list] || @format.chunk_list
  @chunks = Parser.new(chunk_list, self).parse(content)
  super(@chunks.any? ? @chunks : content)
end

Instance Attribute Details

#chunks ⇒ Object (readonly)

Returns the value of attribute chunks.



14
15
16
 
# File 'card/lib/card/content.rb', line 14

def chunks
  @chunks
end

#format ⇒ Object (readonly)

Returns the value of attribute format.



14
15
16
 
# File 'card/lib/card/content.rb', line 14

def format
  @format
end

#opts ⇒ Object (readonly)

Returns the value of attribute opts.



14
15
16
 
# File 'card/lib/card/content.rb', line 14

def opts
  @opts
end

#revision ⇒ Object (readonly)

Returns the value of attribute revision.



14
15
16
 
# File 'card/lib/card/content.rb', line 14

def revision
  @revision
end

Instance Method Details

#card ⇒ Card

Content must be associated with a Format object, which in turn must be associated with a Card

Returns:



33
34
35
 
# File 'card/lib/card/content.rb', line 33

def card
  @format.card
end

#custom_process_chunks ⇒ Object 



56
57
58
59
60
 
# File 'card/lib/card/content.rb', line 56

def custom_process_chunks
  each_chunk do |chunk|
    chunk.burn_after_reading yield(chunk)
  end
end

#each_chunk ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'card/lib/card/content.rb', line 66

def each_chunk
  return enum_for(:each_chunk) unless block_given?

  iterator =
    case __getobj__
    when Hash   then :each_value
    when Array  then :each
    when String then return # no chunks
    else
      Rails.logger.warn "unrecognized type for #each_chunk: " \
                        " #{self.class} #{__getobj__.class}"
      return
    end
  send(iterator) { |item| yield item if item.is_a?(Chunk::Abstract) }
end

#find_chunks(chunk_type = nil) ⇒ Array of Chunk instances

Find all chunks of a given type

Parameters:

  • chunk_type (Chunk Class or Symbol) (defaults to: nil)

Returns:

  • (Array of Chunk instances) 


40
41
42
43
 
# File 'card/lib/card/content.rb', line 40

def find_chunks chunk_type=nil
  chunk_type = interpret_chunk_type chunk_type
  each_chunk.select { |chunk| chunk.is_a?(chunk_type) }
end

#has_chunk?(chunk_type) ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'card/lib/card/content.rb', line 45

def has_chunk? chunk_type
  each_chunk.any { |chunk| chunk.is_a?(chunk_type) }
end

#inspect ⇒ Object 



97
98
99
 
# File 'card/lib/card/content.rb', line 97

def inspect
  "<#{__getobj__.class}:#{card}:#{self}>"
end

#pieces ⇒ Object 



62
63
64
 
# File 'card/lib/card/content.rb', line 62

def pieces
  Array.wrap(__getobj__)
end

#process_chunks(&block) ⇒ Object

sends &block to #process_chunk on each Chunk object



50
51
52
53
54
 
# File 'card/lib/card/content.rb', line 50

def process_chunks &block
  return custom_process_chunks(&block) if block_given?

  each_chunk(&:process_chunk)
end

#strip_chunks(chunk_type) ⇒ Object 



120
121
122
 
# File 'card/lib/card/content.rb', line 120

def strip_chunks chunk_type
  chunks.reject! { |c| c.is_a? chunk_type }
end

#strip_nests ⇒ Object 



116
117
118
 
# File 'card/lib/card/content.rb', line 116

def strip_nests
  strip_chunks Chunk::Nest
end

#to_s ⇒ Object

convert content to String. the common cases here are that either

  • (a) content is already a String, or
  • (b) it’s an Array that needs to be iterated over and converted into a a string by running to_s on each item.


88
89
90
91
92
93
94
95
 
# File 'card/lib/card/content.rb', line 88

def to_s
  case __getobj__
  when Array    then map(&:to_s) * ""
  when String   then __getobj__
  when NilClass then "" # raise "Nil Card::Content"
  else               __getobj__.to_s
  end
end

#without_chunks(*chunk_classes) ⇒ Object 



109
110
111
112
113
114
 
# File 'card/lib/card/content.rb', line 109

def without_chunks *chunk_classes
  chunk_classes = ::Set.new Array.wrap(chunk_classes)
  stash = stash_chunks chunk_classes
  processed = yield to_s
  unstash_chunks processed, stash
end

#without_nests(&block) ⇒ Object 



101
102
103
 
# File 'card/lib/card/content.rb', line 101

def without_nests &block
  without_chunks Chunk::Nest, &block
end

#without_references(&block) ⇒ Object 



105
106
107
 
# File 'card/lib/card/content.rb', line 105

def without_references &block
  without_chunks Chunk::Nest, Chunk::Link, Chunk::EscapedLiteral, &block
end