blogelator 0.2.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00f63921c184ae963cd440bb448af9fefbe193cd
-  data.tar.gz: d38067a0784ddfe2586072dc8f9ca9216ecbf77c
+  metadata.gz: f0a3cf7c7a3935d792b07946a466709b88a08143
+  data.tar.gz: 099dc2c44719226df1db2ef5af896c94838bb65f
 SHA512:
-  metadata.gz: a8a4baceed1591c2a6c44ccbeb81af70a33d17abb0a56fe75ec210617d9de9f17a414e32d0c892942d6b4af39b967ce410f437d50e52b08f9a4125b0e96f8b00
-  data.tar.gz: 8909c05d0b46829e4dbea5edb4558c4e5a5555fb2ce88cccbf09b0a8ad072b80b0e740635d1454022736e43183b9ca9bb374dcaa5e668cb8b46715f7c81bb033
+  metadata.gz: 82e9d90458b61a38a0129a42b3845d754d22a84a021780c6fa8ce221181879b57657d09bb2158ba819090066d088136af7a74a64a58da7234a53f0b2958f7ee5
+  data.tar.gz: 8294c5a96ac19c807e71c7df4f55848e22a15d7d5014003f7b7a7d2b4557a44b9b1922e34ebfac4ed8c93d546c808972d1b3f2910fe8690781fde0c6ef1d62dd

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 Brian Pattison and Blogelator contributors
+Copyright 2014-2015 Brian Pattison
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,23 +1,8 @@
 # Blogelator
 
