nitro 0.20.0 → 0.21.0

data/lib/nitro/mixin/pager.rb

@@ -14,180 +14,180 @@ module Nitro
 # interaction.
 
 class Pager
-	# Items per page.
-	
-	setting :per_page, :default => 10, :doc => 'Items per page'	
-	
-	# The request key.
-	
-	setting :key, :default => '_page', :doc => 'The request key'
-
-	# The current page.
-	
-	attr_accessor :page
-
-	# Items per page.
-	
-	attr_accessor :per_page 
-	
-	# The total number of pages.
-	
-	attr_accessor :page_count 
-	
-	# Total count of items.
-	
-	attr_accessor :total_count
-		
-	def initialize(request, per_page, total_count, key = Pager.key)
-		raise 'per_page should be > 0' unless per_page > 0
-	
-		@request, @key = request, key
-		@page = request.query.fetch(key, 1).to_i
-		@per_page = per_page
-		set_count(total_count)
-		@start_idx = (@page - 1) * per_page		
-	end
-
-	def set_count(total_count)
-		@total_count = total_count
-		@page_count = (@total_count.to_f / @per_page).ceil
-	end
-
-	def first_page
-		return 1
-	end
-	
-	def last_page 
-		return @page_count
-	end
-	
-	def previous_page
-		return [@page - 1, 1].max()
-	end
-	
-	def next_page
-		return [@page + 1, @page_count].min()
-	end
-	
-	# Iterator
-	
-	def each(&block)
-		@page_items.each(&block)
-	end
-	
-	# Iterator
-	# Returns 1-based index.
-	
-	def each_with_index
-		idx = @start_idx
-		for item in @page_items
-			yield(idx + 1, item)
-			idx += 1
-		end
-	end
-	
-	def empty?
-		return @items.empty?
-	end
-	
-	def size
-		return @items.size()
-	end
-	
-	# Returns the range of the current page.
-	
-	def page_range
-		s = @idx
-		e = [@idx + @items_per_page - 1, all_total_count].min
-		
-		return [s, e]
-	end
-	
-	# Override if needed.
-	
-	def nav_range
-		# effective range = 10 pages.
-		s = [@page - 5, 1].max()
-		e = [@page + 9, @page_count].min()
-		
-		d = 9 - (e - s)
-		e += d if d < 0
-		
-		return (s..e)
-	end
-
-	# To be used with Og queries.
-		
-	def limit
-		{ :limit => @per_page, :offset => @start_idx }
-	end
-
-	def offset 
-		@start_idx
-	end
-
-	# Create an appropriate SQL limit clause.
-	# Returns postgres/mysql compatible limit.
-	
-	def to_sql
-		if @start_idx > 0
-			return "LIMIT #{@per_page} OFFSET #{@start_idx}"
-		else
-			# gmosx: perhaps this is optimized ? naaaaaah...
-			return "LIMIT #{@per_page}"
-		end
-	end	
-
-	# Override this method in your application if needed.
-	#--
-	# TODO: better markup.
-	#++
-	
-	def navigation
-		nav = ""
-		
-		unless @page == first_page()
-			nav << %{
-				<div class="first"><a href="#{target_uri(first_page())}">First</a></div>
-				<div class="previous"><a href="#{target_uri(previous_page())}">Previous</a></div>
-			}
-		end
-		
-		unless @page == last_page()
-			nav << %{
-				<div class="last"><a href="#{target_uri(last_page())}">Last</a></div>
-				<div class="next"><a href="#{target_uri(next_page())}">Next</a></div>
-			}
-		end
-
-		nav << %{<ul>}
-		
-		for i in nav_range()
-			if i == @page
-				nav << %{
-					<li class="active">#{i}</li>
-				}
-			else
-				nav << %{
-					<li><a href="#{target_uri(i)}">#{i}</a></li>
-				}			
-			end
-		end
-		
-		nav << %{</ul>}
-		
-		return nav
-	end
-	alias_method :links, :navigation
+  # Items per page.
+  
+  setting :per_page, :default => 10, :doc => 'Items per page'  
+  
+  # The request key.
+  
+  setting :key, :default => '_page', :doc => 'The request key'
+
+  # The current page.
+  
+  attr_accessor :page
+
+  # Items per page.
+  
+  attr_accessor :per_page 
+  
+  # The total number of pages.
+  
+  attr_accessor :page_count 
+  
+  # Total count of items.
+  
+  attr_accessor :total_count
+    
+  def initialize(request, per_page, total_count, key = Pager.key)
+    raise 'per_page should be > 0' unless per_page > 0
+  
+    @request, @key = request, key
+    @page = request.query.fetch(key, 1).to_i
+    @per_page = per_page
+    set_count(total_count)
+    @start_idx = (@page - 1) * per_page    
+  end
+
+  def set_count(total_count)
+    @total_count = total_count
+    @page_count = (@total_count.to_f / @per_page).ceil
+  end
+
+  def first_page
+    return 1
+  end
+  
+  def last_page 
+    return @page_count
+  end
+  
+  def previous_page
+    return [@page - 1, 1].max()
+  end
+  
+  def next_page
+    return [@page + 1, @page_count].min()
+  end
+  
+  # Iterator
+  
+  def each(&block)
+    @page_items.each(&block)
+  end
+  
+  # Iterator
+  # Returns 1-based index.
+  
+  def each_with_index
+    idx = @start_idx
+    for item in @page_items
+      yield(idx + 1, item)
+      idx += 1
+    end
+  end
+  
+  def empty?
+    return @items.empty?
+  end
+  
+  def size
+    return @items.size()
+  end
+  
+  # Returns the range of the current page.
+  
+  def page_range
+    s = @idx
+    e = [@idx + @items_per_page - 1, all_total_count].min
+    
+    return [s, e]
+  end
+  
+  # Override if needed.
+  
+  def nav_range
+    # effective range = 10 pages.
+    s = [@page - 5, 1].max()
+    e = [@page + 9, @page_count].min()
+    
+    d = 9 - (e - s)
+    e += d if d < 0
+    
+    return (s..e)
+  end
+
+  # To be used with Og queries.
+    
+  def limit
+    { :limit => @per_page, :offset => @start_idx }
+  end
+
+  def offset 
+    @start_idx
+  end
+
+  # Create an appropriate SQL limit clause.
+  # Returns postgres/mysql compatible limit.
+  
+  def to_sql
+    if @start_idx > 0
+      return "LIMIT #{@per_page} OFFSET #{@start_idx}"
+    else
+      # gmosx: perhaps this is optimized ? naaaaaah...
+      return "LIMIT #{@per_page}"
+    end
+  end  
+
+  # Override this method in your application if needed.
+  #--
+  # TODO: better markup.
+  #++
+  
+  def navigation
+    nav = ""
+    
+    unless @page == first_page()
+      nav << %{
+        <div class="first"><a href="#{target_uri(first_page())}">First</a></div>
+        <div class="previous"><a href="#{target_uri(previous_page())}">Previous</a></div>
+      }
+    end
+    
+    unless @page == last_page()
+      nav << %{
+        <div class="last"><a href="#{target_uri(last_page())}">Last</a></div>
+        <div class="next"><a href="#{target_uri(next_page())}">Next</a></div>
+      }
+    end
+
+    nav << %{<ul>}
+    
+    for i in nav_range()
+      if i == @page
+        nav << %{
+          <li class="active">#{i}</li>
+        }
+      else
+        nav << %{
+          <li><a href="#{target_uri(i)}">#{i}</a></li>
+        }      
+      end
+    end
+    
+    nav << %{</ul>}
+    
+    return nav
+  end
+  alias_method :links, :navigation
 
 private
 
