blogit 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0ce028f63a809be074f923a4b1870599cd6616ab
-  data.tar.gz: f0053eda22037fab3ad53ea7719f844c630000df
+SHA256:
+  metadata.gz: f9c716ed9ef8c03894a63bc2b0342be087d114551df23bb0b3012b7d8bab6fe5
+  data.tar.gz: 2bf4e5ccb458df7370061c4e33bc25294e6cd3df450cb55ea3cc0240b4c49441
 SHA512:
-  metadata.gz: dc9cd5c907b64cef43daf98242da3d4f787fa3e9f125a7b476238eaf457f726f7e44b55f4972310210cbaf0f572caf0f8c6f0d17523f0a5aa15a242172c6620d
-  data.tar.gz: 7999542af4e13f1b5af091963f9be9ad6abf7f582e189a6065aa5e11f9db0e2c2ca6898ea5eaeaada81b58c203a79801b169fa6c0f8e65a316baac201d708c2e
+  metadata.gz: 3610d9b3906ee55d231a4bffe80fc0ec4c92e5edce1861b9e07a2991a3a15fe0d2201cf3196c47ddb90b4c9cb9f917976dcd585eb6dc1f255e32c838d61db61c
+  data.tar.gz: eeb122baf4b37c7c7dabb8c3c143816e4c64865b3dabd5618cabbd6f4f15b1e7f67a34523941359d9c29b0532315c4d93cfb7af4cd04e25bd8f0efa4b61de74b

data/README.md

