active_blog 0.0.2 → 0.5.0

data/README.markdown

@@ -1,6 +1,6 @@
 # ActiveBlog is a work in progress.
 
-ActiveBlog is Rails engine written to satisfy blogging requirements. 
+ActiveBlog is Rails engine written to satisfy *minimal* blogging requirements. 
 
 The ActiveBlog BlogPost model:
 
@@ -38,6 +38,8 @@ Run the generator
 
     ./script/rails generate active_blog:install
 
+[Follow the installer's directions](https://github.com/mchung/active_blog/blob/master/lib/generators/active_blog/install/templates/README)
+
 Install the migrations
 
     rake db:migrate
@@ -49,3 +51,11 @@ Start your server with `foreman` or `rails s` and visit your new blog located at
 To create a new blog post, visit the admin area located at:
 
     http://localhost:5000/admin/active_blog_blog_posts
+
+
+# TODO
+
+* The ActiveAdmin BlogPost form should show realtime Markdown updates
+* The ActiveAdmin BlogPost form should allow users to upload content to S3
+* Tests
+* Document Parent App Hooks (content_for :sidebar, content_for :title, content_for: head)

data/app/assets/javascripts/active_blog/active_admin.js

@@ -0,0 +1,23 @@
+$(document).ready(function() {
+  var $form = $('form.active_blog_blog_post');
+
+  $("#button-preview").bind("ajax:before", function() {
+    var action = $form.attr('action');
+    $form.attr('action', '/blog/-/preview');
+    $form.submit();
+    $form.attr('action', action);
+    return false;
+  });
+
+  $form.bind('submit', function() {
+    if ($form.attr('action') === '/blog/-/preview') {
+      console.log("In post " + this.action);
+      $.post(this.action, $(this).serialize(), null, "script");
+      return false;
+    }
+  });
+
+  // $("#new_active_blog_blog_post").live('keyup', function() {
+  //   $("#button-preview").trigger('click');
+  // });
+});

data/app/assets/stylesheets/active_blog/active_admin.css.scss

@@ -0,0 +1,21 @@
+#main_content {
+  margin: 0 auto;
+  #main_form, .panel.show.blog {
+    float: left;
+    width: 49%;
+  }
+  #live_preview, .buffer {
+    float: right;
+    width: 49%;
+    background-color: #efefef;
+  }
+}
+
+.panel {
+  h4 {
+    span {
+      font-size: 90%;
+      font-weight: bold;
+    }
+  }
+}

data/app/assets/stylesheets/active_blog/application.css

@@ -3,5 +3,6 @@
  * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
  * the top of the compiled file, but it's generally better to create a new file per style scope.
  *= require_self
- *= require_tree . 
+ *= require 'active_blog/active_admin'
+ *= require 'active_blog/blog_posts'
 */

data/app/assets/stylesheets/active_blog/blog_posts.css

@@ -2,3 +2,11 @@
   Place all the styles related to the matching controller here.
   They will automatically be included in application.css.
 */
+
+div.active_blog.body {
+  padding-top: 10px;
+}
+
+ul.recent li {
+  padding-top: 5px;
+}

data/app/controllers/active_blog/blog_posts_controller.rb

@@ -1,11 +1,42 @@
 module ActiveBlog
   class BlogPostsController < ApplicationController
+
+    before_filter :only => [:index, :show, :archives] do
+      @recent_blog_posts = BlogPost.live.recent
+    end
+
     def index
-      @blog_posts = BlogPost.live.order('published_at DESC')
+      @blog_posts = BlogPost.live.page(params[:page])
+    end
+
+    def archives
+      @blog_posts = BlogPost.all
     end
-  
+
     def show
       @blog_post = BlogPost.live.where(:cached_slug => params[:cached_slug]).first
