blogo 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fa8f05b64cf6073de50276463fd756e4ae1ea6c
-  data.tar.gz: e849c0b55e525c40fd2425ca6fc043e3ad7b0d0e
+  metadata.gz: 267c58dc478854e27327ad35435293f38555184e
+  data.tar.gz: 676ee2ecc4e6f947e929f60ff3d65d3e05632621
 SHA512:
-  metadata.gz: caa17c96c373209c272f0a806959ce2c5078dd4e96607c57c1c120625fd988f2b7bbe01f84b349f2bc87cb04e9b7978c96832943dc87baf7b50e5758e01e1ced
-  data.tar.gz: 43a1e53c9af3c9190403e8a55673f9ff982ab8bcb676791f53ae3f23af86c291ec69b9d32278e862a5341ffae066eb48fabdc482f8b9da80aa51e37514438327
+  metadata.gz: 35308726152df9737d2bb597bc58a9bed9e69cbacddf7f058564a669018fe8e6d1df3152584470dbd4f081797c1f4560705521ea0f176dc7cb7bad9053e32cbd
+  data.tar.gz: 399072ad5edc5019b984c0f0921d293d79139c523852ea31565ee8164d9c85461e943c22915f0902681c89606d0ab8b8a4acf5bde1eceda6405e1a971edd5ee2

data/app/controllers/blogo/admin/comments_controller.rb

@@ -1,7 +1,11 @@
 module Blogo::Admin
+  # Does nothing, simply displays Disqus comments, that loaded with JS.
   class CommentsController < BaseController
-    def index
 
+    # GET /admin/comments
+    #
+    def index
     end
+
   end
 end

data/app/controllers/blogo/admin/posts_controller.rb

@@ -1,14 +1,21 @@
 module Blogo::Admin
+  # Responsible for posts management: creation, editing, deletion, preview.
   class PostsController < BaseController
 
+    # GET /admin/posts
+    #
     def index
       @posts = Blogo::Post.all
     end
 
+    # GET /admin/posts/new
+    #
     def new
       @post = Blogo::Post.new(published: true)
     end
 
+    # POST /admin/posts
+    #
     def create
       service = Blogo::CreatePostService.new(blogo_current_user, post_params)
 
@@ -22,12 +29,16 @@ module Blogo::Admin
       end
     end
 
+    # GET /admin/posts/:id/edit
+    #
     def edit
-      @post = Blogo::Post.find(params[:id])
+      @post = Blogo::Post.where(permalink: params[:id]).first!
     end
 
+    # PATCH /admin/posts/:id
+    #
     def update
-      @post = Blogo::Post.find(params[:id])
+      @post = Blogo::Post.where(permalink: params[:id]).first!
       service = Blogo::UpdatePostService.new(@post, post_params)
 
       if service.update!
@@ -38,6 +49,8 @@ module Blogo::Admin
       end
     end
 
+    # DELETE /admin/posts/:id
+    #
     def destroy
       post = Blogo::Post.find(params[:id])
       Blogo::DestroyPostService.new(post).destroy!
@@ -46,6 +59,8 @@ module Blogo::Admin
       redirect_to blogo_admin_posts_path
     end
 
+    # POST /admin/posts/preview
+    #
     def preview
       @post = Blogo::PreviewPostService.new(blogo_current_user, post_params).preview
 
@@ -57,6 +72,9 @@ module Blogo::Admin
 
     private
 
+    # Get post parameters from params.
+    #
+    # @return [Hash]
     def post_params
       params.require(:post).permit(:title, :permalink, :published_at, :raw_content, :published, :tags_string)
     end

data/app/controllers/blogo/admin/sessions_controller.rb

@@ -1,10 +1,18 @@
 module Blogo::Admin
+  # Responsible for authentication of blog users.
+  # Simply performs 2 operation: login and logout.
+  # User is logged in if it has set sessions[:blogo_user_id].
+  #
   class SessionsController < BaseController
     skip_before_filter :ensure_authenticated!
 
