RubyGems - aerial - Versions diffs - 0.0.0 - Mend

aerial 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (48) hide show

data/.gitignore +1 -0
data/MIT-LICENSE +22 -0
data/README.md +74 -0
data/Rakefile +96 -0
data/VERSION +1 -0
data/config/config.yml +19 -0
data/config/deploy.rb +50 -0
data/lib/aerial.rb +100 -0
data/lib/aerial/article.rb +241 -0
data/lib/aerial/base.rb +172 -0
data/lib/aerial/comment.rb +160 -0
data/lib/aerial/config.rb +41 -0
data/lib/aerial/content.rb +74 -0
data/lib/aerial/vendor/akismetor.rb +52 -0
data/lib/aerial/vendor/cache.rb +139 -0
data/lib/features/article.feature +10 -0
data/lib/features/home.feature +16 -0
data/lib/features/step_definitions/article_steps.rb +4 -0
data/lib/features/step_definitions/home_steps.rb +8 -0
data/lib/features/support/env.rb +38 -0
data/lib/features/support/pages/article.rb +9 -0
data/lib/features/support/pages/homepage.rb +9 -0
data/lib/spec/aerial_spec.rb +203 -0
data/lib/spec/article_spec.rb +338 -0
data/lib/spec/base_spec.rb +65 -0
data/lib/spec/comment_spec.rb +216 -0
data/lib/spec/config_spec.rb +25 -0
data/lib/spec/fixtures/articles/sample-article/sample-article.article +6 -0
data/lib/spec/fixtures/articles/test-article-one/test-article.article +7 -0
data/lib/spec/fixtures/articles/test-article-three/test-article.article +7 -0
data/lib/spec/fixtures/articles/test-article-two/comment-missing-fields.comment +8 -0
data/lib/spec/fixtures/articles/test-article-two/test-article.article +7 -0
data/lib/spec/fixtures/articles/test-article-two/test-comment.comment +10 -0
data/lib/spec/fixtures/config.yml +35 -0
data/lib/spec/fixtures/public/javascripts/application.js +109 -0
data/lib/spec/fixtures/public/javascripts/jquery-1.3.1.min.js +19 -0
data/lib/spec/fixtures/public/javascripts/jquery.template.js +255 -0
data/lib/spec/fixtures/views/article.haml +19 -0
data/lib/spec/fixtures/views/articles.haml +2 -0
data/lib/spec/fixtures/views/comment.haml +8 -0
data/lib/spec/fixtures/views/home.haml +2 -0
data/lib/spec/fixtures/views/layout.haml +22 -0
data/lib/spec/fixtures/views/post.haml +27 -0
data/lib/spec/fixtures/views/rss.haml +15 -0
data/lib/spec/fixtures/views/sidebar.haml +21 -0
data/lib/spec/fixtures/views/style.sass +163 -0
data/lib/spec/spec_helper.rb +117 -0
metadata +101 -0

data/lib/aerial/vendor/akismetor.rb ADDED Viewed

@@ -0,0 +1,52 @@
+require 'net/http'
+# http://railscasts.com/episodes/65-stopping-spam-with-akismet
+# http://github.com/hornbeck/blerb-core/tree/master/lib/akismetor.rb
+class Akismetor
+  attr_accessor :attributes
+  # Does a comment-check on Akismet with the submitted hash.
+  # Returns true or false depending on response.
+  def self.spam?(attributes)
+    self.new(attributes).execute('comment-check') == "true"
+  end
+  # Does a submit-spam on Akismet with the submitted hash.
+  # Use this when Akismet incorrectly approves a spam comment.
+  def self.submit_spam(attributes)
+    self.new(attributes).execute('submit-spam')
+  end
+  # Does a submit-ham on Akismet with the submitted hash.
+  # Use this for a false positive, when Akismet incorrectly rejects a normal comment
+  def self.submit_ham(attributes)
+    self.new(attributes).execute('submit-ham')
+  end
+  def initialize(attributes)
+    @attributes = attributes
+  end
+  def execute(command)
+    http = Net::HTTP.new("#{attributes[:key]}.rest.akismet.com", 80)
+    response, content = http.post("/1.1/#{command}", attributes_for_post, http_headers)
+    content
+  end
+private
+  def http_headers
+    {
+      'User-Agent' => 'Akismetor Ruby Library/1.0',
+      'Content-Type' => 'application/x-www-form-urlencoded'
+    }
+  end
+  def attributes_for_post
+    result = attributes.map { |k, v| "#{k}=#{v}" }.join('&')
+    URI.escape(result)
+  end
+end

data/lib/aerial/vendor/cache.rb ADDED Viewed

