Class: RuneBlog

Inherits:
Object
  • Object
show all
Extended by:
Helpers
Includes:
Helpers
Defined in:
lib/global.rb,
lib/version.rb,
lib/runeblog.rb

Overview

skeleton

Defined Under Namespace

Modules: Helpers, REPL Classes: Default, Post, Publishing, View

Constant Summary collapse

VERSION =
"0.1.11"
Path =
File.expand_path(File.join(File.dirname(__FILE__)))
DotDir =
".blog"
ConfigFile =
"#{DotDir}/config"

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers

create_dir, dump, error, find_src_slugs, get_views, interpolate, new_dotfile, new_sequence, read_config, subdirs, write_config

Constructor Details

#initializeRuneBlog

assumes existing blog



58
59
60
61
62
63
64
65
66
67
# File 'lib/runeblog.rb', line 58

def initialize   # assumes existing blog
  # Crude - FIXME later - 
  # What views are there? Publishing, etc.
  self.class.blog = self   # Weird. Like a singleton - dumbass circular dependency?
  @root, @view_name, @editor = 
    read_config(ConfigFile, :root, :current_view, :editor)
  @views = get_views
  @view = str2view(@view_name)
  @sequence = get_sequence
end

Class Attribute Details

.blogObject

Returns the value of attribute blog.



30
31
32
# File 'lib/runeblog.rb', line 30

def blog
  @blog
end

Instance Attribute Details

#editorObject (readonly)

Returns the value of attribute editor.



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

def editor
  @editor
end

#rootObject (readonly)

Returns the value of attribute root.



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

def root
  @root
end

#sequenceObject (readonly)

Returns the value of attribute sequence.



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

def sequence
  @sequence
end

#view(name = nil) ⇒ Object

overridden

Raises:

  • (ArgumentError)


35
36
37
# File 'lib/runeblog.rb', line 35

def view
  @view
end

#viewsObject (readonly)

Returns the value of attribute views.



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

def views
  @views
end

Class Method Details

.create_new_blog(dir = ".blog") ⇒ Object



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/runeblog.rb', line 39

def self.create_new_blog(dir = ".blog")
  raise ArgumentError unless dir.is_a?(String) && ! dir.empty?
  root_dir = Dir.pwd + "/" + dir
  raise BlogAlreadyExists if Dir.exist?(root_dir)
  new_dotfile(root: root_dir, current_view: "test_view")
  create_dir(dir)
  Dir.chdir(dir) do
    create_dir("views")
    create_dir("assets")
    create_dir("src")
    new_sequence
  end
  blog = self.new
  blog.create_view("test_view")
rescue => err
  puts "Can't create blog: '#{dir}' - #{err}"  # CHANGE_FOR_CURSES?
  puts err.backtrace.join("\n")  # CHANGE_FOR_CURSES?
end

.exist?Boolean

Returns:

  • (Boolean)


115
116
117
# File 'lib/runeblog.rb', line 115

def self.exist?
  Dir.exist?(DotDir) && File.exist?(ConfigFile)
end

Instance Method Details

#build_post_view(view) ⇒ Object



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/runeblog.rb', line 224

def build_post_view(view)
  # Create dir using slug (index.html, metadata?)
  vdir = self.viewdir(view) # FIXME
  dir = vdir + @meta.slug + "/"
  create_dir(dir + "assets") 
  Dir.chdir(dir) do
    dump(@meta.teaser, "teaser.txt")
    dump(@meta.body, "body.txt")
    # FIXME make get_post_template method
    template = File.read("#{vdir}/custom/post_template.html")
    post = interpolate(template)
    dump(post, "index.html")
  end
  generate_index(view)
rescue => err
  error(err)
end

#change_view(view) ⇒ Object

Raises:

  • (ArgumentError)


200
201
202
203
204
205
206
# File 'lib/runeblog.rb', line 200

def change_view(view)
  raise ArgumentError unless view.is_a?(String) || view.is_a?(RuneBlog::View)
  x = OpenStruct.new
  x.root, x.current_view, x.editor = @root, view.to_s, @editor   # dumb - FIXME later
  write_config(x, ConfigFile)
  self.view = view   # error checking?
end

#create_new_post(meta, testing = false) ⇒ Object

def create_new_post(title, testing = false, teaser = nil, body = nil)



168
169
170
171
172
173
174
175
176
177
178
# File 'lib/runeblog.rb', line 168

def create_new_post(meta, testing = false)
  meta.teaser ||= "Teaser goes here."
  meta.body ||= "Remainder of post goes here."
  post = RuneBlog::Post.new(meta, @view.to_s)
  post.edit unless testing
  post.build
  post.num
rescue => err
  puts err # error(err)  # CHANGE_FOR_CURSES?
  puts err.backtrace.join("\n")  # CHANGE_FOR_CURSES?
end

#create_view(arg) ⇒ Object

Raises:

  • (ArgumentError)


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/runeblog.rb', line 119