+    # GET /admin/login
+    #
     def new
     end
 
+    # POST /admin/sessions
+    #
     def create
       user = Blogo::User.find_by_email(params[:email])
       if user && user.authenticate(params[:password])
@@ -16,6 +24,9 @@ module Blogo::Admin
       end
     end
 
+
+    # GET /admin/logout
+    #
     def destroy
       session[:blogo_user_id] = nil
       redirect_to blogo_admin_url, notice: "You have logged out"

data/app/controllers/blogo/posts_controller.rb

@@ -1,38 +1,45 @@
 module Blogo
+  # Responsible for showing posts and atom feeds to visitors.
   class PostsController < ApplicationController
     layout 'blogo/blog'
 
     # Number of posts shown in feed.
     FEED_POSTS_LIMIT = 20
 
+    # GET /posts
+    #
     def index
       @tag = params[:tag]
       set_vars
       set_paginator
 
       @meta = {}
-      @meta[:title]         = "#{Blogo.config.site_title} - #{Blogo.config.site_subtitle}"
-      @meta[:site_name]     = Blogo.config.site_title
-      @meta[:keywords]      = Blogo.config.keywords
-      @meta[:type]          = 'website'
+      @meta[:title]     = "#{Blogo.config.site_title} - #{Blogo.config.site_subtitle}"
+      @meta[:site_name] = Blogo.config.site_title
+      @meta[:keywords]  = Blogo.config.keywords
+      @meta[:type]      = 'website'
     end
 
+    # GET /posts/:permalink
+    #
     def show
       @post = Post.published.where(:permalink => params[:permalink]).first!
       set_vars
 
       @meta = {}
-      @meta[:title]         = "#{@post.title} - #{Blogo.config.site_title}"
-      @meta[:description]   = @post.meta_description
-      @meta[:keywords]      = [@post.tags_string, Blogo.config.keywords].flatten.join(", ")
-      @meta[:url]           = request.url
-      @meta[:image]         = meta_image
-      @meta[:type]          = 'article'
-      @meta[:site_name]     = Blogo.config.site_title
+      @meta[:title]       = "#{@post.title} - #{Blogo.config.site_title}"
+      @meta[:description] = @post.meta_description
+      @meta[:keywords]    = [@post.tags_string, Blogo.config.keywords].flatten.join(", ")
+      @meta[:url]         = request.url
+      @meta[:image]       = meta_image
+      @meta[:type]        = 'article'
+      @meta[:site_name]   = Blogo.config.site_title
     end
 
+    # GET /posts/feed
+    #
     def feed
-      @posts   = published_posts.limit(FEED_POSTS_LIMIT)
+      @posts   = Post.published.limit(FEED_POSTS_LIMIT)
       @updated = @posts.first.try(:updated_at)
 
       render 'feed', layout: false
@@ -41,25 +48,28 @@ module Blogo
 
     private
 
+    # Build a paginator object and set to @paginator.
+    #
+    # @return [Blogo::Paginator]
     def set_paginator
-      posts = published_posts
-      posts = posts.joins(:tags).where("#{Tag.table_name}.name = ?", @tag) if @tag
+      posts_scope = Post.published
+
+      if @tag
+        posts_scope = posts_scope.joins(:tags).where("#{Tag.table_name}.name = ?", @tag)
+      end
 
       @paginator = Paginator.new(
-        posts,
+        posts_scope,
         :page     => (params[:page] || 1),
         :per_page => conf.posts_per_page,
         :size     => conf.paginator_size)
     end
 
+    # Sets @recent_posts and @tags.
+    #
     def set_vars
-      @recent_posts = published_posts.limit(conf.recent_posts) if conf.recent_posts
-      @tags = Tag.all
-    end
-
-
-    def published_posts
-      Post.published
+      @recent_posts = Post.published.limit(conf.recent_posts) if conf.recent_posts
+      @tags         = Tag.all
     end
 
     # Engine configuration. Method +config+ is already used by Rails.
