rethoth 0.4.1

data/lib/thoth/migrate/007_add_comment_summary.rb

@@ -0,0 +1,37 @@
+#--
+# Copyright (c) 2009 Ryan Grove <ryan@wonko.com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#   * Neither the name of this project nor the names of its contributors may be
+#     used to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#++
+
+class AddCommentSummary < Sequel::Migration
+  def down
+    drop_column(:comments, :summary)
+  end
+
+  def up
+    add_column(:comments, :summary, :varchar, :default => '', :null => false)
+  end
+end

data/lib/thoth/model/comment.rb

@@ -0,0 +1,216 @@
+#--
+# Copyright (c) 2009 Ryan Grove <ryan@wonko.com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#   * Neither the name of this project nor the names of its contributors may be
+#     used to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#++
+
+require 'digest/md5'
+require 'strscan'
+
+module Thoth
+  class Comment < Sequel::Model
+    plugin :hook_class_methods
+    plugin :validation_helpers
+
+    CONFIG_SANITIZE = {
+      :elements => [
+        'a', 'b', 'blockquote', 'br', 'code', 'dd', 'dl', 'dt', 'em', 'i',
+        'li', 'ol', 'p', 'pre', 'small', 'strike', 'strong', 'sub', 'sup',
+        'u', 'ul'
+      ],
+
+      :attributes => {
+        'a'          => ['href', 'title'],
+        'blockquote' => ['cite'],
+        'pre'        => ['class']
+      },
+
+      :add_attributes => {'a' => {'rel' => 'nofollow'}},
+      :protocols => {'a' => {'href' => ['ftp', 'http', 'https', 'mailto']}}
+    }
+
+    before_create do
+      self.created_at = Time.now
+    end
+
+    before_save do
+      self.updated_at = Time.now
+    end
+
+    #--
+    # Class Methods
+    #++
+
+    # Recently-posted comments (up to _limit_) sorted in reverse order by
+    # creation time.
+    def self.recent(page = 1, limit = 10)
+      filter(:deleted => false).reverse_order(:created_at).paginate(page, limit)
+    end
+
+    #--
+    # Instance Methods
+    #++
+
+    def author=(author)
+      self[:author] = author.strip unless author.nil?
+    end
+
+    def author_email=(email)
+      @gravatar_url = nil
+      self[:author_email] = email.strip unless email.nil?
+    end
+
+    def author_url=(url)
+      self[:author_url] = url.strip unless url.nil?
+    end
+
+    def body=(body)
+      body = body.force_encoding('utf-8')
+      redcloth = RedCloth.new(body, [:filter_styles])
+
+      self[:body]          = body
+      self[:body_rendered] = insert_breaks(Sanitize.clean(redcloth.to_html(
+        :refs_textile,
+        :block_textile_lists,
+        :inline_textile_link,
+        :inline_textile_code,
+        :glyphs_textile,
+        :inline_textile_span
+      ), CONFIG_SANITIZE))
+
+      summary = Sanitize.clean(body[0..128].gsub(/[\r\n]/, ' '))
+
+      if summary.length >= 64
+        summary = summary[0..64] + '...'
+      end
+
+      self[:summary] = summary
+    end
+
+    # Gets the creation time of this comment. If _format_ is provided, the time
+    # will be returned as a formatted String. See Time.strftime for details.
+    def created_at(format = nil)
+      if new?
+        format ? Time.now.strftime(format) : Time.now
+      else
+        format ? self[:created_at].strftime(format) : self[:created_at]
+      end
+    end
+
+    # Gets the Gravatar URL for this comment.
+    def gravatar_url
+      return @gravatar_url if @gravatar_url
+
+      md5     = Digest::MD5.hexdigest((author_email || author).downcase)
+      default = CGI.escape(Config.site['gravatar']['default'])
+      rating  = Config.site['gravatar']['rating']
+      size    = Config.site['gravatar']['size']
+
+      @gravatar_url = "http://www.gravatar.com/avatar/#{md5}.jpg?d=#{default}&r=#{rating}&s=#{size}"
+    end
+
+    # Gets the post to which this comment is attached.
+    def post
+      @post ||= Post[post_id]
+    end
+
+    def relative_url
+      new? ? '#' : "#comment-#{id}"
+    end
+
+    def title=(title)
+      self[:title] = title.strip unless title.nil?
+    end
+
+    # Gets the time this comment was last updated. If _format_ is provided, the
+    # time will be returned as a formatted String. See Time.strftime for details.
+    def updated_at(format = nil)
+      if new?
+        format ? Time.now.strftime(format) : Time.now
+      else
+        format ? self[:updated_at].strftime(format) : self[:updated_at]
+      end
+    end
+
+    # URL for this comment.
+    def url
+      new? ? '#' : post.url + "#comment-#{id}"
+    end
+
+    def validate
+      validates_presence(:author, :message => 'Please enter your name.')
+
+      validates_max_length(64,    :author,       :message => 'Please enter a name under 64 characters.')
+      validates_max_length(255,   :author_email, :message => 'Please enter a shorter email address.')
+      validates_max_length(255,   :author_url,   :message => 'Please enter a shorter URL.')
+      validates_max_length(65536, :body,         :message => 'You appear to be writing a novel. Please try to keep it under 64K.')
+
+      validates_format(/[^\s@]+@[^\s@]+\.[^\s@]+/,    :author_email, :message => 'Please enter a valid email address.')
+      validates_format(/^(?:$|https?:\/\/\S+\.\S+)/i, :author_url,   :message => 'Please enter a valid URL or leave the URL field blank.')
+    end
+
+    protected
+
+    # Inserts <wbr /> tags in long strings without spaces, while being careful
+    # not to break HTML tags.
+    def insert_breaks(str, length = 30)
+      scanner = StringScanner.new(str)
+
+      char    = ''
+      count   = 0
+      in_tag  = 0
+      new_str = ''
+
+      while char = scanner.getch do
+        case char
+        when '<'
+          in_tag += 1
+
+        when '>'
+          in_tag -= 1
+          in_tag = 0 if in_tag < 0
+
+        when /\s/
+          count = 0 if in_tag == 0
+
+        else
+          if in_tag == 0
+            if count == length
+              new_str << '<wbr />'
+              count = 0
+            end
+
+            count += 1
+          end
+        end
+
+        new_str << char
+      end
+
+      return new_str
+    end
+
+  end
+end