@@ -3,6 +3,7 @@
 [![Test Coverage](https://d3s6mut3hikguw.cloudfront.net/github/KatanaCode/blogit/badges/coverage.svg)](http://codeclimate.com/github/KatanaCode/blogit/badges/)
 [![Blogit](https://gemnasium.com/KatanaCode/blogit.png)](https://gemnasium.com/KatanaCode/blogit)
 [![Travis CI](https://travis-ci.org/KatanaCode/blogit.png)](https://travis-ci.org/KatanaCode/blogit.png)
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/Bodacious/blogit/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
 # Blogit - A Rails blogging solution
 
@@ -30,12 +31,12 @@ $ rails g blogit:install
 rake blogit:install:migrations
 
 # You don't need to run this again if you've already done so
-rake acts_as_taggable_on:install:migrations
+rake acts_as_taggable_on_engine:install:migrations
 
 # This will run any pending migrations
 rake db:migrate
 
-``` 
+```
 
 then add the following to your routes.rb file:
 
@@ -48,11 +49,11 @@ Finally, declare which of your models acts as blogger in your app (probably User
 
 ``` ruby
 class User < ActiveRecord::Base
-  
+
   blogs
 
 end
-```  
+```
 
 Go to http://localhost:3000/blog and see your marvelous new blog.
 
@@ -69,13 +70,19 @@ Blogit provides you with the following features
 * Code Syntax Highlighting CSS file (add `*= require pygments` to your app's stylesheet)
 * CSS themes
 
+## Modular
+
+We're designing blogit to be as modular as possible, so you can pick and choose the elements you'd like to use.
+
+* For **Admin CMS** please install [blogit-admin](https://github.com/katanacode/blogit-admin)
+
 ## Documentation
 
 Full documentation and how-to guides available here: http://blogit.katanacode.com
 
 ## Issues
 
-If you discover a problem with Blogit, please let us know about it. 
+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
@@ -104,4 +111,4 @@ Katana Code are [web developers based in Edinburgh, Scotland](http://katanacode.
 
 Copyright © 2011 - 2015 [Katana Code Ltd.](http://katanacode.com)
 
-  [GithubLicence]: https://github.com/KatanaCode/blogit/blob/master/MIT-LICENSE
+  [GithubLicence]: https://github.com/KatanaCode/blogit/blob/master/MIT-LICENSE

data/Rakefile

@@ -1,27 +1,20 @@
 #!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-
-load 'rails/tasks/engine.rake'
-
-Bundler::GemHelper.install_tasks
-
-
-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}
-
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 
+require "rubygems"
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require "blogit/version"
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
-desc "Run all specs in spec directory (excluding plugin specs)"
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+
+load 'rails/tasks/engine.rake'
 
-RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+Dir[File.join(File.dirname(__FILE__), 'lib/tasks/**/*.rake')].each { |f| import f }
+Dir[File.join(File.dirname(__FILE__), 'spec/dummy/lib/tasks/**/*.rake')].
+  each { |f| import f }
 
-task :default => :spec
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec)

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

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

data/app/views/blogit/posts/index.xml.builder

@@ -1,11 +1,18 @@
-xml.instruct! 
-xml.urlset :xmlns => 'http://www.sitemaps.org/schemas/sitemap/0.9' do 
+xml.instruct!
+xml.urlset :xmlns => 'http://www.sitemaps.org/schemas/sitemap/0.9' do
 
+  # Show the blog index in sitemap
+  xml.url do
+    xml.loc posts_url
+    xml.lastmod @posts.maximum(:updated_at).xmlschema
+  end
+
+  # Include a record for each active post
   for post in @posts
     xml.url do
       xml.loc post_url(post)
       xml.lastmod post.updated_at.xmlschema
     end
   end
-  
+
 end

data/lib/blogit/configuration.rb

@@ -1,22 +1,22 @@
 module Blogit
-  
+
   # This class handles the global configuration options for Blogit.
   #  When you run `rails g blogit:install` this will add an initializer file to
   #  config/initializers/blogit.rb with all of the default configurations applied.
   #
   #  You can read about each of the individual configuration options below.
   class Configuration
-    
+
     include ActiveSupport::Configurable
-    
-    # An Array containing the default states for {Blogit::Post Posts} that are considered 
+
+    # An Array containing the default states for {Blogit::Post Posts} that are considered
     #   "active". ("Active" {Post posts} are those that can be viewed by the public).
     ACTIVE_STATES = [:published]
 
-    # An Array containing the default states for {Blogit::Post Posts} that are considered 
+    # An Array containing the default states for {Blogit::Post Posts} that are considered
     #   "hidden". ("Hidden" {Post posts} are those that may not be viewed by the public).
-    HIDDEN_STATES = [:draft, :archive]    
-    
+    HIDDEN_STATES = [:draft, :archive]
+
     # When using redcarpet as content parser, pass these options as defaults.
     REDCARPET_OPTIONS = {
       hard_wrap: true,
@@ -26,94 +26,99 @@ module Blogit
       fenced_code_blocks: true,
       gh_blockcode: true,
     }
-    
-    ## 
+
+    ##
     # How do you want to handle comments for your blog?
-    #   Valid options are :active_record, :disquss, or :no for none. 
+    #   Valid options are :active_record, :disquss, or :no for none.
     #   (default: :active_record)
     config_accessor(:include_comments) { :active_record }
-    
-    ## 
+
+    ##
     # When using :disqus comments, what is the shortname of your forum?
     #  (default: nil)
     config_accessor(:disqus_shortname, instance_writer: false)
-    
+
     ##
     # Load a javascript-based share bar on each blog post?. (default: true)
     config_accessor(:include_share_bar) { true }
-    
+
     ##
     # Twitter username used in the share bar. (default: nil)
     config_accessor(:twitter_username)
-    
+
     ##
     # The name of the controller method we'll call to return the current blogger.
     #   (default: :current_user)
     config_accessor(:current_blogger_method) { :current_user }
-    
+
     ##
     # What method do we call on blogger to return their display name? (default: :username)
     config_accessor(:blogger_display_name_method) { :username }
-    
+
     ##
     # Which DateTime::FORMATS format do we use to display blog and comment publish time
     #   (default: :short)
     config_accessor(:datetime_format) { :short }
-    
+
     ##
     # Number of {Blogit::Post posts} to show per page. This is a configuration for {https://github.com/amatsuda/kaminari Kaminari} (default: 5)
     #
     # Returns an Integer
     config_accessor(:posts_per_page) { 5 }
-    
+
     ##
     # If set to true, the comments form will POST and DELETE to the comments
     # controller using AJAX calls.
     #
     # Returns true or false
     config_accessor(:ajax_comments)  { true }
-    
+
     ##
     # The default format for parsing the blog content.
     #
     # Defaults to :markdown
     config_accessor(:default_parser) { :markdown }
-    
+
     ##
     # Should text within "```" or "`" be highlighted as code?
     # Defaults to true
     # @note - At the moment this only works when default_parser is :markdown
     config_accessor(:highlight_code_syntax) { true }
-    
+
+    ##
+    # The renderer used for code highlighting
+    # Defaults to :albino
+    config_accessor(:syntax_highlighter) { :albino }
+
     ##
     # When using redcarpet as content parser, pass these options as defaults
     #
     # Defaults to {REDCARPET_OPTIONS}
     config_accessor(:redcarpet_options) { REDCARPET_OPTIONS }
-    
+
     ##
     # List of states that will be visible to the public
     #
     # Defaults to ACTIVE_STATES
     config_accessor(:active_states) { ACTIVE_STATES }
-    
+
     ##
     # List of states that will hide the posts from the public.
     #
     # Defaults to HIDDEN_STATES
     config_accessor(:hidden_states) { HIDDEN_STATES }
-    
+
     ##
     # The title of the RSS feed for the blog posts
     #
     # Defaults to "[Application Name] Blog Posts"
     config_accessor(:rss_feed_title, instance_reader: false)
-    
+
     ##
     # The description of the RSS feed for the blog posts
     # Defaults to "[Application Name] Blog Posts"
     config_accessor(:rss_feed_description, instance_reader: false)
-    
+
     ##
     # The layout to be used by the posts controller
     #
@@ -126,13 +131,13 @@ module Blogit
     #
     # Defaults to true
     config_accessor(:show_post_description) { true }
-    
-    
+
+
     def default_parser_class
       "Blogit::Parsers::#{default_parser.to_s.classify}Parser".constantize
     end
 
-    # Sets {#disqus_shortname}. 
+    # Sets {#disqus_shortname}.
     #   If the user has defined a disqus shortname but hasn't set include_comments to
     #   :disqus will print a warning to the console.
     #
@@ -155,19 +160,19 @@ module Blogit
       @rss_feed_title ||= "#{rails_app_name} Blog Posts"
     end
 
-    # The description to use in the index.rss template. 
+    # The description to use in the index.rss template.
     #   (default: "Latest from [My Application]")
     #
-    # Returns a String    
+    # Returns a String
     def rss_feed_description
       @rss_feed_description ||= "Latest from #{rails_app_name}"
     end
 
-    
-    
+
+
     private
 
-  
+
     # The name of this application derived from the app's engine name.
     #   If your Rails app module is KatanaCode, the application name will be "Katana Code"
     #
@@ -179,7 +184,7 @@ module Blogit
     # Print a warning message to $STDOUT with the prefix "[Blogit]: "
     #
     # Examples
-    # 
+    #
     #  blogit_warn("Blogit is not a toy!")
     #  # => "[Blogit]: Blogit is not a toy!"
     #
@@ -188,5 +193,5 @@ module Blogit
     end
 
   end
-  
-end
+
+end

data/lib/blogit/parsers/markdown_parser.rb

@@ -1,17 +1,16 @@
 class Blogit::Parsers::MarkdownParser
-  
+
   require "nokogiri"
-  require "albino"
   require "blogit/renderers"
-  
-  # A String containing the content to be parsed  
+
+  # A String containing the content to be parsed
   attr_reader :content
-  
+
   def initialize(content)
     @content = content
   end
 
-  # The parsed content 
+  # The parsed content
   #
   # Returns an HTML safe String
   def parsed
@@ -21,26 +20,26 @@ class Blogit::Parsers::MarkdownParser
 
 
   private
-  
-  
+
+
   # The Redcarpet renderer to use
   def renderer
     if Blogit::configuration.highlight_code_syntax
-      Redcarpet::Render::HTMLWithAlbino
+      Blogit::Renderers.choose_highlight_renderer
     else
       Redcarpet::Render::HTML
     end
   end
-  
+
   # The Redcarpet Markdown handler
   def markdown
     @markdown ||= Redcarpet::Markdown.new(renderer,
       Blogit.configuration.redcarpet_options)
   end
 
-  
+
   # Ensures pygments is installed
-  # 
+  #
   # Raises StandardError if pygments is not available on this machine
   def ensure_pygments_is_installed
     warning = <<-WARNING
@@ -48,15 +47,15 @@ class Blogit::Parsers::MarkdownParser
          Please either do one of the following:
 
          $ sudo easy_install Pygments # to install it
-         
-         or 
-         
+
+         or
+
          set config.highlight_code_syntax to false in your blogit.rb config file.
-         
+
 WARNING
     raise warning unless which(:pygmentize)
   end
-  
+
   # Check if an executable exists in the load path
   #
   # Returns nil if no executable is found
@@ -70,5 +69,5 @@ WARNING
     end
     return nil
   end
-  
+
 end

data/lib/blogit/renderers.rb

@@ -1,3 +1,15 @@
 module Blogit::Renderers
-  require "blogit/renderers/html_with_albino"
+  def self.choose_highlight_renderer
+    case Blogit::configuration.syntax_highlighter
+    when :albino
+      require "blogit/renderers/html_with_albino"
+      Redcarpet::Render::HTMLWithAlbino
+    when :pygments
+      require "blogit/renderers/html_with_pygments"
+      Redcarpet::Render::HTMLWithPygments
+    else
+      raise Blogit::ConfigurationError,
+        "'#{Blogit.configuration.syntax_highlighter}' is not a valid renderer"
+    end
+  end
 end