baron 1.0.7 → 1.0.8

data/Rakefile

@@ -25,6 +25,7 @@ end
 # Run RSpec tests
 
 require 'rspec/core/rake_task'
+'clear'
 RSpec::Core::RakeTask.new(:spec)
 
 

data/VERSION

@@ -1 +1 @@
-1.0.7
+1.0.8

data/baron.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "baron"
-  s.version = "1.0.7"
+  s.version = "1.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Buggia"]
-  s.date = "2013-03-22"
+  s.date = "2013-03-23"
   s.description = "What's in the box: (1) Publish to Heroku using Git (2) Author articles in markdown (3) Article categories (4) Multiple permalink formats supported (5) Redirects (6) Advanced SEO optimizations and Google Analytics/ Webmaster Tools support. Uses Rack, RSpec, Bootstrap, JQuery, Disqus, Thin"
   s.email = "nbuggia@gmail.com"
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "spec/baron_article_spec.rb",
     "spec/baron_blog_engine_spec.rb",
     "spec/baron_spec.rb",
+    "spec/baron_theme_spec.rb",
     "spec/sample_data/.gitignore",
     "spec/sample_data/Gemfile",
     "spec/sample_data/Rakefile",
@@ -39,6 +40,7 @@ Gem::Specification.new do |s|
     "spec/sample_data/images/robert-frost-small.png",
     "spec/sample_data/images/robert-frost.png",
     "spec/sample_data/pages/about.rhtml",
+    "spec/sample_data/pages/test.rhtml",
     "spec/sample_data/resources/feed.rss",
     "spec/sample_data/resources/redirects.txt",
     "spec/sample_data/resources/robots.txt",
@@ -61,6 +63,26 @@ Gem::Specification.new do |s|
     "spec/sample_data/themes/typography/templates/error.rhtml",
     "spec/sample_data/themes/typography/templates/home.rhtml",
     "spec/sample_data/themes/typography/templates/layout.rhtml",
+    "spec/sample_data/themes/typography/theme_config.yml",
+    "spec/sample_data/themes/typography/typography/css/app.css",
+    "spec/sample_data/themes/typography/typography/css/bootstrap-responsive.css",
+    "spec/sample_data/themes/typography/typography/css/bootstrap-responsive.min.css",
+    "spec/sample_data/themes/typography/typography/css/bootstrap.css",
+    "spec/sample_data/themes/typography/typography/css/bootstrap.min.css",
+    "spec/sample_data/themes/typography/typography/img/github.png",
+    "spec/sample_data/themes/typography/typography/img/glyphicons-halflings-white.png",
+    "spec/sample_data/themes/typography/typography/img/glyphicons-halflings.png",
+    "spec/sample_data/themes/typography/typography/img/instagram.png",
+    "spec/sample_data/themes/typography/typography/js/bootstrap.js",
+    "spec/sample_data/themes/typography/typography/js/bootstrap.min.js",
+    "spec/sample_data/themes/typography/typography/js/image_alt.js",
+    "spec/sample_data/themes/typography/typography/js/read_later.js",
+    "spec/sample_data/themes/typography/typography/templates/archives.rhtml",
+    "spec/sample_data/themes/typography/typography/templates/article.rhtml",
+    "spec/sample_data/themes/typography/typography/templates/category.rhtml",
+    "spec/sample_data/themes/typography/typography/templates/error.rhtml",
+    "spec/sample_data/themes/typography/typography/templates/home.rhtml",
+    "spec/sample_data/themes/typography/typography/templates/layout.rhtml",
     "spec/spec_helper.rb"
   ]
   s.homepage = "https://github.com/nbuggia/baron-blog-engine-gem"

data/lib/baron.rb

@@ -57,15 +57,14 @@ module Baron
   end
   
   class PageController
-    def initialize articles_parts, categories, max_articles, params, config
-      @categories, @params, @config = categories, params, config
+    def initialize articles_parts, categories, max_articles, params, theme, config
+      @categories, @params, @theme, @config = categories, params, theme, config
       stop_at = (:all == max_articles) ? articles_parts.count : max_articles
       @articles = articles_parts.take(stop_at).map { |file_parts| Article.new(file_parts, @config) }
       @article = @articles.first
     end
     
     def render_html partial_template, layout_template
-      @theme_root = "/themes/#{@config[:theme]}"
       @content = ERB.new(File.read(partial_template)).result(binding)
       if @content[0..99].include? '<html'
         return @content
