postview 0.7.0 → 0.8.0

data/HISTORY

@@ -1,12 +1,37 @@
-[0.7.0 - not released - Features]
-  * The project is a Gem package.
-  * Postview command for create a new directory structure.
-  * Added CLI commands.
-  * Added basic classes for version and information about project.
-  * Added basic files for versioning and informations.
-  * Updated methods and constants to path of directories.
-  * Updated default views.
-  * Support to themes using ERB.
+[0.8.0 - 2009-09-15 - Improvements]
+  * Added helper methods for improves all theme views source.
+  * Added core extensions.
+
+[0.7.0 - 2009-09-10 - Features, enhancements and improvements]
+  New features and enhancements for version 0.7.0.
+
+  * Features
+    * Postview is a RubyGems project.
+    * Added executable for creates new Postview blogs.
+    * Added support to themes.
+    * CLI and commands have been added in application libraries.
+
+  * Enhancements
+    * Added basic classes and files for version and information about project.
+    * Support to creates default Postview theme have been added.
+    * Default views have been updated to default theme.
+    * Added new images and logos in default theme.
+    * The helper methods have been separated from application.
+    * The method "mapping" has been renamed to "sections".
+    * Added patches for Ruby v1.8.5.
+    * Added creation of Rakefile in new Postview blogs.
+    * Fixes for new features of the Postage API.
+
+  * Improvements
+    * Updates in application class to new features of the Sinatra::Mapping.
+    * Updates in CLI commands. Need fix to load the production environment.
+    * Updated method for synchronize.
+    * Removed archive tags path.
+    * Change host attribute name.
+    * Updated methods and constants to path of directories.
+    * Updates all tests to new features.
+    * Improvements in method that creates config.ru file.
+    * Updates in the settings and site classes.
 
 [0.6.0 - 2009-07-31 - Features and enhancements]
   * Added task for build settings file.

data/README.rdoc

@@ -2,7 +2,7 @@
 
 Just write your posts ... and view!
 
-Postview is a simple blogware written in Ruby using Sinatra DSL that
+Postview is a simple blogware written in Ruby using Sinatra DSL and
 renders files written in Markdown.
 
 * Easy to configure.
