blogit 0.8.0 → 1.0.0.rc1

data/lib/blogit/configuration.rb

@@ -87,7 +87,20 @@ module Blogit
     # when posts are created, updated or destroyed?
     # Defaults to false
     attr_accessor :ping_search_engines
-    
+
+    # The layout to be used by the posts controller
+    # Defaults to nil
+    attr_accessor :layout
+
+    # list of states that will be visible to the public
+    attr_accessor :active_states
+
+    # list of states that will hide the posts from the public.
+    attr_accessor :hidden_states
+
+    # list of states for the Post state machine in order or lifecycle, aggregation of hidden_states and active_states
+    #attr_accessor :post_states
+
     # When using redcarpet as content parser, pass these options as defaults.
     REDCARPET_OPTIONS = {
       hard_wrap: true,
@@ -98,6 +111,12 @@ module Blogit
       gh_blockcode: true,
     }
 
+    #default values for active_state
+    ACTIVE_STATES = [:published]
+
+    #default values for hidden_state
+    HIDDEN_STATES = [:draft, :archive]
+
     def initialize
       @include_comments            = :active_record
       @disqus_shortname            = ""
@@ -119,6 +138,8 @@ module Blogit
       @rss_feed_description        = "#{Rails.application.engine_name.titleize} Blog Posts"
       @ping_search_engines         = false
       @redcarpet_options           = REDCARPET_OPTIONS
+      @active_states               = ACTIVE_STATES
+      @hidden_states               = HIDDEN_STATES
     end
 
     def default_parser_class
@@ -147,6 +168,10 @@ module Blogit
       blogit_warn "#{self.class}#rss_feed_language has been deprecated. You can remove this from your blogit.rb configuration file"
     end
     
+    def cache_pages=(value)
+      blogit_warn "config.cache_pages is deprecated. Please remove this from your blogit.rb file"
+    end
+
     private
 
     def blogit_warn(message)

data/lib/blogit/version.rb

@@ -1,3 +1,3 @@
 module Blogit
-  VERSION = "0.8.0"
+  VERSION = "1.0.0.rc1"
 end

data/lib/blogit.rb

@@ -1,5 +1,4 @@
 # Third-party requirements
-require "acts-as-taggable-on"
 require "kaminari"
 require "redcarpet"
 require "pingr"
@@ -10,9 +9,9 @@ require "blogit/engine"
 require "blogit/parsers"
 
 require "validators"
+
 module Blogit
   
-  autoload :ActsAsTaggableOn, "acts-as-taggable-on"
   autoload :Kaminari, "kaminari"
   
   # Exception raised when gem may not be configured properly

data/lib/generators/blogit/table_name_migration_generator.rb

@@ -0,0 +1,15 @@
+module Blogit
+  module Generators
+    class TableNameMigrationGenerator < Rails::Generators::Base
+      
+      source_root File.expand_path('../../templates', __FILE__)
+
+      desc "Creates a Blogit initializer in your application's config/initializers dir"
+
+      def copy_migration_file
+        template "rename_blogit_tables.rb", "db/migrate/#{Time.now.to_s(:number)}_rename_blogit_tables.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/templates/blogit.rb

@@ -24,9 +24,6 @@ Blogit.configure do |config|
   # Which DateTime::FORMATS format do we use to display blog and comment publish time
   # config.datetime_format = :short
 
-  # Should the controllers cache the blog pages as HTML?
-  # config.cache_pages = false
-
   # No. of posts to show per page
   # config.posts_per_page = 5
 
@@ -62,13 +59,13 @@ Blogit.configure do |config|
 
   # Should blogit ping search engines with your sitemap
   # when posts are created, updated or destroyed?
-  # 
+  #
   # Can pass true to ping all supported search engines, or an array of search
   # engine names. e.g. [:google, :bing]
-  # 
+  #
   # Defaults to false
   # config.ping_search_engines = false
-  
+
   # When using redcarpet as content parser, pass these options as defaults.
   # @see here for more options: https://github.com/tanoku/redcarpet
   # config.redcarpet_options = {
@@ -87,4 +84,13 @@ Blogit.configure do |config|
   # app's named routes are missing.
   # config.inline_main_app_named_routes = true
 
+  # If this is set, Blogit::PostsController will use the layout named here
+  # config.layout = "custom_layout"
+
+  # List of states that will be visible to the public
+  # config.active_states = [:published]
+
+  # List of states that will hide the posts from the public.
+  # config.hidden_states = [:draft, :archive]
+
 end