@@ -102,25 +101,26 @@ module Baron
       categories = get_all_categories
       params = {:page_name => route.first, :rss_feed => get_feed_path}
       params[:page_title] = (route.first == @config[:root] ? '' : "#{route.first.capitalize} #{@config[:title_delimiter]} ") + "#{@config[:title]}"          
+      theme = Theme.new(@config)
     
       begin
 
         # RSS feed... /feed.rss
         body = if mime_type == :rss
-          PageController.new(get_all_articles, categories, @config[:article_max], params, @config) . 
+          PageController.new(get_all_articles, categories, @config[:article_max], params, theme, @config) . 
             render_rss(get_system_resource('feed.rss'))
             
         # Robots... /robots.txt
         elsif route.first == 'robots'
-          PageController.new(get_all_articles, categories, @config[:article_max], params, @config) . 
+          PageController.new(get_all_articles, categories, @config[:article_max], params, theme, @config) . 
             render_rss(get_system_resource('robots.txt'))
         
         # Home page... /
         elsif route.first == @config[:root]
           all_articles = get_all_articles
           params[:page_forward] = '/page/2/' if @config[:article_max] < all_articles.count
-          PageController.new(all_articles, categories, @config[:article_max], params, @config) . 
-            render_html(get_theme_template(route.first), get_theme_template('layout'))
+          PageController.new(all_articles, categories, @config[:article_max], params, theme, @config) . 
+            render_html(theme.get_template(route.first), theme.get_template('layout'))
             
         # Pagination... /page/2, /page/2/
         elsif route.first == 'page' && route.count == 2
@@ -137,33 +137,33 @@ module Baron
           params[:page_forward] = "/page/#{(page_num+1).to_s}/" if show_next
           params[:page_title] = "Page #{page_num.to_s} #{@config[:title_delimiter]} #{@config[:title]}"
           
-          PageController.new(articles_on_this_page, categories, @config[:article_max], params, @config) . 
-            render_html(get_theme_template('home'), get_theme_template('layout'))
+          PageController.new(articles_on_this_page, categories, @config[:article_max], params, theme, @config) . 
+            render_html(theme.get_template('home'), theme.get_template('layout'))
         
         # System routes... /robots.txt, /archives
         elsif route.first == 'archives' or route.first == 'robots'
           max_articles = ('archives' == route.first) ? :all : @config[:article_max]
-          PageController.new(get_all_articles, categories, max_articles, params, @config) . 
-            render_html(get_theme_template(route.first), get_theme_template('layout'))
+          PageController.new(get_all_articles, categories, max_articles, params, theme, @config) . 
+            render_html(theme.get_template(route.first), theme.get_template('layout'))
         
         # Custom pages... /about, /contact-us
         elsif is_route_custom_page? route.first
-          PageController.new(get_all_articles, categories, @config[:article_max], params, @config) . 
-            render_html(get_page_template(route.first), get_theme_template('layout'))
+          PageController.new(get_all_articles, categories, @config[:article_max], params, theme, @config) . 
+            render_html(get_page_template(route.first), theme.get_template('layout'))
       
         # Category home pages... /projects/, /photography/, /poems/, etc
         elsif is_route_category_home? route.last
           filtered_articles = get_all_articles.select { |h| h[:category] == route.last }
           params[:page_name] = route.last.gsub('-', ' ').titleize
-          PageController.new(filtered_articles, categories, :all, params, @config) .
-            render_html(get_theme_template('category'), get_theme_template('layout'))
+          PageController.new(filtered_articles, categories, :all, params, theme, @config) .
+            render_html(theme.get_template('category'), theme.get_template('layout'))
       
         # Articles... /posts/2013/01/18/my-article-title, /posts/category/2013/my-article-title, etc
         else
           article = [ find_single_article(route.last) ]
           params[:page_title] = "#{article.first[:filename].gsub('-',' ').titleize} #{@config[:title_delimiter]} #{@config[:title]}"
-          PageController.new(article, categories, 1, params, @config) .
-            render_html(get_theme_template('article'), get_theme_template('layout'))
+          PageController.new(article, categories, 1, params, theme, @config) .
+            render_html(theme.get_template('article'), theme.get_template('layout'))
         end
 
         return :body => body, :type => mime_type, :status => 200
@@ -173,8 +173,8 @@ module Baron
         # 404 Page Not Found
         params[:error_message] = 'Page not found'
         params[:error_code] = '404'
