blogit 1.0.0.rc1 → 1.0.0

data/lib/blogit/archive/month.rb

@@ -0,0 +1,34 @@
+module Blogit
+  module Archive
+    
+    # Used internally by {List} when creating a new archive list.
+    class Month
+  
+      attr_reader :month_name
+      
+      alias_method :to_s, :month_name
+      
+      attr_reader :archiveables
+      
+      # Creates a new {Month} object
+      #
+      # month_name   - The name of the month for this collection of archiveables
+      # archiveables - A collection of _archiveable_ objects
+      #
+      def initialize(month_name, archiveables)
+        @month_name   = month_name
+        @archiveables = archiveables
+      end
+  
+  
+      # The name of the partial to load for a {Month} object
+      #
+      # Returns a String
+      def to_partial_path
+        self.class.name.underscore
+      end
+
+    end
+    
+  end
+end

data/lib/blogit/archive/year.rb

@@ -0,0 +1,40 @@
+module Blogit
+  module Archive
+    class Year
+  
+      attr_accessor :year, :months
+  
+      def initialize(year, archiveables)
+        @year   = year
+        @months = create_months_from_archiveables(archiveables)
+      end
+  
+      def to_s
+        year
+      end
+      
+      # The name of the partial to load for a {Year} object
+      #
+      # Returns a String
+      def to_partial_path
+        self.class.name.underscore
+      end
+      
+      
+      private
+      
+      
+      def create_months_from_archiveables(archiveables)
+        months_with_archiveables(archiveables).
+          map { |month, archs| Month.new(month, archs) }
+      end
+      
+      def months_with_archiveables(archiveables)
+        archiveables.chunk { |a| 
+          I18n.localize(a.published_at, format: :plain_month_only) 
+        }
+      end
+  
+    end
+  end
+end

data/lib/blogit/blogs.rb

@@ -1,17 +1,23 @@
 module Blogit
   module Blogs
-
-    def self.included(base)
-      base.extend ClassMethods
-    end
+    
+    extend ActiveSupport::Concern
     
     module ClassMethods
       
       # When called within a model (usually User) this creates
-      # a has-many assosciation between the model and Blogit::Post
+      # a has-many assosciation between the model and {Post}
       def blogs
+        @blogs = true
         has_many :blog_posts, :as => "blogger", :class_name => "Blogit::Post"
       end
+      
+      # Has this model been registered as a blogging model?
+      #
+      # Returns true or false
+      def blogs?
+        @blogs == true
+      end
             
     end
     

data/lib/blogit/configuration.rb

@@ -1,182 +1,192 @@
 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 
+    #   "active". ("Active" {Post posts} are those that can be viewed by the public).
+    ACTIVE_STATES = [:published]
 
-    # What kind of comments do you want to add to your blog ? (:active_record, :disqus or :no)
-    attr_accessor :include_comments
-
-    # When using disqus comments, what is the shortname of your forum ?
-    attr_reader :disqus_shortname
-
-    # Should there be a share bar on every post ?
-    attr_accessor :include_share_bar
-
-    # Twitter username used in the share bar
-    attr_reader :twitter_username
-
+    # 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]    
+    
+    # When using redcarpet as content parser, pass these options as defaults.
+    REDCARPET_OPTIONS = {
+      hard_wrap: true,
+      filter_html: true,
+      autolink: true,
+      no_intra_emphasis: true,
+      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. 
+    #   (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.
-    attr_accessor :current_blogger_method
-
-    # what method do we call on blogger to return their display name?
-    # Defaults to :username
-    attr_accessor :blogger_display_name_method
-
-    # Which DateTime::FORMATS format do we use to display
-    # blog and comment publish time
-    # Defaults to :short
-    attr_accessor :datetime_format
-
-    # Number of posts to show per page
-    # @see https://github.com/amatsuda/kaminari
-    # @see Blogit::Post
-    attr_accessor :posts_per_page
-
-    # Should text within "```" or "`" be highlighted as code?
-    # Defaults to true
-    # @note - At the moment this only works when default_parser
-    #   is :markdown
-    attr_accessor :highlight_code_syntax
-
-    # The name of the before filter we'll call to authenticate the current user.
-    # Defaults to :login_required
-    attr_accessor :authentication_method
-
-    # If set to true, only the user who authored the post may, edit or destroy.
-    # Defaults to false
-    attr_accessor :author_edits_only
-
+    #   (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.
-    # Defaults to true
-    attr_accessor :ajax_comments
-
-    # If set to true, the create, edit, update and destroy actions
-    # will be included. If set to false, you'll have to set these
-    # yourself elsewhere in the app
-    attr_accessor :include_admin_actions
-
-    # 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.
-    attr_accessor :include_admin_links
-
+    #
+    # Returns true or false
+    config_accessor(:ajax_comments)  { true }
+    
+    ##
     # The default format for parsing the blog content.
+    #
     # Defaults to :markdown
-    attr_accessor :default_parser
-
+    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 }
+    
+    ##
     # When using redcarpet as content parser, pass these options as defaults
