baron 1.0.0

data/spec/baron_article_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+###
+# Tests Baron::ArticleModel class
+#
+# This class represents an individual article
+
+describe "Baron::ArticleModel" do
+  before :all do
+    @config = load_config()
+    @article_parts = {:filename_and_path => "#{SAMPLE_DATA_PATH}articles/poems/1916-01-01-the-road-not-taken.txt", 
+                      :date => '1916-01-01', 
+                      :filename => 'the-road-not-taken', 
+                      :category => 'poems'}
+    @article = Baron::Article.new(@article_parts, @config)
+  end
+  
+  describe "Provides access to properties" do
+    it "should return input parameters" do
+      @article[:filename_and_path].should eq(@article_parts[:filename_and_path])
+      @article[:date].should be_instance_of(Date)
+      @article[:category].should eq(@article_parts[:category])
+    end
+    
+    it "should return article data correctly" do
+      @article[:title].should eq('The Road Not Taken')
+      @article.title.should eq('The Road Not Taken')
+      @article[:author].should eq('Robert Frost')
+      @article.author.should eq('Robert Frost')
+      @article[:body].length.should > 0
+      @article[:category].should eq('poems')
+      @article.category.should eq('poems')
+      @article[:slug].should eq('the-road-not-taken')
+      @article.slug.should eq('the-road-not-taken')      
+    end
+    
+    it "should handle different path configuations" do
+      @article.path('', :no_date).should eq('/poems/the-road-not-taken/')
+      @article.path('', :year_month_day_date).should eq('/poems/1916/01/01/the-road-not-taken/')
+      @article.path('', :year_month_date).should eq('/poems/1916/01/the-road-not-taken/')
+      @article.path('', :year_date).should eq('/poems/1916/the-road-not-taken/')
+      @article.path('posts', :no_date).should eq('/posts/poems/the-road-not-taken/')
+      @article.path('posts', :year_month_day_date).should eq('/posts/poems/1916/01/01/the-road-not-taken/')
+      @article.path('posts', :year_month_date).should eq('/posts/poems/1916/01/the-road-not-taken/')
+      @article.path('posts', :year_date).should eq('/posts/poems/1916/the-road-not-taken/')
+      @article.path('/foo/bar/', :no_date).should eq('/foo/bar/poems/the-road-not-taken/')
+      @article.path('/foo/bar/', :no_date).should eq('/foo/bar/poems/the-road-not-taken/')
+      @article.path('/foo/bar/', :year_month_day_date).should eq('/foo/bar/poems/1916/01/01/the-road-not-taken/')
+      @article.path('/foo/bar/', :year_month_date).should eq('/foo/bar/poems/1916/01/the-road-not-taken/')
+      @article.path('/foo/bar/', :year_date).should eq('/foo/bar/poems/1916/the-road-not-taken/')
+    end
+  end
+end