-	# Generate the target URI.
-	 
-	def target_uri(page)
-		params = { @key => page }
-		return UriUtils.update_query_string(@request.uri.to_s, params)
-	end
+  # Generate the target URI.
+   
+  def target_uri(page)
+    params = { @key => page }
+    return UriUtils.update_query_string(@request.uri.to_s, params)
+  end
 
 end
 
@@ -196,37 +196,37 @@ end
 module PagerMixin
 
 private
-	
-	# Helper method that generates a collection of items and the
-	# asorted pager object.
-	#
-	# === Example
-	#
-	# entries, pager = paginate(Article, :condition => 'title LIKE %Ab%', :per_page => 10)
-	# 
-	# <ul>
-	# <?r for entry in entries ?>
-	#		<li>#{entry.to_link}</li>
-	# <?r end ?>
-	#	</ul>
-	#	#{pager.links}
-	
-	def paginate(klass_or_array, options = {})
-		per_page = options.delete(:per_page) || Pager.per_page
-		
-		if klass_or_array.is_a? Array
-			items = klass_or_array.dup
-			pager = Pager.new(request, per_page, items.size, key = Pager.key)
-			items = items.slice(pager.offset, pager.per_page)
-			return items, pager			
-		else
-			pager = Pager.new(request, per_page, klass_or_array.count(options), key = Pager.key)
-			options.update(pager.limit)
-			items = klass_or_array.all(options)
-			return items, pager
-		end
-	end
-	
+  
+  # Helper method that generates a collection of items and the
+  # asorted pager object.
+  #
+  # === Example
+  #
+  # entries, pager = paginate(Article, :condition => 'title LIKE %Ab%', :per_page => 10)
+  # 
+  # <ul>
+  # <?r for entry in entries ?>
+  #    <li>#{entry.to_link}</li>
+  # <?r end ?>
+  #  </ul>
+  #  #{pager.links}
+  
+  def paginate(klass_or_array, options = {})
+    per_page = options.delete(:per_page) || Pager.per_page
+    
+    if klass_or_array.is_a? Array
+      items = klass_or_array.dup
+      pager = Pager.new(request, per_page, items.size, key = Pager.key)
+      items = items.slice(pager.offset, pager.per_page)
+      return items, pager      
+    else
+      pager = Pager.new(request, per_page, klass_or_array.count(options), key = Pager.key)
+      options.update(pager.limit)
+      items = klass_or_array.all(options)
+      return items, pager
+    end
+  end
+  
 end
 
 end