+      if @blog_post
+        render
+      else
+        # TODO(mc): Should 404
+        redirect_to active_blog_path, :notice => "No blog post with that URL"
+      end
+    end
+
+    def preview
+      @blog_post = BlogPost.new(params[:active_blog_blog_post])
+      @blog_post_partial = render_to_string(:partial => 'active_blog/active_admin/blog_post_show')
+
+      respond_to do |format|
+        format.js
+      end
+    end
+
+    def atom
+      @blog_posts = BlogPost.live.order('published_at DESC').limit(10)
+      respond_to do |format|
+        format.xml
+      end
     end
   end
 end

data/app/helpers/active_blog/application_helper.rb

@@ -1,16 +1,39 @@
 module ActiveBlog
+  # These helpers are intended to be used by developers.
+  #
+  #
   module ApplicationHelper
-    def blog_title
-      ActiveBlog.blog_title
+    def active_blog_title
+      ActiveBlog.title
     end
 
-    def blog_sidebar(&block)
-      sidebar_content_for = ActiveBlog.blog_content_for_sidebar
+    def active_blog_description
+      ActiveBlog.description
+    end
+
+    def active_blog_sidebar(&block)
+      sidebar_content_for = ActiveBlog.content_for_sidebar
       if sidebar_content_for
         content_for sidebar_content_for do
           yield
         end
       end
     end
+
+    def active_blog_author_name
+      ActiveBlog.author_name
+    end
+
+    def active_blog_author_uri
+      ActiveBlog.author_uri
+    end
+
+    def active_blog_author_email
+      ActiveBlog.author_email
+    end
+
+    def active_blog_atom_link_tag
+      auto_discovery_link_tag(:atom, "#{active_blog_feed_url}", {:title => "Subscribe to this blog"})
+    end
   end
 end

data/app/helpers/active_blog/blog_posts_helper.rb

@@ -1,7 +1,33 @@
 module ActiveBlog
   module BlogPostsHelper
     def markdown(text)
-      Redcarpet.new(text, :hard_wrap).to_html.html_safe
+      regular = { :hard_wrap => true, :autolink => true, :space_after_headers => true }
+      make_markdown(regular).render(text).html_safe
+    end
+
+    def markdown_for_schema(text)
+      truncate(strip_tags(markdown(text)).strip.gsub(/\n/, ' '), :length => 250)
+    end
+
+    def make_markdown(opts)
+      markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, opts)
+      markdown
+    end
+
+    def schema_date(date)
+      date.strftime("%Y-%m-%d")
+    end
+
+    def schema_span_for(name, content)
+      content_tag(:span, "", :itemprop => name, :content => content)
+    end
+
+    def blog_post_path(blog_post)
+      if blog_post.new_record?
+        admin_blog_posts_path(blog_post)
+      else
+        admin_blog_post_path(blog_post)
+      end
     end
   end
 end

data/app/models/active_blog/blog_post.rb

@@ -1,51 +1,43 @@
 module ActiveBlog
   class BlogPost < ActiveRecord::Base
     set_table_name 'active_blog_blog_posts'
-    validates_presence_of :cached_slug, :on => :create, :message => "can't be blank"
-
+    paginates_per ActiveBlog.paginates_per
+    default_scope :order => 'published_at DESC'
+
+    scope :live, where('published_at < ? AND draft = ?', Time.zone.now, false)
+    scope :recent, limit(5)
+
+    validates_presence_of :title, :allow_blank => false, :allow_nil => false, :message => "can't be blank"
+    validates_presence_of :body, :allow_blank => false, :allow_nil => false, :message => "can't be blank"
+    validates_presence_of :cached_slug, :allow_blank => false, :allow_nil => false, :message => "can't be blank"
+    validates_uniqueness_of :cached_slug, :message => "must be unique"
+    validate :title_must_not_start_with_dash
+    validate :title_must_not_be
     before_validation :build_cached_slug
+    after_initialize :init
+
+    # protected methods
 
-    scope :live, where("published_at < ? AND draft = ?", Time.now, false)
     def build_cached_slug
