blog_logic 1.4.0 → 1.4.1

data/Gemfile

@@ -29,4 +29,5 @@ group :test do
   gem 'mocha'
   gem 'rcov'
   gem 'rspec-rails'
+  gem 'yard'
 end

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.4.1

data/app/controllers/admin/posts_controller.rb

@@ -11,8 +11,8 @@ class Admin::PostsController < ApplicationController
       :state         => 'Status',
       :updated_at    => 'Last Modified'
     }
-    params[:by] ||= 'slug'
-    params[:dir] ||= 'asc'
+    params[:by] ||= 'publication_date'
+    params[:dir] ||= 'desc'
     @posts = @blog.posts.sort_by{ |p| p[params[:by]] || p[params[:by]].to_s }
     @posts.reverse! if params[:dir] == 'desc'
   end

data/app/models/blog.rb

@@ -24,6 +24,8 @@ class Blog
   validates_uniqueness_of :slug
 
   # Instance methods ===============================================================================
+
+  # Migrates this blog's embedded posts to referenced ones.
   def copy_posts
     self.posts.each do |post|
       p = Post2.create :slug => post.slug, :content => post.content, :tags => post.tags, :author => post.author, :published_at => post.published_at, :state => post.state, :publication_date => post.publication_date, :summary => post.summary
@@ -60,6 +62,9 @@ class Blog
     "/#{self.slug}"
   end
 
+  # Returns this blog's posts keyed by publication date.
+  #
+  # @return [Hash] this blog's posts keyed by publication date
   def posts_by_month
     dates = {}
     self.posts.published.each do |p|
@@ -72,6 +77,10 @@ class Blog
     dates
   end
 
+  # Returns published posts matching the specified keyword.
+  #
+  # @param [String] the keyword to search for
+  # @return [Array] matching published posts
   def search(keyword)
     self.posts.published.where :content => /#{keyword}/i
   end

data/app/models/blog_category.rb

@@ -17,41 +17,74 @@ class BlogCategory
   validates_uniqueness_of :name
 
   # Class methods: Overrides =======================================================================
+
+  # Overrides children to sort by name.
+  #
+  # @return [Array] this blog category's children sorted by name
   def self.children
     super.asc :name
   end
 
+  # Overrides roots to sort by name.
+  #
+  # @return [Array] this blog category's roots sorted by name
   def self.roots
     super.asc :name
   end
 
   # Class methods ==================================================================================
+
+  # Returns the blog categories matching the specified name.
+  #
+  # @param [String] the name to search for
+  # @return [Array] the matching blog categories
   def self.by_name value
     self.find :first, :conditions => {:name => value}
   end
 
