k3cms_blog 0.1.0

data/db/migrate/20110118023300_add_cached_slug_to_blog_posts.rb

@@ -0,0 +1,10 @@
+class AddCachedSlugToBlogPosts < ActiveRecord::Migration
+  def self.up
+    add_column :k3_blog_blog_posts, :cached_slug, :string
+    add_index  :k3_blog_blog_posts, :cached_slug, :unique => true
+  end
+
+  def self.down
+    remove_column :k3_blog_blog_posts, :cached_slug
+  end
+end

data/db/migrate/20110120172202_add_meta_description_to_blog_posts.rb

@@ -0,0 +1,15 @@
+class AddMetaDescriptionToBlogPosts < ActiveRecord::Migration
+  def self.up
+    change_table :k3_blog_blog_posts do |t|
+      t.text :meta_description
+      t.text :meta_keywords
+    end
+  end
+
+  def self.down
+    change_table :k3_blog_blog_posts do |t|
+      t.remove :meta_description
+      t.remove :meta_keywords
+    end
+  end
+end

data/db/migrate/20110415180204_rename_to_k3cms_blog_posts.rb

@@ -0,0 +1,9 @@
+class RenameToK3cmsBlogPosts < ActiveRecord::Migration
+  def self.up
+    rename_table :k3_blog_blog_posts, :k3cms_blog_blog_posts
+  end
+
+  def self.down
+    rename_table :k3cms_blog_blog_posts, :k3_blog_blog_posts
+  end
+end

data/k3cms_blog.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "k3cms/blog/version"
+
+Gem::Specification.new do |s|
+  s.name          = "k3cms_blog"
+  s.summary       = %q{K3cms Blog}
+  s.description   = %q{Provides a simple blog}
+  s.homepage      = "http://k3cms.org/#{s.name}"
+
+  s.authors       = `git shortlog --summary --numbered         | awk '{print $2, $3    }'`.split("\n")
+  s.email         = `git shortlog --summary --numbered --email | awk '{print $2, $3, $4}'`.split("\n")
+
+  s.add_dependency 'facets'
+  s.add_dependency 'rails',        '~> 3.0.0'
+  s.add_dependency 'activerecord', '~> 3.0.0'
+  s.add_dependency 'actionpack',   '~> 3.0.0'
+  s.add_dependency 'cancan'
+  s.add_dependency 'cells'
+  s.add_dependency 'attribute_normalizer'
+  s.add_dependency 'friendly_id'
+  s.add_dependency 'stringex'
+  s.add_dependency 'k3cms_core'
+  s.add_dependency 'validates_timeliness'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sqlite3-ruby'
+  s.add_development_dependency 'ruby-debug19'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.version       = K3cms::Blog::Version
+  s.platform      = Gem::Platform::RUBY
+end

data/lib/form_tag_helper.rb

@@ -0,0 +1,3 @@
+def email_field_tag(name, value = nil, options = {})
+  text_field_tag(name, value, options.stringify_keys.update("type" => "email"))
+end

data/lib/k3cms/blog/railtie.rb

