radiant-page_preview-extension 0.1.1

data/README

@@ -0,0 +1,13 @@
+= Page Preview
+
+An extension to preview editing a page in it's enclosing layout to give the author an idea of what the output will be like.
+
+== Installation
+
+ git clone git://github.com/tricycle/radiant-page-preview-extension.git vendor/extensions/page_preview
+ rake radiant:extensions:page_preview:update
+
+== Todo
+
+  1. Allow previewing of existing pages when changing page types
+

data/Rakefile

@@ -0,0 +1,136 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-page_preview-extension"
+    gem.summary = %Q{Preview extension for Radiant CMS}
+    gem.description = %Q{Enables previewing pages from the edit screen}
+    gem.email = "benny@gorilla-webdesign.be"
+    gem.homepage = "https://github.com/tricycle/radiant-page-preview-extension"
+    gem.authors = ["Adam Sven Johnson", "Glenn Francis Murray", "Kunal Shah", "Matthew Fallshaw"]
+    gem.add_dependency 'radiant', ">=0.9.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package copy_move as a gem."
+end
+
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+# require 'spec/translator'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the page_preview extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PagePreviewExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the page_preview extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/app/controllers/preview_controller.rb

@@ -0,0 +1,39 @@
+class ClassChangedException < Exception; end
+
+class PreviewController < ApplicationController
+  layout false
+  def show
+    Page.transaction do # Extra safe don't save anything voodoo
+      PagePart.transaction do
+        def request.request_method; :get; end
+        construct_page.process(request,response)
+        @performed_render = true
+        raise "Don't you dare save any changes" 
+      end
+    end
+  rescue => exception
+    render :text => exception.message unless @performed_render
+  end
+  
+  private
+  def page_class
+    classname = params[:page][:class_name].classify
+    if Page.descendants.collect(&:name).include?(classname)
+      classname.constantize
+    else
+      Page
+    end
+  end
+  
+  def construct_page
+    if request.referer =~ %r{/admin/pages/(\d+)/edit}
+      page = Page.find($1).becomes(page_class)
+      page.update_attributes(params[:page])
+    else
+      page = page_class.new(params[:page])
+      page.published_at = page.updated_at = page.created_at = Time.now
+      page.parent = Page.find($1) if request.referer =~ %r{/admin/pages/(\d+)/children/new}
+    end
+    return page
+  end
+end

data/app/helpers/page_preview_helper.rb

@@ -0,0 +1,5 @@
+module PagePreviewHelper
+  def save_model_and_continue_editing_button(model)
+    super.to_s + submit_tag(I18n.t('page_preview.preview'), :class => 'button', :id => 'show-preview')
+  end
+end

data/app/views/preview/_preview_iframe.haml

@@ -0,0 +1,3 @@
+- include_javascript 'admin/page_preview'
+%iframe{:id => 'page-preview', :name => 'page-preview', :src => '/loading-iframe.html', :frameborder => 0, :style => 'width:100%;height:40em;display:none;border:1px solid black;'}
+  You don't support iframes. No preview for you.

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  page_preview:
+    preview: Preview

data/config/locales/nl.yml

@@ -0,0 +1,3 @@
+nl:
+  page_preview:
+    preview: Voorbeeld bekijken

data/config/routes.rb

@@ -0,0 +1,3 @@
+ActionController::Routing::Routes.draw do |map|
+  map.connect 'admin/preview', :controller => 'preview', :action => 'show'
+end

data/lib/tasks/page_preview_extension_tasks.rake