def create_view(arg)
  raise ArgumentError unless arg.is_a?(String) && ! arg.empty?
  names = self.views.map(&:to_s)
  raise ViewAlreadyExists(arg) if names.include?(arg)

  dir = "#@root/views/#{arg}/"
  raise DirAlreadyExists(dir) if Dir.exist?(dir)
  create_dir(dir)
  up = Dir.pwd
  Dir.chdir(dir)
  x = RuneBlog::Default
  create_dir('custom')
  create_dir('assets')
  # FIXME dump method??
  pub = "user: xxx\nserver: xxx\ndocroot: xxx\npath: xxx\nproto: xxx\n"
  dump(pub, "publish")  # FIXME publish
  dump(x::BlogHeader, "custom/blog_header.html")
  dump(x::BlogTrailer, "custom/blog_trailer.html")
  dump(x::PostTemplate, "custom/post_template.html")
  dump("Initial creation", "last_published")
  Dir.chdir(up)
  @views << RuneBlog::View.new(arg)
end

#delete_draft(num) ⇒ Object

Raises:

  • (ArgumentError)


341
342
343
344
345
# File 'lib/runeblog.rb', line 341

def delete_draft(num)
  raise ArgumentError unless num.is_a?(Integer)
  tag = prefix(num)
  system("rm -rf #@root/src/#{tag}-*")
end

#delete_view(name, force = false) ⇒ Object

Raises:

  • (ArgumentError)


143
144
145
146
147
148
149
# File 'lib/runeblog.rb', line 143

def delete_view(name, force = false)
  raise ArgumentError unless name.is_a?(String) && ! name.empty?
  if force
    system("rm -rf #@root/views/#{name}") 
    @views -= [str2view(name)]
  end
end

#draftsObject



195
196
197
198
# File 'lib/runeblog.rb', line 195

def drafts
  dir = "#@root/src"
  drafts = Dir.entries(dir).grep(/^\d{4}.*/)
end

#edit_initial_post(file, testing = false) ⇒ Object



180
181
182
183
184
185
186
187
# File 'lib/runeblog.rb', line 180

def edit_initial_post(file, testing = false)
  sourcefile = "#@root/src/#{file}"
  result = system("#@editor #{sourcefile} +8") unless testing
  raise EditorProblem(sourcefile) unless result
  nil
rescue => err
  error(err)
end

#files_by_id(id) ⇒ Object

FIXME get rid of this later

Raises:

  • (ArgumentError)


159
160
161
162
163
164
165
# File 'lib/runeblog.rb', line 159