@@ -0,0 +1,67 @@
+require "rails"
+require "k3cms_blog"
+require 'facets/kernel/__dir__'
+require 'facets/pathname'
+
+module K3cms
+  module Blog
+    class Railtie < Rails::Engine
+      puts self
+
+      config.before_initialize do
+        # Work around the fact that the line:
+        #   Bundler.require(:default, Rails.env) if defined?(Bundler)
+        # in config/application.rb only does a 'require' for the gems explicitly listed in the app's Gemfile -- not for the gems *they* might depend on.
+        require 'haml'
+        #require 'haml-rails'
+        require 'validates_timeliness'
+        require 'cancan'
+      end
+
+      config.before_configuration do |app|
+        # Ensure that friendly_id/railtie is loaded soon enough
+        # The Bundler.require(:default, Rails.env) in application.rb *only* *requires* gems listed in the *app*'s Gemfile, not gems that those gems depend on, even though it *installs* those.
+        # We could simply list these gems in the app's Gemfile, but they are dependencies of *this* gem, not of the app, so we should handle requiring them here.
+        require 'friendly_id'
+        require 'stringex'
+
+        # Ensure that active_record is loaded before attribute_normalizer, since attribute_normalizer only loads its active_record-specific code if active_record is loaded.
+        require 'active_record'
+        require 'attribute_normalizer'
+      end
+
+      # This is to avoid errors like undefined method `can?' for #<K3cms::Blog::BlogPostCell>
+      initializer 'k3cms.authorization.cancan' do
+        ActiveSupport.on_load(:action_controller) do
+          include CanCan::ControllerAdditions
+          Cell::Base.send :include, CanCan::ControllerAdditions
+        end
+      end
+
+      config.action_view.javascript_expansions[:k3cms_editing].concat [
+        'k3cms/blog.js',
+      ]
+      config.action_view.stylesheet_expansions[:k3cms].concat [
+        'k3cms/blog.css',
+      ]
+
+      initializer 'k3cms.blog.cells_paths' do |app|
+        Cell::Base.view_paths += [Pathname[__DIR__] + '../../../app/cells']
+      end
+
+      initializer 'k3cms.pages.hooks', :before => 'k3cms.core.hook_listeners' do |app|
+        class K3cms::Blog::Hooks < K3cms::ThemeSupport::HookListener
+          insert_after :top_of_page, :file => 'k3cms/blog/init.html.haml'
+        end
+      end
+
+      initializer 'k3cms.blog.require_decorators', :after => 'k3cms.core.require_decorators' do |app|
+        #puts 'k3cms.blog.require_decorators'
+        Dir.glob(config.root + "app/**/*_decorator*.rb") do |c|
+          Rails.env.production? ? require(c) : load(c)
+        end
+      end
+
+    end
+  end
+end

data/lib/k3cms/blog/version.rb

@@ -0,0 +1,5 @@
+module K3cms
+  module Blog
+    Version = "0.1.0"
+  end
+end

data/lib/k3cms_blog.rb

@@ -0,0 +1,8 @@
+$:.unshift File.join(File.dirname(__FILE__), '..')  # so we can require 'app/models/...'
+
+require 'k3cms/blog/railtie' if defined?(Rails)
+
+module K3cms
+  module Blog
+  end
+end

data/lib/tasks/tasks.rake

@@ -0,0 +1,17 @@
+namespace :k3cms do
+  namespace :blog do
+    desc "Install K3cms Blog"
+    task :install => [:copy_public, :copy_migrations] do
+    end
+    
+    desc "Copy public files"
+    task :copy_public do
+      K3cms::FileUtils.copy_or_symlink_files_from_gem K3cms::Blog, 'public/**/*'
+    end
+    
+    desc "Copy migrations"
+    task :copy_migrations do
+      K3cms::FileUtils.copy_from_gem K3cms::Blog, 'db/migrate'
+    end
+  end
+end

data/public/javascripts/k3cms/blog.js

@@ -0,0 +1,13 @@
+K3cms_Blog = {
+}
+
+K3cms_Blog_BlogPost = {
+  updatePage: function(object_name, object_id, object, source_element) {
+    K3cms_InlineEditor.updatePageFromObject(object_name, object_id, object, source_element)
+
+    // TODO: only update title if page title was originally set to @page.title. Perhaps we should set some JS variable to indicate which object/attribute the page title was taken form?
+    $('title').html(object.title)
+    $('meta[name=description]').attr('content', object.meta_description);
+    $('meta[name=keywords]').   attr('content', object.meta_keywords);
+  }
+}

data/public/stylesheets/k3cms/blog.css