-    # Defaults to REDCARPET_OPTIONS
-    attr_accessor :redcarpet_options
-
-    # Should the controllers cache the blog pages as HTML?
-    # Defaults to false
-    attr_accessor :cache_pages
-
+    #
+    # 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"
-    attr_accessor :rss_feed_title
-
+    config_accessor(:rss_feed_title, instance_reader: false)
+    
+    ##
     # The description of the RSS feed for the blog posts
     # Defaults to "[Application Name] Blog Posts"
-    attr_accessor :rss_feed_description
-
-    # Should the routes of the main app be accessible without
-    # the "main_app." prefix ?
-    attr_accessor :inline_main_app_named_routes
-
-    # Should blogit ping search engines with your sitemap
-    # when posts are created, updated or destroyed?
-    # Defaults to false
-    attr_accessor :ping_search_engines
-
+    config_accessor(:rss_feed_description, instance_reader: false)
+    
+    ##
     # 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,
-      filter_html: true,
-      autolink: true,
-      no_intra_emphasis: true,
-      fenced_code_blocks: true,
-      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            = ""
-      @include_share_bar           = false
-      @twitter_username            = ""
-      @current_blogger_method      = :current_user
-      @blogger_display_name_method = :username
-      @datetime_format             = :short
-      @posts_per_page              = 5
-      @authentication_method       = :login_required
-      @author_edits_only           = false
-      @ajax_comments               = true
-      @include_admin_actions       = true
-      @include_admin_links         = true
-      @cache_pages                 = false
-      @default_parser              = :markdown
-      @highlight_code_syntax       = true
-      @rss_feed_title              = "#{Rails.application.engine_name.titleize} Blog Posts"
-      @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
+    config_accessor :layout
 
+    ##
+    # Should show a description of the blog post on the index
+    # and RSS feed.
+    #
+    # Defaults to true
+    config_accessor(:show_post_description) { true }
+    
+    
     def default_parser_class
-      "Blogit::Parsers::#{@default_parser.to_s.classify}Parser".constantize
+      "Blogit::Parsers::#{default_parser.to_s.classify}Parser".constantize
     end
 
-    # If the user has defined a disqus shortname but hasn't set include_comments to
-    # disqus, print a warning to the console.
+    # 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.
+    #
+    # shortname - A String with the diquss username to use.
+    #
     def disqus_shortname=(shortname)
-      if @include_comments && @include_comments != :disqus
-        blogit_warn "You've set config.disqus_shortname in your blogit config file but config.include_comments is not set to :disqus"
+      return if shortname.blank?
+      unless include_comments == :disqus
+        blogit_warn "You've set config.disqus_shortname in your blogit config file but " \
+         "config.include_comments is not set to :disqus"
       end
       @disqus_shortname = shortname
     end
 
-    # If the user has defined a disqus shortname but hasn't set include_comments to
-    # disqus, print a warning to the console.
-    def twitter_username=(username)
-      if not @include_share_bar
-        blogit_warn "You've set config.twitter_username in your blogit config file but config.include_share_bar is set to false"
-      end
-      @twitter_username = username
+    # The title to use in the index.rss template. (default: [My Application] Blog
+    #   Posts")
+    #
+    # Returns a String
+    def rss_feed_title
+      @rss_feed_title ||= "#{rails_app_name} Blog Posts"
     end
 
-    def rss_feed_language=(locale)
-      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"
+    # The description to use in the index.rss template. 
+    #   (default: "Latest from [My Application]")
+    #
+    # 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"
+    #
+    # Returns a String
+    def rails_app_name
+      Rails.application.engine_name.titleize
+    end
+
+    # Print a warning message to $STDOUT with the prefix "[Blogit]: "
+    #
+    # Examples
+    # 
+    #  blogit_warn("Blogit is not a toy!")
+    #  # => "[Blogit]: Blogit is not a toy!"
+    #
     def blogit_warn(message)
       warn "[Blogit]: #{message}"
     end
 
   end
-end
+  
+end

data/lib/blogit/parsers/html_parser.rb

@@ -1,9 +1,12 @@
 class Blogit::Parsers::HtmlParser
-
-  attr_reader :parsed
+  
+  # A String containing the content to be parsed
+  attr_reader :content
+  
+  alias_method :parsed, :content
 
   def initialize(content)
-    @parsed = content
+    @content = content
   end
 
 end