k3cms_blog 0.1.0

data/app/controllers/k3cms/blog/base_controller.rb

@@ -0,0 +1,29 @@
+module K3cms
+  module Blog
+    class BaseController < ApplicationController
+
+      include CanCan::ControllerAdditions
+      helper K3cms::InlineEditor::InlineEditorHelper
+
+      def current_ability
+        @current_ability ||= K3cms::Blog::Ability.new(k3cms_user)
+      end
+
+      rescue_from CanCan::AccessDenied do |exception|
+        k3cms_authorization_required(exception)
+      end
+
+    protected
+      # Unfortunately, FriendlyId raises an error for some things instead of just adding a validation error to the errors array.
+      # Let's try to respond the same as we would for a validation error though.
+      rescue_from ::FriendlyId::BlankError, :with => :rescue_friendly_id_blank_error
+
+      def rescue_friendly_id_blank_error
+        respond_to do |format|
+          format.json { render :json => {:error => 'Cannot be blank'} }
+        end
+      end
+
+    end
+  end
+end

data/app/controllers/k3cms/blog/blog_posts_controller.rb

@@ -0,0 +1,82 @@
+module K3cms
+  module Blog
+    class BlogPostsController < K3cms::Blog::BaseController
+      load_and_authorize_resource :blog_post, :class => 'K3cms::Blog::BlogPost'
+
+      def index
+        @blog_posts = @blog_posts.order('id desc')
+        respond_to do |format|
+          format.html # index.html.erb
+          format.xml  { render :xml  => @blog_posts }
+          format.json { render :json => @blog_posts }
+        end
+      end
+
+      def show
+        respond_to do |format|
+          format.html # show.html.erb
+          format.xml  { render :xml  => @blog_post }
+          format.json { render :json => @blog_post }
+        end
+      end
+
+      def new
+        respond_to do |format|
+          format.html # new.html.erb
+          format.xml  { render :xml  => @blog_post }
+          format.json { render :json => @blog_post }
+        end
+      end
+
+      def create
+        @blog_post.attributes = params[:k3cms_blog_blog_post]
+        @blog_post.author = current_user
+
+        respond_to do |format|
+          if @blog_post.save
+            format.html do
+              #redirect_to(k3cms_blog_blog_post_url(@blog_post),
+
+              redirect_to(k3cms_blog_blog_posts_url(:focus => "##{dom_id(@blog_post)} .editable[data-attribute=title]"),
+                          :notice => 'Blog post was successfully created.')
+            end
+            format.xml  { render :xml => @blog_post, :status => :created, :location => @blog_post }
+            format.json { render :nothing =>  true }
+          else
+            format.html { render :action => "new" }
+            format.xml  { render :xml => @blog_post.errors, :status => :unprocessable_entity }
+            format.json { render :nothing =>  true }
+          end
+        end
+      end
+
+      def edit
+      end
+
+      def update
+        respond_to do |format|
+          if @blog_post.update_attributes(params[:k3cms_blog_blog_post])
+            format.html { redirect_to(k3cms_blog_blog_post_url(@blog_post), :notice => 'Blog post was successfully updated.') }
+            format.xml  { head :ok }
+            format.json { render :json => {} }
+          else
+            format.html { render :action => "edit" }
+            format.xml  { render :xml => @blog_post.errors, :status => :unprocessable_entity }
+            format.json { render :json => {:error => @blog_post.errors.full_messages.join('<br/>')} }
+          end
+        end
+      end
+
+      def destroy
+        @blog_post.destroy
+        respond_to do |format|
+          #format.html { redirect_to(k3cms_blog_blog_posts_url) }
+          format.html { redirect_to k3cms_blog_blog_posts_url }
+          format.xml  { head :ok }
+          format.json { render :nothing =>  true }
+        end
+      end
+
+    end
+  end
+end

data/app/models/k3cms/blog/ability.rb