data/lib/thoth/model/media.rb

@@ -0,0 +1,87 @@
+#--
+# Copyright (c) 2009 Ryan Grove <ryan@wonko.com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#   * Neither the name of this project nor the names of its contributors may be
+#     used to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#++
+
+module Thoth
+  class Media < Sequel::Model(:media)
+    plugin :hook_class_methods
+
+    before_create do
+      self.created_at = Time.now
+    end
+
+    before_destroy do
+      FileUtils.rm(path)
+    end
+
+    before_save do
+      self.updated_at = Time.now
+    end
+
+    # Gets the creation time of this file. If _format_ is provided, the time
+    # will be returned as a formatted String. See Time.strftime for details.
+    def created_at(format = nil)
+      if new?
+        format ? Time.now.strftime(format) : Time.now
+      else
+        format ? self[:created_at].strftime(format) : self[:created_at]
+      end
+    end
+
+    def filename=(filename)
+      self[:filename] = filename.strip unless filename.nil?
+    end
+
+    # Gets the absolute path to this file.
+    def path
+      File.join(Config.media, filename[0].chr.downcase, filename)
+    end
+
+    def size
+      return self[:size] unless self[:size] == 0 && File.exist?(path)
+
+      self[:size] = File.size(path)
+      save
+      self[:size]
+    end
+
+    # Gets the time this file was last updated. If _format_ is provided, the time
+    # will be returned as a formatted String. See Time.strftime for details.
+    def updated_at(format = nil)
+      if new?
+        format ? Time.now.strftime(format) : Time.now
+      else
+        format ? self[:updated_at].strftime(format) : self[:updated_at]
+      end
+    end
+
+    # URL for this file.
+    def url
+      Config.site['url'].chomp('/') + MediaController.r(:/, filename).to_s
+    end
+  end
+end

data/lib/thoth/model/page.rb