@@ -69,9 +79,10 @@ module Blogo
       Blogo.config
     end
 
-
+    # @return [String, nil] full URL to image or nil
     def meta_image
       return nil unless @post.meta_image.present?
+
       if @post.meta_image =~ /\Ahttp/
         @post.meta_image
       else

data/app/helpers/blogo/application_helper.rb

@@ -3,19 +3,6 @@ module Blogo
   module ApplicationHelper
     include Rails.application.routes.url_helpers
 
-    # Path to a post with year prefix.
-    #
-    # @param post [Blogo::Post]
-    #
-    # @return [String]
-    def path_to_post(post)
-      blogo_post_path(:permalink => post.permalink)
-    end
-
-    def url_to_post(post)
-      blogo_post_url(:permalink => post.permalink)
-    end
-
     # Path to a page or a page in scope of a particular tag.
     #
     # @param page [Integer]
@@ -36,7 +23,7 @@ module Blogo
     #
     # @return [String]
     def post_overview(post)
-      post.html_overiew ? post.html_overiew : post.html_content
+      post.html_overview ? post.html_overview : post.html_content
     end
   end
 end

data/app/models/blogo/post.rb

@@ -31,13 +31,18 @@ class Blogo::Post < ActiveRecord::Base
   end
 
 
+  def to_param
+    permalink
+  end
+
+
   private
 
   # Filter html content to get plain text and set first 200 characters as meta_description.
   #
   # @return [void]
   def set_meta_description
-    html = html_overiew || html_content
+    html = html_overview || html_content
 
     self.meta_description =
       html.gsub(/<\/?[^>]*>/, ' ').  # replace HTML tags with spaces

data/app/services/blogo/base_post_service.rb

@@ -36,14 +36,16 @@ module Blogo
     end
 
     def render_and_set_content!
-      renderer = Blogo::Renderer.get(Blogo.config.markup_lang)
+      return unless @post.raw_content
 
+      renderer = Blogo::Renderer.get(Blogo.config.markup_lang)
       overview, rest = @post.raw_content.split(JUMP_BREAK, 2)
+
       if rest.present?
-        @post.html_overiew = renderer.render(overview)
+        @post.html_overview = renderer.render(overview)
         @post.html_content = renderer.render(overview + rest)
       else
-        @post.html_overiew = nil
+        @post.html_overview = nil
         @post.html_content = renderer.render(@post.raw_content)
       end
     end

data/app/views/blogo/{shared → posts}/_disqus_comments.html.erb

@@ -9,7 +9,7 @@
   <script type="text/javascript">
     var disqus_shortname  = '<%= Blogo.config.disqus_shortname %>';
     var disqus_identifier = 'blog-post-<%= @post.id %>';
-    var disqus_url        = '<%= url_to_post(@post) %>';
+    var disqus_url        = '<%= blogo_post_url(@post) %>';
     var disqus_title      = '<%= @post.title %>';
     var disqus_script     = 'embed.js';
 

data/app/views/blogo/posts/_post_header.html.erb

@@ -1,5 +1,5 @@
 <header>
-  <h1><%= link_to post.title, path_to_post(post) %></h1>
+  <h1><%= link_to post.title, blogo_post_path(post) %></h1>
 
   <div class="posted">
     <span>

data/app/views/blogo/posts/_post_overview.html.erb

@@ -5,5 +5,5 @@
     <%= raw post_overview(post) %>
   </div>
 
-  <%= link_to "Read ➞", path_to_post(post), class: 'pure-button button-secondary' %>
+  <%= link_to "Read ➞", blogo_post_path(post), class: 'pure-button button-secondary' %>
 </section>

data/app/views/blogo/posts/feed.atom.builder

@@ -4,8 +4,8 @@ atom_feed do |feed|
   feed.updated  @updated
 
   @posts.each do |post|