@@ -0,0 +1,37 @@
+module K3cms
+  module Blog
+    class Ability
+      include CanCan::Ability
+
+      def initialize(user)
+        if user.k3cms_permitted?(:view_blog_post)
+          can :read, K3cms::Blog::BlogPost, [] do |blog_post|
+            blog_post.published?
+          end
+        end
+
+        if user.k3cms_permitted?(:edit_blog_post)
+          can :read, K3cms::Blog::BlogPost
+          can :update, K3cms::Blog::BlogPost
+        end
+
+        if user.k3cms_permitted?(:edit_own_blog_post)
+          can :read, K3cms::Blog::BlogPost
+          can :update, K3cms::Blog::BlogPost, :author_id => user.id
+        end
+
+        if user.k3cms_permitted?(:create_blog_post)
+          can :create, K3cms::Blog::BlogPost
+        end
+
+        if user.k3cms_permitted?(:delete_blog_post)
+          can :destroy, K3cms::Blog::BlogPost
+        end
+
+        if user.k3cms_permitted?(:delete_own_blog_post)
+          can :destroy, K3cms::Blog::BlogPost, :author_id => user.id
+        end
+      end
+    end
+  end
+end

data/app/models/k3cms/blog/blog_post.rb

@@ -0,0 +1,75 @@
+
+module K3cms
+  module Blog
+    class BlogPost < ActiveRecord::Base
+      self.include_root_in_json = false
+      set_table_name 'k3cms_blog_blog_posts'
+
+      # There are multiple fields/methods involved for the slug/friendly_id. Don't be confused:
+      # * The cached_slug attribute is used when we do BlogPost.find('my-slug')
+      # * The url attribute is never (!!!) "used", except as input to friendly_id, which will then process it and *convert* it to a valid url, as necessary. The result of that, of course, is available in cached_slug.
+      # * The url= setter is left intact, but the url getter is overridden to return cached_slug, because we essentially never want to accidentally use a user-supplied value (read_attribute(:url)) instead of the processed value.
+      # The url attribute will remain nil unless it is ever manually set by the user.
+      # As long as custom_url? is false (the url attribute is nil), it will automatically create a slug based on title any time the title is updated.
+      # As soon as you set the url manually, however, it will stop doing that.
+      has_friendly_id :title_or_custom_url, :use_slug => true
+
+      belongs_to :author, :class_name => 'User'
+
+      normalize_attributes :title, :summary, :body, :with => [:strip, :blank]
+
+      validates :title, :presence => true
+      validates :date, :timeliness => {:type => :date}
+      #validates :url, :uniqueness => true, :allow_nil => true, :allow_blank => true
+
+      after_initialize :set_defaults
+      def set_defaults
+        # Copy summary to body
+        default_summary = '<p>Summary description goes here</p>'
+        self.body = self.attributes['summary']                   if self.attributes['body'].nil? && self.attributes['summary'].present? && self.attributes['summary'] != default_summary
+
+        if new_record?
+          self.title   = 'New Post'                             if self.attributes['title'].nil?
+          self.summary = default_summary                        if self.attributes['summary'].nil?
+          self.date = Date.tomorrow                             if self.attributes['date'].nil?
+        end
+      end
+
+      def to_s
+        title
+      end
+
+      #---------------------------------------------------------------------------------------------
+      # url/slug/friendly_id
+    private
+      def title_or_custom_url
+        custom_url? ? read_attribute(:url) : title
+      end
+    public
+      def normalize_friendly_id(text)
+        # This uses stringex
+        text.to_url
+      end
+      def url
+        cached_slug
+      end
+      def url=(new)
+        if new
+          new = normalize_friendly_id(new)
+        end
+        # By checking if new != url, we solve the problem where a user might tab from the title field to the url field, and then when they tab out of the url field, it will try to save the current url as a custom url instead of realizing that this is still an automatic url from the title.
+        if new != url # NOT read_attribute(:url) -- we want to compare to the cached_slug based on the title if that's what is currently being used for the slug
+          write_attribute(:url, new)
+        end
+      end
+      def custom_url?
+        read_attribute(:url).present?
+      end
+
+      #---------------------------------------------------------------------------------------------
+      def published?
+        date and Time.zone.now >= date.beginning_of_day
+      end
+    end
+  end
+end

data/app/models/user_decorator.rb

@@ -0,0 +1,3 @@
+User.class_eval do
+  has_many :k3cms_blog_posts
+end

data/app/views/k3cms/blog/blog_posts/_form.html.erb