@@ -0,0 +1,204 @@
+#--
+# Copyright (c) 2017 John Pagonis <john@pagonis.org>
+# Copyright (c) 2009 Ryan Grove <ryan@wonko.com>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+#   * Redistributions of source code must retain the above copyright notice,
+#     this list of conditions and the following disclaimer.
+#   * Redistributions in binary form must reproduce the above copyright notice,
+#     this list of conditions and the following disclaimer in the documentation
+#     and/or other materials provided with the distribution.
+#   * Neither the name of this project nor the names of its contributors may be
+#     used to endorse or promote products derived from this software without
+#     specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#++
+
+module Thoth
+  class Page < Sequel::Model
+    include Thoth::Helper::Wiki
+
+    plugin :hook_class_methods
+    plugin :validation_helpers
+    plugin :blacklist_security
+
+    after_destroy do
+      Page.normalize_positions
+    end
+
+    before_create do
+      self.created_at = Time.now
+    end
+
+    before_save do
+      self.updated_at = Time.now
+    end
+
+    set_restricted_columns :position
+
+    #--
+    # Class Methods
+    #++
+
+    # Returns true if the specified page name is already taken or is a reserved
+    # name.
+    def self.name_unique?(name)
+      !PageController.methods.include?(name) &&
+          !PageController.instance_methods.include?(name) &&
+          !Page[:name => name.to_s.downcase]
+    end
+
+    # Returns true if the specified page name consists of valid characters and
+    # is not too long or too short.
+    def self.name_valid?(name)
+      !!(name =~ /^[0-9a-z_-]{1,64}$/i)
+    end
+
+    # Adjusts the position values of all pages, resolving duplicate positions
+    # and eliminating gaps.
+    def self.normalize_positions
+      db.transaction do
+        i = 1
+
+        order(:position).all do |page|
+          unless page.position == i
+            filter(:id => page.id).update(:position => i)
+          end
+
+          i += 1
+        end
+      end
+    end
+
+    # Sets the display position of the specified page, adjusting the position of
+    # other pages as necessary.
+    def self.set_position(page, pos)
+      unless page.is_a?(Page) || page = Page[page.to_i]
+        raise ArgumentError, "Invalid page id: #{page}"
+      end
+
+      pos     = pos.to_i
+      cur_pos = page.position
+
+      unless pos > 0
+        raise ArgumentError, "Invalid position: #{pos}"
+      end
+
+      db.transaction do
+        if pos < cur_pos
+          filter{:position >= pos && :position < cur_pos}.
+              update(:position => 'position + 1'.lit)
+        elsif pos > cur_pos
+          filter{:position > cur_pos && :position <= pos}.
+              update(:position => 'position - 1'.lit)
+        end
+
+        filter(:id => page.id).update(:position => pos)
+      end
+    end
+
+    # Returns a valid, unique page name based on the specified title. If the
+    # title is empty or cannot be converted into a valid name, an empty string
+    # will be returned.
+    def self.suggest_name(title)
+      index = 1
+
+      # Remove HTML entities and non-alphanumeric characters, replace spaces
+      # with hyphens, and truncate the name at 64 characters.
+      name = title.to_s.strip.downcase.gsub(/&[^\s;]+;/, '_').
+          gsub(/[^\s0-9a-z-]/, '').gsub(/\s+/, '-')[0..63]
+
+      # Strip off any trailing non-alphanumeric characters.
+      name.gsub!(/[_-]+$/, '')
+
+      return '' if name.empty?
+
+      # Ensure that the name doesn't conflict with any methods on the Page
+      # controller and that no two pages have the same name.
+      until self.name_unique?(name)
+        if name[-1] == index
+          name[-1] = (index += 1).to_s
+        else
+          name = name[0..62] if name.size >= 64
+          name += (index += 1).to_s
+        end
+      end
+
+      return name
+    end
+
+    #--
+    # Instance Methods
+    #++
+
+    def body=(body)
+      self[:body]          = body.strip
+      self[:body_rendered] = RedCloth.new(wiki_to_html(body.dup.strip)).to_html
+    end
+
+    # Gets the creation time of this page. If _format_ is provided, the time
+    # will be returned as a formatted String. See Time.strftime for details.
+    def created_at(format = nil)
+      if new?
+        format ? Time.now.strftime(format) : Time.now
+      else
+        format ? self[:created_at].strftime(format) : self[:created_at]
+      end
+    end
+
+    def name=(name)
+      self[:name] = name.strip.downcase unless name.nil?
+    end
+
+    def title=(title)
+      title.strip!
+
+      # Set the page name if it isn't already set.
+      if self[:name].nil? || self[:name].empty?
+        self[:name] = Page.suggest_name(title)
+      end
+
+      self[:title] = title
+    end
+
+    # Gets the time this page was last updated. If _format_ is provided, the time
+    # will be returned as a formatted String. See Time.strftime for details.
+    def updated_at(format = nil)
+      if new?
+        format ? Time.now.strftime(format) : Time.now
+      else
+        format ? self[:updated_at].strftime(format) : self[:updated_at]
+      end
+    end
+
+    # URL for this page.
+    def url
+      Config.site['url'].chomp('/') + PageController.r(:/, name).to_s
+    end
+
+    def validate
+      validates_presence(:name,  :message => 'Please enter a name for this page.')
+      validates_presence(:title, :message => 'Please enter a title for this page.')
+      validates_presence(:body,  :message => "Come on, I'm sure you can think of something to write.")
+
+      validates_max_length(255, :title, :message => 'Please enter a title under 255 characters.')
+      validates_max_length(64,  :name,  :message => 'Please enter a name under 64 characters.')
+
+      validates_format(/^[0-9a-z_-]+$/i, :name, :message => 'Page names may only contain letters, numbers, underscores, and dashes.')
+    end
+
+  end
+end