jakewendt-simply_pages 2.0.0

data/README.rdoc

@@ -0,0 +1,65 @@
+= SimplyPages
+
+This WAS both a plugin engine and a basic rails app.
+
+It is now being converted in a simple generator to copy the code into the app.
+
+Still working on it, so it may be a bit bumpy.
+
+
+
+== ToDo
+
+
+== Required Gem Sources
+
+ gem sources -a http://rubygems.org
+ gem sources -a http://gems.github.com
+
+== Required Gems
+
+* {jakewendt-assert_this_and_that}[http://github.com/jakewendt/assert_this_and_that]
+* {jakewendt-ruby_extension}[http://github.com/jakewendt/ruby_extension] - modifications, updates and patches for ruby.
+* rails ~> 2
+* jrails
+* chronic
+* ruby-hmac
+* ssl_requirement
+* ryanb-acts-as-list
+* RedCloth	#	NOT 4.2.6
+* thoughtbot-factory_girl
+* {jakewendt-simply_helpful}[http://github.com/jakewendt/simply_helpful]
+* {jakewendt-simply_authorized}[http://github.com/jakewendt/simply_authorized]
+* {jakewendt-calnet_authenticated}[http://github.com/jakewendt/calnet_authenticated]
+
+== Installation (as a plugin/engine)
+
+# config.gem 'jakewendt-simply_pages',
+#   :source => 'http://rubygems.org'
+
+ script/generate simply_pages
+
+# User.find_create_and_update_by_uid('859908').deputize
+
+== 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/generators/simply_pages/simply_pages_generator.rb

@@ -0,0 +1,120 @@
+class SimplyPagesGenerator < Rails::Generator::Base
+
+	def manifest
+		#	See Rails::Generator::Commands::Create
+		#	rails-2.3.10/lib/rails_generator/commands.rb
+		#	for code methods for record (Manifest)
+		record do |m|
+
+			#	Will add this multiple times with multiple calls.
+			#	TODO Would like to only do it conditionally.
+			#	TODO Also, would prefer a bit more control as have other routes.
+
+#	map.resources :pages, :collection => {
+#		:all => :get,
+#		:translate => :get,
+#		:order => :post }
+#	map.resources :locales, :only => :show
+
+			m.route_resources :pages
+
+#			m.directory('config/autotest')
+#			m.file('autotest_simply_pages.rb', 'config/autotest/simply_pages.rb')
+#			m.directory('lib/tasks')
+#			m.file('simply_pages.rake', 'lib/tasks/simply_pages.rake')
+
+#			File.open('Rakefile','a'){|f| 
+#				f.puts <<-EOF
+##	From `script/generate simply_pages` ...
+#require 'simply_pages/test_tasks'
+#				EOF
+#			}
+#
+#			File.open('.autotest','a'){|f| 
+#				f.puts <<-EOF
+##	From `script/generate simply_pages` ...
+#require 'simply_pages/autotest'
+#				EOF
+#			}
+
+			dot = File.dirname(__FILE__)
+
+			%w( create_pages ).each do |migration|
+				m.migration_template "migrations/#{migration}.rb",
+					'db/migrate', :migration_file_name => migration
+			end
+
+			m.directory('public/javascripts')
+			Dir["#{dot}/templates/javascripts/*js"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "public/javascripts/#{File.basename(file)}")
+			}
+			m.directory('public/stylesheets')
+			Dir["#{dot}/templates/stylesheets/*css"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "public/stylesheets/#{File.basename(file)}")
+			}
+
+			m.directory('app/models')
+			Dir["#{dot}/templates/models/*rb"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "app/models/#{File.basename(file)}")
+			}
+
+			m.directory('app/controllers ')
+			Dir["#{dot}/templates/controllers/*rb"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "app/controllers/#{File.basename(file)}")
+			}
+
+			m.directory('app/views/pages')
+			Dir["#{dot}/templates/views/pages/*rb"].each{|file| 
+				f = file.split('/').slice(-3,3).join('/')			# has an extra directory in path
+				m.file(f, "app/views/pages/#{File.basename(file)}")
+			}
+
+			m.directory('test/functional')
+			Dir["#{dot}/templates/functional/*rb"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "test/functional/#{File.basename(file)}")
+			}
+
+			m.directory('test/unit')
+			Dir["#{dot}/templates/unit/*rb"].each{|file| 
+				f = file.split('/').slice(-2,2).join('/')
+				m.file(f, "test/unit/#{File.basename(file)}")
+			}
+
+		end
+	end
+
+end
+module Rails::Generator::Commands
+	class Create
+		def migration_template(relative_source, 
+				relative_destination, template_options = {})
+			migration_directory relative_destination
+			migration_file_name = template_options[
+				:migration_file_name] || file_name
+			if migration_exists?(migration_file_name)
+				puts "Another migration is already named #{migration_file_name}: #{existing_migrations(migration_file_name).first}: Skipping" 
+			else
+				template(relative_source, "#{relative_destination}/#{next_migration_string}_#{migration_file_name}.rb", template_options)
+			end
+		end
+	end #	Create
+	class Base
+	protected
+		#	the loop through migrations happens so fast
+		#	that they all have the same timestamp which
+		#	won't work when you actually try to migrate.
+		#	All the timestamps MUST be unique.
+		def next_migration_string(padding = 3)
+			@s = (!@s.nil?)? @s.to_i + 1 : if ActiveRecord::Base.timestamped_migrations
+				Time.now.utc.strftime("%Y%m%d%H%M%S")
+			else
+				"%.#{padding}d" % next_migration_number
+			end
+		end
+	end	#	Base
+end

