radiant-concurrent_draft-extension 1.0.0

data/HELP.rdoc

@@ -0,0 +1,32 @@
+The <b>ConcurrentDraft</b> extension enables draft versions of pages, snippets and layouts, which can be scheduled for promotion to Production.  Every such artifact (page, snippet or layout) can have a concurrent draft version, which will be displayed in development mode, and a promoted live version, which will be displayed in production mode.  The admin edit page for each artifact will show the draft version.  
+
+== Usage
+
+* At the upper right-hand corner of each edit screen (Page, Layout, Snippet), you will find: 
+
+<b>Draft Controls ></b> <em>current status</em>
+
+* To the right of the  label is a link which will show the current status, e.g. 'Unpublished', 'Draft promotion unscheduled', or 'Scheduled 03/21/11 01:00PM'.
+* Clicking on the status link will display a dropdown of currently available functions.
+
+== Functions
+
+=== Promote Now
+
+This promotes the saved draft version of your artifact to production immediately.  Remember that you must save your artifact first.
+
+=== Schedule Promotion
+
+This spawns a popup window which enables you set the promotion date and time of your artifact. Upon completion, the status link will show 'Scheduled ...' with the date and time.  When the page is accessed on or after that time, the draft will be promoted.
+
+=== Cancel Promotion
+
+This cancels a scheduled promotion, and returns the artifact to its previous status.
+
+=== Unpublish
+
+This takes a published page and changes it back to 'Draft' status.  It will still appear in development mode, but not in production mode until it is published again.
+
+=== Revert Draft
+
+This will overlay the current draft with the promoted production version.  This is a safety feature which enables you to 'start over' if you have worked on some draft changes and want to go back to square one.

data/README.textile

@@ -0,0 +1,52 @@
+h2. Concurrent Draft
+
+The *ConcurrentDraft* extension enables draft versions of pages, snippets and layouts, which can be scheduled for promotion to Production.  Every such artifact (page, snippet or layout) can have a concurrent draft version, which will be displayed in development mode, and a promoted live version, which will be displayed in production mode.
+
+Created by: Andrew vonderLuft and Sean Cribbs, August 2008, in Portland Oregon
+
+h3. Version History
+
+* 1.0.0 - Compatible with Blade UI - 0.9 and above
+* 0.8.0 - Compatible with Radiant 0.8.0 and above
+* 0.7.1 - Compatible with Radiant 0.7.1
+
+h3. Requirements
+
+* Radiant 0.7 or greater
+
+h3. Installation
+
+h4. With the Radiant Extensions registry:
+
+* From your Radiant root run:
+
+<pre>script/extension install concurrent_draft
+rake radiant:extensions:concurrent_draft:migrate
+rake radiant:extensions:concurrent_draft:update  
+</pre>
+
+* Restart your radiant app, and you should be good to go.
+
+h4. Using the gem
+
+* Install the gem
+
+<pre>gem install radiant-concurrent_draft-extension</pre>
+
+* Update your Radiant config:  add to environment.rb with other gem.configs
+
+<pre>config.gem 'radiant-concurrent_draft-extension', :lib => false</pre>
+
+
+h3. Caveats
+
+Scheduled times are dependent on the ActiveRecord time setting.  If you want to use local time, add this to your environment.rb:
+
+<pre>config.active_record.default_timezone = :local</pre>
+
+h3. Acknowledgments
+
+* Andrew conceived of the ideas for this extension and its initial design,  and did model changes, migrations, and initial code for pages.
+* Sean collaborated on its expansion and refactoring to include snippets and layouts, and produced most of the final code, including all of the UI.
+* Andrew refactored the UI for Radiant 0.9 and higher, added i18n, and gemified the extension.
+* After some discussion, they rightly identified the mystery piece as a Haydn Cello concerto.

data/Rakefile

