blogit 1.0.0.rc1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 284698e6cf80971f9da206a03066356e5d290bae
-  data.tar.gz: 87263f108741571411bb221b9c670997ea1bbaa6
+  metadata.gz: 8c100074e27c335df3fbbc251e983062f76a5e52
+  data.tar.gz: d482a38203f1de73be23c06a03c5d1729d3020c5
 SHA512:
-  metadata.gz: 2367ee69877ce6372bbc302ba3a80f4cd7b42882a33007cb1e43b48628de4c0b63b77809dd4724128eca87a44162aa86e61f90aa7b3a5b2a02819e4ba707a48c
-  data.tar.gz: ced761eb3174ff8af85d7abcedfd12ae10ea661c315e11e5cca5fe96ffd90f5d58e27cb72e5d14b6c303e2d60201d0e8a709eefc91eb01c9d75b346032f00a99
+  metadata.gz: 58ac47d957cfaacee0dcfb48217c912ead6fc0de4a06015096c5c7231c8a1da671c24e4dc4069df687d0c7289c06c14dd01d970d62d62945e668d24b6d83ce39
+  data.tar.gz: 44bd76bb85d8bd99a2fb0ea88a1f6c5074911a6e81241dc7f99134cabe2e96214123b9dbff8148bfb09d18b38462c685caa3d9053249a219d6b93815fdf73031

data/README.md

@@ -5,20 +5,18 @@
 
 
 
-# Blogit (beta)
+# Blogit - A Rails blogging solution
 
-Blogit is a flexible blogging solution for Rails apps. It:
-
-* Is Rack based;
-* Is a complete MVC solution based on Rails engines;
-* Aims to work right out of the box but remain fully customisable.
+Blogit lets you add a blog to your Ruby on Rails application in just a few seconds.
 
 ## Installation
 
-Add this to your Gemfile
+Add these to your Gemfile
 
 ``` ruby
 gem "blogit"
+# Blogit depends on ActsAsTaggableOn
+gem "acts-as-taggable-on"
 ```
 
 ...and run `bundle install` to install the gem.
@@ -28,11 +26,18 @@ Next, run:
 ``` bash
 # add an initializer to config/initializers with all of the configuration options
 $ rails g blogit:install
+
 # This will add the necessary migrations to your app's db/migrate directory
 rake blogit:install:migrations
+
+# You don't need to run again this if you've already done so
+rake acts\_as\_taggable\_on:install:migrations
+
 # This will run any pending migrations
 rake db:migrate
+
 ``` 
+
 then add the following to your routes.rb file:
 
 ``` bash
@@ -40,39 +45,34 @@ then add the following to your routes.rb file:
 mount Blogit::Engine => "/blog"
 ```
 
-Define `ApplicationController#current_user` and `ApplicationController#login_required` methods if your app doesn't already have these.
-
-... and finally, declare which of your models acts as blogger in your app (usually User).
+Finally, declare which of your models acts as blogger in your app (probably User or Admin).
 
 ``` ruby
-class User
+class User < ActiveRecord::Base
   
   blogs
 
 end
 ```  
 
-## Configuration
+Go to http://localhost:3000/blog and see your marvelous new blog.
 