def files_by_id(id)   # FIXME get rid of this later
  raise ArgumentError unless id.is_a?(Integer)
  files = Find.find(self.view.dir).to_a
  tag = prefix(id)
  result = files.grep(/#{tag}-/)
  result
end

#generate_index(view) ⇒ Object



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
# File 'lib/runeblog.rb', line 242

def generate_index(view)
  raise ArgumentError unless view.is_a?(String) || view.is_a?(RuneBlog::View)
  # Gather all posts, create list
  vdir = "#@root/views/#{view}"
  posts = Dir.entries(vdir).grep /^\d{4}/
  posts = posts.sort.reverse

  # Add view header/trailer
  head = tail = nil
  Dir.chdir(vdir) do 
    head = File.read("custom/blog_header.html")
    tail = File.read("custom/blog_trailer.html")
  end
  @bloghead = interpolate(head)
  @blogtail = interpolate(tail)

  # Output view
  posts.map! do |post|
    meta = nil
    pdir = vdir + "/" + post
    Dir.chdir(pdir) do
      meta = read_config("metadata.txt")
      meta.teaser = File.read("teaser.txt")
      meta.body = File.read("body.txt")
    end
    meta  # block return
  end
  File.open("#{vdir}/index.html", "w") do |f|
    f.puts @bloghead
    posts.each {|post| f.puts index_entry(view, post) }
    f.puts @blogtail
  end
rescue => err
  error(err)
  exit
end

#get_sequenceObject



99
100
101
# File 'lib/runeblog.rb', line 99

def get_sequence
  File.read(root + "/sequence").to_i
end

#index_entry(view, meta) ⇒ Object

Raises:

  • (ArgumentError)


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

def index_entry(view, meta)
  raise ArgumentError unless view.is_a?(String) || view.is_a?(RuneBlog::View)
  meta.slug ||= make_slug(meta.title)
  # FIXME clean up and generalize
  ref = "#{view}/#{meta.slug}/index.html"
  <<-HTML
    <br>
    <font size=+1>#{meta.pubdate}&nbsp;&nbsp;</font>
    <font size=+2 color=blue><a href=../#{ref} style="text-decoration: none">#{meta.title}</font></a>
    <br>
    #{meta.teaser}  
    <a href=../#{ref} style="text-decoration: none">Read more...</a>
    <br><br>
    <hr>
  HTML
end

#make_slug(title, postnum = nil) ⇒ Object

Raises:

  • (ArgumentError)


353
354
355
356
357
358
359
360
# File 'lib/runeblog.rb', line 353

def make_slug(title, postnum = nil)
  debug "title = #{title.inspect} (#{title.class})"
  raise ArgumentError unless title.is_a?(String)
  postnum ||= self.next_sequence
  num = '%04d' % postnum   # FIXME can do better
  slug = title.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
  [postnum, "#{num}-#{slug}"]
end

#next_sequenceObject



103
104
105
106
# File 'lib/runeblog.rb', line 103

def next_sequence
  dump(@sequence += 1, "#@root/sequence")
  @sequence
end

#post_exists?(num) ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (ArgumentError)


347
348
349
350
351
# File 'lib/runeblog.rb', line 347

def post_exists?(num)
  raise ArgumentError unless num.is_a?(Integer)
  list = files_by_id(num)  # FIXME search under view dirs
  list.empty? ? nil : list
end

#postsObject



189
190
191
192
193
# File 'lib/runeblog.rb', line 189

def posts
  dir = self.view.dir
  posts = Dir.entries(dir).grep(/^\d{4}/)
  posts
end

#process_post(file) ⇒ Object



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

def process_post(file)
  raise ArgumentError unless file.is_a?(String)
  path = @root + "/src/#{file}"
  raise FileNotFound(path) unless File.exist?(path)
  livetext = Livetext.new(STDOUT) # (nil)
  @meta = livetext.process_file(path, binding)
  raise LivetextError(path) if @meta.nil?

  num, slug = self.make_slug(@meta.title, self.sequence)
  slug = file.sub(/.lt3$/, "")
  @meta.slug = slug
  @meta
rescue => err
  error(err)
end

#rebuild_post(file) ⇒ Object



300
301
302
303
304
305
306
307
308
309
# File 'lib/runeblog.rb', line 300

def rebuild_post(file)
  debug "Called rebuild_post(#{file.inspect})"
  raise ArgumentError unless file.is_a?(String)
  @meta = process_post(file)
  @meta.views.each do |view| 
    build_post_view(view)
  end
rescue => err
  error(err)
end


279
280
281
# File 'lib/runeblog.rb', line 279

def relink
  self.views.each {|view| generate_index(view) }
end

#remove_post(num) ⇒ Object

Raises:

  • (ArgumentError)


311
312
313
314
315
316
317
318
319
320
321
322
323
324
# File 'lib/runeblog.rb', line 311

def remove_post(num)
  raise ArgumentError unless num.is_a?(Integer)
  tag = prefix(num)
  files = Find.find(self.view.dir).to_a
  list = files.select {|x| File.directory?(x) and x =~ /#{tag}/ }
  return nil if list.empty?
  dest = list.map {|f| f.sub(/(?<num>\d{4}-)/, "_\\k<num>") }
  list.each.with_index do |src, i| 
    cmd = "mv #{src} #{dest[i]} 2>/dev/null"
    system(cmd)
  end
  # FIXME - update index/etc
  true
end

#str2view(str) ⇒ Object

Raises:

  • (ArgumentError)


79
80
81
82
# File 'lib/runeblog.rb', line 79

def str2view(str)
  raise ArgumentError unless str.is_a?(String) && ! str.empty?
  @views.find {|x| x.name == str }
end

#undelete_post(num) ⇒ Object

Raises:

  • (ArgumentError)


326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'lib/runeblog.rb', line 326

def undelete_post(num)
  raise ArgumentError unless num.is_a?(Integer)
  files = Find.find("#@root/views/").to_a
  tag = prefix(num)
  list = files.select {|x| File.directory?(x) and x =~ /_#{tag}/ }
  return nil if list.empty?
  dest = list.map {|f| f.sub(/_(?<num>\d{4}-)/, "\\k<num>") }
  list.each.with_index do |src, i| 
    cmd = "mv #{src} #{dest[i]} 2>/dev/null"
    system(cmd)
  end
  # FIXME - update index/etc
  true
end

#view?(name) ⇒ Boolean

Returns:

  • (Boolean)

Raises:

  • (ArgumentError)


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

def view?(name)
  raise ArgumentError unless name.is_a?(String) && ! name.empty?
  views.any? {|x| x.name == name }
end

#view_filesObject



151
152
153
154
155
156
157
# File 'lib/runeblog.rb', line 151

def view_files
  vdir = @blog.viewdir
  files = ["#{vdir}/index.html"]
  files += posts.map {|x| "#{vdir}/#{x}" }
  # Huh? 
  files.reject! {|f| File.mtime(f) < File.mtime("#{vdir}/last_published") }
end

#viewdir(v = nil) ⇒ Object

Raises:

  • (ArgumentError)


108
109
110
111
112
113
# File 'lib/runeblog.rb', line 108

def viewdir(v = nil)
  v = str2view(v) if v.is_a?(String)
  raise ArgumentError unless v.nil? || v.is_a?(RuneBlog::View)
  v ||= @view
  @root + "/views/#{v}/"
end