@@ -0,0 +1,28 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :page_preview do
+      
+      desc "Runs the migration of the Page Preview extension"
+      task :migrate => :environment do
+        require 'radiant/extension_migrator'
+        if ENV["VERSION"]
+          PagePreviewExtension.migrator.migrate(ENV["VERSION"].to_i)
+        else
+          PagePreviewExtension.migrator.migrate
+        end
+      end
+      
+      desc "Copies public assets of the Page Preview to the instance public/ directory."
+      task :update => :environment do
+        is_svn_or_dir = proc {|path| path =~ /\.svn/ || File.directory?(path) }
+        Dir[PagePreviewExtension.root + "/public/**/*"].reject(&is_svn_or_dir).each do |file|
+          path = file.sub(PagePreviewExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end

data/page_preview_extension.rb

@@ -0,0 +1,10 @@
+class PagePreviewExtension < Radiant::Extension
+  version "1.1"
+  description "Enables previewing pages from the edit screen"
+  url "http://github.com/tricycle/raidant-page-preview-extension"
+  
+  def activate
+    admin.page.edit.add :form_bottom, 'preview/preview_iframe', :after => 'edit_buttons'
+    Admin::PagesController.helper PagePreviewHelper
+  end
+end

data/public/javascripts/admin/page_preview.js

@@ -0,0 +1,20 @@
+document.observe('dom:loaded', function() {
+  $('show-preview').observe('click', function(e) {
+    e.preventDefault()
+    
+    var form = this.form,
+      oldTarget = form.target,
+      oldAction = form.action
+    
+    try {
+      var iframe = $('page-preview').show()
+      location.hash = this.id
+      form.target = iframe.id
+      form.action = '/admin/preview'
+      form.submit()
+    } finally {
+      form.target = oldTarget
+      form.action = oldAction
+    }
+  })
+})

data/public/loading-iframe.html

@@ -0,0 +1,11 @@
+<html>
+ <head>
+  <meta http-Equiv="Cache-Control" Content="no-cache">
+  <meta http-Equiv="Pragma" Content="no-cache">
+  <meta http-Equiv="Expires" Content="0">
+  <title>Loading...</title>
+ </head>
+ <body>
+  <p>Loading Preview...</p>
+ </body>
+</html> 

data/spec/controllers/preview_controller_spec.rb

@@ -0,0 +1,120 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class TestPage < Page
+end
+
+describe PreviewController do
+  dataset :users, :home_page
+  before(:each) do
+    controller.stub! :verify_authenticity_token
+    login_as :admin
+  end
+
+  describe 'show' do
+    it 'should construct the page and process it' do
+      controller.should_receive(:construct_page).and_return(mock('page', :process => true))
+      post :show
+    end
+    
+    # It doesn't make sense to preview a :post, as we can't specify the parameters
+    # We're using :post to overcome the :get 65Kb limitation, but still want to
+    # Page.process method to think it is a :get action (for logic like request.post?)
+    it 'should override the request such that it is a get' do
+      post :show
+      request.method.should == :get
+    end
+
+    it 'should test that it does not modify page'
+    it 'should test that it renders exceptions'
+  end
+  
+  describe 'construct page' do
+    before(:all) do
+      PreviewController.class_eval { public :construct_page }
+      Page.find_by_slug("/").parts.clear
+    end
+    before(:each) do
+      part_parameters = HashWithIndifferentAccess.new('1' => {:name=> 'new part'})
+      page_parameters = HashWithIndifferentAccess.new(:class_name => 'Page', :parts_attributes => part_parameters)
+      query_parameters = HashWithIndifferentAccess.new(:page => page_parameters)
+
+      controller.stub!(:params).and_return(query_parameters)
+      controller.stub!(:request).and_return(request)
+    end
+    describe 'any page', :shared => true do
+      it 'should contain parts created' do
+        page = controller.construct_page
+
+        page.parts.should_not be_empty
+        page.parts.first.name.should == 'new part'
+      end
+      it 'should not retain parts marked for deletion' do
+        controller.params[:page][:parts_attributes] = {'1' => {:name=> 'new part', :_delete => true}}
+      
+        controller.construct_page.parts.should be_empty 
+      end
+    end
+    
+    describe 'new child' do
+      before do
+        Page.stub!(:find).and_return @page
+        request.stub!(:referer).and_return('/admin/pages/1/children/new')
+      end
+      it_should_behave_like "any page"
+      it 'should not save any changes' do
+        page_count = Page.count
+        controller.construct_page
+        Page.count.should == page_count
+      end
+      it 'should get the referrer' do
+        request.should_receive(:referer).at_least(:once)
+        controller.construct_page
+      end
+      it 'should retrieve the class_name from the params' do
+        controller.params[:page].should_receive(:[]).with(:class_name).and_return 'page'
+        controller.construct_page
+      end
+      it 'should create a new page' do
+        controller.params[:page].stub!(:[]).with(:class_name).and_return 'test_page'
+        controller.construct_page.class.should == TestPage
+      end
+      it 'should set get the parent from the referer' do
+        request.stub!(:referer).and_return('/admin/pages/100/children/new')
+        Page.should_receive(:find).with('100')
+        controller.construct_page
+      end
+      it 'should assign the parent from the referer to the page' do
+        parent = mock_model(Page)
+        Page.stub!(:find).and_return parent
+        controller.construct_page.parent.should == parent
+      end
+    end
+    describe 'edit existing page' do
+      before do
+        request.stub!(:referer).and_return('/admin/pages/1/edit')
+        controller.params[:page][:class_name] = "Page"
+        @page = Page.find(:first)
+        Page.stub!(:find).and_return @page
+      end
+      it_should_behave_like "any page"
+      it 'should not save any changes' #TODO: Test this somehow
+      it 'should have the original pages children' do
+        #TODO: Make this text more explicitly test children
+        controller.construct_page.children.should == @page.children
+      end
+      it 'should have the original pages parent' do
+        #TODO: Make this text more explicitly test parent
+        controller.construct_page.parent.should == @page.parent
+      end
+      it 'should change page class if it has changed' do
+        controller.params[:page][:class_name] = "TestPage"  
+        controller.construct_page.class.should == TestPage
+      end
+      it 'should have params attributes, not the existing page attributes' do
+        @page.title = 'foo'
+        controller.params[:page][:title] = 'bar'
+        controller.construct_page.title.should == 'bar'
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+if File.directory?(File.dirname(__FILE__) + "/scenarios")
+  Scenario.load_paths.unshift File.dirname(__FILE__) + "/scenarios"
+end
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: radiant-page_preview-extension
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Adam Sven Johnson
+- Glenn Francis Murray
+- Kunal Shah
+- Matthew Fallshaw
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: radiant
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :runtime
+  version_requirements: *id001
+description: Enables previewing pages from the edit screen
+email: benny@gorilla-webdesign.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- VERSION
+- app/controllers/preview_controller.rb
+- app/helpers/page_preview_helper.rb
+- app/views/preview/_preview_iframe.haml
+- config/locales/en.yml
+- config/locales/nl.yml
+- config/routes.rb
+- lib/tasks/page_preview_extension_tasks.rake
+- page_preview_extension.rb
+- public/javascripts/admin/page_preview.js
+- public/loading-iframe.html
+- spec/controllers/preview_controller_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/tricycle/radiant-page-preview-extension
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Preview extension for Radiant CMS
+test_files: 
+- spec/controllers/preview_controller_spec.rb
+- spec/spec_helper.rb