-Running `rails g blogit:install` will add an initializer file named blogit.rb. In here
-you can set various configuration options. Please [read the documentation](http://rubydoc.info/gems/blogit/Blogit/Configuration) for a full list of the options available.
 
-## At no extra cost...
+## Batteries included
 
-we'll also throw in:
+Blogit provides you with the following features
 
 * An XML Sitemap located at `/blog/posts.xml`
 * An RSS feed located at `/blog/posts.rss`
-* Sitemap submission to the major search engines (via [Pingr](http://github.com/katanacode/pingr "Pingr") - off by default)
-* Page Caching and Sweeping
 * Internationalization (see the [locales file](config/locales/en.yml) for configurable options)
 * Share links (Google+, Twitter & Facebook)
 * [Disquss Comments](http://disqus.com)
 * Code Syntax Highlighting CSS file (add `*= require pygments` to your app's stylesheet)
+* CSS themes
 
-## Rails 4
+## Documentation
 
-@grncdr Has contributed changes for Rails 4 compatibility. Check out the rails 4 branch for more info. NOTE - This code hasn't been tested yet and may contain bugs.
+Full documentation and how-to guides available here: http://blogit.katanacode.com
 
 ## Issues
 
@@ -81,25 +81,18 @@ If you discover a problem with Blogit, please let us know about it.
 **Remember** to search the [issues list](https://github.com/KatanaCode/blogit/issues) first in case your issue has already been raised
 by another Githuber
 
-## Documentation
-
-Full documentation is available here: http://rubydoc.info/gems/blogit
 
 ## Contributing
 
-You're welcome to contribute to Blogit. Please consult the [contribution guidelines](https://github.com/KatanaCode/blogit/wiki/Contributing) for more info.
+Want to help make Blogit better?. Please read the [contribution guidelines](http://blogit.katanacode.com/doc/file.Contributing.html) for more information on how you can contribute.
 
 ## Legal Stuff
 
-Copyright 2011 [Katana Code Ltd.](http://katanacode.com)
-
-See (LEGAL)[LEGAL] for full details.
+See [LEGAL][GithubLicence] for full details.
 
 ## Credits
 
-Developed by [Katana Code](http://katanacode.com)
-
-with generous contributions from:
+Blogit was developed by [Katana Code](http://katanacode.com) with generous contributions from:
 
 * [Philou](https://github.com/philou)
 * [Stewart McKee](https://github.com/stewartmckee)
@@ -107,4 +100,8 @@ with generous contributions from:
 
 ## About Katana Code
 
-Katana Code are [iPhone app and Ruby on Rails Developers in Edinburgh, Scotland](http://katanacode.com/ "Katana Code").
+Katana Code are [web developers based in Edinburgh, Scotland](http://katanacode.com/ "Katana Code").
+
+Copyright © 2011 - 2015 [Katana Code Ltd.](http://katanacode.com)
+
+  [GithubLicence]: https://github.com/KatanaCode/blogit/blob/master/MIT-LICENSE

data/Rakefile

@@ -11,7 +11,11 @@ load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+Dir[File.join(File.dirname(__FILE__), 'lib/tasks/**/*.rake')].each {|f| load f }
+
+Dir[File.join(File.dirname(__FILE__), 'spec/dummy/lib/tasks/**/*.rake')].each {|f| load f}
+
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
@@ -20,4 +24,4 @@ desc "Run all specs in spec directory (excluding plugin specs)"
 
 RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
 
-task :default => :spec
+task :default => :spec

data/app/assets/stylesheets/blogit/themes/default.css

@@ -0,0 +1,4 @@
+/* No files to import found in base/* */
+/* No files to import found in blocks/* */
+
+/*# sourceMappingURL=default.css.map */

data/app/assets/stylesheets/blogit/themes/default.css.map

@@ -0,0 +1,7 @@
+{
+"version": 3,
+"mappings": "",
+"sources": [],
+"names": [],
+"file": "default.css"
+}

data/app/assets/stylesheets/blogit/themes/default.min.css

@@ -0,0 +1,2 @@
+
+/*# sourceMappingURL=default.min.css.map */

data/app/assets/stylesheets/blogit/themes/default.min.css.map

@@ -0,0 +1,7 @@
+{
+"version": 3,
+"mappings": "",
+"sources": [],
+"names": [],
+"file": "default.min.css"
+}

data/app/assets/stylesheets/blogit/themes/default.sass

@@ -0,0 +1,2 @@
+@import "base/*"
+@import "blocks/*"

data/app/assets/stylesheets/blogit/themes/default/base/_colors.sass

@@ -0,0 +1 @@
+$color-font-default: #444444

data/app/assets/stylesheets/blogit/themes/default/base/_typography.sass

@@ -0,0 +1 @@
+$font-size-xl: 2em

data/app/assets/stylesheets/blogit/themes/default/blocks/_archives.sass

@@ -0,0 +1,18 @@
+.blogit_archive
+
+.blogit_archive__list
+  padding: 0
+  list-style-type: none
+
+.blogit_archive__list--months
+  padding-left: 0.5em
+  display: none
+
+.blogit_archive__list--archiveables
+  margin-bottom: 0.5em
+  padding-left: 0.5em
+  display: none
+
+.blogit_archive__item
+.blogit_archive__item--post
+  margin: 0.5em 0

data/app/assets/stylesheets/blogit/themes/default/blocks/_comments.sass

@@ -0,0 +1,7 @@
+.blogit_comment
+
+.blogit_comment__name
+
+.blogit_comment__body
+
+.blogit_comment__created_at

data/app/assets/stylesheets/blogit/themes/default/blocks/_forms.sass

@@ -0,0 +1,9 @@
+.blogit_form
+
+.blogit_form__header
+
+.blogit_form__label
+
+.blogit_form__field
+
+.blogit_form__field--textarea

data/app/assets/stylesheets/blogit/themes/default/blocks/_headers.sass

@@ -0,0 +1,4 @@
+.blogit_header
+.blogit_header--page
+  font-size: $font-size-xl
+.blogit_header--section

data/app/assets/stylesheets/blogit/themes/default/blocks/_posts.sass

@@ -0,0 +1,8 @@
+.blogit_post
+
+.blog_post--is_preview
+
+.blogit_post__header
+  font-size: $font-size-xl
+
+.blogit_post__header_link

data/app/assets/stylesheets/blogit/themes/default/blocks/_related_posts_list.sass

@@ -0,0 +1,3 @@
+.blogit_related_posts
+
+.blogit_related_posts__header

data/app/assets/stylesheets/blogit/themes/default/blocks/_share_bars.sass

@@ -0,0 +1,7 @@
+.blogit_share_bar
+
+.blogit_share_bar__social_button
+
+.blogit_share_bar__social_button--facebook
+.blogit_share_bar__social_button--google_plus
+.blogit_share_bar__social_button--twitter

data/app/assets/stylesheets/blogit/themes/default/blocks/_tags.sass

@@ -0,0 +1,4 @@
+.blog_tags
+
+.blog_tags-li
+  display: inline

data/app/controllers/blogit/application_controller.rb

@@ -3,44 +3,28 @@ module Blogit
   # Inherits from the application's controller instead of ActionController::Base
   class ApplicationController < ::ApplicationController
 
-    helper Blogit::ApplicationHelper, Blogit::PostsHelper
-    helper_method :current_blogger, :blogit_conf
-
-    # Sets a class method to specify a before-filter calling
-    # whatever Blogit.configuration.authentication_method is set to
-    # Accepts the usual before_filter optionss
-    def self.blogit_authenticate(options ={})
-      before_filter blogit_conf.authentication_method, options
-    end
-
-    # A helper method to access the Blogit::configuration
-    # at the class level
+    helper Blogit::ApplicationHelper
+    helper Blogit::LayoutHelper
+    helper Blogit::PostsHelper
+    helper Blogit::CommentsHelper
+    
+    helper_method :blogit_conf
+
+    # A helper method to access the {Blogit::configuration} at the class level.
+    #
+    # Returns a Blogit::Configuration
     def self.blogit_conf
       Blogit::configuration
     end
 
-    # A helper method to access the Blogit::configuration
-    # at the controller instance level
+    # A helper method to access the {Blogit::configuration} at the controller instance
+    #   level.
+    #
+    # Returns a Blogit::Configuration
     def blogit_conf
       self.class.blogit_conf
     end
 
-    # Returns the currently logged in blogger by calling
-    # whatever Blogit.current_blogger_method is set to
-    def current_blogger
-      send blogit_conf.current_blogger_method
-    end
-
-    # Returns true or false if current_blogger is present
-    def is_blogger_logged_in?
-      !!current_blogger 
-    end
-
-    # Returns true if the current_blogger is the owner of the post
-    # @param post An instance of Blogit::Post
-    def this_blogger?(post)
-      current_blogger == post.blogger
-    end
-
   end
+  
 end

data/app/controllers/blogit/comments_controller.rb

@@ -1,47 +1,65 @@
 module Blogit
+  
+  # Handles requests for creating Blogit::Comments 
   class CommentsController < ApplicationController
 
-    blogit_authenticate except: [:create]
-
+    # Accessor method for the comment being created
+    #
+    # Returns a Blogit::Comment
+    attr_reader :comment
+    
+    # Accessor method for the Post we're adding a Comment to
+    #
+    # Returns Post
+    attr_reader :post
+    
+    # Handles POST requests to /blogit/comments.html and /blogit/comments.js
     def create
-      @comment = post.comments.new(comment_params)
-
+      set_post_from_post_id
+      set_comment_as_new
+      comment.save
       respond_to do |format|
-        format.js {
-          # the rest is dealt with in the view
-          @comment.save
-        }
-
-        format.html {
-          if @comment.save
-            redirect_to(post, notice: t(:successfully_added_comment, scope: 'blogit.comments'))
-          else
-            render "blogit/posts/show"
-          end
-        }
-
+        format.js   { create_respond_to_js }
+        format.html { create_respond_to_html }
       end
+    end
+
+
+    private
 
+
+    # Set this controller's post attribute to the current Post
+    def set_post_from_post_id
+      @post = Blogit::Post.find(params[:post_id])
     end
 
-    def destroy
-      @comment = post.comments.find(params[:id])
-      @comment.destroy
-      respond_to do |format|
-        format.html { redirect_to(post, notice: t(:successfully_removed_comment, scope: 'blogit.comments'))}
-        format.js
-      end
+    # Set this controller's comment attribute as a new comment with params
+    def set_comment_as_new
+      @comment = post.comments.new(comment_params)
     end
 
-    private
+    # The create action render call when format is JS
+    def create_respond_to_js
+      render status: (comment.persisted? ? :created : :bad_request)
+    end
 
+    # The create action render call when format is HTML    
+    def create_respond_to_html
+      if comment.persisted?
+        redirect_to(post, 
+          notice: t(:successfully_added_comment, scope: 'blogit.comments'))
+      else
+        render "blogit/posts/show"
+      end  
+    end
+    
+    # The comment attribute params 
+    # 
+    # Returns a Hash
     def comment_params
       params.require(:comment).permit(:name, :nickname, :email, :body, :website)
     end
-
-    def post
-      @post ||= Blogit::Post.find(params[:post_id])
-    end
     
   end
-end
+  
+end

data/app/controllers/blogit/posts_controller.rb

@@ -1,114 +1,80 @@
 module Blogit
 
-  # Using explicit ::Blogit::ApplicationController fixes NoMethodError 'blogit_authenticate' in
-  # the main_app
+  # Handles requests for viewing Blogit::Posts
   class PostsController < ::Blogit::ApplicationController
 
+    # The current Blogit::Post being displayed.
+    #
+    # Returns a Blogit::Post with id from params
+    attr_reader :post
+
+    # The current Posts being displayed
+    #
+    # Returns ActiveRecord::Relation for Post table
+    attr_reader :posts
+    
     # If a layout is specified, use that. Otherwise, fall back to the default
     layout Blogit.configuration.layout if Blogit.configuration.layout
 
-    # If using Blogit's Create, Update and Destroy actions AND ping_search_engines is
-    # set, call ping_search_engines after these requests
-    if Blogit.configuration.include_admin_actions
-      after_filter :ping_search_engines, only: [:create, :update, :destroy], :if => lambda { Blogit.configuration.ping_search_engines }
-    end
-
-    # Raise a 404 error if the admin actions aren't to be included
-    # We can't use blogit_conf here because it sometimes raises NoMethodError in main app's routes
-    unless Blogit.configuration.include_admin_actions
-      before_filter :raise_404, except: [:index, :show]
-    end
-
-    blogit_authenticate(except: [:index, :show, :tagged])
-
+    # Handles GET requests to /blogit/posts.html, /blogit/posts.xml, and /blogit/posts.rss
+    # Possible formats include:
+    #
+    # "XML" -  calls {#set_posts_for_feed}.
+    # "RSS" -  calls {#set_posts_for_feed}.
+    # "HTML" - calls {#set_posts_for_index_page}.
+    #
+    # Returns nil
     def index
       respond_to do |format|
-        format.xml {
-          @posts = Post.active.order('created_at DESC')
-        }
-        format.html {
-          @posts = if is_blogger_logged_in?
-                    Post.for_index(params[Kaminari.config.param_name])
-                  else
-                    Post.active.for_index(params[Kaminari.config.param_name])
-                  end
-        }
-        format.rss {
-          @posts = Post.active.order('created_at DESC')
-        }
+        format.xml  { set_posts_for_feed }
+        format.rss  { set_posts_for_feed }
+        format.html { set_posts_for_index_page }
       end
     end
 
+    # Handles GET requests to /blogit/posts/:id.html
     def show
-      @post = Post.find(params[:id])
+      set_post
     end
 
+    # Handles GET requests to /blogit/posts/tagged/:tag.html. Renders the index template
+    # with Posts tagged with tag in *tag* parameter
     def tagged
-      param_name = params[Kaminari.config.param_name]
-      @posts = Post.for_index(param_name).tagged_with(params[:tag])
+      set_posts_for_tagged_page
       render :index
     end
 
-    def new
-      @post = current_blogger.blog_posts.new(post_paramters)
-    end
-
-    def edit
-      @post = current_blogger.blog_posts.find(params[:id])
-    end
-
-    def create
-      @post = current_blogger.blog_posts.new(post_paramters)
-      if @post.save
-        redirect_to @post, notice: t(:blog_post_was_successfully_created, scope: 'blogit.posts')
-      else
-        render action: "new"
-      end
-    end
 
-    def update
-      @post = current_blogger.blog_posts.find(params[:id])
-      if @post.update_attributes(post_paramters)
-        redirect_to @post, notice: t(:blog_post_was_successfully_updated, 
-          scope: 'blogit.posts')
-      else
-        render action: "edit"
-      end
+    private
+    
+    
+    # Set {#post} based on the :id param
+    def set_post
+      @post = Post.active_with_id(params[:id])
     end
-
-    def destroy
-      @post = current_blogger.blog_posts.find(params[:id])
-      @post.destroy
-      redirect_to posts_url, notice: t(:blog_post_was_successfully_destroyed, scope: 'blogit.posts')
+    
+    # The page parameter value for the current locale
+    def page_number
+      @page_number ||= params[Kaminari.config.param_name]
     end
-
-    def post_paramters
-      if params[:post]
-        params.require(:post).permit(:title, :body, :tag_list, :state)
-      else
-        {}
-      end
+    
+    # Sets {#posts} for the XML feed
+    def set_posts_for_feed
+      @posts ||= Post.for_feed
     end
 
-    private
-
-    def raise_404
-      # Don't include admin actions if include_admin_actions is false
-      render file: "#{Rails.root}/public/404.html", status: :not_found, layout: false
+    # Sets {#posts} for the HTML index page
+    # 
+    # tag - The tag name to filter Posts by (default: nil)
+    #
+    def set_posts_for_index_page(tag = nil)
+      @posts ||= Post.for_index(page_number)
     end
-
-
-    # @See the Pingr gem for more info https://github.com/KatanaCode/pingr
-    def ping_search_engines
-      case blogit_conf.ping_search_engines
-      when Array
-        search_engines = blogit_conf.ping_search_engines
-      when true
-        search_engines = Pingr::SUPPORTED_SEARCH_ENGINES
-      end
-      for search_engine in search_engines
-        Pingr::Request.new(search_engine, posts_url(format: :xml)).ping
-      end
+    
+    # Sets {#posts} for the HTML index page when a tag parameter is present
+    # 
+    def set_posts_for_tagged_page
+      @posts = set_posts_for_index_page.tagged_with(params[:tag])
     end
 
   end