Class: Card::Content

Inherits:
SimpleDelegator
  • Object
show all
Extended by:
Clean, Truncate
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/truncate.rb,
card/lib/card/content/diff/l_c_s.rb,
card/lib/card/content/diff/result.rb,
card/lib/card/content/chunk/abstract.rb,
card/lib/card/content/diff/l_c_s/processor.rb,
card-mod-content/lib/card/content/chunk/uri.rb,
card-mod-content/lib/card/content/chunk/link.rb,
card-mod-content/lib/card/content/chunk/nest.rb,
card-mod-content/lib/card/content/chunk/reference.rb,
card-mod-content/lib/card/content/chunk/view_stub.rb,
card-mod-content/lib/card/content/chunk/escaped_literal.rb,
card-mod-content/lib/card/content/chunk/query_reference.rb,
card-mod-content/lib/card/content/chunk/keep_escaped_literal.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, Truncate Classes: Diff, Parser

Constant Summary

Constants included from Clean

Clean::ALLOWED_TAGS, Clean::ATTR_VALUE_RE

Constants included from Truncate

Truncate::ELLIPSES_HTML

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Clean

clean!

Methods included from Truncate

smart_truncate

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


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

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

#chunksObject (readonly)

Returns the value of attribute chunks.



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

def chunks
  @chunks
end

#formatObject (readonly)

Returns the value of attribute format.



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

def format
  @format
end

#optsObject (readonly)

Returns the value of attribute opts.



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

def opts
  @opts
end

#revisionObject (readonly)

Returns the value of attribute revision.



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

def revision
  @revision
end

Instance Method Details

#cardCard

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

Returns:



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

def card
  @format.card
end

#custom_process_chunksObject



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

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

#each_chunkObject



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

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)


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

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)


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

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

#inspectObject



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

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

#piecesObject



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

def pieces
  Array.wrap(__getobj__)
end

#process_chunks(&block) ⇒ Object

sends &block to #process_chunk on each Chunk object



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

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

  each_chunk(&:process_chunk)
end

#to_sObject

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.


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

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



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

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



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

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

#without_references(&block) ⇒ Object



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

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