@@ -0,0 +1,28 @@
+<%= form_for(@blog_post) do |f| %>
+  <% if @blog_post.errors.any? %>
+  <div id="errorExplanation">
+    <h2><%= pluralize(@blog_post.errors.count, "error") %> prevented this blog post from being saved:</h2>
+    <ul>
+    <% @blog_post.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+    </ul>
+  </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </div>
+  <div class="field">
+    <%= f.label :body %><br />
+    <%= f.text_field :body %>
+  </div>
+  <div class="field">
+    <%= f.label :summary %><br />
+    <%= f.text_field :summary %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/k3cms/blog/blog_posts/edit.html.erb

@@ -0,0 +1,3 @@
+<h1>Editing blog post</h1>
+
+<%= render 'form' %>

data/app/views/k3cms/blog/blog_posts/index.html.haml

@@ -0,0 +1,3 @@
+- content_for :title do
+  News
+= render_cell 'k3cms/blog/blog_posts', :index

data/app/views/k3cms/blog/blog_posts/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New blog_post</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', k3cms_blog_blog_posts_path %>

data/app/views/k3cms/blog/blog_posts/show.html.haml

@@ -0,0 +1,41 @@
+.k3cms_blog_blog_posts_show
+  - content_for :title do
+    = strip_tags @blog_post.title
+
+  - if edit_mode? and can?(:edit, K3cms::Blog::BlogPost)
+    :javascript
+      $(function() {
+        $('#k3cms_ribbon').k3cms_ribbon('enable', '.k3cms_blog .blog_post_metadata.button');
+      })
+
+    - k3cms_ribbon_add_drawer :k3cms_blog_blog_post_metadata do
+      = render_cell 'k3cms/blog/blog_posts', :metadata_drawer, :blog_post => @blog_post
+
+  %div{:class => dom_class(@blog_post), :id => dom_id(@blog_post)}
+    = render_cell 'k3cms/blog/blog_posts', :published_status, :blog_post => @blog_post
+    %h2.title
+      - if edit_mode? and can?(:edit, K3cms::Blog::BlogPost)
+        = inline_editable('span', @blog_post, :title) do
+          = raw @blog_post.title
+      - else
+        = raw @blog_post.title
+
+    .date
+      - if edit_mode? and can?(:edit, K3cms::Blog::BlogPost)
+        = inline_editable('span', @blog_post, :date) do
+          = raw @blog_post.date
+      - else
+        = @blog_post.date && @blog_post.date.to_s(:long)
+
+    .body
+      - if edit_mode? and can?(:edit, K3cms::Blog::BlogPost)
+        = inline_editable('div', @blog_post, :body) do
+          = raw @blog_post.body
+      - else
+        = raw @blog_post.body
+
+    .post_bottom
+      -# Comments, etc. go here
+
+:javascript
+  #{inline_editor_update_page_from_object(@blog_post)}

data/app/views/k3cms/blog/init.html.haml

@@ -0,0 +1,34 @@
+- if edit_mode?
+  :javascript
+    $(function() {
+      $('#k3cms_ribbon').k3cms_ribbon({tabs: [
+        new K3cms_Ribbon.Tab('k3cms_blog', {label: 'Blog Post', sections: [
+          new K3cms_Ribbon.Section('k3cms_blog', {items: [
+            new K3cms_Ribbon.Button({
+              element: $('<li/>', { 'class': "icon button blog_post_metadata" }).
+                append($('<a/>', {title: "Post Information", href: "javascript:;", html: '&nbsp;'})),
+              onClick:  function() { $(this).k3cms_ribbon('isEnabled') && $(this).trigger('invoke'); },
+              onInvoke: function() { $('.k3cms_blog_blog_post_metadata.drawer').slideToggle(); $('.k3cms_blog_blog_post_metadata.drawer .editable:visible:eq(0)').focus() }
+            }),
+            new K3cms_Ribbon.Button({
+              element: $('<li/>', { 'class': "icon button list_blog_posts" }).
+                append($('<a/>', {title: "List Blog Posts", href: "#{k3cms_blog_blog_posts_path}", html: '&nbsp;'})),
+              onMousedown: function(event) {
+                var a = $(this).find('a').eq(0);
+                if ($(this).k3cms_ribbon('isEnabled')) {
+                  a.attr('href', a.data('href'));
+                } else {
+                  a.data('href', a.attr('href'));
+                  a.attr('href', 'javascript:;');
+                }
+              },
+            }),
+          ]})
+        ]})
+      ]})
+      $('#k3cms_ribbon').k3cms_ribbon({
+        always_enabled: [
+          '.k3cms_blog .list_blog_posts.button',
+        ]
+      });
+    })