@@ -0,0 +1,53 @@
+.k3cms_blog_blog_posts_index .k3cms_blog_blog_post .title {
+}
+.k3cms_blog_blog_post + .k3cms_blog_blog_post {
+  margin-top: 20px;
+}
+
+.k3cms_blog_blog_posts_index .unpublished,
+.k3cms_blog_blog_posts_show  .unpublished {
+  border: 1px solid #A33028;
+  background: #E6554B;
+  color: white;
+}
+.k3cms_blog_blog_posts_index .unpublished {
+}
+.k3cms_blog_blog_posts_show  .unpublished {
+  font-size: 110%;
+}
+
+.k3cms_blog_blog_posts_index .below_summary {
+  clear: both;
+}
+
+/*------------------------------------------------------------------------------------------------*/
+/* Icons */
+.k3cms_blog li.icon.button a {
+  background: url(/images/k3cms/blog/icons.png) no-repeat;
+}
+
+.k3cms_blog li.icon.button.b1 a                 { background-position: 0 -24px;}
+.k3cms_blog li.icon.button.b2 a                 { background-position: 0 -48px;}
+.k3cms_blog li.icon.button.list_blog_posts a    { background-position: 0 -72px;}
+.k3cms_blog li.icon.button.blog_post_metadata a { background-position: 0 -96px;}
+.k3cms_blog li.icon.button.b5 a                 { background-position: 0 -121px;}
+.k3cms_blog li.icon.button.b6 a                 { background-position: 0 -144px;}
+.k3cms_blog li.icon.button.b7 a                 { background-position: 0 -168px;}
+.k3cms_blog li.icon.button.b8 a                 { background-position: 0 -192px;}
+.k3cms_blog li.icon.button.b9 a                 { background-position: 0 -384px;}
+.k3cms_blog li.icon.button.b10 a                { background-position: 0 -408px;}
+.k3cms_blog li.icon.button.b11 a                { background-position: 0 -430px;}
+.k3cms_blog li.icon.button.b12 a                { background-position: 0 -454px;}
+.k3cms_blog li.icon.button.b13 a                { background-position: 0 -502px;}
+.k3cms_blog li.icon.button.b14 a                { background-position: 0 -526px;}
+.k3cms_blog li.icon.button.b15 a                { background-position: 0 -552px;}
+.k3cms_blog li.icon.button.b16 a                { background-position: 0 -574px;}
+.k3cms_blog li.icon.button.b17 a                { background-position: 0 -598px;}
+.k3cms_blog li.icon.button.b18 a                { background-position: 0 -624px;}
+.k3cms_blog li.icon.button.b19 a                { background-position: 0 -648px;}
+.k3cms_blog li.icon.button.b20 a                { background-position: 0 -672px;}
+.k3cms_blog li.icon.button.b21 a                { background-position: 0 -696px;}
+.k3cms_blog li.icon.button.b22 a                { background-position: 0 -720px;}
+.k3cms_blog li.icon.button.b23 a                { background-position: 0 -744px;}
+
+/*------------------------------------------------------------------------------------------------*/

data/spec/connection_and_schema.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection({
+  :database => ":memory:",
+  :adapter  => 'sqlite3',
+  :timeout  => 500
+})
+
+ActiveRecord::Schema.define do
+end
+
+ActiveRecord::Migrator.migrate('db/migrate')

data/spec/models/blog_post_spec.rb