-        body = PageController.new([], categories, 0, params, @config) .
-                render_html(get_theme_template('error'), get_theme_template('layout'))
+        body = PageController.new([], categories, 0, params, theme, @config) .
+                render_html(theme.get_template('error'), theme.get_template('layout'))
         
         return :body => body, :type => :html, :status => 404
       end 
@@ -232,6 +232,15 @@ module Baron
       get_all_categories.each { |h| return true if h[:node_name] == path_node }
       return false
     end
+    
+    def load_theme_config filename_and_path
+      bar = {}
+      metadata = File.read(filename_and_path)
+      YAML.load(metadata).each_pair { |key, value| bar[key.downcase.to_sym] = value }
+      bar
+    rescue Errno::ENOENT => e
+      return {}
+    end
 
     def get_pages_path()          "#{@config[:sample_data_path]}pages/"                                             end
     def get_articles_path()       "#{@config[:sample_data_path]}articles"                                           end
@@ -240,6 +249,29 @@ module Baron
     def get_system_resource(name) "#{@config[:sample_data_path]}resources/#{name}"                                  end
     def get_feed_path()           "#{@config[:url]}/feed.rss"                                                       end 
   end
+  
+  class Theme < Hash
+    def initialize config
+      @config = config
+      self[:root] = "/themes/#{config[:theme]}"
+      self[:name] = config[:theme]
+      self[:file_root] = "#{@config[:sample_data_path]}themes/#{@config[:theme]}".squeeze('/')
+      load_config("#{self[:file_root]}/theme_config.yml")
+    end
+
+    def load_config filename_and_path
+      metadata = File.read(filename_and_path)
+      YAML.load(metadata).each_pair { |key, value| self[key.downcase.to_sym] = value }
+    rescue Errno::ENOENT => e
+      puts "Warning: unable to load config file : " + filename_and_path
+    end
+        
+    def root()   self[:root]    end
+          
+    def get_template name
+      "#{self[:file_root]}/templates/#{name}.rhtml".squeeze('/')
+    end
+  end
 
   class Article < Hash
     def initialize file_parts, config = {}
@@ -289,7 +321,7 @@ module Baron
     
     def load_article filename_and_path
       metadata, self[:body] = File.read(filename_and_path).split(/\n\n/, 2)
-      YAML.load(metadata).each_pair { |k,v| self[k.downcase.to_sym] = v }
+      YAML.load(metadata).each_pair { |key, value| self[key.downcase.to_sym] = value }
     end
     
     def markdown text

data/spec/baron_article_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
 ###
-# Tests Baron::ArticleModel class
+# Tests Baron::Article class
 #
 # This class represents an individual article
 