data/config/authorization.rb

@@ -0,0 +1,37 @@
+K3cms::Blog::Railtie.authorization.draw do
+  # First define and describe some suggested permission sets.
+  suggested_permission_set :default, 'Allows managers to create & edit all blog_posts, and delete their own blog_posts'
+  suggested_permission_set :user_creation, 'Allows users to create and manage their own blog_posts'
+
+  # Context makes all abilities defined within to be prefixed with the
+  # singularized version of the given string.  Contexts can be nested.
+  context :blog_posts do
+    ability :view, 'Can view a blog_post'  # Creates :view_blog_post ability
+    ability :edit, 'Can edit a blog_post'
+    ability :edit_own, 'Can edit only my blog_posts'
+    ability :create, 'Can create a new blog_post'
+    ability :delete, 'Can delete a blog_post'
+    ability :delete_own, 'Can delete only blog_posts created by me'
+
+    # This defines the abilities for the default suggested permission set
+    # in terms of the four default roles (guest, user, manager, admin)
+    extend_suggested_permission_set :default do
+      guest :has => :view
+      # NOTE: :includes_role without first defining the role to be included
+      # will cause an error.  The included abilities are limited to
+      # this extend_suggested_permission_set block.
+      user :includes_role => :guest
+      manager :has => [:create, :edit_own, :delete_own], :includes_role => :user
+      # :all only applies to the abilities in this context (:blog_posts)
+      admin :has => :all
+    end
+
+    # Define abilities for the suggested permission set.
+    extend_suggested_permission_set :user_creation do
+      guest :has => :view
+      user :has => [:create, :edit_own, :delete_own], :includes_role => :guest
+      manager :has => :all
+      admin :has => :all
+    end
+  end
+end

data/config/locales/validates_timeliness.en.yml

@@ -0,0 +1,16 @@
+en:
+  errors:
+    messages:
+      invalid_date: "is not a valid date"
+      invalid_time: "is not a valid time"
+      invalid_datetime: "is not a valid datetime"
+      is_at: "must be at %{restriction}"
+      before: "must be before %{restriction}"
+      on_or_before: "must be on or before %{restriction}"
+      after: "must be after %{restriction}"
+      on_or_after: "must be on or after %{restriction}"
+  validates_timeliness:
+    error_value_formats:
+      date: '%Y-%m-%d'
+      time: '%H:%M:%S'
+      datetime: '%Y-%m-%d %H:%M:%S'

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  resources :k3cms_blog_blog_posts, :path => 'news', :controller => 'k3cms/blog/blog_posts'
+end

data/db/migrate/20110113015852_create_k3_blog_posts.rb

@@ -0,0 +1,17 @@
+class CreateK3BlogPosts < ActiveRecord::Migration
+  def self.up
+    create_table 'k3_blog_blog_posts' do |t|
+      t.string   'title'
+      t.string   'url'
+      t.text     'summary'
+      t.text     'body'
+      t.date     'date'
+      t.integer  'author_id'
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table 'k3_blog_blog_posts'
+  end
+end

data/db/migrate/20110118015034_create_slugs.rb

@@ -0,0 +1,18 @@
+class CreateSlugs < ActiveRecord::Migration
+  def self.up
+    create_table :slugs do |t|
+      t.string :name
+      t.integer :sluggable_id
+      t.integer :sequence, :null => false, :default => 1
+      t.string :sluggable_type, :limit => 40
+      t.string :scope
+      t.datetime :created_at
+    end
+    add_index :slugs, :sluggable_id
+    add_index :slugs, [:name, :sluggable_type, :sequence, :scope], :name => "index_slugs_on_n_s_s_and_s", :unique => true
+  end
+
+  def self.down
+    drop_table :slugs
+  end
+end