@@ -14,14 +14,12 @@ Install {Ruby}[http://www.ruby-lang.org/] Gem package and try.
 
 The Postview requires the following gems:
 
-* {Rack}[http://rack.rubyforge.org/]
-* {Rack-Test}[http://github.com/brynary/rack-test]
 * {Sinatra}[http://www.sinatrarb.com/]
 * {Sinatra-Mapping}[http://sinatra-mapping.rubyforge.org/]
-* {Maruku}[http://maruku.rubyforge.org/]
 * {Postage}[http://postage.rubyforge.org/]
 
-Install stable gem from {RubyForge.org}[http://rubyforge.org/].
+Install stable gem from {RubyForge.org}[http://rubyforge.org/] or
+{GemCutter.org}[http://gemcutter.org/].
 
   $ sudo gem install postview
 
@@ -33,6 +31,10 @@ So, run command for create and setup a new Postview directory structure.
 
   $ postview create path/to/website
 
+Or run using +--prompt-values+.
+
+  $ postview create --prompt-values
+
 After setup, run server with command:
 
   $ RACK_ENV=production postview server
@@ -40,7 +42,7 @@ After setup, run server with command:
 NOTE: Inopportunely, Postview not run server using production environment,
 yet.
 
-In your browser, access http://localhost:9000/.
+In your browser, access http://127.0.0.1:9000/.
 
 == Create new post
 
@@ -50,7 +52,7 @@ New post can be created by using the task `post`:
     $ rake post
 
 Following all instructions. Please, set environment variable +EDITOR+
-or +VISUAL+ for editing your posts. Ether else, run:
+or +VISUAL+ for editing your posts. Other else, run:
 
     $ cd path/to/postview
     $ EDITOR=<your favorite editor> rake post
@@ -101,3 +103,5 @@ Example:
     # To synchronize all
     $ rake sync:all
 
+NOTE: Will added new enhancements for this feature.
+

data/Rakefile

@@ -168,6 +168,10 @@ namespace :sync do
   task :all => settings.directories.keys
 end
 
+Rake::TestTask.new do |spec|
+  spec.test_files = FileList["test/*_test.rb"]
+end
+
 Dir["tasks/**.rake"].each do |task_file|
   load task_file
 end

data/VERSION

@@ -1,8 +1,8 @@
 --- 
-:major: 0
 :release: 
-:minor: 7
 :cycle: Beta release
-:patch: 0
-:date: 2009-09-10
 :timestamp: 2009-08-24 07:46:28 -04:00
+:major: 0
+:date: 2009-09-15
+:minor: 8
+:patch: 0

data/lib/postview.rb

@@ -31,7 +31,7 @@ $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
 # == Themes
 #
 # Default theme is generated in <tt>themes/default</tt>. Change or migrate your favorite
-# theme.
+# theme. To help for this, read Helpers for more informations.
 #
 module Postview
 
@@ -44,14 +44,19 @@ module Postview
   require 'ostruct'
 
   # 3rd part libraries/projects.
+  require 'rack'
   require 'sinatra/base' unless defined? ::Sinatra::Base
   require 'sinatra/mapping' unless defined? ::Sinatra::Mapping
   require 'postage' unless defined? ::Postage
 
   # Internal requires
   require 'postview/patches' if RUBY_VERSION < "1.8.7"
+  require 'postview/extensions'
 
+  # Root path for Postview source.
   ROOT = Pathname.new("#{File.dirname(__FILE__)}/..").expand_path
+
+  # Current path.
   PATH = Pathname.new(".").expand_path
 
   # Auto-load all internal requires.

data/lib/postview/application.rb

@@ -22,12 +22,14 @@ class Application < Sinatra::Base #:nodoc: all
   end
 
   before do
-    @settings = options.settings
-    @site     = options.site
-    @page     = options.page
-    @tags     = @site.find_all_tags
-    @posts    = @site.find.all_posts.reverse
-    @archive  = @site.find_archived.all_posts.reverse
+    @page = options.page
+    @settings ||= options.settings
+    @site ||= options.site
+    @all_tags ||= @site.find_all_tags
+    @all_posts ||= @site.find.all_posts.reverse
+    @all_archived_posts ||= @site.find_in_archive.all_posts.reverse
+    @all_drafted_posts ||= @site.find_in_drafts.all_posts.reverse
+    @current_post ||= @all_posts.last
   end
 
   helpers Postview::Helpers
@@ -38,71 +40,63 @@ class Application < Sinatra::Base #:nodoc: all
     send_file options.views.join(resource, "#{file}.#{ext}")
   end
 
-  # Show only the last 5 posts.
+  # Show all information for site.
   get root_path do
-    @posts = @site.find.all_posts.limit(5).reverse
     @page.title, @page.keywords = @site.subtitle, "posts"
-    show :index, :posts_path => :posts, :tags_path => :tags
+    show :index, :posts_path => :posts, :archive_path => :archive, :tags_path => :tags
   end
 
   # Show all posts.
   get posts_path do
-    @page.title, @page.keywords = title_path(:posts), @tags.join(' ')
+    @page.title, @page.keywords = title_path(:posts), @all_tags.join(' ')
     show :"posts/index", :posts_path => :posts, :tags_path => :tags
   end
 
   # Show selected post.
   get posts_path "/:year/:month/:day/:name" do |year, month, day, name|
-    @post = @site.find.post(year, month, day, name)
-    @page.title, @page.keywords = @post.title, @post.tags.join(' ')
+    @current_post = @site.find.post(year, month, day, name)
+    @page.title, @page.keywords = @current_post.title, @current_post.tags.join(' ')
     show :"posts/show", :posts_path => :posts, :tags_path => :tags
   end
 
   # Show all tags.
   get tags_path do
-    @page.title, @page.keywords = title_path(:tags), @tags.join(' ')
+    @page.title, @page.keywords = title_path(:tags), @all_tags.join(' ')
     show :"tags/index", :posts_path => :posts, :tags_path => :tags
   end
 
   # Show all posts by selected tag.
   get tags_path "/:tag" do |tag|
-    @tag     = @site.find_tag(tag)
-    @posts   = @site.find.all_posts_by_tag(tag)
-    @archive = @site.find_archived.all_posts_by_tag(tag)
-    @page.title, @page.keywords = "#{title_path(:tags)} - #{@tag.capitalize}", "posts #{@tag}" unless @posts.empty?
+    @current_tag = @site.find_tag(tag)
+    @posts_found, @archived_posts_found = @site.find_all_posts_tagged_with(tag)
+    @page.title, @page.keywords = "#{title_path(:tags)} - #{@current_tag.capitalize}", "posts #{@current_tag}"
     show :"tags/show", :posts_path => :posts, :archive_path => :archive, :tags_path => :tags
   end
 
   # Show archives grouped by year.
   get archive_path do
-    @posts = @site.find_archived.all_posts.reverse
-    @page.title, @page.keywords = title_path(:archive), @tags.join(' ')
+    @page.title, @page.keywords = title_path(:archive), @all_tags.join(' ')
     show :"archive/index", :archive_path => :archive, :posts_path => :archive, :tags_path => :tags
   end
 
   # Show selected post in archive.
   get archive_path "/:year/:month/:day/:name" do |year, month, day, name|
-    @post  = @site.find_archived.post(year, month, day, name)
-    @posts = @site.find_archived.all_posts.reverse
-    @tags  = @site.find_archived.all_tags
-    @page.title, @page.keywords = @post.title, @post.tags.join(' ')
+    @current_post = @site.find_in_archive.post(year, month, day, name)
+    @page.title, @page.keywords = @current_post.title, @current_post.tags.join(' ')
     show :"archive/show", :posts_path => :archive, :tags_path => :tags
   end
 
   # Show all drafts.
   get drafts_path do
-    @posts = @site.find_drafted.all_posts.reverse
-    @tags  = @site.find_drafted.all_tags.sort
-    @page.title, @page.keywords = title_path(:drafts), "drafts #{@tags.join(' ')}"
+    @page.title, @page.keywords = title_path(:drafts), "drafts #{@all_tags.join(' ')}"
     show :"posts/index", :posts_path => :drafts, :tags_path => [:drafts, :tags]
   end
 
   # Show selected drafted post.
   get drafts_path "/:year/:month/:day/:name" do |year, month, day, name|
-    @post  = @site.find_drafted.post(year, month, day, name)
-    @posts = @site.find_drafted.all_posts.reverse
-    @tags  = @site.find_drafted.all_tags.sort
-    @page.title, @page.keywords = @post.title, @post.tags.join(' ')
+    @current_post = @site.find_in_drafts.post(year, month, day, name)
+    @all_tags ||= @site.find_in_drafts.all_tags.sort
+    @page.title, @page.keywords = @current_post.title, @current_post.tags.join(' ')
     show :"posts/show", :posts_path => :drafts, :tags_path => [:drafts, :tags]
   end
 
@@ -113,9 +107,8 @@ class Application < Sinatra::Base #:nodoc: all
 
   # Search posts by title or match file name.
   get search_path do
-    @posts   = @site.find.posts(*params.values)
-    @archive = @site.find_archived.posts(*params.values)
-    @page.title, @page.keywords = title_path(:search), @tags.join(' ')
+    @posts_found, @archived_posts_found = @site.search_posts(*params.values)
+    @page.title, @page.keywords = title_path(:search), @all_tags.join(' ')
     show :search, :posts_path => :posts, :tags_path => :tags, :archive_path => :archive, :search_path => :search
   end
 

data/lib/postview/cli.rb

@@ -6,6 +6,7 @@ module CLI
   autoload :CreateCommand, 'postview/cli/create_command'
   autoload :ServerCommand, 'postview/cli/server_command'
 
+  # List all commands for CLI options.
   def self.commands
     constants.select do |constant|
       constant =~ /.Command/
@@ -14,6 +15,7 @@ module CLI
     end.sort
   end
 
+  # Run!
   def self.run(command, args)
     const_get("#{command.capitalize}Command").run(args)
   end

data/lib/postview/extensions.rb

@@ -0,0 +1,8 @@
+class Array
+
+  # Returns elements between first and the specific limit.
+  def limit(size)
+    self[0..size - 1]
+  end
+
+end

data/lib/postview/helpers.rb

@@ -3,16 +3,74 @@ module Postview
 # Copyright (c) 2009 Hallison Batista
 module Helpers
 
-  attr_reader :site, :page
-  attr_reader :post, :posts, :archive, :tag, :tags
-
-  # ...
-  def count_posts_by_tag(tagname)
-    @count_posts_by_tag ||= @tags.inject({}) do |hash, tag|
-      hash[tag] = (@site.find.all_posts + @site.find_archived.all_posts).count{ |post| post.tags.include? tag }
-      hash
+  # Site information.
+  attr_reader :site
+
+  # Current page.
+  attr_reader :page
+
+  # Current post.
+  attr_reader :current_post
+
+  # Current tag.
+  attr_reader :current_tag
+
+  # All tags used in posts and archived posts.
+  attr_reader :all_tags
+
+  # All posts
+  attr_reader :all_posts
+
+  # All archived posts.
+  attr_reader :all_archived_posts
+
+  # All posts found by search.
+  attr_reader :posts_found
+
+  # All archived posts found by search.
+  attr_reader :archived_posts_found
+
+  # Returns latest posts.
+  def latest_posts(limit = 5)
+    @all_posts.limit(limit) || []
+  end
+
+  # Returns all posts related to any post.
+  def related_posts_in(folder = :posts)
+    posts = case folder
+              when :posts
+                all_posts
+              when :archive
+                all_archived_posts
+              when :drafts
+                all_drafted_posts
+              else
+                return nil
+            end
+    posts.reject do |post|
+      (post.tags & current_post.tags).empty? || post == current_post
+    end
+  end
+
+  # Returns all tags related with a post tags.
+  def related_tags_in(folder = :posts)
+    (related_posts_in(folder) << current_post).map{ |post| post.tags }.flatten.uniq.sort
+  end
+
+  # Returns all tags related with a post tags.
+  def all_related_tags
+    (all_posts + all_archived_posts).reject do |post|
+      (post.tags & current_post.tags).empty?
+    end.map{ |post| post.tags }.flatten.uniq.sort
+  end
+
+  # Count posts by tag name.
+  def count_posts_by_tag(name)
+    @count_posts_by_tag ||= all_tags.inject({}) do |count, tag|
+      count[tag] = (all_posts + all_archived_posts).count{ |post| post.tags.include? tag }
+      count
     end
-    @count_posts_by_tag[tagname]
+    @count_posts_by_tag[name]
   end
 
 end # module Helpers

data/lib/postview/patches.rb

@@ -1,4 +1,5 @@
 class Array
+
   # Count objects in elements.
   def count(obj = nil)
     if block_given?
@@ -7,5 +8,6 @@ class Array
       select { |item| item == obj }.size
     end
   end
+
 end
 

data/lib/postview/settings.rb

@@ -34,35 +34,45 @@ class Settings
 
   attr_reader :site, :theme, :directories, :sections
 
+  # Initialize the settings using attributes passed by arguments.
+  # Only attributes valid are read. See DEFAULTS.
   def initialize(attributes = {})
     attributes.symbolize_keys.merge(DEFAULTS) do |key, value, default|
       value || default
     end.instance_variables_set_to(self)
   end
 
+  # Build site using attributes found in +site+ key.
   def build_site
     build_all_finders_for(Site.new(site))
   end
 
+  # Build a simple structure for pages.
   def build_page
     OpenStruct.new(:title => "", :keywords => [])
   end
 
+  # Build finders for site. The finders load all post files
+  # placed in directories setted in +directories+ values.
   def build_all_finders_for(site)
-    site.find          = build_finder_for(:posts)
-    site.find_archived = build_finder_for(:archive)
-    site.find_drafted  = build_finder_for(:drafts)
+    site.find = build_finder_for(:posts)
+    site.find_in_archive = build_finder_for(:archive)
+    site.find_in_drafts = build_finder_for(:drafts)
     site
   end
 
+  # Build a specific finder for directory.
   def build_finder_for(directory)
     Postage::Finder.new(directory_for(directory))
   end
 
+  # Load a default settings values from file placed in +config/settings.yml+.
   def self.load
     load_file(FILE)
   end
 
+  # Load a specific settings file.
+  # Returns default values for attributes not found.
   def self.load_file(file_name)
     begin
       new(YAML.load_file(file_name) || DEFAULTS)
@@ -71,30 +81,36 @@ class Settings
     end
   end
 
+  # Load file from a path.
   def self.load_file_from(path)
     file = Pathname.new(path).join(FILE_DIR, FILE_NAME)
     new(YAML.load_file(file))
   end
 
+  # Build settings file using DEFAULTS.
   def self.build_default_file
     FILE.open "w+" do |file|
       file << DEFAULTS.to_yaml
     end unless FILE.exist?
   end
 
+  # Returns settings file.
   def file
     FILE
   end
 
+  # Check directory and returns file that matches with a pattern.
   def file_names_for(directory, pattern = "**.*")
     directory_for(directory, pattern)
   end
 
+  # Returns a valid directory loaded from settings file.
   def directory_for(name, *paths)
     return Pathname.new(directories[name], *paths) if directories[name].match(%r{^/.*})
     PATH.join(directories[name], *paths)
   end
 
+  # Parse all attributes to hash.
   def to_hash
     DEFAULTS.keys.inject({}) do |hash, method|
       hash[method] = send(method)