jakewendt-pages 0.1.2

data/README.rdoc

@@ -0,0 +1,55 @@
+= Pages
+
+This is both a plugin engine and a basic rails app.
+
+
+
+== ToDo
+
+
+== Required Gem Sources
+
+ gem sources -a http://rubygems.org
+ gem sources -a http://gems.github.com
+
+== Required Gems
+
+* {assert_this_and_that}[http://github.com/jakewendt/assert_this_and_that]
+* {ruby_extension}[http://github.com/jakewendt/ruby_extension] - modifications, updates and patches for ruby.
+* rails ~> 2
+* i18n =0.3.7
+* jrails
+* chronic
+* ruby-hmac
+* ssl_requirement
+* ryanb-acts-as-list
+* RedCloth
+* thoughtbot-factory_girl
+* jakewendt-rails_helpers
+* jakewendt-calnet_authenticated
+
+== Installation (as a plugin/engine)
+
+
+== Testing (as an app)
+
+ rake db:migrate
+ rake db:fixtures:load
+ rake test
+ script/server
+
+== Gemified with Jeweler
+
+ vi Rakefile
+ rake version:write
+
+ rake version:bump:patch
+ rake version:bump:minor
+ rake version:bump:major
+
+ rake gemspec
+
+ rake install
+ rake release
+
+Copyright (c) 2010 [Jake Wendt], released under the MIT license

data/app/controllers/locales_controller.rb

@@ -0,0 +1,15 @@
+class LocalesController < ApplicationController
+
+	skip_before_filter :login_required
+	skip_before_filter :build_menu_js
+
+	def show
+		session[:locale] = params[:id]
+		respond_to do |format|
+			format.html { redirect_to_referer_or_default(root_path) }
+# format.js {}
+			format.js { render :text => "locale = '#{session[:locale]}'" }
+		end
+	end
+
+end

data/app/controllers/pages_controller.rb

@@ -0,0 +1,138 @@
+class PagesController < ApplicationController
+
+	skip_before_filter :login_required, 
+		:only => [:show, :translate]
+	skip_before_filter :build_menu_js, 
+		:only => [:translate]
+
+	before_filter :may_maintain_pages_required, :except => [:show, :translate]
+	before_filter :id_required, :only => [ :edit, :update, :destroy ]
+	before_filter :page_required, :only => :show
+	before_filter :build_submenu_js, :except => [:index, :order, :translate]
+
+#	caches partials from layout as well, which is too much
+#	caching still buggy
+#	if do cache layout, contains user links
+#	if don't cache layout, submenu goes missing
+
+#	caches_action saves to memory
+#	caches_page generates an actual file in public/
+#	it would probably require modifications to the
+#	page_sweeper's expire calls
+	caches_action :show	#, :layout => false
+#	caches_page :show	#, :layout => false
+	cache_sweeper :page_sweeper, :only => [:create, :update, :order, :destroy]
+
+	ssl_allowed :show, :translate
+
+	def order
+#		params[:pages].reverse.each { |id| Page.find(id).move_to_top }
+#	this doesn't even check for parents or anything
+#	making it faster, but potentially error prone.
+		params[:pages].each_with_index { |id,index| 
+			Page.find(id).update_attribute(:position, index+1 ) }
+		redirect_to pages_path(:parent_id=>params[:parent_id])
+	end
+
+	def translate
+		respond_to do |format|
+			format.js {}
+		end
+	end
+		
+	def show
+	end
+
+	def index
+		@page_title = "CCLS Pages"
+		params[:parent_id] = nil if params[:parent_id].blank?
+		@pages = Page.all(:conditions => { :parent_id => params[:parent_id] })
+	end
+
+	def new
+		@page_title = "Create New CCLS Page"
+		@page = Page.new(:parent_id => params[:parent_id])
+	end
+
+	def edit
+		@page_title = "Edit CCLS Page #{@page.title(session[:locale])}"
+	end
+
+	def create
+		@page = Page.new(params[:page])
+		@page.save!
+		flash[:notice] = 'Page was successfully created.'
+		redirect_to(@page)
+	rescue ActiveRecord::RecordInvalid
+		flash.now[:error] = "There was a problem creating the page"
+		render :action => "new"
+	end
+
+	def update
+		@page.update_attributes!(params[:page])
+		flash[:notice] = 'Page was successfully updated.'
+		redirect_to(@page)
+	rescue ActiveRecord::RecordInvalid
+		flash.now[:error] = "There was a problem updating the page."
+		render :action => "edit"
+	end
+
+	def destroy
+		@page.destroy
+		redirect_to(pages_path)
+	end
+
+protected
+
+	def id_required
+		if !params[:id].blank? and Page.exists?(params[:id])
+			@page = Page.find(params[:id])
+		else
+			access_denied("Valid page id required!", pages_path)
+		end
+	end
+
+	#	Put this in a separate before_filter so that
+	#	another before_filter can access @page
+	def page_required
+		if params[:path]
+ 			@page = Page.by_path("/#{params[:path].join('/')}")
+			raise ActiveRecord::RecordNotFound if @page.nil?
+		else
+			@page = Page.find(params[:id])
+		end
+		@page_title = @page.title(session[:locale])
+		if @page.is_home? && class_exists?('HomePagePic')
+			@hpp = HomePagePic.random_active()
+		end
+	rescue ActiveRecord::RecordNotFound
+		flash_message = "Page not found with "
+		flash_message << (( params[:id].blank? ) ? "path '/#{params[:path].join('/')}'" : "ID #{params[:id]}")
+		flash.now[:error] = flash_message
+	end
+
+	def build_submenu_js
+		if @page && !@page.root.children.empty?
+			js = "" <<
+				"if ( typeof(translatables) == 'undefined' ){\n" <<
+				"	var translatables = [];\n" <<
+				"}\n"
+			js << "tmp={tag:'#current_root',locales:{}};\n"
+			%w( en es ).each do |locale|
+				js << "tmp.locales['#{locale}']='#{@page.root.menu(locale)}'\n"
+			end
+			js << "translatables.push(tmp);\n"
+			@page.root.children.each do |child|
+				js << "tmp={tag:'#menu_#{dom_id(child)}',locales:{}};\n"
+				%w( en es ).each do |locale|
+					js << "tmp.locales['#{locale}']='#{child.menu(locale)}'\n"
+				end
+				js << "translatables.push(tmp);\n"
+			end
+			@template.content_for :head do
+				@template.javascript_tag js
+			end
+		end
+	end
+
+end

data/app/models/page.rb

@@ -0,0 +1,99 @@
+#	==	requires
+#	*	path ( unique, > 1 char and starts with a / )
+#	*	menu ( unique and > 3 chars )
+#	*	title ( > 3 chars )
+#	*	body ( > 3 chars )
+#
+#	==	named_scope(s)
+#	*	not_home (returns those pages where path is not just '/')
+#	*	roots
+#
+#	uses acts_as_list for parent / child relationship.  As this
+#	is only a parent and child and no deeper, its ok.  If it
+#	were to get any deeper, the list should probably be changed
+#	to something like a nested set.
+class Page < ActiveRecord::Base
+	default_scope :order => :position
+
+	acts_as_list :scope => :parent_id
+#	acts_as_list :scope => "parent_id \#{(parent_id.nil?)?'IS NULL':'= parent_id'} AND locale = '\#{locale}'"
+
+	validates_length_of :path,  :minimum => 1
+	validates_format_of :path,  :with => /^\//
+	validates_length_of :menu_en,  :minimum => 4
+	validates_length_of :title_en, :minimum => 4
+	validates_length_of :body_en,  :minimum => 4
+	validates_uniqueness_of :menu_en
+	validates_uniqueness_of :path
+
+	belongs_to :parent, :class_name => 'Page'
+	has_many :children, :class_name => 'Page', :foreign_key => 'parent_id',
+		:dependent => :nullify
+	
+	named_scope :roots, :conditions => { 
+		:parent_id => nil, :hide_menu => false }
+
+	named_scope :hidden, :conditions => { 
+		:hide_menu => true }
+
+	named_scope :not_home, :conditions => [ "path != '/'" ]
+
+	attr_accessible :path, :parent_id, :hide_menu,
+		:menu,  :menu_en,  :menu_es, 
+		:title, :title_en, :title_es,
+		:body,  :body_en,  :body_es
+
+	before_validation :adjust_path
+
+	def adjust_path
+		unless self.path.nil?
+			#	remove any duplicate /'s
+#			self.path = path.gsub(/\/+/,'/')
+			self.path.gsub!(/\/+/,'/')
+
+			#	add leading / if none
+#			self.path = path.downcase
+			self.path.downcase!
+		end
+	end
+
+	#	named_scopes ALWAYS return an "Array"
+	#	so if ONLY want one, MUST use a method.
+	#	by_path returns the one(max) page that
+	#	matches the given path.
+	def self.by_path(path)
+		page = find(:first,
+			:conditions => {
+				:path   => path.downcase
+			}
+		)
+	end
+
+	def root
+		page = self
+		until page.parent == nil
+			page = page.parent
+		end 
+		page
+	end
+
+	def is_home?
+		self.path == "/"
+	end
+
+	#	Virtual attributes
+	%w( menu title body ).each do |attr|
+		define_method "#{attr}" do |*args|
+			r = send("#{attr}_#{args[0]||'en'}")
+			(r.blank?) ? send("#{attr}_en") : r
+		end
+		define_method "#{attr}=" do |new_val|
+			self.send("#{attr}_en=",new_val)
+		end
+#		attr_accessible attr.to_sym
+#		%w( en es ).each do |lang|
+#			attr_accessible "#{attr}_#{lang}".to_sym
+#		end
+	end
+
+end

data/app/models/page_sweeper.rb

@@ -0,0 +1,74 @@
+#	While sweepers are model observers, they only seem
+#	to be so within the scope of a given controller.
+#	If the 'cache_sweeper' line is not given in the 
+#	controller, these observers don't see it.
+#	In addition, saving or destroying a page outside
+#	of the scope of the controller (ie. from console)
+#	will also go unnoticed.
+#
+#	Interestingly, in unit/model testing, this fails
+#	as request is nil.  This means that I don't quite
+#	understand how this works.  Perhaps because the cache
+#	is in memory and not a file, the server and console
+#	are completely separate.  Destroying in the console
+#	doesn't effect the server's cache.  That makes sense.
+#	So then.  How to get the host_with_port without a 
+#	request then?
+class PageSweeper < ActionController::Caching::Sweeper
+	observe Page
+
+	#	After saving (creating or updating) a page,
+	#	expire any associated caches.
+	def after_save(page)
+		expire_cache(page)
+	end
+
+	#	After destroying a page, expire any associated
+	#	caches.
+	def after_destroy(page)
+		expire_cache(page)
+	end
+
+	#	Always expire the menu cache.  This may not
+	#	be necessary as it only relies on the menu,
+	#	path and position attributes which may have
+	#	remained unchanged.  Also expire the "show"
+	#	action cache.  As the pages are rarely accessed
+	#	via /pages/:id, we need to expire the special
+	#	routes used by the catch-all route.  In the 
+	#	real world, this works just fine, but in testing
+	#	the app tries to expire cache when in unit tests
+	#	as well as functional tests.  There is no 
+	#	"request" in a unit test causing failure and
+	#	my usage of ".try"
+	def expire_cache(page)
+		#	Please note that the "views/" prefix is
+		#	internal to rails.  Don't meddle with it.
+
+		#	Expired fragment: views/page_menu (0.0ms)
+		expire_fragment 'page_menu'
+
+		#	We don't really access the pages via :id
+		#		but they can be so we need to deal with the cache.
+		#	Expired fragment: views/dev.sph.berkeley.edu:3000/pages/1 (0.0ms)
+		#	Expired fragment: views/dev.sph.berkeley.edu:3000/pages/5 (0.0ms)
+		expire_action
+
+		#	Expired fragment: views/dev.sph.berkeley.edu:3000/alpha (0.0ms)
+		#	Expired fragment: views/dev.sph.berkeley.edu:3000/ (0.0ms)
+		#	This fails for the home page as "/" is 
+		#		called "index" by the server
+		#	NEEDS to change page.path to /index for home page
+		#		be views/dev.sph.berkeley.edu:3000/index !
+		page_path = ( page.path == "/" ) ? "/index" : page.path
+#		expire_fragment "#{request.host_with_port}#{page_path}"
+		expire_fragment "#{request.try(:host_with_port)}#{page_path}"
+
+		#	In production, the page caches weren't expiring
+		#	Adding the relative_url_root should fix it.
+		page_path = ActionController::Base.relative_url_root.to_s + page_path
+		expire_fragment "#{request.try(:host_with_port)}#{page_path}"
+
+	end
+
+end

data/app/views/pages/_child.html.erb

@@ -0,0 +1,23 @@
+<% content_tag_for( :tr, child ) do %>
+<td class='path'>
+<%= link_to child.path, child.path -%>
+</td>
+<td class='menu'>
+<%= link_to child.menu(session[:locale]), child -%>
+</td>
+<td class='title'>
+<%= link_to child.title(session[:locale]), child -%>
+</td>
+<td class='manage'>
+<%= link_to "Edit", edit_page_path(child) -%>
+&nbsp;
+<%= link_to "Destroy", page_path(child), 
+	:confirm => "Delete '#{child.title(session[:locale])}'?\nAre you sure?", 
+	:method => :delete -%>
+</td>
+<!--
+<td class='children'>
+<%#= render :partial => 'child', :collection => child.children %>
+</td>
+-->
+<% end %><!-- class='child' -->

data/app/views/pages/_form.html.erb

@@ -0,0 +1,44 @@
+<% stylesheets('page') %>
+
+<fieldset id='page'>
+<legend>Page</legend>
+
+<div class='parent'>
+<b>Parent?</b> (Is this a main or sub menu page?)<br/>
+<%= f.collection_select :parent_id, Page.all(:order => "menu_en"), 
+	:id, :menu, :include_blank => true %>  
+</div>
+
+<div class='hide_menu'>
+<br/>
+<%= f.check_box :hide_menu %>
+<%= f.label :hide_menu, "Hide in menu system" %>
+</div>
+
+<div class='fields'>
+
+<p><b>Path:</b> (this is the path in the url. ie. /help/login )</p>
+<%= f.text_field :path %>
+
+<p><b>Title</b> (this is the text on the top of the browser)</p>
+English:<%= f.text_field :title_en %>
+Spanish:<%= f.text_field :title_es %>
+
+<p><b>Menu</b> (this is the text on the menu)</p>
+English:<%= f.text_field :menu_en %>
+Spanish:<%= f.text_field :menu_es %>
+
+<p><b>Body</b> (uses sanitized <%= link_to 'textile', 'http://redcloth.org', :target => 'new' %>)</p>
+English:<%= f.text_area :body_en %>
+Spanish:<%= f.text_area :body_es %>
+</div><!-- fields -->
+
+<p class='note'>
+For special characters, like &ntilde;, &oacute;, &eacute;, etc., use the 'friendly code' from 
+<%= link_to "About.com", "http://webdesign.about.com/library/bl_htmlcodes.htm", :target => 'new' %> 
+or 'Entity Name' from
+<%= link_to "W3Schools.com", "http://www.w3schools.com/tags/ref_entities.asp", :target => 'new' %>.
+The 'Numerical Code', 'Hex Code' or 'Entity Number' work just as well, but aren't as clear.
+</p>
+
+</fieldset>