aerial 0.0.0

data/lib/aerial/base.rb

@@ -0,0 +1,172 @@
+CONFIG = YAML.load_file( File.join(AERIAL_ROOT, 'config', 'config.yml') ) unless defined?(CONFIG)
+
+require 'aerial/content'
+require 'aerial/article'
+require 'aerial/comment'
+require 'aerial/vendor/cache'
+require 'aerial/vendor/akismetor'
+require 'aerial/config'
+
+module Aerial
+
+  VERSION = '0.1.0'
+
+  class << self
+    attr_accessor :debug, :logger, :repo, :config
+
+    def log(str)
+      logger.debug { str } if debug
+    end
+  end
+
+  # Make sure git is added to the env path
+  ENV['PATH'] = "#{ENV['PATH']}:/usr/local/bin"
+  @logger ||= ::Logger.new(STDOUT)
+  @config ||= Aerial::Config.new(CONFIG)
+  @repo   ||= Grit::Repo.new(File.join(AERIAL_ROOT, '.'))
+  @debug  ||= false
+
+  module Helper
+
+    # Defines the url for our application
+    def hostname
+      if request.env['HTTP_X_FORWARDED_SERVER'] =~ /[a-z]*/
+        request.env['HTTP_X_FORWARDED_SERVER']
+      else
+        request.env['HTTP_HOST']
+      end
+    end
+
+    # Returns the
+    def path
+      base = "#{request.env['REQUEST_URI']}".scan(/\w+/).first
+      return base.blank? ? "index" : base
+    end
+
+    # Creates a complete link including the hostname
+    def full_hostname(link = "")
+      "http://#{hostname}#{link}"
+    end
+
+    # Display the page titles in proper format
+    def page_title
+      title = @page_title ? "| #{@page_title}" : ""
+      return "#{Aerial.config.title} #{title}"
+    end
+
+    # Format just the DATE in a nice easy to read format
+    def humanized_date(date)
+      if date && date.respond_to?(:strftime)
+        date.strftime('%A %B, %d %Y').strip
+      else
+        'Never'
+      end
+    end
+
+    # Format just the DATE in a short way
+    def short_date(date)
+      if date && date.respond_to?(:strftime)
+        date.strftime('%b %d').strip
+      else
+        'Never'
+      end
+    end
+
+    # Format for the rss 2.0 feed
+    def rss_date(date)
+      date.strftime("%a, %d %b %Y %H:%M:%S %Z") #Tue, 03 Jun 2003 09:39:21 GMT
+    end
+
+    # Truncate a string
+    def blurb(text, options ={})
+      options.merge!(:length => 160, :omission => "...")
+      if text
+        l = options[:length] - options[:omission].length
+        chars = text
+        (chars.length > options[:length] ? chars[0...l] + options[:omission] : text).to_s
+      end
+    end
+
+    # Handy method to render partials including collections
+    def partial(template, options = {})
+      options.merge!(:layout => false)
+      return if options.has_key?(:collection) && options[:collection].nil?
+
+      if collection = options.delete(:collection) then
+        collection.inject([]) do |buffer, member|
+          buffer << haml(template, options.merge(:layout => false,
+                                                 :locals => {template.to_sym => member}))
+        end.join("\n")
+      else
+         haml(template, options)
+      end
+    end
+
+    # Author link
+    def link_to_author(comment)
+      unless comment.homepage.blank?
+        return "<a href='#{comment.homepage}' rel='external'>#{comment.author}</a>"
+      end
+      comment.author
+    end
+
+    # Create a list of hyperlinks with a set of tags
+    def link_to_tags(tags)
+      return unless tags
+      links = []
+      tags.each do |tag|
+        links << "<a href='/tags/#{tag}' rel='#{tag}'>#{tag}</a>"
+      end
+      links.join(", ")
+    end
+
+  end
+
+  # Provides a few methods for interacting with that Aerial repository
+  class Git
+
+    # Commit the new file and push it to the remote repository
+    def self.commit_and_push(path, message)
+      self.commit(path, message)
+      self.push
+    end
+
+    # Added the file in the path and commit the changs to the repo
+    #   +path+ to the new file to commit
+    #   +message+ description of the commit
+    def self.commit(path, message)
+      Dir.chdir(File.expand_path(Aerial.repo.working_dir)) do
+        Aerial.repo.add(path)
+      end
+      Aerial.repo.commit_index(message)
+    end
+
+    # Adds all untracked files and commits them to the repo
+    def self.commit_all(path = ".", message = "Commited all changes at: #{DateTime.now}")
+      unless Aerial.repo.status.untracked.empty?
+        self.commit(path, message)
+      end
+      true
+    end
+
+    # Upload all new commits to the remote repo (if exists)
+    def self.push
+      return unless Aerial.config.git.name && Aerial.config.git.branch
+
+      begin
+        cmd = "push #{Aerial.config.git.name} #{Aerial.config.git.branch} "
+        Aerial.repo.git.run('', cmd, '', {}, "")
+      rescue Exception => e
+        Aerial.log(e.message)
+      end
+    end
+
+  end
+
+end
+
+class Object
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+end