@@ -0,0 +1,136 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-concurrent_draft-extension"
+    gem.summary = %Q{Concurrent Draft Extension for Radiant CMS}
+    gem.description = %Q{Enables draft versions of pages, snippets and layouts, which can be scheduled for promotion.}
+    gem.email = "avonderluft@avlux.net"
+    gem.homepage = "https://github.com/avonderluft/radiant-concurrent_draft-extension"
+    gem.authors = ['Andrew vonderLuft','Sean Cribbs']
+    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 concurrent_draft 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 concurrent_draft extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ConcurrentDraftExtension'
+  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 concurrent_draft 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 @@
+1.0.0

data/app/views/admin/_draft_controls.html.haml

@@ -0,0 +1,85 @@
+- include_javascript 'admin/concurrent_draft'
+- resource = "#{@controller.model.display_name}  #{@controller.model_class.to_s.downcase}"
+
+.draft_controls
+  %table.index
+    %tr
+      %td.label Draft Controls > 
+      %td.actions
+        - if @controller.model.has_draft_promotion_scheduled?
+          = link_to t('scheduled') + ' ' + @controller.model.draft_promotion_scheduled_at.strftime('%m/%d/%y %I:%M%p'), "#draft_options", :class => "action dropdown"
+        - elsif @controller.model.publishable? && ! @controller.model.published?
+          %em= link_to t('unpublished'), "#draft_options", :class => "action dropdown"
+        - else
+          %em= link_to t('draft_promotion_unscheduled'), "#draft_options", :class => "action dropdown"
+        %ul.menu{:id => "draft_options"}
+          - if @controller.authorized_user?
+            %li.schedule_draft= link_to image('clock') + ' ' + t('schedule_promotion'), '#schedule-draft-popup', :class => 'popup'
+            %li.publish
+              - form_for @controller.model, :url => {:action => 'schedule_draft_promotion', :commit => @controller.model_class.promote_now_text}, :html => {:method => :post} do |f|
+                = link_to_function image('tick') + ' ' + t('promote_now'), "$(this).up('form').submit();showStatus('Promoting #{resource}', true)"
+            - if @controller.model.has_draft_promotion_scheduled?
+              %li.cancel
+                - form_for @controller.model, :url => {:action => 'schedule_draft_promotion', :commit => @controller.model_class.cancel_promotion_text}, :html => {:method => :post} do |f|
+                  = link_to_function image('cancel') + ' ' + t('cancel_promotion'), "$(this).up('form').submit();showStatus('Canceling scheduled promotion of #{resource}', true)"
+            - if @controller.model.publishable? && @controller.model.published?
+              %li.unpublish
+                - form_for @controller.model, :url => {:action => 'unpublish', :method => :post} do |f|
+                  = link_to_function image('page_delete') + ' ' + t('unpublish'), "$(this).up('form').submit();showStatus('Unpublishing #{resource}', true)"
+            - if @controller.model.has_draft_promoted?
+              %li.revert= link_to image('page_refresh') + ' ' + t('revert_draft'), '#revert-draft-popup', :class => 'popup'
+
+- content_for :popups do
+  - if @controller.authorized_user?
+    .popup#schedule-draft-popup{:style => 'display:none'}
+      %h3.title
+        = image('clock')
+        = t('schedule_promotion')
+      - form_for @controller.model, :url => {:action => 'schedule_draft_promotion'}, :html => {:method => :post, 'data-onsubmit_status' => "Scheduling promotion of #{resource}"} do |f|
+        %div
+          = f.datetime_select :draft_promotion_scheduled_at, :start_year => Date.today.year, :minute_step => 15, :twelve_hour => true
+          = hidden_field_tag :commit, @controller.model_class.schedule_promotion_text
+        %p{:style => 'text-align: right'}
+          %button{:type => 'submit'}= t('schedule')
+          = t('or')
+          = link_to_function t('cancel'), "$(this).closePopup();"
+
+  .popup#revert-draft-popup{:style => 'display:none'}
+    %p.revert
+      = image('page_refresh')
+      The draft has been replaced with the live content.  
+      %br/
+      %br/
+      %em You must save the page for this to take effect.
+      %span{:style => 'padding-left:8px'}= link_to_function 'OK', "$(this).closePopup();"
+
+- content_for :page_css do
+  :sass
+    .draft_controls
+      float: right
+      width: 300px
+      background: #7E7E7E
+      table.index
+        margin: 0
+        border: none
+        tr, td.label, td.actions
+          border: none
+          padding: 0px
+          background: #7E7E7E
+        td.label
+          text-align: right
+          padding-right: 6px
+        td.actions
+          width: 178px
+          a.action, span.action.disabled
+            color: white
+            text-decoration: underline
+            margin: 0
+            &:hover
+              color: black
+              text-decoration: none
+              background: #eee image_url('admin/buttons_background.png') repeat-x
+            &.selected
+              color: black
+              text-decoration: none
+              background: #c5e0f5