@@ -0,0 +1,139 @@
+require 'fileutils'
+# require 'sinatra/base'
+module Sinatra
+  # Sinatra Caching module
+  #
+  #  TODO:: Need to write documentation here
+  #
+  module Cache
+    VERSION = 'Sinatra::Cache v0.2.2'
+    def self.version; VERSION; end
+    module Helpers
+      # Caches the given URI to a html file in /public
+      #
+      # <b>Usage:</b>
+      #    >> cache( erb(:contact, :layout => :layout))
+      #      =>  returns the HTML output written to /public/<CACHE_DIR_PATH>/contact.html
+      #
+      # Also accepts an Options Hash, with the following options:
+      #  * :extension => in case you need to change the file extension
+      #
+      #  TODO:: implement the opts={} hash functionality. What other options are needed?
+      #
+      def cache(content, opts={})
+        return content unless options.respond_to?("cache_enabled") && options.cache_enabled
+        unless content.nil?
+          content = "#{content}\n#{page_cached_timestamp}"
+          path = cache_page_path(request.path_info,opts)
+          FileUtils.makedirs(File.dirname(path))
+          open(path, 'wb+') { |f| f << content }
+          log("Cached Page: [#{path}]",:info)
+          content
+        end
+      end
+      # Expires the cached URI (as .html file) in /public
+      #
+      # <b>Usage:</b>
+      #    >> cache_expire('/contact')
+      #      =>  deletes the /public/<CACHE_DIR_PATH>contact.html page
+      #
+      #    get '/contact' do
+      #     cache_expire   # deletes the /public/<CACHE_DIR_PATH>contact.html page as well
+      #    end
+      #
+      #  TODO:: implement the options={} hash functionality. What options are really needed ?
+      def cache_expire(path = nil, opts={})
+        return unless options.respond_to?("cache_enabled") && options.cache_enabled
+        path = (path.nil?) ? cache_page_path(request.path_info) : cache_page_path(path)
+        if File.exist?(path)
+          File.delete(path)
+          log("Expired Page deleted at: [#{path}]",:info)
+        else
+          log("No Expired Page was found at the path: [#{path}]",:info)
+        end
+      end
+      # Prints a basic HTML comment with a timestamp in it, so that you can see when a file was cached last.
+      #
+      # *NB!* IE6 does NOT like this to be the first line of a HTML document, so output
+      # inside the <head> tag. Many hours wasted on that lesson ;-)
+      #
+      # <b>Usage:</b>
+      #    >> <%= page_cached_timestamp %>
+      #      => <!--  page cached: 2009-02-24 12:00:00 -->
+      #
+      def page_cached_timestamp
+        "<!-- page cached: #{Time.now.strftime("%Y-%d-%m %H:%M:%S")} -->\n" if options.cache_enabled
+      end
+      private
+        # Establishes the file name of the cached file from the path given
+        #
+        # TODO:: implement the opts={} functionality, and support for custom extensions on a per request basis.
+        #
+        def cache_file_name(path,opts={})
+          name = (path.empty? || path == "/") ? "index" : Rack::Utils.unescape(path.sub(/^(\/)/,'').chomp('/'))
+          name << options.cache_page_extension unless (name.split('/').last || name).include? '.'
+          return name
+        end
+        # Sets the full path to the cached page/file
+        # Dependent upon Sinatra.options .public and .cache_dir variables being present and set.
+        #
+        def cache_page_path(path,opts={})
+          # test if given a full path rather than relative path, otherwise join the public path to cache_dir
+          # and ensure it is a full path
+          cache_dir = (options.cache_output_dir == File.expand_path(options.cache_output_dir)) ?
+              options.cache_output_dir : File.expand_path("#{options.public}/#{options.cache_output_dir}")
+          cache_dir = cache_output_dir[0..-2] if cache_dir[-1,1] == '/'
+          "#{cache_dir}/#{cache_file_name(path,opts)}"
+        end
+        #  TODO:: this implementation really stinks, how do I incorporate Sinatra's logger??
+        def log(msg,scope=:debug)
+          if options.cache_logging
+            "Log: msg=[#{msg}]" if scope == options.cache_logging_level
+          else
+            # just ignore the stuff...
+            # puts "just ignoring msg=[#{msg}] since cache_logging => [#{options.cache_logging.to_s}]"
+          end
+        end
+    end #/module Helpers
+    # Sets the default options:
+    #
+    #  * +:cache_enabled+ => toggle for the cache functionality. Default is: +true+
+    #  * +:cache_page_extension+ => sets the default extension for cached files. Default is: +.html+
+    #  * +:cache_dir+ => sets cache directory where cached files are stored. Default is: ''(empty) == root of /public.<br>
+    #      set to empty, since the ideal 'system/cache/' does not work with Passenger & mod_rewrite :(
+    #  * +cache_logging+ => toggle for logging the cache calls. Default is: +true+
+    #  * +cache_logging_level+ => sets the level of the cache logger. Default is: <tt>:info</tt>.<br>
+    #      Options:(unused atm) [:info, :warn, :debug]
+    #
+    def self.registered(app)
+      app.helpers(Cache::Helpers)
+      app.set :cache_enabled, true
+      app.set :cache_page_extension, '.html'
+      app.set :cache_output_dir, ''
+      app.set :cache_logging, true
+      app.set :cache_logging_level, :info
+    end
+  end #/module Cache
+  #register(Sinatra::Cache)
+end #/module Sinatra