data/spec/baron_blog_engine_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+###
+# Tests Baron::BlogEngine class
+#
+# This class understands how the blog directory structure works, and is used by the app to access
+# all content from the directory structure.
+
+describe "Baron::BlogEngine" do
+  before :all do
+    @config = load_config()
+    @blog_engine = Baron::BlogEngine.new @config
+  end
+    
+  describe "Access all content" do
+    it "finds application paths" do
+      @blog_engine.get_pages_path.should == SAMPLE_DATA_PATH + 'pages/'
+      @blog_engine.get_articles_path.should == SAMPLE_DATA_PATH + 'articles'
+      @blog_engine.get_page_template('about').should == SAMPLE_DATA_PATH + 'pages/about.rhtml'
+      @blog_engine.get_theme_template('article').should == SAMPLE_DATA_PATH + 'themes/test/templates/article.rhtml'
+      @blog_engine.get_theme_template('category').should == SAMPLE_DATA_PATH + 'themes/test/templates/category.rhtml'
+      @blog_engine.get_theme_template('error').should == SAMPLE_DATA_PATH + 'themes/test/templates/error.rhtml'
+      @blog_engine.get_theme_template('index').should == SAMPLE_DATA_PATH + 'themes/test/templates/index.rhtml'
+      @blog_engine.get_theme_template('layout').should == SAMPLE_DATA_PATH + 'themes/test/templates/layout.rhtml'
+      @blog_engine.get_system_resource('redirects.txt').should == SAMPLE_DATA_PATH + 'resources/redirects.txt'
+      @blog_engine.get_system_resource('robots.txt').should == SAMPLE_DATA_PATH + 'resources/robots.txt'
+      @blog_engine.get_system_resource('feeds.rss').should == SAMPLE_DATA_PATH + 'resources/feeds.rss'
+    end 
+    
+    it "finds all categories" do
+      categories = @blog_engine.get_all_categories
+      categories.count.should == 2
+      categories.first[:name].should == 'Code Projects'
+      categories.first[:path].should == '/code-projects/'
+      categories.first[:count].should == 0
+      categories.last[:name].should == 'Poems'
+      categories.last[:path].should == '/poems/'
+      categories.last[:count].should == 2
+    end
+    
+    it "finds all articles" do
+      articles_fileparts = @blog_engine.get_all_articles()
+      articles_fileparts.count.should == 3
+      articles_fileparts.first[:filename_and_path].should == SAMPLE_DATA_PATH + 'articles/2012-11-09-sample-post.txt' 
+      articles_fileparts.first[:date].should == '2012-11-09' 
+      articles_fileparts.first[:filename].should == 'sample-post' 
+      articles_fileparts.first[:category].should == ''
+      articles_fileparts.last[:filename_and_path].should == SAMPLE_DATA_PATH + 'articles/poems/1909-01-02-If.txt' 
+      articles_fileparts.last[:date].should == '1909-01-02' 
+      articles_fileparts.last[:filename].should == 'if' 
+      articles_fileparts.last[:category].should == 'poems' 
+    end
+    
+    it "returns all article parts" do
+      @blog_engine.get_all_articles().each do |article_parts|
+        article_parts[:filename_and_path].should_not == nil
+        article_parts[:date].should_not == nil
+        article_parts[:filename].should_not == nil
+      end
+    end
+  end # Access all content
+end