-[![Build Status](https://travis-ci.org/codelation/blogelator.png?branch=master)](https://travis-ci.org/codelation/blogelator)
 [![Code Climate](https://codeclimate.com/github/codelation/blogelator.png)](https://codeclimate.com/github/codelation/blogelator)
 
-Blogelator is a mountable `Rails::Engine` for adding a blog to your Rails app.
-
-## Demo
-
-Check out Blogelator in action. No login required. Content resets every hour.
-
-- **Blog**: <http://blogelator.herokuapp.com>
-- **Admin**: <http://blogelator.herokuapp.com/admin>
-
-## Features
-
-- Awesome writing experience for developers with GitHub Flavored Markdown
-- [Ember.js](http://emberjs.com) backend with live GFM -> HTML preview
-- Upload images to Amazon S3 via drag and drop
-- Follows [Spree](https://github.com/spree/spree)'s conventions for extending and overriding defaults
+Blogelator is a Ruby gem for adding a blog to a Rails project.
 
 ## Installation
 
@@ -30,61 +15,26 @@ gem "blogelator"
 Install the Blogelator gem with Bundler:
 
 ```bash
-$ bundle install
+bundle install
 ```
 
-Use the install generator to set up Blogelator:
+Install the controller, views, and database migrations:
 
 ```bash
-$ rails g blogelator:install
-```
-
-## Configuration
-
-The install generator will create `config/initializers/blogelator.rb`:
-
-```ruby
-Blogelator.site_name            = "My Awesome Blog"
-Blogelator.posts_per_page       = 5
-Blogelator.show_full_post       = false
-Blogelator.user_class           = "User"
-Blogelator.s3_access_key_id     = ENV["BLOGELATOR_S3_KEY"]
-Blogelator.s3_secret_access_key = ENV["BLOGELATOR_S3_SECRET"]
-Blogelator.s3_bucket            = ENV["BLOGELATOR_S3_BUCKET"]
+rails g blogelator:install
+rake db:migrate
 ```
 
-### Authentication
-
-Blogelator does not include authentication because there's a good chance
-you've already added authentication to your Rails app.
-
-TODO: Add info about requirements/configuration.
-
-### Authorization
-
-Blogelator uses [CanCan](https://github.com/ryanb/cancan) for authorization.
-By default, any logged in user can create, update, and delete any blog post.
-
-TODO: Add example for limiting access to admin users.
-
-### Styles
-
-The install generator will create three SCSS files in `app/assets/stylesheets/blogelator/`:
-
-- **_variables.scss** - Easiest way to change fonts and/or colors
-- **admin.css.scss** - Loads the default styles for the backend
-- **application.css.scss** - Loads the default styles for the frontend
-
-### Views
-
-View customization can be done by using [Deface](https://github.com/spree/deface)
-or by replacing view templates. If you have experience with customizing
-[Spree](https://github.com/spree/spree), you'll be right at home. Blogelator
-aims to follow Spree's conventions, so you can simply follow their documentation:
+### Active Admin
 
-> <http://guides.spreecommerce.com/developer/view.html>
+Blogelator registers the blog posts with [Active Admin](http://activeadmin.info) to
+provide the editing interface for your blog posts. Everything works best if you
+are using Active Admin and if `current_admin_user` is used to return an authenticated
+user who can manage the blog posts when signed in.
 
-TODO: Add example for using Deface to add author's name to post
+If you're not using Active Admin, it should be pretty easy to create a simple interface
+for managing your blog posts. The reason the old admin interface was removed was to
+simplify the project and remove authorization methods that don't belong in this gem.
 
 ## Contributing
 

data/Rakefile

@@ -1,34 +1,34 @@
 begin
-  require "bundler/setup"
+  require 'bundler/setup'
 rescue LoadError
-  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-desc "Run the javascript specs"
-task :teaspoon => "app:teaspoon"
-
-require "rdoc/task"
+require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "Blogelator"
-  rdoc.options << "--line-numbers"
-  rdoc.rdoc_files.include("README.rdoc")
-  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Blogelator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load "rails/tasks/engine.rake"
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
 
-require "thor"
 
 Bundler::GemHelper.install_tasks
-Dir[File.join(File.dirname(__FILE__), "tasks/**/*.rake")].each {|f| load f }
 
-require "rspec/core"
-require "rspec/core/rake_task"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
 
-desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec => "app:db:test:prepare")
 
-task :default => :spec
+task default: :test

data/app/controllers/blogelator/posts_controller.rb

@@ -1,37 +1,55 @@
-require_dependency "blogelator/application_controller"
-
 module Blogelator
   class PostsController < ApplicationController
+    before_action :set_tag, :set_posts, only: [:index]
     before_action :set_post, only: [:show]
-    
-    # GET /
+    PER_PAGE = 5
+
     def index
-      page = params[:page] ? params[:page].to_i : 1
-      per_page = Blogelator.posts_per_page
-      
-      @posts = Blogelator::Post.published.page(page).per(per_page)
     end
-    
-    # GET /post-title
+
     def show
       @title = @post.title
     end
-    
+
   private
-  
-    def set_next_post
-      @next_post = Blogelator::Post.where("published_at > ?", @post.published_at).order("published_at ASC").first
+
+    def all_posts
+      Blogelator::Post.page(params[:page]).per(PER_PAGE)
+    end
+
+    def posts
+      try(:current_admin_user) ? all_posts : published_posts
     end
-    
-    # Use callbacks to share common setup or constraints between actions.
+
+    def published_posts
+      Blogelator::Post.published.page(params[:page]).per(PER_PAGE)
+    end
+
+    def posts_with_tag
+      if try(:current_admin_user)
+        all_posts.joins(:tags).where("blogelator_tags.id = ?", @tag.id)
+      else
+        published_posts.joins(:tags).where("blogelator_tags.id = ?", @tag.id)
+      end
+    end
+
     def set_post
-      @post = Blogelator::Post.find_by_slug(params[:id])
-      set_previous_post
-      set_next_post
+      if try(:current_admin_user)
+        @post = Blogelator::Post.find_by(slug: params[:id])
+      else
+        @post = Blogelator::Post.published.find_by(slug: params[:id])
+      end
+      fail ActionController::RoutingError.new("Not Found") unless @post
     end
-    
-    def set_previous_post
-      @previous_post = Blogelator::Post.where("published_at < ?", @post.published_at).order("published_at DESC").first
+
+    def set_posts
+      @posts = params[:tag_id] ? posts_with_tag : posts
+    end
+
+    def set_tag
+      return unless params[:tag_id]
+      @tag = Blogelator::Tag.find_by(slug: params[:tag_id])
+      fail ActionController::RoutingError.new("Not Found") unless @tag
     end
   end
 end

data/app/models/blogelator/author.rb

@@ -0,0 +1,57 @@
+module Blogelator
+  class Author < ActiveRecord::Base
+    # Assocations
+    belongs_to :user, polymorphic: true
+    has_many :posts
+
+    # Paperclip attached files
+    # @see https://github.com/thoughtbot/paperclip
+    has_attached_file(
+      :profile_photo,
+      styles: {
+        retina:    "242x116>",
+        thumbnail: "121x58>"
+      }
+    )
+
+    has_attached_file(
+      :cover_photo,
+      styles: {
+        retina:    "242x116>",
+        thumbnail: "121x58>"
+      }
+    )
+
+    # Validations
+    validates :name, presence: true
+    validates :slug, presence: true, uniqueness: true
+
+    # Callbacks
+    before_save :parse_markdown
+
+    # Uses the slug as the :id parameter in URLs
+    # @return [String]
+    def to_param
+      slug
+    end
+
+  private
+
+    # Returns a customized Redcarpet Markdown -> HTML renderer.
+    # @return [Redcarpet::Markdown]
+    def markdown
+      @markdown ||= Redcarpet::Markdown.new(
+        Blogelator::HTMLRenderer,
+        autolink:                     true,
+        disable_indented_code_blocks: true,
+        fenced_code_blocks:           true,
+        space_after_headers:          true
+      )
+    end
+
+    # Convert the Markdown for the author's bio to HTML.
+    def parse_markdown
+      self.bio_html = markdown.render(bio_markdown)
+    end
+  end
+end

data/app/models/blogelator/html_renderer.rb

@@ -1,7 +1,10 @@
 module Blogelator
+  # Custom Markdown to HTML Rendered that includes:
+  #   - SmartyPants: Converts ASCII dashes, quotes, and ellipses to their HTML entity equivalents.
+  #   - Pygments: Adds code highlighting
   class HTMLRenderer < Redcarpet::Render::HTML
     include Redcarpet::Render::SmartyPants
-    
+
     def block_code(code, language)
       result = Pygments.highlight(code, lexer: language)
       result

data/app/models/blogelator/post.rb

@@ -1,63 +1,78 @@
 module Blogelator
   class Post < ActiveRecord::Base
-    attr_accessor :custom_summary
-    
-    has_many :tags
-    belongs_to :author, class_name: Blogelator.user_class
-    
-    before_save :parse_markdown, :set_slug, :set_summary
-    
-    scope :published,   -> { where("published_at IS NOT NULL").order("published_at DESC") }
-    scope :unpublished, -> { where("published_at IS NULL").order("created_at DESC") }
-    
-    validates_presence_of :title
-    
-    def active_model_serializer
-      Blogelator::PostSerializer
-    end
-    
-    def published?
-      !self.published_at.nil?
-    end
-    
+    # Assocations
+    belongs_to :author
+    has_and_belongs_to_many :related_posts, class_name: "Blogelator::Post", foreign_key: :post_id, association_foreign_key: :related_post_id
+    has_and_belongs_to_many :tags
+
+    # Paperclip attached file
+    # @see https://github.com/thoughtbot/paperclip
+    has_attached_file(
+      :image,
+      styles: {
+        retina:    "242x116>",
+        thumbnail: "121x58>"
+      }
+    )
+
+    # Validations
+    validates :slug,  presence: true, uniqueness: true
+    validates :title, presence: true
+    validates_attachment_content_type :image, content_type: /\Aimage\/.*\Z/
+
+    # Callbacks
+    before_save :parse_markdown
+    after_save :touch_tags
+
+    # Scopes
+    default_scope { includes(:author, :tags) }
+
+    enum status: {
+      preview:   0,
+      published: 1
+    }
+
+    # Uses the slug as the :id parameter in URLs
+    # @return [String]
     def to_param
-      self.slug
+      slug
+    end
+
+    # The URL for the blog post.
+    # @return [String]
+    def url(request = nil)
+      @url ||= begin
+        if request.try(:ssl?)
+          "https://#{ENV.fetch('HOST')}/blog/#{slug}"
+        else
+          "http://#{ENV.fetch('HOST')}/blog/#{slug}"
+        end
+      end
     end
-    
+
   private
-  
+
+    # Returns a customized Redcarpet Markdown -> HTML renderer.
+    # @return [Redcarpet::Markdown]
     def markdown
-      @markdown ||= Redcarpet::Markdown.new(Blogelator::HTMLRenderer, {
-        autolink: true,
+      @markdown ||= Redcarpet::Markdown.new(
+        Blogelator::HTMLRenderer,
+        autolink:                     true,
         disable_indented_code_blocks: true,
-        fenced_code_blocks: true,
-        space_after_headers: true
-      })
+        fenced_code_blocks:           true,
+        space_after_headers:          true
+      )
     end
-    
+
+    # Convert the Markdown for the post body and summary to HTML.
     def parse_markdown
-      self.body_html = markdown.render(self.body_markdown)
+      self.body_html = markdown.render(body_markdown)
+      self.summary_html = markdown.render(summary_markdown)
     end
-    
-    def set_summary
-      if @custom_summary.blank?
-        summary_text = self.body_markdown.split("\n\n").first.to_s.first(300).strip
-        summary_text += "..." if self.body_markdown.length > 300
-        summary_text = markdown.render(summary_text).to_s
-        self.summary = summary_text.gsub("<p>", "").gsub("</p>", "")
-      else
-        self.summary = markdown.render(@custom_summary)
-      end
-    end
-    
-    def set_slug
-      if self.published_at && self.slug.nil?
-        self.slug = self.title.parameterize
-        existing_slug_count = self.class.where(slug: self.slug).count
-        if existing_slug_count > 0
-          self.slug = self.slug + "-#{existing_slug_count}"
-        end
-      end
+
+    # Touch the associated tags to update cache keys.
+    def touch_tags
+      tags.each(&:touch)
     end
   end
 end

data/app/models/blogelator/tag.rb

@@ -1,5 +1,28 @@
 module Blogelator
   class Tag < ActiveRecord::Base
-    belongs_to :post
+    # Assocations
+    has_and_belongs_to_many :posts
+
+    # Validations
+    validates :name, presence: true
+    validates :slug, presence: true, uniqueness: true
+
+    # Uses the slug as the :id parameter in URLs
+    # @return [String]
+    def to_param
+      slug
+    end
+
+    # The URL for the blog post.
+    # @return [String]
+    def url(request = nil)
+      @url ||= begin
+        if request.try(:ssl?)
+          "https://#{ENV.fetch('HOST')}/blog/tags/#{slug}"
+        else
+          "http://#{ENV.fetch('HOST')}/blog/tags/#{slug}"
+        end
+      end
+    end
   end
 end

data/app/views/blogelator/kaminari/_paginator.html.erb

@@ -0,0 +1,19 @@
+<%# The container tag
+  - available local variables
+    current_page:  a page object for the currently displayed page
+    total_pages:   total number of pages
+    per_page:      number of items to fetch per page
+    remote:        data-remote
+    paginator:     the paginator that renders the pagination tags inside
+-%>
+
+<nav class="pagination">
+  <%# We're hard coding the URLs with the assumption that the blog will be served at /blog %>
+  <% if @tag %>
+    <%= link_to "Newer", "/blog/tags/#{@tag.slug}?page=#{current_page - 1}", class: "newer" unless current_page.first? %>
+    <%= link_to "Older", "/blog/tags/#{@tag.slug}?page=#{current_page + 1}", class: "older" unless current_page.last? %>
+  <% else %>
+    <%= link_to "Newer", "/blog?page=#{current_page - 1}", class: "newer" unless current_page.first? %>
+    <%= link_to "Older", "/blog?page=#{current_page + 1}", class: "older" unless current_page.last? %>
+  <% end %>
+</nav>

data/app/views/blogelator/posts/_meta.html.erb

@@ -0,0 +1,40 @@
+<link rel="canonical" href="<%= @post.url(request) %>" />
+<% unless @post.meta_description.blank? %>
+  <meta name="description" content="<%= @post.meta_description %>">
+<% end %>
+<% unless @post.meta_keywords.blank? %>
+  <meta name="keywords" content="<%= @post.meta_keywords %>">
+<% end %>
+
+<meta property="article:published_time" content="<%= @post.created_at %>" />
+<meta property="og:site_name" content="In the Booth" />
+<meta property="og:type" content="article" />
+<meta property="og:title" content="<%= @post.title %>" />
+<meta property="og:description" content="<%=strip_tags(@post.summary_html) %>" />
+<meta property="og:url" content="<%= @post.url(request) %>" />
+<meta property="og:image" content="<%= @post.image.url %>" />
+<meta name="twitter:card" content="summary_large_image" />
+<meta name="twitter:title" content="<%= @post.title %>" />
+<meta name="twitter:description" content="<%=strip_tags(@post.summary_html) %>" />
+<meta name="twitter:url" content="<%= @post.url(request) %>" />
+<meta name="twitter:image:src" content="<%= @post.image.url %>" />
+
+<script type="application/ld+json">
+  {
+      "@context": "http://schema.org",
+      "@type": "Article",
+      "publisher": "<%= t('titles.application') %>",
+      "author": {
+          "@type": "Person",
+          "name": "<%= @post.author.name %>",
+          "image": "<%= @post.author.profile_photo.url %>",
+          "url": "/blog",
+          "description": "<%= strip_tags(@post.author.bio_html) %>"
+      },
+      "headline": "<%= @post.title %>",
+      "url": "<%= @post.url(request) %>",
+      "datePublished": "<%= @post.created_at %>",
+      "image": "<%= @post.image.url %>",
+      "description": "<%= strip_tags(@post.summary_html) %>"
+  }
+</script>

data/app/views/blogelator/posts/_post.html.erb

@@ -1,18 +1,21 @@
-<% cache [Blogelator::VERSION, post, "index", Blogelator.show_full_post] do %>
-  <div class="post">
-    <h2><%= link_to post.title, post %></h2>
-    <div class="date">
-      <%= local_time(post.published_at, format: '%B %e, %Y') %>
+<% cache [Blogelator::VERSION, post, "index"] do %>
+  <div class="post <%= post.status %>">
+    <h2><%= link_to post.title, post.url(request) %></h2>
+    <div class="published-at">
+      <%= local_time(post.published_at, format: "%B %e, %Y") %>
     </div>
-    <div class="summary">
-      <p>
-        <% if Blogelator.show_full_post %>
-          <%=raw post.body_html %>
-        <% else %>
-          <%=raw post.summary %>
-          <%= link_to raw("Continue reading &raquo;"), post, class: "continue" %>
-        <% end %>
-      </p>
+    <div class="tags">
+      <%= render post.tags %>
     </div>
+    <% if post.summary_html.blank? %>
+      <div class="body">
+        <%== post.body_html %>
+      </div>
+    <% else %>
+      <div class="summary">
+        <%== post.summary_html %>
+        <%= link_to raw("Continue reading &raquo;"), post.url(request), class: "continue" %>
+      </div>
+    <% end %>
   </div>
 <% end %>

data/app/views/blogelator/posts/index.html.erb

@@ -1,39 +1,10 @@
 <% cache [Blogelator::VERSION, @posts] do %>
   <% if @posts.length > 0 %>
     <%= render @posts %>
-    <div class="pagination">
-      <%= link_to_next_page @posts, "Older", class: "older" %>
-      <%= link_to_previous_page @posts, "Newer", class: "newer" %>
-    </div>
+    <%= paginate @posts, views_prefix: "blogelator" %>
   <% else %>
-    <div class="post">
-      <h2>
-        <a href="https://github.com/codelation/blogelator">
-          Welcome to Blogelator
-        </a>
-      </h2>
-      <div class="date">
-        <%= local_time(Time.now, format: '%B %e, %Y') %>
-      </div>
-      <div class="summary">
-        <p>
-          Navigate to <%= link_to "#{File.join(request.path, "admin")}", blogelator.admin_path %>
-          to create your first blog post. You will need to have your authentication set up
-          already before you can access the Blogelator admin section.
-        </p>
-        <p>
-          For more information about setting up Blogelator, check out the Readme on GitHub:
-        </p>
-        <blockquote>
-          <a href="https://github.com/codelation/blogelator">https://github.com/codelation/blogelator</a>
-        </blockquote>
-        <p>
-          Thanks for using Blogelator,
-        </p>
-        <p>
-          <a href="http://twitter.com/brianpattison">@brianpattison</a>
-        </p>
-      </div>
-    </div>
+    <p>
+      There are no blog posts.
+    </p>
   <% end %>
 <% end %>

data/app/views/blogelator/posts/show.html.erb

@@ -1,27 +1,16 @@
 <% cache [Blogelator::VERSION, @post, "show"] do %>
-  <div class="post">
-    <h1><%= link_to @post.title, @post %></h1>
-    <div class="date">
-      <%= local_time(@post.published_at, format: '%B %e, %Y') %>
+  <div class="post <%= @post.status %>">
+    <h1><%= link_to @post.title, @post.url(request) %></h1>
+    <%= local_time(@post.published_at, format: "%B %e, %Y", class: "published-at") %>
+    <div class="tags">
+      <%= render @post.tags %>
     </div>
     <div class="body">
-      <%=raw @post.body_html %>
+      <%== @post.body_html %>
     </div>
   </div>
-<% end %>
-
-<div class="more-posts">
-  <% if @previous_post %>
-    <%= link_to @previous_post, class: "previous" do %>
-      <%= @previous_post.title %><br />
-      <%= local_time(@previous_post.published_at, format: '%B %e, %Y') %>
-    <% end %>
-  <% end %>
 
-  <% if @next_post %>
-    <%= link_to @next_post, class: "next" do %>
-      <%= @next_post.title %><br />
-      <%= local_time(@next_post.published_at, format: '%B %e, %Y') %>
-    <% end %>
+  <% content_for :head do %>
+    <% render "meta" %>
   <% end %>
-</div>
+<% end %>

data/app/views/blogelator/tags/_tag.html.erb

@@ -0,0 +1 @@
+<%= link_to tag.name, tag.url(request), class: "tag" %>