@@ -0,0 +1,254 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'app/models/k3cms/blog/blog_post'
+
+module K3cms::Blog
+  describe BlogPost do
+    before do
+      Time.stub!(:now).and_return(Time.mktime(2011,1,1, 12,0))
+    end
+
+    describe "when a new record is initialized" do
+      before do
+
+        @blog_post = BlogPost.new
+      end
+
+      it "should have summary set to #{s='<p>Summary description goes here</p>'}" do
+        @blog_post.summary.should == s
+      end
+      it "should have body set to nil" do
+        @blog_post.body.should == nil
+      end
+      it "should have date set to tomorrow" do
+        @blog_post.date.should == Date.new(2011,1,2)
+      end
+    end
+
+    describe "when a saved record (with body set to nil) is initialized" do
+      before do
+        @blog_post = BlogPost.create!(:title => 'Something')
+        @blog_post.update_attributes!(:body => nil)
+      end
+
+      it "should not change body" do
+        @blog_post.body.should be_nil
+      end
+    end
+
+    describe "when a new record is initialized with summary 'This talks about the stuff'" do
+      before do
+        @blog_post = BlogPost.new(:summary => 'This talks about the stuff')
+      end
+
+      it 'sets body accordingly' do
+        @blog_post.body.should == @blog_post.summary
+      end
+    end
+
+    describe "when a *saved* record is initialized with summary 'This talks about the stuff'" do
+      before do
+        @blog_post = BlogPost.create!(:title => 'Something')
+        @blog_post.update_attributes!(:body => nil, :summary => 'Old summary')
+        @blog_post = BlogPost.new(:summary => 'This talks about the stuff')
+      end
+
+      it 'sets body accordingly' do
+        @blog_post.body.should == @blog_post.summary
+      end
+    end
+
+    describe 'friendly_id' do
+      [['my COOL tItLe!', 'my-cool-title'],
+       ['你好',           'ni-hao'],
+       ['Łódź, Poland',   'lodz-poland'],
+      ].each do |title, slug|
+        it "converts title '#{title}' to #{slug}" do
+          @blog_post = BlogPost.create!(:title => title)
+          @blog_post.friendly_id.should == slug
+        end
+      end
+
+      it "when I create 2 posts with default title 'New Post', the url for the 2nd post gets a sequence ('new-post--2')" do
+        BlogPost.destroy_all
+        @blog_post_1 = BlogPost.create!()
+        @blog_post_1.cached_slug.should == 'new-post'
+        @blog_post_2 = BlogPost.create!()
+        @blog_post_2.cached_slug.should == 'new-post--2'
+      end
+
+      it "when I change the url/slug, it should still be accessable by the old as well as the new" do
+        BlogPost.destroy_all
+        @blog_post = BlogPost.create!()
+        @blog_post.cached_slug.should == 'new-post'
+
+        @blog_post.update_attributes!(:url => 'a')
+        @blog_post.cached_slug.should == 'a'
+
+        @blog_post.should == BlogPost.find('new-post')
+        @blog_post.should == BlogPost.find('a')
+      end
+
+      # Updates slug automatically because custom url has not been set
+      it "when I set title to 'A', then change title to 'B', url and cached_slug ends up being 'b'" do
+        BlogPost.destroy_all
+        @blog_post = BlogPost.create!(:title => 'A')
+        @blog_post.url        .should == 'a'
+        @blog_post.cached_slug.should == 'a'
+        @blog_post.should_not be_custom_url
+
+        @blog_post.update_attributes!(:title => 'B')
+        @blog_post.url        .should == 'b'
+        @blog_post.cached_slug.should == 'b'
+        @blog_post.should_not be_custom_url
+      end
+
+      it "when I set title to 'A', causing the url to automatically be 'a', and then try to set manually url to 'a', the url attribute should not get updated because the new value is not different from the existing value" do
+        BlogPost.destroy_all
+        @blog_post = BlogPost.create!(:title => 'A')
+        @blog_post.url        .should == 'a'
+        @blog_post.cached_slug.should == 'a'
+        @blog_post.should_not be_custom_url
+
+        @blog_post.update_attributes!(:url => 'a')
+        @blog_post.url        .should == 'a'
+        @blog_post.cached_slug.should == 'a'
+        @blog_post.should_not be_custom_url
+      end
+
+      # Setting custom url disables automatic slug generation
+      it "when I set url to 'a', then change title to 'B', cached_slug remains at the custom url, 'a'" do
+        BlogPost.destroy_all
+        @blog_post = BlogPost.create!()
+        @blog_post.url        .should == 'new-post'
+        @blog_post.cached_slug.should == 'new-post'
+        @blog_post.should_not be_custom_url
+
+        @blog_post.update_attributes!(:url => 'a')
+        @blog_post.url        .should == 'a'
+        @blog_post.cached_slug.should == 'a'
+        @blog_post.should be_custom_url
+
+        @blog_post.update_attributes!(:title => 'B')
+        @blog_post.url        .should == 'a'
+        @blog_post.cached_slug.should == 'a'
+      end
+
+      1.times do
+      it "when I set url to invalid url value '#{s='Invalid as URL'}', it converts it to something valid" do
+        BlogPost.destroy_all
+        @blog_post = BlogPost.create!()
+        @blog_post.url        .should == 'new-post'
+        @blog_post.cached_slug.should == 'new-post'
+        @blog_post.should == BlogPost.find('new-post')
+
+        @blog_post.update_attributes!(:url => s)
+        @blog_post.read_attribute(:url).should == 'invalid-as-url'
+        @blog_post.url.                 should == 'invalid-as-url'
+        @blog_post.cached_slug.         should == 'invalid-as-url'
+        @blog_post.should == BlogPost.find('invalid-as-url')
+
+        @blog_post.update_attributes!(:title => 'B')
+        @blog_post.url        .should == 'invalid-as-url'
+        @blog_post.cached_slug.should == 'invalid-as-url'
+      end
+      end
+
+      1.times do
+      it "when I set url to invalid url value '#{s='<blink>cool</blink>'}', it strips out the tags" do
+        BlogPost.destroy_all
+        @blog_post = BlogPost.create!()
+        @blog_post.url        .should == 'new-post'
+        @blog_post.cached_slug.should == 'new-post'
+        @blog_post.should == BlogPost.find('new-post')
+
+        @blog_post.update_attributes!(:url => s)
+        @blog_post.read_attribute(:url).should == 'cool'
+        @blog_post.url.                 should == 'cool'
+        @blog_post.cached_slug.         should == 'cool'
+        @blog_post.should == BlogPost.find('cool')
+
+        @blog_post.update_attributes!(:title => 'B')
+        @blog_post.url        .should == 'cool'
+        @blog_post.cached_slug.should == 'cool'
+      end
+      end
+
+      [
+        [nil]*2,
+        ['']*2,
+        ['<br>', '']
+      ].each do |s, normalized_s|
+        it "when I set url to #{s.inspect}, it goes back to creating the slug based on title" do
+          BlogPost.destroy_all
+          @blog_post = BlogPost.create!(:title => 'My title', :url => 'my-url')
+          @blog_post.url        .should == 'my-url'
+          @blog_post.cached_slug.should == 'my-url'
+          @blog_post.should be_custom_url
+
+          @blog_post.update_attributes!(:url => s)
+          @blog_post.read_attribute(:url).should == normalized_s
+          @blog_post.url        .should == 'my-title'
+          @blog_post.cached_slug.should == 'my-title'
+          @blog_post.should_not be_custom_url
+        end
+      end
+    end
+
+    describe "published?" do
+      it 'when date is yesterday, it will report itself as being unpublished' do
+        @blog_post = BlogPost.create!(:date => Date.new(2011,12,31))
+        @blog_post.should_not be_published
+      end
+
+      it 'when date is today, it will report itself as being published' do
+        @blog_post = BlogPost.create!(:date => Date.new(2011,1,1))
+        @blog_post.should be_published
+      end
+
+    end
+
+    describe "normalization" do
+      [:title, :summary, :body].each do |attr_name|
+        it { should normalize_attribute(attr_name).from('  Something  ').to('Something') }
+        it { should normalize_attribute(attr_name).from('').to(nil) }
+      end
+    end
+
+    describe "validation" do
+     #describe "when it has the same url as another page" do
+     #  it "should fail validation" do
+     #    page1 = BlogPost.create(url: '/page1')
+     #    page2 = BlogPost.create(url: '/page1')
+     #    page2.should_not be_valid
+     #    page2.errors[:url].should be_present
+     #  end
+     #end
+
+      describe 'date' do
+        it "accepts valid dates" do
+          BlogPost.destroy_all
+          page = BlogPost.new(url: '/page1', :date => '2011-02-10')
+          page.should be_valid
+        end
+
+        it "doesn't accept valid date" do
+          BlogPost.destroy_all
+          page = BlogPost.new(url: '/page1')
+          page.date = '2011-02-99'
+          page.valid?
+          page.should_not be_valid
+          page.errors['date'].first.should match(/not a valid date/)
+        end
+      end
+
+    end
+
+    describe 'to_s' do
+      it 'should return the title' do
+        blog_post = BlogPost.new(:title => 'Home')
+        blog_post.to_s.should match(/Home/)
+      end
+    end
+  end
+end