data/generators/simply_pages/templates/autotest_simply_pages.rb

@@ -0,0 +1,2 @@
+#	From `script/generate simply_pages` ...
+require 'simply_pages/autotest'

data/generators/simply_pages/templates/controllers/locales_controller.rb

@@ -0,0 +1,16 @@
+class LocalesController < ApplicationController
+
+	skip_before_filter :login_required
+#	removed method
+#	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/generators/simply_pages/templates/controllers/pages_controller.rb

@@ -0,0 +1,160 @@
+class PagesController < ApplicationController
+
+	before_filter :login_required
+
+	#	calnet_authenticated
+	skip_before_filter :login_required, 
+		:only => [:show, :translate]
+
+#	removed method
+#	skip_before_filter :build_menu_js, 
+#		:only => [:translate]
+
+	#	simply_authorized
+	before_filter :may_maintain_pages_required, 
+		:except => [:show, :translate]
+
+	before_filter :id_required, :only => [ :edit, :update, :destroy ]
+	before_filter :page_required, :only => :show
+#	removed method
+#	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
+
+	#	This will also cache the flash output so don't cache layout
+	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.
+
+		if params[:pages] && params[:pages].is_a?(Array)
+			params[:pages].each_with_index { |id,index| 
+				Page.find(id).update_attribute(:position, index+1 ) }
+		else
+			flash[:error] = "No page order given!"
+		end
+		redirect_to pages_path(:parent_id=>params[:parent_id])
+	end
+
+	def translate
+		respond_to do |format|
+			format.js {}
+		end
+	end
+		
+	def show
+	end
+
+	def all
+		@page_title = "All CCLS Pages"
+		@pages = Page.all
+	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, ActiveRecord::RecordNotSaved
+		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, ActiveRecord::RecordNotSaved
+		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/generators/simply_pages/templates/functional/locales_controller_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+
+class LocalesControllerTest < ActionController::TestCase
+
+	test "should set locale to en" do
+		assert_nil session[:locale]
+		get :show, :id => 'en'
+		assert_equal 'en', session[:locale]
+		assert_response :redirect
+	end
+
+	test "should change locale to es" do
+		assert_nil session[:locale]
+		session[:locale] = 'en'
+		assert_equal 'en', session[:locale]
+		get :show, :id => 'es'
+		assert_equal 'es', session[:locale]
+		assert_response :redirect
+	end
+
+	test "should change locale to en" do
+		assert_nil session[:locale]
+		session[:locale] = 'es'
+		assert_equal 'es', session[:locale]
+		get :show, :id => 'en'
+		assert_equal 'en', session[:locale]
+		assert_response :redirect
+	end
+
+	test "should set locale to en via js" do
+		@request.accept = "text/javascript"
+		assert_nil session[:locale]
+		get :show, :id => 'en'
+		assert_equal 'en', session[:locale]
+		assert_response :success
+	end
+
+	test "should change locale to es via js" do
+		@request.accept = "text/javascript"
+		assert_nil session[:locale]
+		session[:locale] = 'en'
+		assert_equal 'en', session[:locale]
+		get :show, :id => 'es'
+		assert_equal 'es', session[:locale]
+		assert_response :success
+	end
+
+	test "should change locale to en via js" do
+		@request.accept = "text/javascript"
+		assert_nil session[:locale]
+		session[:locale] = 'es'
+		assert_equal 'es', session[:locale]
+		get :show, :id => 'en'
+		assert_equal 'en', session[:locale]
+		assert_response :success
+	end
+
+end