data/app/views/admin/_edit_buttons.html.haml

@@ -0,0 +1,10 @@
+- if @controller.model.is_a?(Page)
+  - @buttons_partials.each do |partial|
+    = render :partial => partial
+%p.buttons
+  = save_model_and_continue_editing_button(@controller.model)
+  = save_model_button(@controller.model)
+  - if @controller.authorized_user?
+    = save_model_and_promote_button(@controller.model)
+  or
+  = link_to t('cancel'), :action => 'index'

data/app/views/admin/layouts/_edit_content.html.haml

@@ -0,0 +1,5 @@
+%p.content
+  %label{:for=>"layout_draft_content"} Body
+  ~ text_area "layout", "draft_content", :class => "textarea", :style => "width: 100%"
+  = preserve do
+    = hidden_field "layout", "content"

data/app/views/admin/page_parts/_page_part.html.haml

@@ -0,0 +1,20 @@
+.page{:id => "page_#{page_part.name.to_slug}", 'data-caption'=>h(page_part.name)}
+  .part{:id => "part-#{page_part.name.to_slug}"}
+    = hidden_field_tag "page[parts_attributes][#{page_part_counter}][name]", page_part.name, :id => "part_#{page_part.name.to_slug}_name"
+    = hidden_field_tag "page[parts_attributes][#{page_part_counter}][id]", page_part.id, :id => "part_#{page_part_counter}_id", :class => "id_input" unless page_part.new_record?
+    = hidden_field_tag "page[parts_attributes][#{page_part_counter}][_destroy]", page_part._destroy, :class => "delete_input"
+    %p
+      %label{:for => "part_#{page_part.name.to_slug}_filter_id"} 
+        = t('filter') 
+      = select_tag "page[parts_attributes][#{page_part_counter}][filter_id]", filter_options_for_select(page_part.filter_id), :id => "part_#{page_part.name.to_slug}_filter_id"
+      %span.reference_links
+        = t('reference')
+        %span{:id => "filter_reference_link_#{page_part.name.to_slug}"}
+          = link_to_function t('filter'), "loadFilterReference('#{page_part.name.to_slug}');"
+        %span{:id => "tag_reference_link_#{page_part.name.to_slug}"}
+          = link_to_function t('available_tags'), "loadTagReference('#{page_part.name.to_slug}');"
+      = render_region :part_controls, :locals => {:page_part => page_part}
+    %div
+      ~ text_area_tag "page[parts_attributes][#{page_part_counter}][draft_content]", page_part.draft_content, :class => "textarea large", :style => "width: 100%", :id => "part_#{page_part.name.to_slug}_draft_content"
+      = preserve do 
+        = hidden_field_tag "page[parts_attributes][#{page_part_counter}][content]", page_part.content, :id => "part_#{page_part.name.to_slug}_content"

data/app/views/admin/pages/_edit_layout_and_type.html.haml

@@ -0,0 +1,11 @@
+.row
+  %p
+    %label{:for=>"page_layout_id"}
+      Layout
+    = select "page", "layout_id", [['<inherit>', '']] + Layout.find(:all).map { |s| [s.name, s.id] }
+  %p
+    %label{:for=>"page_class_name"}
+      Page Type
+    = select "page", "class_name", [['<normal>', 'Page']] + Page.descendants.map { |p| [p.display_name, p.name] }.sort_by { |p| p.first }
+  = render_region :layout_row
+%span.clear &nbsp;

data/app/views/admin/pages/_published_meta.html.haml