data/spec/baron_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+
+##
+# Integration testing for the Baron Blog Engine to make sure things are
+# working end-to-end
+
+shared_examples_for "Server Response" do
+  it "should be valid" do
+    @response.status.should == 200
+    @response.body.length.should > 0
+  end
+end
+
+shared_examples_for "Server HTML Response" do
+  it "should be instrumented" do
+    @response.body.should include(GOOGLE_ANALYTICS) unless GOOGLE_ANALYTICS.empty?
+  end
+  
+  it "should generate valid HTML" do
+    @response.body.scan(/<html/).count.should == 1
+    @response.body.scan(/<\/html>/).count.should == 1
+    @response.body.scan(/<head>/).count.should == 1
+    @response.body.scan(/<\/head>/).count.should == 1
+    @response.body.scan(/<body/).count.should == 1
+    @response.body.scan(/<\/body>/).count.should == 1
+  end
+end
+
+describe "Baron" do  
+  before :all do
+    @config = load_config
+    @baron = Rack::MockRequest.new(Baron::Server.new(@config))
+  end
+
+  describe "GET /" do
+    before :all do
+      @response = @baron.get('/')
+    end
+    
+    it_behaves_like "Server Response"
+    it_behaves_like "Server HTML Response"
+    
+    it "is instrumented for Google Webmaster Tools" do
+      @response.body.should include(GOOGLE_WEBMASTER) unless GOOGLE_WEBMASTER.empty?
+    end    
+  end
+  
+  describe "GET /archives" do
+    before :all do
+      @response = @baron.get('/archives')
+    end
+
+    it_behaves_like "Server Response"
+    it_behaves_like "Server HTML Response"    
+  end
+
+  describe "GET custom page" do
+    before :all do
+      @response = @baron.get('/about')
+    end
+
+    it_behaves_like "Server Response"
+    it_behaves_like "Server HTML Response"    
+  end
+
+  describe "GET category index page" do
+    before :all do
+      @response = @baron.get('/poems/')
+    end
+
+    it_behaves_like "Server Response"
+    it_behaves_like "Server HTML Response"
+  end
+        
+  describe "GET single article" do    
+    before :all do
+      @response = @baron.get('/poems/the-road-not-taken')
+    end
+    
+    it_behaves_like "Server Response"
+    it_behaves_like "Server HTML Response"    
+  end
+  
+  describe "GET pagination" do
+    before :all do
+      config = load_config()
+      config.set(:article_max, 2)
+      @baron = Rack::MockRequest.new(Baron::Server.new(config))
+    end
+    
+    it "should not render a page out of bounds" do
+      @baron.get('/page/0/').status.should == 404
+      @baron.get('/page/100/').status.should == 404
+    end
+    
+    it "should not render a mal-formed URL" do
+      @baron.get('/page/foobar/').status.should == 404
+    end
+
+    it "should render a valid request" do
+      response = @baron.get('/page/2/')
+      response.status.should == 200
+      response.body.length.should > 0
+      response.body.should include(GOOGLE_WEBMASTER) unless GOOGLE_WEBMASTER.empty?
+    end
+  end
+  
+  describe "GET error page" do
+    it "returns proper error data" do
+      response = @baron.get('/fake-url-of-impossible-page-give-me-your-404-error')
+      response.status.should == 404
+      response.body.should include('Page not found')
+      response.body.should include('404')
+    end
+  end
+  
+  describe "GET /feed.rss" do    
+    before :all do
+      @response = @baron.get('/feed.rss')
+    end
+    
+    it_behaves_like "Server Response"
+    
+    it "returns expected content" do
+      @response.body.should include(@config[:title])
+      @response.body.should include("#{@config[:url]}/feed.rss")
+      @response.body.scan(/<entry>/).count.should == 3
+      @response.body.scan(/<\/entry>/).count.should == 3
+      @response.body.should include('<feed')
+      @response.body.should include('</feed>')
+    end    
+  end
+  
+  describe "GET /robots.txt" do
+    before :all do
+      @response = @baron.get('/robots.txt')
+    end
+    
+    it_behaves_like "Server Response"    
+  end
+  
+  describe "Redirect URLs" do
+    it "should redirect with 301" do
+      @response = @baron.get('/foobar-test-1')
+      @response.status.should == 301
+      @response['Location'].should == '/'
+      @response = @baron.get('/foobar-test-2')
+      @response.status.should == 301
+      @response['Location'].should == '/archives'
+    end
+    
+    it "should canonicalize pagination at page 1" do
+      @response = @baron.get('/page/1/')
+      @response.status.should == 301
+      @response['Location'].should == '/'
+      @response = @baron.get('/page/1')
+      @response.status.should == 301
+      @response['Location'].should == '/'
+    end
+    
+    it "should redirect with 302" do
+      @response = @baron.get('/foobar-test-3')
+      @response.status.should == 302
+      @response['Location'].should == '/posts/poems/the-road-not-taken/'
+    end
+  end
+  
+  describe "Helper Functions" do
+    it "should return a titleized string" do
+      "the quick red fox".titleize.should == "The Quick Red Fox"
+    end
+  end
+  
+end

data/spec/sample_data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+ruby '1.9.3'
+gem 'baron'
+gem 'rack'
+gem 'rdiscount'

data/spec/sample_data/Rakefile

@@ -0,0 +1,42 @@
+require 'baron'
+
+@config = Baron::Config::Defaults
+
+task :default => :new
+
+desc "Create a new article."
+task :new do
+  title = ask('Title: ')
+  slug = title.empty?? nil : title.strip.slugize
+
+  article = {'title' => title, 'date' => Time.now.strftime("%d/%m/%Y")}.to_yaml
+  article << "\n"
+  article << "Once upon a time...\n\n"
+
+  path = "#{Baron::Paths[:articles]}/#{Time.now.strftime("%Y-%m-%d")}#{'-' + slug if slug}.#{@config[:ext]}"
+
+  unless File.exist? path
+    File.open(path, "w") do |file|
+      file.write article
+    end
+    baron "an article was created for you at #{path}."
+  else
+    baron "I can't create the article, #{path} already exists."
+  end
+end
+
+desc "Publish my blog."
+task :publish do
+  baron "publishing your article(s)..."
+  `git push heroku master`
+end
+
+def baron msg
+  puts "\n  toto ~ #{msg}\n\n"
+end
+
+def ask message
+  print message
+  STDIN.gets.chomp
+end
+