+  # Returns the blog categories matching the specified slug.
+  #
+  # @param [String] the slug to search for
+  # @return [Array] the matching blog categories
   def self.by_slug value
     self.find :first, :conditions => {:slug => /^#{value}$/i}
   end
 
+  # Returns the root blog categories that have posts.
+  #
+  # @return [Array] blog categories with posts
   def self.roots_with_posts
     self.roots.asc(:name).select{ |c| c.has_posts? }
   end
 
   # Instance methods: Overrides ====================================================================
+
+  # Returns child blog categories that have posts.
+  #
+  # @return [Array] child blog categories with posts
   def children_with_posts
     self.children.asc(:name).select{ |c| c.has_posts? }
   end
 
+  # Override the parent-ID setter to accept nil as a string.
+  #
+  # @param [String] parent ID
   def parent_id= value
     self[:parent_id] = value == 'nil' ? nil : value
   end
 
   # Instance methods ===============================================================================
+
+  # Returns true if this blog category has any posts.
+  #
+  # @return [Boolean] true if any posts exist
   def has_posts?
     ! self.all_posts.blank?
   end
 
+  # Sets the specified category as this blog category's parent.
+  #
+  # @param [String] the parent category's name
   def parent_category=(name)
     unless name.blank?
       self.parent = BlogCategory.find_or_create_by :name => name
@@ -59,18 +92,28 @@ class BlogCategory
     end
   end
 
+  # Returns all posts belonging to this blog category and its children.
+  #
+  # @return [Array] all posts for this blog category
   def all_posts
     (self.posts + self.children.map{ |c| c.posts }).uniq.flatten
   end
 
+  # Returns the path for this blog category.
+  #
+  # @return [String] this blog category's path
   def path
     "#{Blog.first.path}/topics/#{self.slug}"
   end
 
+  # Returns true if this blog category has a parent.
+  #
+  # @return [Boolean] true if subcategory
   def subcategory?
     ! self.root?
   end
 
+  # @deprecated Please use {#path} instead
   def url
     warn "[DEPRECATION] `url` is deprecated.  Please use `path` instead."
     self.path
@@ -78,12 +121,14 @@ class BlogCategory
 
   private
 
-  # Returns an array of this category's and its ancestors' names.
+  # Returns an array of names for this blog category and those of its ancestors.
+  #
+  # @return [Array] this blog category's name and those of its ancestors
   def ancestors_and_self_names
     self.ancestors_and_self.map{ |l| l.name }
   end
 
-  # Returns the permalink for this locale.
+  # Sets this blog category's slug, based on its name and those of its ancestors.
   def set_slug
     self.slug = (ancestors_and_self_names * '/').to_url.gsub('-slash-', '/')
   end

data/app/models/post.rb

@@ -4,7 +4,6 @@ class Post
   include Mongoid::Timestamps
   include Tanker
 
-  # Constants ======================================================================================
   STATES = ['draft', 'published']
 
   # Scopes =========================================================================================
@@ -49,15 +48,25 @@ class Post
   validates_presence_of :content, :title
 
   # Instance methods: Overrides ====================================================================
+
+  # Returns this post's publication date, defaulting to published-at.
+  #
+  # @return [DateTime] publication or published-at date
   def publication_date
     self[:publication_date] || self.published_at
   end
 
   # Instance methods ===============================================================================
+
+  # Returns true if this post is an unpublished draft.
+  #
+  # @return [Boolean] true if draft
   def draft?
     self.state == 'draft' || self.state.nil?
   end
 
+  # Joins this post to its associated blog categories, insuring data integrity at both ends of the
+  # join.
   def fix_blog_category_join
     self.blog_categories.each do |cat|
       cat.post_ids << self.id
@@ -77,10 +86,16 @@ class Post
     self.path
   end
 
+  # Returns the index of this post in the blog's collection of posts.
+  #
+  # @return [Fixnum] the path for this post
   def my_index
     self.blog.posts.index(self)
   end
 
+  # Returns the next post in the blog.
+  #
+  # @return [Post] the next post
   def next_post
     i = self.my_index + 1
     i = 0 if i > (self.blog.posts.size - 1)
@@ -94,36 +109,56 @@ class Post
     "#{self.blog.path}/#{self.slug}".gsub('//', '/')
   end
 
+  # Returns the previous post in the blog.
+  #
+  # @return [Post] the previous post
   def previous_post
     i = self.my_index - 1
     i = self.blog.posts.size - 1 if i < 0
     self.blog.posts[i]
   end
 
+  # Publishes this post so it's publically available.
   def publish!
     self.update_attributes :state => 'published', :published_at => Time.zone.now
   end
 
+  # Returns whether this post is publically available.
+  #
+  # @return [Boolean] true if published
   def published?
     self.state == 'published'
   end
 
+  # Returns the first 200 characters of this post's summary, suitable for use as a meta description.
+  #
+  # @return [String] search description
   def search_description
     self.summary.gsub(/<\/?[^>]*>/, '')[0..199].html_safe
   end
 
+  # Returns this post's title.
+  #
+  # @return [String] title
   def search_title
     self.title
   end
 
+  # Reverts this post's status to draft so it is no longer publically available.
   def unpublish!
     self.update_attributes :state => 'draft'
   end
 
+  # Sets the specified state for this post, forcing lowercase.
+  #
+  # @param [String] state
   def state=(arg)
     self[:state] = arg.downcase
   end
 
+  # Returns this post's status.
+  #
+  # @return [String] status
   def status
     self.state ? self.state.capitalize : 'Draft'
   end

data/blog_logic.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "blog_logic"
-  s.version = "1.4.0"
+  s.version = "1.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bantik"]
-  s.date = "2011-10-04"
+  s.date = "2011-11-01"
   s.description = "An engine for search-engine-optimized blog management."
   s.email = "corey@seologic.com"
   s.extra_rdoc_files = [
@@ -69,7 +69,6 @@ Gem::Specification.new do |s|
     "config/application.rb",
     "config/boot.rb",
     "config/cucumber.yml",
-    "config/deploy.rb",
     "config/environment.rb",
     "config/environments/development.rb",
     "config/environments/production.rb",

data/config.ru

@@ -1,4 +1,2 @@
-# This file is used by Rack-based servers to start the application.
-
 require ::File.expand_path('../config/environment',  __FILE__)
-run BlogLogic::Application
+run BlogLogic::Application

data/config/application.rb

@@ -10,35 +10,7 @@ Bundler.require(:default, Rails.env) if defined?(Bundler)
 
 module BlogLogic
   class Application < Rails::Application
-    # 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.
-
-    # Custom directories with classes and modules you want to be autoloadable.
-    # config.autoload_paths += %W(#{config.root}/extras)
-
-    # Only load the plugins named here, in the order given (default is alphabetical).
-    # :all can be used as a placeholder for all plugins not explicitly named.
-    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
-
-    # Activate observers that should always be running.
-    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
-
-    # 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)'
-
-    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
-    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
-    # config.i18n.default_locale = :de
-
-    # JavaScript files you want as :defaults (application.js is always included).
-    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
-
-    # Configure the default encoding used in templates for Ruby 1.9.
     config.encoding = "utf-8"
-
-    # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
   end
-end
+end

data/config/boot.rb

@@ -1,6 +1,3 @@
 require 'rubygems'
-
-# Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

data/config/cucumber.yml

@@ -7,4 +7,4 @@ int_opts = "#{std_opts} -o tmp/feature_results.txt"
 default: <%= std_opts %> features
 wip: --tags @wip:3 --wip features
 rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip
-integration: <%= int_opts %> features
+integration: <%= int_opts %> features

data/config/environment.rb

@@ -1,6 +1,3 @@
-# Load the rails application
 require File.expand_path('../application', __FILE__)
 require File.expand_path('../../lib/blog_logic', __FILE__)
-
-# Initialize the rails application
-BlogLogic::Application.initialize!
+BlogLogic::Application.initialize!

data/config/environments/development.rb

@@ -1,27 +1,11 @@
 BlogLogic::Application.configure do
-  # 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
-  # since you don't have to restart the webserver 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
   config.consider_all_requests_local       = true
   config.action_controller.perform_caching = false
-
-  # Don't care if the mailer can't send
   config.action_mailer.raise_delivery_errors = false
-
-  # 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
-
   # Custom settings
   config.feature_results_path = "#{Rails.root}/tmp/feature_results.txt"
-end
+end

data/config/environments/production.rb

@@ -1,49 +1,9 @@
 BlogLogic::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
-
-  # The production environment is meant for finished, "live" apps.
-  # Code is not reloaded between requests
   config.cache_classes = true
-
-  # Full error reports are disabled and caching is turned on
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true
-
-  # Specifies the header that your server uses for sending files
   config.action_dispatch.x_sendfile_header = "X-Sendfile"
-
-  # For nginx:
-  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
-
-  # If you have no front-end server that supports something like X-Sendfile,
-  # just comment this out and Rails will serve the files
-
-  # See everything in the log (default is :info)
-  # config.log_level = :debug
-
-  # Use a different logger for distributed setups
-  # config.logger = SyslogLogger.new
-
-  # Use a different cache store in production
-  # config.cache_store = :mem_cache_store
-
-  # Disable Rails's static asset server
-  # In production, Apache or nginx will already do this
   config.serve_static_assets = false
-
-  # Enable serving of images, stylesheets, and javascripts from an asset server
-  # config.action_controller.asset_host = "http://assets.example.com"
-
-  # Disable delivery errors, bad email addresses will be ignored
-  # 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)
   config.i18n.fallbacks = true
-
-  # Send deprecation notices to registered listeners
   config.active_support.deprecation = :notify
-end
+end

data/config/environments/test.rb

@@ -1,38 +1,12 @@
 BlogLogic::Application.configure do
-  # 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
-  # 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!
   config.cache_classes = true
-
-  # Log error messages when you accidentally call methods on nil.
   config.whiny_nils = true
-
-  # 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
   config.action_dispatch.show_exceptions = 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
-
-  # 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
   config.active_support.deprecation = :stderr
-
   # Custom settings
   config.admin_host = 'admin.bloglogic.com'
   # tanker gem

data/config/mongoid.yml

@@ -15,5 +15,4 @@ development:
 
 test:
   <<: *defaults
-  database: blog_logic_test
-
+  database: blog_logic_test

data/config/routes.rb

@@ -19,4 +19,4 @@ Rails.application.routes.draw do
     end
     resources :blog_categories
   end
-end
+end

data/init.rb

@@ -1 +1 @@
-require 'blog_logic'
+require 'blog_logic'

data/spec/controllers/admin/blogs_controller_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require 'spec_helper'
 
 describe Admin::BlogsController do
   before :each do

data/spec/controllers/admin/posts_controller_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require 'spec_helper'
 
 describe Admin::PostsController do
   before :each do

data/spec/controllers/blogs_controller_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe BlogsController do
   before :each do

data/spec/controllers/posts_controller_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe PostsController do
   before :each do

data/spec/models/blog_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Blog do
 

data/spec/models/post_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe Post do
   before :all do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: blog_logic
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 1
   - 4
-  - 0
-  version: 1.4.0
+  - 1
+  version: 1.4.1
 platform: ruby
 authors: 
 - Bantik
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-04 00:00:00 Z
+date: 2011-11-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bson_ext
@@ -267,7 +267,6 @@ files:
 - config/application.rb
 - config/boot.rb
 - config/cucumber.yml
-- config/deploy.rb
 - config/environment.rb
 - config/environments/development.rb
 - config/environments/production.rb
@@ -1046,3 +1045,4 @@ specification_version: 3
 summary: An engine for search-engine-optimized blog management.
 test_files: []
 
+has_rdoc: 

data/config/deploy.rb

@@ -1,40 +0,0 @@
-# Deploy this gem to the gem server.
-#
-# Usage for a gem already on the gem server:
-#
-#   cap deploy
-#
-# For a new gem:
-#
-#   cap deploy:new
-
-# Global Variables =================================================================================
-default_run_options[:pty] = true
-role :app, 'jose.seologic.com'
-set :deploy_to, '/home/containers/rails/system/blog_logic'
-set :repository, 'git@github.com:ivanoblomov/blog_logic.git'
-set :scm, :git
-set :use_sudo, false
-set :user, 'cnewton'
-
-namespace :deploy do
-  desc "Clone a new gem's repository on the gem server."
-  task :new do
-    run "git clone -q #{repository} #{deploy_to}"
-  end
-
-  task :install do
-    run "cd #{deploy_to}; rm -f Gemfile.lock; sudo bundle; sudo rake install"
-  end
-
-  # disable default behavior
-  task :restart do
-  end
-
-  task :update do
-    run "cd #{deploy_to}; git pull"
-  end
-end
-
-after 'deploy', 'deploy:install'
-after 'deploy:new', 'deploy:install'