data/generators/simply_pages/templates/functional/pages_controller_test.rb

@@ -0,0 +1,237 @@
+require 'test_helper'
+
+class PagesControllerTest < ActionController::TestCase
+
+	ASSERT_ACCESS_OPTIONS = {
+		:model => 'Page',
+		:actions => [:new,:create,:edit,:update,:destroy,:index],
+		:method_for_create => :factory_create,
+		:attributes_for_create => :factory_attributes
+	}
+
+	def factory_create(options={})
+		Factory(:page,options)
+	end
+	def factory_attributes(options={})
+		Factory.attributes_for(:page,options)
+	end
+
+	with_options :actions => [:show] do |show|
+		show.assert_access_with_http
+		show.assert_access_with_https
+		show.assert_access_with_login({
+			:logins => [:superuser,:administrator,:editor],
+			:skip_show_failure => true })
+		show.assert_access_with_login({
+			:logins => [:interviewer,:reader,:active_user], 
+			:skip_show_failure => true })
+		show.assert_access_without_login
+	end
+
+	assert_no_access_with_login({ 
+		:logins => [:interviewer,:reader,:active_user] })
+	assert_no_access_without_login
+	assert_no_access_with_http 
+
+	%w( superuser administrator editor ).each do |cu|
+	#
+	#		index/new/create/edit/update/destroy 
+	#			should only be visible to admins for editing
+	#	
+
+		test "should get all with pages with #{cu} login" do
+			login_as send(cu)
+			get :all
+			assert_template 'all'
+			assert_response :success
+			assert_equal Page.count, assigns(:pages).length
+		end
+
+		test "should get index with pages with #{cu} login" do
+			3.times{ factory_create }
+			login_as send(cu)
+			get :index
+			assert_template 'index'
+			assert_response :success
+			assert_not_nil assigns(:pages)
+			assigns(:pages).each { |page| assert_nil page.parent }
+#	this isn't always true, depending the apps fixtures/pages.yml
+#			assert Page.count != assigns(:pages).length
+		end
+
+		test "should get index with blank parent with #{cu} login" do
+			3.times{ factory_create }
+			login_as send(cu)
+			get :index, :parent_id => ''
+			assert_template 'index'
+			assert_response :success
+			assert_not_nil assigns(:pages)
+			assigns(:pages).each { |page| assert_nil page.parent }
+		end
+
+		test "should get index with subpages with #{cu} login" do
+			parent = factory_create
+			3.times{ factory_create(:parent_id => parent.id) }
+			login_as send(cu)
+			get :index, :parent_id => parent.id
+			assert_template 'index'
+			assert_response :success
+			assert_not_nil assigns(:pages)
+			assigns(:pages).each do |page|
+				assert_equal page.parent_id, parent.id
+			end
+		end
+
+		test "should create page with parent with #{cu} login" do
+			parent = factory_create
+			login_as send(cu)
+			assert_difference('Page.count') do
+				post :create, :page => factory_attributes(
+					:parent_id => parent.id)
+			end
+			assert_equal parent, assigns(:page).parent
+			assert_redirected_to page_path(assigns(:page))
+		end
+
+		#	I don't think that this is pertinant anymore
+		test "should get index with both help and non-help pages with #{cu} login" do
+			#	test css menus
+			login_as send(cu)
+			nonhelp_page = factory_create(:path => "/hello" )
+			help_page = factory_create(:path => "/help/test" )
+			get :index
+			assert_response :success
+			assert_template 'index'
+		end
+
+	#	action: order
+
+		test "should order pages with #{cu} login" do
+			login_as send(cu)
+	#		pages = 3.times.collect{|i| factory_create }
+	#	3.times.collect doesn't work on 
+	#> ruby --version
+	#ruby 1.8.6 (2008-08-11 patchlevel 287) [universal-darwin9.0]
+			pages = []
+			3.times{ pages.push(factory_create) }
+			before_page_ids = Page.all.collect(&:id)
+			post :order, :pages => before_page_ids.reverse
+			after_page_ids = Page.all.collect(&:id)
+			assert_equal after_page_ids, before_page_ids.reverse
+			assert_redirected_to pages_path
+		end
+
+		test "should NOT order pages without pages with #{cu} login" do
+			login_as send(cu)
+			post :order
+			assert_not_nil flash[:error]
+			assert_redirected_to pages_path
+		end
+
+		test "should order sub pages with #{cu} login" do
+			login_as send(cu)
+			parent = factory_create
+			pages = []
+			3.times{ pages.push(factory_create(:parent_id => parent.id)) }
+			assert_equal [1,2,3], pages.collect(&:position)
+			before_page_ids = parent.reload.children.collect(&:id)
+			post :order,:parent_id => parent.id, :pages => before_page_ids.reverse
+			after_page_ids = parent.reload.children.collect(&:id)
+			assert_equal after_page_ids, before_page_ids.reverse
+			assert_redirected_to pages_path(:parent_id => parent.id)
+		end
+
+	end
+
+	%w( interviewer reader active_user ).each do |cu|
+
+		test "should NOT order pages with #{cu} login" do
+			login_as send(cu)
+			pages = []
+			3.times{ pages.push(factory_create) }
+			before_page_ids = Page.all.collect(&:id)
+			post :order, :pages => before_page_ids.reverse
+			assert_not_nil flash[:error]
+			assert_redirected_to root_path
+		end
+
+	end
+
+	test "should NOT order pages without login" do
+		pages = []
+		3.times{ pages.push(factory_create) }
+		before_page_ids = Page.all.collect(&:id)
+		post :order, :pages => before_page_ids.reverse
+		assert_redirected_to_login
+	end
+
+#
+#	/pages/:id should be visible to anyone ?
+#
+#	as the pages controller uses the gateway filter, not being logged in currently
+#	requires the addition of the line ...
+#		CASClient::Frameworks::Rails::GatewayFilter.stubs(:filter).returns(false)
+#
+
+	test "should NOT show page with invalid id" do
+		get :show, :id => 0
+		assert_not_nil flash[:error]
+		assert_template 'show'
+		assert_response :success
+	end
+
+	test "should NOT show page without matching path" do
+		get :show, :path => "/i/do/not/exist".split('/').delete_if{|x|x.blank?}
+		assert_not_nil flash[:error]
+		assert_template 'show'
+		assert_response :success
+	end
+
+	test "should show page by path" do
+		page = factory_create
+		get :show, :path => page.path.split('/').delete_if{|x|x.blank?}
+		assert_equal assigns(:page), page
+		assert_template 'show'
+		assert_response :success
+		assert_select 'title', page.title
+	end
+
+	test "should show page by path with slashes" do
+		page = factory_create(:path => "/help/blogs")
+		get :show, :path => page.path.split('/').delete_if{|x|x.blank?}
+		assert_equal assigns(:page), page
+		assert_template 'show'
+		assert_response :success
+		assert_select 'title', page.title
+	end
+
+	test "should show HOME page without HPP" do
+		page = Page.by_path('/')
+		get :show, :id => page.id
+		assert_nil assigns(:hpp)
+		assert_template 'show'
+		assert_response :success
+		assert_select 'title', page.title
+	end
+
+	test "should get translate via js without login" do
+		@request.accept = "text/javascript"
+		get :translate
+		assert_response :success
+		assert_match /jQuery/, @response.body
+	end
+
+	test "should get each page in fixtures in each locale" do
+		puts
+		Page.all.each do |page|
+			[ nil,'en','es' ].each do |locale|
+				puts "- Showing page id #{page.id} with locale #{locale}"
+				session[:locale] = locale
+				get :show, :id => page.id
+				assert_response :success
+				assert_template 'show'
+			end
+		end
+	end
+
+end