data/lib/generators/templates/rename_blogit_tables.rb

@@ -0,0 +1,21 @@
+class RenameBlogitTables < ActiveRecord::Migration
+  def change
+    if table_exists?('blog_posts')
+      rename_table('blog_posts', 'blogit_posts') 
+    else
+      report_missing_table("blog_posts")
+    end
+    
+    if table_exists?('blog_comments')
+      rename_table('blog_comments', 'blogit_comments')
+    else
+      report_missing_table("blog_posts")
+    end  
+  end
+  
+  private
+  
+  def report_missing_table(t_name)
+    warn "Table named: #{t_name} not found. Have you run the initial blogit migrations yet?"
+  end
+end

data/spec/controllers/blogit/comments_controller_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe CommentsController do
+describe Blogit::CommentsController do
   
   let(:blog_post) { Blogit::Post.first || create(:post) }
     

data/spec/controllers/blogit/posts_controller_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe PostsController do
+describe Blogit::PostsController do
 
   before do
     reset_configuration
@@ -16,16 +16,60 @@ describe PostsController do
       get :index, :use_route => :blogit, page: page.to_s
     end
 
-    it "should set posts to Blogit::Post.for_index" do
-      Blogit::Post.expects(:for_index).returns(posts)
-      do_get
-      assigns(:posts).should == posts
+    context 'when user is  logged in' do
+
+      before(:each) do
+        controller.stubs(:is_blogger_logged_in?).returns(false)
+        Blogit::Post.stubs(:active).returns(posts)
+      end
+
+      it 'should set posts to Blogit::Post.active.for_index' do
+        Blogit::Post.stubs(:for_index).returns(posts)
+        Blogit::Post.active.expects(:for_index).returns(posts)
+        do_get
+        assigns(:posts).should == posts
+      end
+
+      it 'should pass the page param to Blogit::Post.active.for_index' do
+        Blogit::Post.stubs(:for_index).with('2').returns(posts)
+        Blogit::Post.active.expects(:for_index).with('2').returns(posts)
+        do_get('2')
+        assigns(:posts).should == posts
+      end
     end
 
-    it "should pass the page param to for_index" do
-      Blogit::Post.expects(:for_index).with("2").returns(posts)
-      do_get("2")
-      assigns(:posts).should == posts
+    context 'when user is not logged in' do
+      before(:each) do
+        controller.stubs(:is_blogger_logged_in?).returns(true)
+      end
+
+      it 'sets posts to Blogit::Post.for_index' do
+        Blogit::Post.expects(:for_index).returns(posts)
+        do_get
+        assigns(:posts).should == posts
+      end
+
+      it 'should pass the page param to Blogit::Post.active.for_index' do
+        Blogit::Post.expects(:for_index).with('2').returns(posts)
+        do_get('2')
+        assigns(:posts).should == posts
+      end
+   end
+
+    describe "when layout is set" do
+
+      # TODO: Think of a way to test this. The PostsController is being cached
+      # because cache-classes is set to true but that means the layout is not
+      # being changed. 
+      #
+      # This works in practice but not in testing
+      # it "should use the specified layout" do
+      #   reset_configuration
+      #   Blogit.configuration.layout = "custom"
+      #   do_get
+      #   response.should.should render_template("layouts/custom")
+      # end
+
     end
 
   end
@@ -40,7 +84,8 @@ describe PostsController do
     end
 
     it "should load all posts in reverse date order" do
-      Blogit::Post.expects(:order).with('created_at DESC').returns(posts)
+      Blogit::Post.stubs(:active).returns(posts)
+      Blogit::Post.active.expects(:order).with('created_at DESC').returns(posts)
       do_get
       assigns(:posts).should == posts
     end
@@ -148,7 +193,6 @@ describe PostsController do
 
   end
 
-
   describe "GET 'edit'" do
 
     context "when logged in" do
@@ -193,7 +237,7 @@ describe PostsController do
     context "when logged in" do
 
       before do
-        @post_attributes = { "title" => "Something new" }
+        @post_attributes = {"title" => "Something new"}
         mock_login
         @current_blogger.expects(:blog_posts).returns(@blog_posts = [])
         @blog_posts.expects(:find).with("1").returns(blog_post)
@@ -249,7 +293,7 @@ describe PostsController do
     context "when not logged in" do
 
       before do
-        @post_attributes = { "title" => "Something new" }
+        @post_attributes = {"title" => "Something new"}
       end
 
       def do_put

