Class: MindWords

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(raws = '', parent: nil, debug: false) ⇒ MindWords

Returns a new instance of MindWords.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/mindwords.rb', line 25

def initialize(raws='', parent: nil, debug: false)

  @parent, @debug = parent, debug

  s, type = RXFHelper.read raws

  @filepath = raws if type == :file or type == :dfs
  lines = (s.strip.gsub(/(^\n|\r)/,'') + "\n").lines.uniq
  lines.shift if lines.first =~ /<\?mindwords\?>/

  @lines = lines.inject([]) do |r,line|

    # the following does 2 things:
    #      1. splits words separated by a bar (|) onto their own line
    #      2. prefixes a word with an underscore if the word is the
    #         same as the hashtag. That way it's not removed by the
    #         redundancy checker

    raw_words, raw_hashtags = line.split(/(?= #)/,2)
    words = raw_words.split(/ *\| */)
    hashtags = raw_hashtags.scan(/(?<=#)\w+/)

    words.each do |word|

      linex = (word +  raw_hashtags)
      r << (hashtags.include?(word) ? linex.sub!(/\b#{word}\b/, '_\0') \
            : linex)
    end

    r
  end

end

Instance Attribute Details

#filepath ⇒ Object

Returns the value of attribute filepath.



23
24
25
 
# File 'lib/mindwords.rb', line 23

def filepath
  @filepath
end

#lines ⇒ Object

Returns the value of attribute lines.



23
24
25
 
# File 'lib/mindwords.rb', line 23

def lines
  @lines
end

Instance Method Details

#add(s) ⇒ Object 



59
60
61
62
63
 
# File 'lib/mindwords.rb', line 59

def add(s)

  @lines.concat s.strip.lines

end

#breadcrumb ⇒ Object 



65
66
67
 
# File 'lib/mindwords.rb', line 65

def breadcrumb()
  @parent.attributes[:breadcrumb].split(/ +\/ +/) if @parent
end

#element(id) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/mindwords.rb', line 74

def element(id)

  doc = Rexle.new(to_xml())
  e =  doc.root.element("//*[@id='#{id}']")
  #e.attributes[:breadcrumb].to_s if e

end

#hashtags(title = nil) ⇒ Object

If title supplied, searches for a requested title and returns the

associated hashtags

When no title is supplied, it will return the hashtags for the

parent element of a search result object



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/mindwords.rb', line 87

def hashtags(title=nil)

  if title then
    found = search(title)
    found.hashtags() if found
  else
    @parent.attributes[:hashtags].split if @parent
  end

end

#headings ⇒ Object 



69
70
71
 
# File 'lib/mindwords.rb', line 69

def headings()
  breadcrumb[0..-2]
end

#linesplus ⇒ Object

same as #lines but inludes the breadcrumb path; Helpful to identify which words don’t have a breadcrumb path.



107
108
109
110
111
112
113
114
 
# File 'lib/mindwords.rb', line 107

def linesplus()

  to_a.map do |word, _|
    r = search word
    r ? [word, r.breadcrumb] : [r, nil]
  end

end

#lookup(s) ⇒ Object

helpful when searching for a word itself using autosuggest



100
101
102
 
# File 'lib/mindwords.rb', line 100

def lookup(s)
  self.to_words.keys.sort.grep /^#{s}/i
end

#reflect(raws) ⇒ Object

Accepts a list of words with the aim of returning a MindWords document using matched words with hashtags from the existing MindWords document.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/mindwords.rb', line 129

def reflect(raws)

  h = to_h

  missing_words = []

  # add the tags from the main list
  a = raws.strip.lines.map do |x|
    if h[x.chomp] then
      [x.chomp, h[x.chomp]]
    else
      missing_words << x
      nil
    end
  end.compact

  # add any linkage words from the tags
  #
  a.map(&:last).flatten(1).each do |s|

    a << [s, h[s]] if h[s]

  end

  # remove suplicates lines and transform it into a raw mindwords format
  #
  raws3 = a.uniq.map {|s,tags| [s, tags.map {|x| '#' + x }.join(' ')].join(' ') }.join("\n")

  [MindWords.new(raws3), missing_words]

end

#save(file = @filepath) ⇒ Object 



116
117
118
119
120
121
122
123
124
 
# File 'lib/mindwords.rb', line 116

def save(file=@filepath)

  return if @lines.empty?

  puts 'before save' if @debug

  File.write file, to_s()

end

#search(keyword, succinct: true) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/mindwords.rb', line 161

def search(keyword, succinct: true)

  a = @lines.grep(/#{keyword}/i).map do |line|

    puts 'line: ' + line.inspect if @debug

    words = line.split
    r = words.grep /#{keyword}/i
    i = words.index r[0]

    [line, i]

  end

  return nil if a.empty?
  #return a[0][0] if a.length < 2

  a2 = a.sort_by(&:last).map(&:first)
  puts 'a2: ' + a2.inspect if @debug
  e = element(keyword.downcase.gsub(/ +/,'-'))

  return MindWords.new(a2.uniq.join,  debug: @debug) if e.nil?

  # find and add any linkage support lines
  #

  a3 = []

  a2.each do |line|

    line.chomp.scan(/#[^ ]+/).each do |hashtag|

      puts 'hashtag: ' + hashtag.inspect  if @debug
      r2 = @lines.grep(/^#{hashtag[1..-1]} #/)
      a3 << r2.first if r2

    end
  end

  puts 'a2: ' + a2.inspect if @debug
  a2.concat a3

  if succinct then
    MindWords.new(a2.uniq.join, parent: e, debug: @debug)
  else
    MindWords.new(a2.uniq.join,  debug: @debug)
  end

end

#sort ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/mindwords.rb', line 211

def sort()
  s = @lines.sort.join

  def s.to_s()
    self.lines.map do |x|
      title, hashtags = x.split(/(?=#)/,2)
      title + hashtags.chomp.brown
    end.join("\n")
  end

  return s
end

#sort! ⇒ Object 



224
225
226
227
 
# File 'lib/mindwords.rb', line 224

def sort!()
  @lines = sort().lines
  self
end

#tag_sort ⇒ Object 



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/mindwords.rb', line 229

def tag_sort()

  h = @lines.group_by  {|x| x[/#\w+/]}
  s = h.sort.map {|key, value| value.sort }.join

  def s.to_s()
    self.lines.map do |x|
      title, hashtags = x.split(/(?=#)/,2)
      title + hashtags.chomp.brown
    end.join("\n")
  end

  return s

end

#tag_sort! ⇒ Object 



245
246
247
248
 
# File 'lib/mindwords.rb', line 245

def tag_sort!()
  @lines = tag_sort().lines
  self
end

#to_a ⇒ Object 



250
251
252
253
254
255
256
257
 
# File 'lib/mindwords.rb', line 250

def to_a()

  @lines.map do |x|
    s, rawtags = x.split(/(?= #)/,2)
    [s, rawtags.scan(/(?<=#)\w+/)]
  end

end

#to_h ⇒ Object 



259
260
261
 
# File 'lib/mindwords.rb', line 259

def to_h()
  to_a.to_h
end

#to_hashtags ⇒ Object 



263
264
265
 
# File 'lib/mindwords.rb', line 263

def to_hashtags()
  @hashtags
end

#to_outline(sort: true) ⇒ Object Also known as: to_tree 



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/mindwords.rb', line 267

def to_outline(sort: true)

  build()

  if sort then
    a = LineTree.new(@outline).to_a
    puts ('a: ' + a.inspect).debug if @debug
    a2tree(tree_sort(a))
  else
    @outline
  end

end

#to_s(colour: false) ⇒ Object 



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/mindwords.rb', line 283

def to_s(colour: false)

  header = "<?mindwords?>\n\n"
  return header + @lines.map(&:chomp).join("\n") unless colour

  body = @lines.map do |x|
      title, hashtags = x.split(/(?=#)/,2)
      title + hashtags.chomp.brown
  end.join("\n")

  header + body

end

#to_words ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/mindwords.rb', line 297

def to_words()

  h = {}

  Rexle.new(to_xml).root.each_recursive do |e|

    h[e.attributes[:title]] = {
      breadcrumb: e.attributes[:breadcrumb],
      hashtags: e.attributes[:hashtags]
    }

  end

  h

end

#to_xml ⇒ Object 



314
315
316
317
 
# File 'lib/mindwords.rb', line 314

def to_xml()
  build() unless @xml
  @xml
end