@@ -0,0 +1,4 @@
+%tr
+  %th.label Published date
+  %td.field{:style => "text-align: left"}
+    = datetime_select 'page', 'published_at', :include_blank => true

data/app/views/admin/snippets/_edit_content.html.haml

@@ -0,0 +1,5 @@
+%p.content
+  %label{:for=>"snippet_draft_content"} Body
+  ~ text_area "snippet", "draft_content", :class => "textarea", :style => "width: 100%"
+  = preserve do
+    = hidden_field "snippet", "content"

data/app/views/admin/users/_edit_roles.html.haml

@@ -0,0 +1,26 @@
+- if @user.respond_to?(:designer)
+  %p
+    %label.multi_option Roles
+    = check_box "user", "admin", :class => "checkbox"
+    %label{:for=> :user_admin, :class => "checkbox"} Administrator
+    = check_box "user", "designer", :class => "checkbox"
+    %label{:for=> :user_designer, :class => "checkbox"} Designer
+    = check_box "user", "publisher", :class => "checkbox"
+    %label{:for=> :user_publisher, :class => "checkbox"} Publisher    
+- elsif @user.respond_to?(:developer)
+  %tr
+    %th.label
+      %label{:for=>"user_admin"} Roles
+    %td.field
+      %span.checkbox
+        = check_box "user", "admin"
+        %label{:for=> "user_admin"} Administrator
+      %span.checkbox
+        = check_box "user", "developer"
+        %label{:for=> "user_developer"} Developer
+      %span.checkbox
+        = check_box "user", "publisher"
+        %label{:for=>"user_publisher"} Publisher
+    %td.help
+      Roles restrict user privileges and turn parts of the administrative interface on or off.
+

data/concurrent_draft_extension.rb

@@ -0,0 +1,30 @@
+# Uncomment this if you reference any of your controllers in activate
+require_dependency 'application_controller'
+
+class ConcurrentDraftExtension < Radiant::Extension
+  version "#{File.read(File.expand_path(File.dirname(__FILE__)) + '/VERSION')}"
+  description "Enables default draft versions of pages, snippets and layouts, which can be scheduled for promotion to Production"
+  url "https://github.com/avonderluft/radiant-concurrent_draft-extension/tree/master"
+
+  def activate
+    [Page, Snippet, Layout, PagePart].each do |klass|
+      klass.send :include, ConcurrentDraft::ModelExtensions
+    end
+    Page.send :include, ConcurrentDraft::PageExtensions
+    Page.send :include, ConcurrentDraft::Tags
+    [Admin::PagesController, Admin::SnippetsController, Admin::LayoutsController].each do |klass|
+      klass.send :include, ConcurrentDraft::AdminControllerExtensions
+      klass.class_eval do
+        helper ConcurrentDraft::HelperExtensions
+      end
+    end
+    SiteController.send :include, ConcurrentDraft::SiteControllerExtensions
+    %w{page snippet layout}.each do |view|
+      admin.send(view).edit.add :main, "admin/draft_controls", :before => "edit_header"
+      admin.send(view).edit.form_bottom.delete 'edit_buttons'
+      admin.send(view).edit.add :form_bottom, 'admin/edit_buttons'
+    end
+    admin.page.edit.add :extended_metadata, 'published_meta'
+    Time::DATE_FORMATS[:long_civilian] = lambda {|time| time.strftime("%B %d, %Y %I:%M%p").gsub(/(\s+)0(\d+)/, '\1\2') }
+  end
+end

data/config/initializers/radiant_config.rb

@@ -0,0 +1,3 @@
+Radiant.config do |config|
+  # config.define "setting.name", :default => 'value', :select_from => ['foo', 'bar']
+end

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+---
+en:
+  cancel_promotion: "Cancel promotion"
+  draft_promotion_unscheduled: "Draft promotion unscheduled"
+  promote_now: "Promote now"
+  revert_draft: "Revert draft"
+  schedule: "Schedule"
+  scheduled: "Scheduled"
+  schedule_promotion: "Schedule promotion"
+  unpublish: "Unpublish"
+  unpublished: "Unpublished"