data/spec/dummy/app/views/layouts/custom.html.erb

@@ -0,0 +1,34 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag "blogit", "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+  <div id="content">
+
+    <% if current_user %>
+      <%= link_to("log out", main_app.session_path, method: :delete) %>
+    <% else %>
+      <%= link_to("log in", main_app.new_session_path) %>
+    <% end %>
+
+    <h1><%= link_to("My Awesome Blog", blogit.blog_root_path) %></h1>
+
+    <%= yield %>
+  </div>
+
+  <div id="sidebar">
+    <%= blog_posts_archive_tag('archive-year', 'archive-month', 'archive-post') do |post| %>
+      <% link_to(post.title, blogit.post_path(post)) %>
+    <% end %>
+  </div>
+
+  <footer id="custom_footer">
+    By <%= link_to("Gavin Morrice", "http://gavinmorrice.com") %>
+  </footer>
+  <%= javascript_include_tag "application", "blogit" %>
+</body>
+</html>

data/spec/dummy/config/application.rb

@@ -2,18 +2,22 @@ require File.expand_path('../boot', __FILE__)
 
 require 'rails/all'
 
-Bundler.require
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env)
 
 require "blogit"
-require "jquery-rails" # this should be auto-included with the Bundler.require :default, Rails.env, but it's not happening
+require 'jquery-rails'
 
 module Dummy
   class Application < Rails::Application
-    # Configure the default encoding used in templates for Ruby 1.9.
-    config.encoding = "utf-8"
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
 
-    # Configure sensitive parameters which will be filtered from the log file.
-    config.filter_parameters += [:password]
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
 
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
@@ -21,6 +25,7 @@ module Dummy
 
     # Enable the asset pipeline
     config.assets.enabled = true
+    
+    config.i18n.enforce_available_locales = false
   end
 end
-

data/spec/dummy/config/database.yml

@@ -1,25 +1,29 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-development:
-  adapter: sqlite3
-  database: db/development.sqlite3
-  pool: 5
-  timeout: 5000
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
+sqlite: &sqlite
+  adapter: sqlite3 
+  database: db/<%= Rails.env %>.sqlite3 
+  
+mysql: &mysql 
+  adapter: mysql2 
+  username: root 
+  password: 
+  database: blogit_app_<%= Rails.env %>
+  
+postgresql: &postgresql
+  adapter: postgresql
+  username: postgres
+  password: 
+  database: blogit_app_<%= Rails.env %>
+  min_messages: ERROR 
+  
+defaults: &defaults
+  pool: 5 
+  timeout: 5000 
+  host: localhost 
+  # Use sqlite by default
+  <<: *<%= ENV['DB'] || "sqlite" %>
+  
+development: 
+  <<: *defaults 
+  
 test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  pool: 5
-  timeout: 5000
-
-production:
-  adapter: sqlite3
-  database: db/production.sqlite3
-  pool: 5
-  timeout: 5000
+  <<: *defaults

data/spec/dummy/config/environments/development.rb

@@ -1,30 +1,39 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
   # In the development environment your application's code is reloaded on
-  # every request.  This slows down response time but is perfect for development
+  # every request. This slows down response time but is perfect for development
   # since you don't have to restart the web server when you make code changes.
   config.cache_classes = false
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
-
-  # Show full error reports and disable caching
+  if Rails.version =~ /\A3/
+    # Log error messages when you accidentally call methods on nil.
+    config.whiny_nils = true
+    
+    # Only use best-standards-support built into browsers
+    config.action_dispatch.best_standards_support = :builtin
+
+    # Do not compress assets
+    config.assets.compress = false
+  end
+  
+  if Rails.version =~ /\A4/
+    config.eager_load = false
+    
+    # Raise an error on page load if there are pending migrations
+    config.active_record.migration_error = :page_load
+  end
+
+  # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Don't care if the mailer can't send
+  # Don't care if the mailer can't send.
   config.action_mailer.raise_delivery_errors = false
 
-  # Print deprecation notices to the Rails logger
+  # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
-
-  # Do not compress assets
-  config.assets.compress = false
-
   # Expands the lines which load the assets
   config.assets.debug = true
 end

data/spec/dummy/config/environments/production.rb

@@ -1,51 +1,84 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
-  # Code is not reloaded between requests
+  # Code is not reloaded between requests.
   config.cache_classes = true
 
-  # Full error reports are disabled and caching is turned on
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true
 