data/spec/sample_data/articles/2012-11-09-sample-post.txt

@@ -0,0 +1,11 @@
+title: Sample Post
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed mauris justo, lobortis et posuere eget, condimentum a sem. In hac habitasse platea dictumst. Vestibulum congue commodo blandit. Quisque lacinia tempus elit quis pulvinar. Pellentesque sit amet pellentesque arcu. Nulla facilisi. Nam aliquet metus sit amet mi pulvinar ornare. Integer et mi non nunc scelerisque tristique. Etiam mattis malesuada rutrum. Fusce eu erat quis neque lacinia mattis sit amet at leo.
+
+Maecenas sit amet consequat lorem. Praesent id risus quis eros molestie interdum nec nec lacus. Cras ultrices arcu sit amet urna mollis in sagittis nibh auctor. Ut non sem at ipsum commodo gravida in eu est. Suspendisse pellentesque euismod mauris, vitae aliquet lectus condimentum at. Praesent nec augue vitae turpis sollicitudin gravida. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus volutpat malesuada lectus, vel faucibus velit accumsan at. Cras rhoncus vulputate sem, et pharetra ipsum rutrum sed. Fusce nibh elit, dapibus et posuere eget, tempus sagittis orci. Nunc in nisi id orci facilisis imperdiet sit amet fringilla orci. Ut scelerisque est ut libero posuere nec accumsan lectus sollicitudin.
+
+Morbi euismod, metus nec rhoncus pulvinar, felis mi ultricies turpis, vitae cursus mi eros eu metus. Morbi condimentum pretium sem, non congue sem ultricies eget. Sed nisi libero, tempor a viverra id, iaculis suscipit ante. Suspendisse potenti. Morbi faucibus fringilla fringilla. Fusce eget orci turpis. Phasellus eleifend lectus sit amet elit eleifend eget venenatis felis fermentum.
+
+Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Fusce eu sodales est. Donec lobortis tristique luctus. Integer pharetra congue nisi vel iaculis. Sed convallis convallis tristique. Aliquam erat volutpat. Maecenas sed volutpat felis. Duis sollicitudin lorem vel felis molestie placerat. Nulla nec lacus lorem, eu sollicitudin lectus. Suspendisse quis ipsum vitae erat rutrum suscipit sit amet non justo. Praesent dignissim pulvinar facilisis. Vivamus vel risus id magna lacinia euismod. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Morbi ultricies nisi sit amet turpis suscipit rhoncus aliquam eros luctus.
+
+Nunc sit amet leo lectus, a eleifend lectus. Nam pulvinar, purus sed dapibus vestibulum, ligula ligula volutpat purus, at blandit enim elit ut risus. Ut rhoncus ultrices magna, id dignissim ligula pharetra vulputate. Ut rutrum pulvinar urna, quis egestas erat facilisis ac. Integer volutpat euismod accumsan. Donec cursus arcu eget sem bibendum ullamcorper. Quisque enim justo, pharetra vel porta vitae, hendrerit id justo. Sed semper congue dapibus. Fusce suscipit iaculis sapien, vel facilisis justo viverra a. Pellentesque augue turpis, imperdiet ut volutpat eu, viverra quis orci.

data/spec/sample_data/articles/poems/1909-01-02-If.txt