data/lib/features/article.feature ADDED Viewed

@@ -0,0 +1,10 @@
+Feature: Article
+    In order to an Article
+    As anonymous
+    wants to view the the first article
+   Scenario: View a single article
+       Given there is one article
+       When I view the Article
+       Then the title should be "Aerial | Congratulations! Aerial is configured correctly"
+       Then I should see "Comments"

data/lib/features/home.feature ADDED Viewed

@@ -0,0 +1,16 @@
+Feature: Homepage
+    In order to view recent Articles
+    As anonymous
+    wants to view the most recent articles
+    Scenario: Opening the home page
+        Given there are articles
+        When I view the Homepage
+        Then the title should be "Aerial | A Microblog by Matt Sears"
+        Then I should see "Congratulations! Aerial is configured correctly"
+        Then I should see a link to "Home":http://localhost:4567/home
+        Then I should see a link to "About":http://localhost:4567/about
+        Then I should see a link to "ruby":http://localhost:4567/tags/ruby
+        Then I should see a link to "sinatra":http://localhost:4567/tags/sinatra
+        Then I should see a link to "git":http://localhost:4567/tags/git
+        Then I should see a link to "aerial":http://localhost:4567/tags/aerial

data/lib/features/step_definitions/article_steps.rb ADDED Viewed

@@ -0,0 +1,4 @@
+Given /^there is one article$/ do
+  @articles = Aerial::Article.all.first
+end

data/lib/features/step_definitions/home_steps.rb ADDED Viewed

@@ -0,0 +1,8 @@
+Given /^there are articles$/ do
+  @articles = Aerial::Article.all
+end
+Then /^I should have 2 articles$/ do
+  @articles.size.should == 2
+end

data/lib/features/support/env.rb ADDED Viewed

@@ -0,0 +1,38 @@
+require 'spec'
+require 'webrat'
+require 'spec/expectations'
+require 'webrat/sinatra'
+require 'safariwatir'
+$0 = File.expand_path(File.dirname(__FILE__) + "/../../aerial.rb")
+require File.expand_path(File.dirname(__FILE__) + "/../../aerial")
+browser = Watir::Safari.new
+pages = {
+  "Homepage" => "http://localhost:4567",
+  "Article"  => "http://localhost:4567/2009/3/31/congratulations-aerial-is-configured-correctly"
+}
+Before do
+  @browser = browser
+  @pages = pages
+end
+# Common steps - should these go somewhere else?
+When /^I view the (.*)$/ do |page|
+  @page =  eval("#{page}.new(@browser)")
+  @page.goto
+end
+Then /^the title should be "(.*)"$/ do |text|
+  @browser.title.should == text
+end
+Then /^I should see "(.*)"$/ do |text|
+  @browser.text.should include(text)
+end
+Then /I should see a link to "(.*)":(.*)/ do |text, url|
+  @browser.link(:url, url).text.should == text
+end

data/lib/features/support/pages/article.rb ADDED Viewed

@@ -0,0 +1,9 @@
+class Article
+  def initialize(browser)
+    @browser = browser
+  end
+  def goto
+    @browser.goto 'http://localhost:4567/2009/3/31/congratulations-aerial-is-configured-correctly'
+  end
+end

data/lib/features/support/pages/homepage.rb ADDED Viewed

@@ -0,0 +1,9 @@
+class Homepage
+  def initialize(browser)
+    @browser = browser
+  end
+  def goto
+    @browser.goto 'http://localhost:4567/'
+  end
+end

data/lib/spec/aerial_spec.rb ADDED Viewed