-describe "Baron::ArticleModel" do
+describe "Baron::Article" do
   before :all do
     @config = load_config()
     @article_parts = {:filename_and_path => "#{SAMPLE_DATA_PATH}articles/favorites/1916-01-01-the-road-not-taken.txt", 

data/spec/baron_blog_engine_spec.rb

@@ -17,11 +17,6 @@ describe "Baron::BlogEngine" 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/typography/templates/article.rhtml'
-      @blog_engine.get_theme_template('category').should == SAMPLE_DATA_PATH + 'themes/typography/templates/category.rhtml'
-      @blog_engine.get_theme_template('error').should == SAMPLE_DATA_PATH + 'themes/typography/templates/error.rhtml'
-      @blog_engine.get_theme_template('home').should == SAMPLE_DATA_PATH + 'themes/typography/templates/home.rhtml'
-      @blog_engine.get_theme_template('layout').should == SAMPLE_DATA_PATH + 'themes/typography/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'
@@ -43,16 +38,24 @@ describe "Baron::BlogEngine" do
     it "finds all articles" do
       articles_fileparts = @blog_engine.get_all_articles()
       articles_fileparts.count.should == 7
-      articles_fileparts.first[:filename_and_path].should == SAMPLE_DATA_PATH + 'articles/favorites/1916-01-01-the-road-not-taken.txt' 
-      articles_fileparts.first[:date].should == '1916-01-01' 
-      articles_fileparts.first[:filename].should == 'the-road-not-taken' 
-      articles_fileparts.first[:category].should == 'favorites'
+    end
+    
+    it "parses all article fileparts" do
+      articles_fileparts = @blog_engine.get_all_articles()
+      articles_fileparts[0][:filename_and_path].should == SAMPLE_DATA_PATH + 'articles/favorites/1916-01-01-the-road-not-taken.txt' 
+      articles_fileparts[0][:date].should == '1916-01-01' 
+      articles_fileparts[0][:filename].should == 'the-road-not-taken' 
+      articles_fileparts[0][:category].should == 'favorites'
+      articles_fileparts[1][:filename_and_path].should == SAMPLE_DATA_PATH + 'articles/north of boston/1914-01-05-A-Hundred-callers.txt' 
+      articles_fileparts[1][:date].should == '1914-01-05' 
+      articles_fileparts[1][:filename].should == 'a-hundred-callers' 
+      articles_fileparts[1][:category].should == 'north of boston'
       articles_fileparts.last[:filename_and_path].should == SAMPLE_DATA_PATH + 'articles/other authors/1909-01-02-If.txt' 
       articles_fileparts.last[:date].should == '1909-01-02' 
       articles_fileparts.last[:filename].should == 'if' 
       articles_fileparts.last[:category].should == 'other authors' 
     end
-    
+        
     it "returns all article parts" do
       @blog_engine.get_all_articles().each do |article_parts|
         article_parts[:filename_and_path].should_not == nil

data/spec/baron_theme_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+###
+# Tests Baron::Theme class
+#
+# This class represents an individual article
+
+describe "Baron::Theme" do
+  before :all do
+    @config = load_config()
+    @theme = Baron::Theme.new(@config)
+  end
+
+  it "finds all parameters in theme_config.yml" do
+    @theme.root.should == '/themes/typography'
+    @theme[:root].should == '/themes/typography'
+    @theme[:masthead_url].should == "http://www.my-corporation.com"
+    @theme[:param_test].should == "FOOBAR"
+    @theme[:company_description].should == "Insert content here"
+  end
+  
+  it "finds all the rendering templates" do
+    @theme.get_template('article').should == SAMPLE_DATA_PATH + 'themes/typography/templates/article.rhtml'
+    @theme.get_template('category').should == SAMPLE_DATA_PATH + 'themes/typography/templates/category.rhtml'
+    @theme.get_template('error').should == SAMPLE_DATA_PATH + 'themes/typography/templates/error.rhtml'
+    @theme.get_template('home').should == SAMPLE_DATA_PATH + 'themes/typography/templates/home.rhtml'
+    @theme.get_template('layout').should == SAMPLE_DATA_PATH + 'themes/typography/templates/layout.rhtml'
+  end
+end

data/spec/sample_data/config.ru

@@ -9,7 +9,7 @@ baron = Baron::Server.new do
   set :disqus, true
 
   # Specify the title of your blog
-  set :title, 'Robert Frost'
+  set :title, 'Robert Frost - Sample Data'
 
   # Specify a description for your blog
   set :description, 'The fake blog of Robert Frost'

data/spec/sample_data/pages/test.rhtml

@@ -0,0 +1,44 @@
+<h1>Test Page</h1>
+<p>
+	This page lists all the variables that are available to any renderingfile 
+	(e.g. ends in .rhtml).
+</p>
+<p>
+	Access them through <code>&lt;%= @params[:page_name] %&gt;</code>, where 
+	<code>:page_name</code> is the name of the attribute you would like to access.
+</p>
+
+<h2>@theme</h2>
+<p>
+	Gives you access to metadata about the theme, including parameters defined in 
+	the <code>themes/theme/theme_config.yml</code> file.
+</p>
+<section style="font-family:'Courier New'; padding-bottom:1em;"><%= @theme.inspect %></section>
+
+<h2>@params</h2>
+<p>
+	Gives you access to some useful data created during the page rendering.
+</p>
+<section style="font-family:'Courier New'; padding-bottom:1em;"><%= @params.inspect %></section>
+
+<h2>@config</h2>
+<p>
+	Gives you access to all the attribute/ value pairs specified in your 
+	<code>config.ru</code> file.
+</p>
+<section style="font-family:'Courier New'; padding-bottom:1em;"><%= @config.inspect %></section>
+
+<h2>@categories</h2>
+<p>
+	Gives you access to your list of categories and associated metadata. Useful
+	for creating a nav bar.
+</p>
+<section style="font-family:'Courier New'; padding-bottom:1em;"><%= @categories.inspect %></section>
+
+<h2>@articles</h2>
+<p>
+	Gives you access to each article returned with your request (the most 
+	recent <code>@config[:max_articles]</code>). This also includes any 
+	additional attribute/ value pairs specified in the article header.
+</p>
+<section style="font-family:'Courier New'; padding-bottom:1em;"><%= @articles.inspect %></section>

data/spec/sample_data/themes/typography/templates/layout.rhtml

@@ -12,9 +12,9 @@
 	<script type="text/javascript" src="//use.typekit.net/xgg5zca.js"></script>
 	<script type="text/javascript">try{Typekit.load();}catch(e){}</script>
 	
-	<link href="<%= @theme_root %>/css/bootstrap.css" rel="stylesheet">
-	<link href="<%= @theme_root %>/css/app.css" rel="stylesheet">
-	<link href="<%= @theme_root %>/css/bootstrap-responsive.css" rel="stylesheet">	
+	<link href="<%= @theme.root %>/css/bootstrap.css" rel="stylesheet">
+	<link href="<%= @theme.root %>/css/app.css" rel="stylesheet">
+	<link href="<%= @theme.root %>/css/bootstrap-responsive.css" rel="stylesheet">	
 	
 	<!-- [if lt IE 9]><script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
 	

data/spec/sample_data/themes/typography/theme_config.yml

@@ -0,0 +1,9 @@
+###
+# Theme Config File
+#
+
+# parameter comments
+masthead_url: 'http://www.my-corporation.com'
+Company_Description: Insert content here
+
+param_test: "FOOBAR"

data/spec/sample_data/themes/typography/typography/css/app.css

@@ -0,0 +1,58 @@
+body {font-family:"source-sans-pro", sans-serif; font-size:18px; line-height:1.6em; color: #444; border-top:3px solid #069;}
+h1, h2, h3 {font-family:"museo-sans", sans-serif; padding-top:0; margin-top:0;}
+h1 {font-size:2.6em; line-height:1.3em; color:#444; text-align:center; }
+h2 {color: #444; font-size: 1.4em;}
+h3 {text-transform: uppercase; font-size:0.9em;}	
+h4 {text-transform: uppercase; font-size:0.76em;}
+
+.small {font-size:0.8em;}
+.center {text-align: center;}
+
+
+a:link, a:hover, a:visited, a:active {color:#069;}
+a:link.subtle, a:hover.subtle, a:visited.subtle, a:active.subtle {color:#444;}
+
+/* Site Layout Template */
+
+a:hover.logo {border:20px solid #eee; border-top-style:none; border-bottom-style:none; padding:0 2em 0 2em; border-radius:1em;}
+
+div.content-strip {max-width: 38em; margin: 0 auto;}
+
+#header {padding-top:2em;}
+#header-image {display:block; text-align:center;}
+#blog-title {text-align:center; font-size:1.8em; line-height:1.8em; padding-top:1em;}
+.blog-title {font-size:1.2em;}
+
+#content {padding-top:2em; padding-bottom:5em;}
+
+#navigation {padding-top:1em;}
+#navigation a:link, #navigation a:hover, #navigation a:visited, #navigation a:active {color:#08c;}
+.navigation-wrapper {background-color:#eee;}
+#navigation ul {list-style-type:none; margin-left:0;}
+#navigation li {padding-top:0.3em; padding-bottom: 0.3em;}
+
+
+#footer {text-align:center; font-size:0.8em; line-height:0.8em; padding-top:1em; padding-bottom:1em;}
+#footer p {margin:1em 0 1em 0}
+.footer-wrapper {background-color:#eee;}
+
+/* Index Template */
+
+#articles {font-size: 1.3em;}
+#articles ol {list-style-type:none; margin-left:0;}
+#articles li {width:100%; line-height:1.3em; padding-top:0.5em; padding-bottom: 0.5em; border-bottom:solid 1px #cecece;}
+#articles .article-title {float: left;}
+#articles time {float:right; color:#999; text-transform:uppercase; font-size:0.8em; vertical-align:baseline;}
+#articles span {color:#ccc; font-size:0.5em; text-transform:uppercase;}
+/*#articles a {overflow:hidden; text-overflow:ellipsis; white-space:nowrap; width:22em;}*/
+
+#pagination {padding-top:1em;}
+
+
+/* Article Template */
+
+.post-details {font-size:0.8em; color:#888; padding-top:0.7em; padding-bottom:1.3em; text-align:center;}
+
+article li {line-height:1.3em; padding-top:0.3em; padding-bottom:0.3em;}
+article p {padding:0.5em 0 0.5em 0;}
+article table, article th, article td {border: 1px solid #444;}