-      self.cached_slug = to_slug(title)
+      # Don't build slug if it already exists.
+      if self.cached_slug.nil?
+        self.cached_slug = title.to_slug
+      end
     end
 
-    # Generate a slug for the string +value+.
-    #
-    # A slug should consist of numbers (0-9), lowercase letters (a-z) and
-    # dashes (-). Any other characters should be filtered.
-    #
-    # ==== Example
-    #
-    #   "The World is Beautiful!".to_slug # => "the-world-is-beautiful"
-    #
-    # ==== Returns
-    # String:: A 'sluggified' version of this string
-    #
-    # --
-    # @api public
-    def to_slug(string)
-      # Perform transliteration to replace non-ascii characters with an ascii
-      # character
-      value = string.mb_chars.normalize(:kd).gsub(/[^\x00-\x7F]/n, '').to_s
-
-      # Remove single quotes from input
-      value.gsub!(/[']+/, '')
-
-      # Replace any non-word character (\W) with a space
-      value.gsub!(/\W+/, ' ')
-
-      # Remove any whitespace before and after the string
-      value.strip!
-
-      # All characters should be downcased
-      value.downcase!
+    def title_must_not_start_with_dash
+      if title.starts_with?('-')
+        errors.add(:title, 'cannot start with a dash')
+      end
+    end
 
-      # Replace spaces with dashes
-      value.gsub!(' ', '-')
+    def title_must_not_be
+      errors.add(:title, "cannot be named 'archives'") if title == 'archives'
+    end
 
-      # Return the resulting slug
-      value
+    def init
+      # Set now as the default published_at date. Only set if currently nil
+      self.published_at ||= Time.zone.now
     end
   end
 end

data/app/views/active_blog/active_admin/_blog_post_form.html.erb

@@ -0,0 +1,16 @@
+<div id="main_form">
+  <%= semantic_form_for(@blog_post, :url => blog_post_path(@blog_post)) do |f| %>
+    <%= f.inputs "Write a new blog post" do %>
+      <%= f.input :title, :as => :string, :required => true, :hint => "A great blog post title", :input_html => { :placeholder => "A great blog post title" } %>
+      <%= f.input :cached_slug, :as => :string, :label => "Slug", :hint => "#{active_blog_url}/...", :input_html => { :disabled => true } %>
+      <%= f.input :body, :as => :text, :label => "Blog post (Markdown)", :hint => "Use Markdown"%>
+      <%= f.input :draft, :as => :boolean, :label => "Draft?", :hint => "Drafts are not published" %>
+      <%= f.input :published_at, :label => "Publication date" %>
+    <% end %>
+    <%= f.buttons do %>
+      <%= f.commit_button %>
+      <li class="cancel"><%= link_to("Preview", active_blog_preview_path, { :id => "button-preview", :remote => true, "data-type" => "script"}) %>
+    <% end %>
+  <% end %>
+</div>
+<div id="live_preview"></div>

data/app/views/active_blog/active_admin/_blog_post_show.html.erb

@@ -0,0 +1,18 @@
+<div class="panel <%= @blog_post.new_record? ? "new" : "show" %> blog">
+  <h3><%= @blog_post.new_record? ? "Live Preview" : "Blog Entry" %></h3>
+  <div>
+    <h4><%= @blog_post.title || "[Title]" %>
+    <span>
+      <% if @blog_post.cached_slug %>
+        (<%= active_blog_post_url(:cached_slug => @blog_post.cached_slug) %>)
+      <% end %>
+    </span>
+    </h4>
+  </div>
+  <div>
+
+  </div>
+  <div>
+    <%= markdown(@blog_post.body || "Body") %>
+  </div>
+</div>

data/app/views/active_blog/active_admin/_show.html.erb

@@ -0,0 +1,2 @@
+<%= render :partial => 'active_blog/active_admin/blog_post_show' %>
+<div id='buffer'></div>

data/app/views/active_blog/blog_posts/_blog_post.html.erb

@@ -0,0 +1,32 @@
+<%#
+  This partial is used by #index and #show. It behaves differently by displaying different schema
+  types according to the caller.
+
+  Google Rich Snippets doesn't like nested schemas in certain cases.
+%>
+<div class="active_blog entry" <%= show ? '' : "itemscope itemtype='http://schema.org/BlogPosting'" %>>
+  <%- if show %>
+    <%= content_for :schema do %>
+      <%= render :partial => 'blog_post_schema', :locals => {:blog_post => blog_post} %>
+    <% end %>
+  <% else %>
+    <%= render :partial => 'blog_post_schema', :locals => {:blog_post => blog_post} %>
+  <% end %>
+
+  <h6>
+    <%= blog_post.published_at.strftime("%B %e %G") %>
+    <% if blog_post.new_record? %>
+      <a href="" itemscope itemprop="url">∞</a>
+    <% else %>
+      <a href="<%= active_blog_post_path(blog_post.cached_slug) %>">∞</a>
+    <% end %>
+  </h6>
+  <h2>
+    <%= blog_post.title %>
+  </h2>
+
+  <div class="active_blog body">
+    <%= markdown(blog_post.body || "") %>
+  </div>
+</div>
+<hr/>

data/app/views/active_blog/blog_posts/_blog_post_schema.html.erb

@@ -0,0 +1,5 @@
+<%= schema_span_for 'name', "#{blog_post.title} | #{active_blog_title}" %>
+<%= schema_span_for 'description', markdown_for_schema(blog_post.body) %>
+<%= schema_span_for 'datePublished', schema_date(blog_post.published_at) %>
+<%= schema_span_for 'headline', blog_post.title %>
+<%= schema_span_for 'url', active_blog_post_url(blog_post.cached_slug) %>

data/app/views/active_blog/blog_posts/_sidebar.html.erb

@@ -0,0 +1,11 @@
+<%= active_blog_sidebar do %>
+  <div class='section active_blog sidebar'>
+    <h6>Recent posts</h6>
+  </div>
+  <ul class='unstyled recent'>
+    <% @recent_blog_posts.each do |recent_blog_post| %>
+      <li><a href='<%= active_blog_post_path(recent_blog_post.cached_slug) %>' title='<%= recent_blog_post.title %>'><%= recent_blog_post.title %></a></li>
+    <% end %>
+  </ul>
+  <%= link_to 'Archives', active_blog_archives_path %>
+<% end %>

data/app/views/active_blog/blog_posts/archives.html.erb

@@ -0,0 +1,12 @@
+<%= content_for :title do %><%= "#{active_blog_title} &raquo; Archives" %><% end %>
+<div class="section active_blog archives">
+  <h1>Archives</h1>
+  <p>By Date</p>
+  <ul>
+  <% @blog_posts.each do |blog_post| %>
+    <li><%= link_to blog_post.title, active_blog_post_path(blog_post.cached_slug) %>
+  <% end %>
+  </ul>
+</div>
+
+<%= render :partial => 'sidebar' %>

data/app/views/active_blog/blog_posts/atom.xml.builder

@@ -0,0 +1,21 @@
+atom_feed({}) do |feed|
+  feed.title(active_blog_title)
+  feed.updated(@blog_posts[0].published_at) if @blog_posts.length > 0
+
+  @blog_posts.each do |post|
+    feed.entry(post, {
+      :published_at => post.published_at,
+      :updated_at => post.updated_at,
+      :url => active_blog_post_url(post.cached_slug)
+    }) do |entry|
+      entry.title(post.title)
+      entry.content(markdown(post.body), :type => 'html')
+
+      entry.author do |author|
+        author.name(active_blog_author_name) if active_blog_author_name
+        author.uri(active_blog_author_uri) if active_blog_author_uri
+        author.email(active_blog_author_email) if active_blog_author_email
+      end
+    end
+  end
+end

data/app/views/active_blog/blog_posts/index.html.erb

@@ -1,17 +1,22 @@
-<h1><%= blog_title %></h1>
-
-<% if @blog_posts.empty? %>
-  <%= link_to "Write your first blog post", admin_active_blog_blog_posts_path %>
+<%= content_for :title do %><%= active_blog_title %><% end %>
+<%= content_for :head do %><%= active_blog_atom_link_tag %><% end %>
+<%= content_for :schema do %>
+  <%= schema_span_for 'name', active_blog_title %>
+  <%= schema_span_for 'description', active_blog_description %>
+  <%= schema_span_for 'url', active_blog_url %>
 <% end %>
+<div class="section active_blog index">
+  <h1><%= active_blog_title %></h1>
 
-<% @blog_posts.each do |blog| %>
-  <h2><%= blog.title %></h2>
-  <%= link_to "Permalink", active_blog_post_path(blog.cached_slug) %>
-  <%= markdown(blog.body) %>
-  <hr/>
-<% end %>
+  <% if @blog_posts.empty? %>
+    <%= link_to "Write your first blog post", new_admin_blog_post_path %>
+  <% end %>
 
+  <div itemprop="blogPosts">
+    <%= render :partial => "blog_post", :collection => @blog_posts, :locals => {:show => false} %>
+  </div>
 
-<%= blog_sidebar do %>
-  <br/>
-<% end %>
+  <%= paginate @blog_posts %>
+</div>
+
+<%= render :partial => "sidebar" %>

data/app/views/active_blog/blog_posts/preview.js.erb

@@ -0,0 +1 @@
+$('#live_preview').html('<%= escape_javascript(@blog_post_partial.html_safe) %>');

data/app/views/active_blog/blog_posts/show.html.erb

@@ -1,10 +1,7 @@
-<h1><%= ActiveBlog.blog_title %></h1>
-
-<h2><%= @blog_post.title %></h2>
-<hr/>
-
-<%= markdown(@blog_post.body) %>
-
-<%= blog_sidebar do %>
-  <br/>
-<% end %>
+<%= content_for :title do %><%= @blog_post.title %><% end %>
+<%= content_for :schema_itemtype do %>http://schema.org/BlogPosting<% end %>
+<div class="section active_blog show">
+  <h1><%= active_blog_title %></h1>
+  <%= render :partial => "blog_post", :locals => {:blog_post => @blog_post, :show => true} %>
+</div>
+<%= render :partial => "sidebar" %>

data/db/migrate/20111116040223_create_active_blog_blog_posts.rb

@@ -2,7 +2,7 @@ class CreateActiveBlogBlogPosts < ActiveRecord::Migration
   def change
     create_table :active_blog_blog_posts do |t|
       t.string :title
-      t.string :body
+      t.text :body
       t.boolean :draft
       t.datetime :published_at
       t.string :cached_slug
@@ -12,5 +12,6 @@ class CreateActiveBlogBlogPosts < ActiveRecord::Migration
       t.timestamps
     end
     add_index :active_blog_blog_posts, :id
+    add_index :active_blog_blog_posts, :cached_slug, :unique => true
   end
-end
+end

data/lib/active_blog/ext/string.rb

@@ -0,0 +1,39 @@
+class String
+  # Generate a slug for the string +value+.
+  #
+  # A slug should consist of numbers (0-9), lowercase letters (a-z) and
+  # dashes (-). Any other characters should be filtered.
+  #
+  # ==== Example
+  #
+  #   "The World is Beautiful!".to_slug # => "the-world-is-beautiful"
+  #
+  # ==== Returns
+  # String:: A 'sluggified' version of this string
+  #
+  # --
+  # @api public
+  def to_slug
+    # Perform transliteration to replace non-ascii characters with an ascii
+    # character
+    value = self.mb_chars.normalize(:kd).gsub(/[^\x00-\x7F]/n, '').to_s
+
+    # Remove single quotes from input
+    value.gsub!(/[']+/, '')
+
+    # Replace any non-word character (\W) with a space
+    value.gsub!(/\W+/, ' ')
+
+    # Remove any whitespace before and after the string
+    value.strip!
+
+    # All characters should be downcased
+    value.downcase!
+
+    # Replace spaces with dashes
+    value.gsub!(' ', '-')
+
+    # Return the resulting slug
+    value
+  end
+end

data/lib/active_blog/mapper.rb

@@ -5,8 +5,19 @@ module ActionDispatch::Routing
       #
       #
       scope mount_location do
-        match '/' => 'active_blog/blog_posts#index', :as => :active_blog
-        match '/:cached_slug' => 'active_blog/blog_posts#show', :as => :active_blog_post
+        resources :blog_posts, :module => 'active_blog', :path => '/', :only => [] do
+          get 'page/:page', :action => :index, :on => :collection
+          # match '/', :action => :index, :on => :collection, :as => :all
+          # match '/-/preview', :action => :preview, :on => :collection, :as => :preview, :via => [:post, :put]
+          # match '/-/feed', :action => :feed, :on => :collection, :as => :feed, :via => [:get]
+          # match '/:cached_slug', :action => :show, :on => :collection, :as => :post, :via => [:get]
+        end
+        match '/' => 'active_blog/blog_posts#index', :as => :active_blog, :via => [:get]
+        match '/-/preview' => 'active_blog/blog_posts#preview', :as => :active_blog_preview, :via => [:post, :put]
+        match '/atom.xml' => 'active_blog/blog_posts#atom', :as => :active_blog_feed, :via => [:get], :format => :xml
+        match '/archives' => 'active_blog/blog_posts#archives', :as => :active_blog_archives, :via => [:get]
+        # Always last.
+        match '/:cached_slug' => 'active_blog/blog_posts#show', :as => :active_blog_post, :via => [:get]
       end
     end
   end

data/lib/active_blog/version.rb

@@ -1,3 +1,3 @@
 module ActiveBlog
-  VERSION = "0.0.2"
+  VERSION = "0.5.0"
 end

data/lib/active_blog.rb

@@ -1,16 +1,37 @@
 require 'active_blog/engine'
 require 'active_blog/mapper'
 require 'redcarpet'
+require 'active_blog/ext/string'
 
 module ActiveBlog
 
   # The blog's title
-  mattr_accessor :blog_title
-  @@blog_title = 'New ActiveBlog!'
+  mattr_accessor :title
+  @@title = 'New ActiveBlog!'
+
+  # The blog's description
+  mattr_accessor :description
+  @@description = "Here's where your description goes"
 
   # Yield to your layout's sidebar, i.e. :sidebar
-  mattr_accessor :blog_content_for_sidebar
-  @@blog_content_for_sidebar = nil
+  mattr_accessor :content_for_sidebar
+  @@content_for_sidebar = nil
+
+  # Blog author's name
+  mattr_accessor :author_name
+  @@author_name = nil
+
+  # Blog author's uri
+  mattr_accessor :author_uri
+  @@author_uri = nil
+
+  # Blog author's email
+  mattr_accessor :author_email
+  @@author_email = nil
+
+  # Blog posts per page
+  mattr_accessor :paginates_per
+  @@paginates_per = 10
 
   def self.setup
     yield self

data/lib/generators/active_blog/install/install_generator.rb

@@ -21,6 +21,10 @@ module ActiveBlog
       def rake_copy_migrations
         rake('active_blog_engine:install:migrations')
       end
+
+      def show_readme
+        readme("README")
+      end
     end
   end
 end

data/lib/generators/active_blog/install/templates/README

@@ -0,0 +1,17 @@
+
+TO COMPLETE YOUR INSTALLATION
+
+1. Add the following line to application.css
+
+    *= require 'active_blog/application'
+
+2. Add the following to active_admin.css
+
+    // ActiveBlog CSS Styles
+    @import "active_blog/active_admin";
+
+3. Add the following to active_admin.js
+
+    //= require active_blog/active_admin
+
+Thanks for installing ActiveBlog!