-    feed.entry(post, url: url_to_post(post)) do |entry|
-      entry.url     url_to_post(post)
+    feed.entry(post, url: blogo_post_url(post)) do |entry|
+      entry.url     blogo_post_url(post)
       entry.title   post.title
       entry.content post_overview(post), :type => 'html'
       entry.updated post.updated_at.strftime("%Y-%m-%dT%H:%M:%SZ")

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

@@ -1,5 +1,5 @@
 <div id="main">
-  <%= render 'blogo/shared/post' %>
+  <%= render 'blogo/posts/post' %>
   <%= render 'blogo/posts/social_share' %>
-  <%= render 'blogo/shared/disqus_comments' %>
+  <%= render 'blogo/posts/disqus_comments' %>
 </div>

data/app/views/blogo/shared/_aside.html.erb

@@ -6,7 +6,7 @@
     <ul class="blogo-recent-posts">
       <% @recent_posts.each do |post| %>
         <li>
-          <%= link_to post.title, path_to_post(post) %>
+          <%= link_to post.title, blogo_post_path(post) %>
         </li>
       <% end %>
     </ul>

data/app/views/layouts/blogo/blog.html.erb

@@ -4,7 +4,7 @@
   <title><%= @meta[:title] %></title>
   <meta charset="UTF-8">
 
-  <%= render partial: 'blogo/posts/meta' %>
+  <%= render partial: 'blogo/shared/meta' %>
 
   <%= csrf_meta_tags %>
   <%= stylesheet_link_tag "blogo/blog" %>
@@ -21,7 +21,7 @@
       </div>
 
       <div class='header-icons'>
-        <%= render partial: 'blogo/posts/icons' %>
+        <%= render partial: 'blogo/shared/social_icons' %>
       </div>
     </header>
 

data/db/migrate/20140218134550_create_blogo_posts.rb

@@ -13,7 +13,7 @@ class CreateBlogoPosts < ActiveRecord::Migration
       t.text     :raw_content  , null: false
 
       t.text     :html_content , null: false
-      t.text     :html_overiew , null: true
+      t.text     :html_overview, null: true
 
       t.string   :tags_string      , null: true
       t.string   :meta_description , null: false
@@ -26,6 +26,7 @@ class CreateBlogoPosts < ActiveRecord::Migration
     add_index posts_table, :permalink, unique: true
     add_index posts_table, :published_at
 
+    # NOTE: respond_to?(:add_foreign_key) does not work
     if defined?(Foreigner)
       users_table = "#{Blogo.table_name_prefix}users"
       add_foreign_key posts_table, users_table, column: :user_id

data/lib/blogo/version.rb

@@ -1,3 +1,3 @@
 module Blogo
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blogo
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Sergey Potapov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -106,9 +134,9 @@ files:
 - app/views/blogo/admin/posts/new.html.erb
 - app/views/blogo/admin/sessions/new.html.erb
 - app/views/blogo/admin/shared/_nav_bar.html.erb
-- app/views/blogo/posts/_icons.html.erb
-- app/views/blogo/posts/_meta.html.erb
+- app/views/blogo/posts/_disqus_comments.html.erb
 - app/views/blogo/posts/_paginator.html.erb
+- app/views/blogo/posts/_post.html.erb
 - app/views/blogo/posts/_post_header.html.erb
 - app/views/blogo/posts/_post_overview.html.erb
 - app/views/blogo/posts/_social_share.html.erb
@@ -116,9 +144,9 @@ files:
 - app/views/blogo/posts/index.html.erb
 - app/views/blogo/posts/show.html.erb
 - app/views/blogo/shared/_aside.html.erb
-- app/views/blogo/shared/_disqus_comments.html.erb
 - app/views/blogo/shared/_google_analytics.html.erb
-- app/views/blogo/shared/_post.html.erb
+- app/views/blogo/shared/_meta.html.erb
+- app/views/blogo/shared/_social_icons.html.erb
 - app/views/layouts/blogo/admin.html.erb
 - app/views/layouts/blogo/blog.html.erb
 - config/environment.rb