data/lib/aerial/comment.rb

@@ -0,0 +1,160 @@
+module Aerial
+
+  # Anonymous feedback
+  class Comment < Content
+
+    attr_reader   :id,           :permalink, :article,      :spam,       :file_path
+    attr_accessor :archive_name, :spam,      :published_at, :name,       :referrer,
+                  :email,        :homepage,  :user_ip,      :user_agent, :file_name
+
+    def initialize(atts = {})
+      super
+      sanitize_url
+    end
+
+    # =============================================================================================
+    # PUBLIC CLASS METHODS
+    # =============================================================================================
+
+    # Create a new instance and write comment to disk
+    #   +path+ the file location of the comment
+    def self.create(archive_name, attributes ={})
+      comment = Comment.new(attributes.merge(:archive_name => archive_name))
+      if comment.valid?
+        return self.save_new(comment)
+      end
+      false
+    end
+
+    # Open and existing comment
+    #   +data+ contains info about the comment
+    def self.open(data, options={})
+      self.new( self.extract_comment_from(data, options) )
+    end
+
+    # =============================================================================================
+    # PUBLIC INSTANCE METHODS
+    # =============================================================================================
+
+    # Save the instance to disk
+    #   +archive_name+ the parent directory of the article, we're forcing the parameter to ensure
+    #   the archive_name is established before attemping to write it to disk
+    def save(archive_name)
+      self.archive_name = archive_name
+      if File.directory? self.archive_path
+        Comment.save_new(self)
+      end
+    end
+
+    # Absolute path of the comment file
+    def expand_file
+      return unless self.archive_name
+      File.join(self.archive_path, self.name)
+    end
+
+    # The absolute file path of the archive
+    def archive_path
+      File.join(Aerial.repo.working_dir, Aerial.config.articles.dir, self.archive_name)
+    end
+
+    # Make sure comment has the required data
+    def valid?
+      return false if self.email.blank? || self.author.blank? || self.body.blank?
+      true
+    end
+
+    # Ask Akismetor if comment is spam
+    def suspicious?
+      return self.spam if self.spam
+      self.spam = Akismetor.spam?(akismet_attributes)
+    end
+
+    # Create a unique file name for this comment
+    def generate_name!
+      return self.name unless self.name.nil?
+
+      extenstion = self.suspicious? ? "spam" : "comment"
+      self.name = "#{DateTime.now.strftime("%Y%m%d%H%d%S")}_#{self.email}.#{extenstion}"
+    end
+
+    # String representation
+    def to_s
+      me = ""
+      me << "Author: #{self.author} \n" if self.author
+      me << "Published: #{self.published_at} \n" if self.published_at.to_s
+      me << "Email: #{self.email} \n" if self.email
+      me << "Homepage: #{self.homepage} \n" if self.homepage
+      me << "User IP: #{self.user_ip} \n" if self.user_ip
+      me << "User Agent: #{self.user_agent} \n" if self.user_agent
+      me << "Spam?: #{self.spam} \n" if self.user_agent
+      me << "\n#{self.body}" if self.body
+      return me
+    end
+
+    private
+
+    # =============================================================================================
+    # PRIVATE CLASS METHODS
+    # =============================================================================================
+
+    # Create a new Comment instance with data from the given file
+    def self.extract_comment_from(data, options = {})
+      comment_file          = data.to_s
+      comment               = options
+      comment[:id]          = self.extract_header("id", comment_file)
+      comment[:user_ip]     = self.extract_header("ip", comment_file)
+      comment[:user_agent]  = self.extract_header("user-agent", comment_file)
+      comment[:referrer]    = self.extract_header("referrer", comment_file)
+      comment[:permalink]   = self.extract_header("permalink", comment_file)
+      comment[:author]      = self.extract_header("author", comment_file)
+      comment[:email]       = self.extract_header("email", comment_file)
+      comment[:homepage]    = self.extract_header("homepage", comment_file)
+      comment[:published_at]= DateTime.parse(self.extract_header("published", comment_file))
+      comment[:body]        = self.scan_for_field(comment_file, self.body_field)
+      return comment
+    end
+
+    # Write the contents of the comment to the same directory as the article
+    def self.save_new(comment)
+      return false unless comment && comment.archive_name
+      comment.generate_name!
+      comment.published_at = DateTime.now
+      path = File.join(Aerial.config.articles.dir, comment.archive_name, comment.name)
+      Dir.chdir(Aerial.repo.working_dir) do
+        File.open(path, 'w') do |file|
+          file << comment.to_s
+        end
+      end
+      Aerial::Git.commit_and_push(path, "New comment: #{comment.name}")
+      return comment
+    end
+
+    # =============================================================================================
+    # PRIVATE INSTANCE METHODS
+    # =============================================================================================
+
+    # Make sure the url is cleaned
+    def sanitize_url
+      return unless self.homepage
+      homepage.gsub!(/^(.*)/, 'http://\1') unless homepage =~ %r{^http://} or homepage.empty?
+    end
+
+    # Try to prevent spam with akismet
+    def akismet_attributes
+      {
+        :key                  => Aerial.config.akismet.key,
+        :blog                 => Aerial.config.akismet.url,
+        :user_ip              => self.user_ip,
+        :user_agent           => self.user_agent,
+        :referrer             => self.referrer,
+        :permalink            => self.permalink,
+        :comment_type         => 'comment',
+        :comment_author       => self.author,
+        :comment_author_email => self.email,
+        :comment_author_url   => self.homepage,
+        :comment_content      => self.body
+      }
+    end
+
+  end
+end

data/lib/aerial/config.rb

@@ -0,0 +1,41 @@
+module Aerial
+
+  class Config
+
+    class << self
+      attr_accessor :config
+    end
+
+    def initialize(yaml)
+      @config = nested_hash_to_openstruct(yaml)
+    end
+
+    # Complete path to the directory theme
+    def theme_directory
+      directory = File.join(AERIAL_ROOT, self.views.dir)
+      File.join(directory)
+    end
+
+    def method_missing(method_name, *attributes)
+      if @config.respond_to?(method_name.to_sym)
+        return @config.send(method_name.to_sym)
+      else
+        false
+      end
+    end
+
+    private
+
+    # Recursively convert nested Hashes into Openstructs
+    def nested_hash_to_openstruct(obj)
+      if obj.is_a? Hash
+        obj.each { |key, value| obj[key] = nested_hash_to_openstruct(value) }
+        OpenStruct.new(obj)
+      else
+        return obj
+      end
+    end
+
+  end
+
+end

data/lib/aerial/content.rb

@@ -0,0 +1,74 @@
+require 'coderay'
+require 'date'
+
+module Aerial
+
+  # Base class for all the site's content
+  class Content
+
+    attr_reader :id, :author, :title, :body, :published_at, :archive_name, :file_name
+
+    def initialize(atts = {})
+      atts.each_pair { |key, value| instance_variable_set("@#{key}", value) if self.respond_to? key}
+    end
+
+    protected
+
+    # =============================================================================================
+    # PROTECTED CLASS METHODS
+    # =============================================================================================
+
+    # With the comment string, attempt to find the given field
+    #   +field+ the label before the ":"
+    #   +comment+ is the contents of the comment
+    def self.extract_header(field, content)
+      return self.scan_for_field(content, self.header_field_for(field))
+    end
+
+    # Returns the string that matches the given pattern
+    def self.scan_for_field(contents, pattern)
+      content = contents.scan(pattern).first.to_s.strip
+    end
+
+    # Returns the regular expression pattern for the header fields
+    def self.header_field_for(header)
+      exp = Regexp.new('^'+header+'\s*:(.*)$', Regexp::IGNORECASE)
+    end
+
+    # Returns the regular expression pattern for the body field
+    def self.body_field
+      exp = Regexp.new('^\n(.*)$', Regexp::MULTILINE)
+    end
+
+    # Look for <code> blocks and convert it for syntax highlighting
+    def self.parse_coderay(text)
+      text.scan(/(\<code>(.+?)\<\/code>)/m).each do |match|
+         match[1] = match[1].gsub("<br>", "\n").
+           gsub("&amp;nbsp;", " ").
+           gsub("&amp;lt;", "<").
+           gsub("&amp;gt;", ">").
+           gsub("&amp;quot;", '"')
+        text.gsub!(match[0], CodeRay.scan(match[1].strip, :ruby).div(:line_numbers => :table, :css => :class))
+      end
+      return text
+    end
+
+    # =============================================================================================
+    # PROTECTED INSTANCE METHODS
+    # =============================================================================================
+
+    # Ensure string contains valid ASCII characters
+    def escape(string)
+      return unless string
+      result = String.new(string)
+      result.gsub!(/[^\x00-\x7F]+/, '') # Remove anything non-ASCII entirely (e.g. diacritics).
+      result.gsub!(/[^\w_ \-]+/i,   '') # Remove unwanted chars.
+      result.gsub!(/[ \-]+/i,      '-') # No more than one of the separator in a row.
+      result.gsub!(/^\-|\-$/i,      '') # Remove leading/trailing separator.
+      result.downcase!
+      return result
+    end
+
+  end
+
+end