@@ -0,0 +1,203 @@
+require "#{File.dirname(__FILE__)}/spec_helper"
+describe 'main aerial application' do
+  before do
+    @articles = Article.all
+    setup_repo
+  end
+  it "should define the root directory" do
+    AERIAL_ROOT.should_not be_nil
+  end
+  it "should define the configuration file" do
+    CONFIG.should_not be_nil
+  end
+  it 'should show the default index page' do
+    get '/'
+    @response.should be_ok
+  end
+  it 'should send 404 properly' do
+    get '/not-found.html'
+    @response.status.should == 404
+  end
+  it "should render a single article page" do
+    get '/2009/1/31/test-article'
+    @response.status.should == 200
+  end
+  it "should render the home page" do
+    get '/home'
+    @response.status.should == 200
+  end
+  describe "calling /style.css" do
+    before do
+      get '/style.css'
+    end
+    it "should return an okay status code" do
+      @response.status.should == 200
+    end
+    it "should return a css stylesheet" do
+      @response.headers["Content-Type"].should == "text/css;charset=utf-8"
+    end
+  end
+   describe "calling /tags" do
+    before do
+      @article = Article.new(:title        => "Test Article",
+                             :tags         => "git, sinatra",
+                             :published_at => DateTime.new,
+                             :comments     => [],
+                             :file_name    => "test-article")
+      Aerial::Article.stub!(:with_tag).and_return([@article])
+      get '/tags/git'
+    end
+    it "should return a valid response" do
+      @response.status.should == 200
+    end
+    it "should return a response body" do
+      @response.body.should_not be_empty
+    end
+  end
+  describe "calling /feed" do
+    before do
+      @articles = Article.find_all
+      Aerial::Article.stub!(:all).and_return(@articles)
+      get '/feed'
+    end
+    it "should produce an rss tag" do
+      @response.body.should have_tag('//rss')
+    end
+    it "should contain a title tag" do
+      @response.body.should have_tag('//title').with_text(Aerial.config.title)
+    end
+    it "should contain a language tag" do
+      @response.body.should have_tag('//language').with_text("en-us")
+    end
+    it "should contain a description tag that containts the subtitle" do
+      @response.body.should have_tag('//description').with_text(Aerial.config.subtitle)
+    end
+    it "should contain an item tag" do
+      @response.body.should have_tag('//item')
+    end
+    it "should have the title tags for the articles" do
+      @response.body.should have_tag('//item[1]/title').with_text(@articles[0].title)
+      @response.body.should have_tag('//item[2]/title').with_text(@articles[1].title)
+    end
+    it "should have the link tag with the articles permalink" do
+      #@response.body.should have_tag('//item[1]/link').with_text("http://#{@articles[0].permalink}")
+    end
+    it "should have a pubDate tag with the article's publication date" do
+      @response.body.should have_tag('//item[1]/pubDate').with_text(@articles[0].published_at.to_s)
+      @response.body.should have_tag('//item[2]/pubDate').with_text(@articles[1].published_at.to_s)
+    end
+    it "should have a guid date that matches the articles id" do
+      @response.body.should have_tag('//item[1]/guid').with_text(@articles[0].id)
+      @response.body.should have_tag('//item[2]/guid').with_text(@articles[1].id)
+    end
+    after do
+      @articles = nil
+    end
+  end
+  describe "calling /feed" do
+    before do
+      @articles = Article.find_all
+      Aerial::Article.stub!(:all).and_return(@articles)
+      get '/articles'
+    end
+    it "should return a valid response" do
+      @response.status.should == 200
+    end
+    it "should return a response body" do
+      @response.body.should_not be_empty
+    end
+  end
+  describe "calling /arhives" do
+    before do
+      @article = Article.new(:title        => "Test Article",
+                             :body         => "Test Content",
+                             :id           => 333,
+                             :published_at => DateTime.new,
+                             :comments     => [],
+                             :file_name    => "test-article.article")
+      Aerial::Article.stub!(:with_date).and_return([@article])
+      get '/archives/year/month'
+    end
+    it "should return a valid response" do
+      @response.status.should == 200
+    end
+  end
+  describe "posting a new comment" do
+    before do
+      @article = Article.new(:title     => "Test Article",
+                             :body      => "Test Content",
+                             :file_name => "test-article",
+                             :archive_name => "test-article",
+                             :id        => 333)
+      Aerial::Article.stub!(:find).and_return(@article)
+      @article.stub!(:comments).and_return(Array.new)
+      @article.stub!(:permalink).and_return('/permalink')
+      post "/article/#{@article.id}/comments"
+    end
+    it "should return a valid response" do
+      @response.status.should == 204
+    end
+  end
+  describe "calling Git operations" do
+    before do
+      @dir = "#{Aerial.repo.working_dir}/articles/new_dir"
+      FileUtils.mkdir(@dir)
+      FileUtils.cd(@dir) do
+        FileUtils.touch 'new.file'
+      end
+    end
+    it "should commit all new untracked and tracked content" do
+      Aerial.repo.status.untracked.should_not be_empty
+      get '/'
+      # Aerial.repo.status.untracked.should be_empty
+    end
+  end
+end