@@ -0,0 +1,48 @@
+title: If
+author: Rudyard Kipling
+
+
+If you can keep your head when all about you   
+Are losing theirs and blaming it on you,   
+
+If you can trust yourself when all men doubt you,
+But make allowance for their doubting too;   
+
+If you can wait and not be tired by waiting,
+Or being lied about, don’t deal in lies,
+Or being hated, don’t give way to hating,
+And yet don’t look too good, nor talk too wise:
+
+If you can dream—and not make dreams your master;   
+
+If you can think—and not make thoughts your aim;   
+
+If you can meet with Triumph and Disaster
+And treat those two impostors just the same;   
+
+If you can bear to hear the truth you’ve spoken
+Twisted by knaves to make a trap for fools,
+Or watch the things you gave your life to, broken,
+And stoop and build ’em up with worn-out tools:
+
+If you can make one heap of all your winnings
+And risk it on one turn of pitch-and-toss,
+And lose, and start again at your beginnings
+And never breathe a word about your loss;
+
+If you can force your heart and nerve and sinew
+To serve your turn long after they are gone,   
+And so hold on when there is nothing in you
+Except the Will which says to them: ‘Hold on!’
+
+If you can talk with crowds and keep your virtue,   
+Or walk with Kings—nor lose the common touch,
+
+If neither foes nor loving friends can hurt you,
+
+If all men count with you, but none too much;
+
+If you can fill the unforgiving minute
+With sixty seconds’ worth of distance run,   
+Yours is the Earth and everything that’s in it,   
+And—which is more—you’ll be a Man, my son!

data/spec/sample_data/articles/poems/1916-01-01-the-road-not-taken.txt

@@ -0,0 +1,26 @@
+title: The Road Not Taken
+author: Robert Frost
+
+Two roads diverged in a yellow wood,
+And sorry I could not travel both
+And be one traveler, long I stood
+And looked down one as far as I could
+To where it bent in the undergrowth;
+ 
+Then took the other, as just as fair,
+And having perhaps the better claim,
+Because it was grassy and wanted wear;
+Though as for that the passing there
+Had worn them really about the same,
+ 
+And both that morning equally lay
+In leaves no step had trodden black.
+Oh, I kept the first for another day!
+Yet knowing how way leads on to way,
+I doubted if I should ever come back.
+ 
+I shall be telling this with a sigh
+Somewhere ages and ages hence:
+Two roads diverged in a wood, and I –
+I took the one less traveled by,
+And that has made all the difference.

data/spec/sample_data/config.ru

@@ -0,0 +1,46 @@
+#
+# Baron configuration
+
+require 'baron'
+
+baron = Baron::Server.new do
+  #
+  # Add your settings here
+  # set [:setting], [value]
+  # 
+  # set :author,                  ENV['USER']                               # blog author
+  # set :title,                   Dir.pwd.split('/').last                   # site title
+  # set :root,                    "index"                                   # page to load on /
+  # set :date,                    lambda {|now| now.strftime("%d/%m/%Y") }  # date format for articles
+  # set :markdown,                :smart                                    # use markdown + smart-mode
+  # set :disqus,                  false                                     # disqus id, or false
+  # set :summary,                 :max => 150, :delim => /~/                # length of article summary and delimiter
+  # set :ext,                     'txt'                                     # file extension for articles
+  # set :cache,                   28800                                     # cache duration, in seconds
+  # set :custom_pages             "about, contact-us"                       # custom pages, should match filename
+  # set :permalink_prefix,        ""                                        # common path prefix for article permalinks
+  # set :permalink_date_format,   :no_date,                                 # :year_date, :year_month_date, :year_month_day_date, :no_date
+  
+  set :disqus, true
+  set :title, 'test blog'
+  set :date, lambda {|now| now.strftime("%B #{now.day.ordinal} %Y") }
+  set :permalink_prefix, 'posts'
+  set :theme, 'test'
+  set :permalink_date_format, :no_date
+  set :article_max, 2
+end
+
+#
+# Rack configuration
+
+use Rack::Static, :urls => ['/themes', '/downloads', '/images']
+use Rack::CommonLogger
+
+if ENV['RACK_ENV'] == 'development'
+  use Rack::ShowExceptions
+end
+
+# RUN!
+run baron
+
+