data/lib/nitro/mixin/rss.rb

@@ -0,0 +1,67 @@
+require 'cgi'
+require 'rss/0.9'
+
+require 'facet/string/first_char'
+
+module Nitro
+
+# Build RSS represenations of ruby object collections.
+# Utilize duck typing to grab the attributes to render.
+# Add this mixin to you classes to support RSS rendering.
+#
+#--
+# TODO: add more options here, 1.0/2.0 support and more.
+# use custom version to add headers like the following.
+# <?xml version="1.0" encoding="UTF-8"?>
+# <?xml-stylesheet href="rss.css" type="text/css"?>
+#++
+
+module RssMixin
+
+  # === Options
+  #
+  # [+:description+]
+  #    Description of the Feed
+  # [+:base+]
+  #    Base url of the Feed.
+  # [+:link+]
+  #    Link of the Feed.
+  
+  def build_rss_09(objects, options = {})
+    c = {
+      :description => 'Syndication'
+    }.update(options)
+
+    c[:base] ||= c[:link]
+
+    raise "Option ':base' cannot be infered!" unless c[:base] 
+  
+    channel = RSS::Rss::Channel.new
+    channel.description = c[:description]
+    channel.link = c[:link] if c[:link] 
+    
+    for obj in objects
+      item = RSS::Rss::Channel::Item.new
+      item.title = obj.title if obj.respond_to?(:title)
+      if obj.respond_to? :body and body = obj.body
+        item.description = CGI.escape(body.first_char(256)) 
+      end
+      if obj.respond_to? :to_href
+        item.link = "#{c[:base]}/#{obj.to_href}" 
+      end
+      channel.items << item
+    end
+    
+    rss = RSS::Rss.new '0.9'
+    rss.channel = channel
+    
+    return rss.to_s
+  end
+  alias_method :build_rss, :build_rss_09
+  alias_method :rss, :build_rss_09
+
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>