-  # Disable Rails's static asset server (Apache or nginx will already do this)
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
   config.serve_static_assets = false
 
-  # Compress JavaScripts and CSS
-  config.assets.compress = true
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
 
-  # Specifies the header that your server uses for sending files
-  # (comment out if your front-end server doesn't support this)
-  config.action_dispatch.x_sendfile_header = "X-Sendfile" # Use 'X-Accel-Redirect' for nginx
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  if Rails.version =~ /\A4/
+    config.eager_load = true
+  end
 
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
   # config.force_ssl = true
 
-  # See everything in the log (default is :info)
-  # config.log_level = :debug
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
 
-  # Use a different logger for distributed setups
-  # config.logger = SyslogLogger.new
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
 
-  # Use a different cache store in production
+  # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
 
-  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
   # config.action_controller.asset_host = "http://assets.example.com"
 
-  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
   # config.assets.precompile += %w( search.js )
 
-  # Disable delivery errors, bad email addresses will be ignored
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
   # config.action_mailer.raise_delivery_errors = false
 
-  # Enable threaded mode
-  # config.threadsafe!
-
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
-  # the I18n.default_locale when a translation can not be found)
+  # the I18n.default_locale when a translation can not be found).
   config.i18n.fallbacks = true
 
-  # Send deprecation notices to registered listeners
+  # Send deprecation notices to registered listeners.
   config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
 end

data/spec/dummy/config/environments/test.rb

@@ -1,39 +1,40 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
   # The test environment is used exclusively to run your application's
-  # test suite.  You never need to work with it otherwise.  Remember that
+  # test suite. You never need to work with it otherwise. Remember that
   # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs.  Don't rely on the data there!
+  # and recreated between test runs. Don't rely on the data there!
   config.cache_classes = true
 
   # Configure static asset server for tests with Cache-Control for performance
   config.serve_static_assets = true
   config.static_cache_control = "public, max-age=3600"
+  
+  if Rails.version =~ /\A3/
+    # Log error messages when you accidentally call methods on nil
+    config.whiny_nils = true
+  end
 
-  # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
+  if Rails.version =~ /\A4/
+    config.eager_load = false
+  end
 
-  # Show full error reports and disable caching
+  # Show full error reports and disable caching.
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
 
-  # Raise exceptions instead of rendering exception templates
+  # Raise exceptions instead of rendering exception templates.
   config.action_dispatch.show_exceptions = false
 
-  # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
 
   # Tell Action Mailer not to deliver emails to the real world.
   # The :test delivery method accumulates sent emails in the
   # ActionMailer::Base.deliveries array.
-  # config.action_mailer.delivery_method = :test
+  config.action_mailer.delivery_method = :test
 
-  # Use SQL instead of Active Record's schema dumper when creating the test database.
-  # This is necessary if your schema can't be completely dumped by the schema dumper,
-  # like if you have constraints or database-specific column types
-  # config.active_record.schema_format = :sql
-
-  # Print deprecation notices to the stderr
+  # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
 end

data/spec/dummy/config/initializers/blogit.rb

@@ -25,9 +25,6 @@ Blogit.configure do |config|
   # Which DateTime::FORMATS format do we use to display blog and comment publish time
   # config.datetime_format = :short
 
-  # Should the controllers cache the blog pages as HTML?
-  # config.cache_pages = false
-
   # No. of posts to show per page
   # config.posts_per_page = 5
 
@@ -46,7 +43,7 @@ Blogit.configure do |config|
   # If set to true, links for new posts, editing posts and deleting comments
   # will be available. If set to false, you'll have to set these
   # yourself in the templates.
-  # config.include_admin_links = true
+  # config.include_admin_links = false
 
   # The default format for parsing the blog content.
   # config.default_parser = :markdown
@@ -63,13 +60,13 @@ Blogit.configure do |config|
 
   # Should blogit ping search engines with your sitemap
   # when posts are created, updated or destroyed?
-  # 
+  #
   # Can pass true to ping all supported search engines, or an array of search
   # engine names. e.g. [:google, :bing]
-  # 
+  #
   # Defaults to false
   config.ping_search_engines = true
-  
+
   # When using redcarpet as content parser, pass these options as defaults.
   # @see here for more options: https://github.com/tanoku/redcarpet
   # config.redcarpet_options = {
@@ -88,4 +85,4 @@ Blogit.configure do |config|
   # app's named routes are missing.
   # config.inline_main_app_named_routes = true
 
-end
+end