skylinecms 3.0.7 → 3.0.8

data/.yardopts

@@ -1,8 +1,10 @@
 lib/**/*.rb
 app/models/**/*.rb
-app/helpers/**/*.rb
+app/helpers/skyline/*.rb
 --no-private 
+--title "Skyline API documentation"
 -o ydoc
 -
 doc/INSTALL.md
-doc/MIGRATION.md
+doc/MIGRATION.md
+doc/Bundler.md

data/CHANGELOG

@@ -1,3 +1,15 @@
+*3.0.8 (December 18, 2009)*
+
+* Added support for SQLite3
+* Always make the last saved variant the default variant
+* Fix longstanding bug which can be caused by copy-paste from one wysiwyg section to another
+* Make the default templates more bullet-proof
+* Implemented capture functionality on RendererHelper#assign
+* Add some helper methods to the ContentCollectionSection. Simplified the templates accordingly
+* Added loads and loads of API documentation
+* Deprecate the settings helper in favour of Settings#get and Settings#get_page
+* Deprecate page_sections_per_column in favour of sections_per_column
+
 *3.0.7 (December 8, 2009)*
 
 * Minor optimalisation to make (auto)loading work better

data/Rakefile

@@ -3,6 +3,63 @@ require File.dirname(__FILE__) + "/lib/skyline/version"
 
 begin
   require 'jeweler'
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+begin
+  require 'yard'
+rescue LoadError
+  puts "Yardoc not available. Install it with: sudo gem install yard"
+end
+
+require 'yaml'
+
+DEFAULT_OPTIONS = {
+  "doc" => {
+    "output_path" => "ydoc",
+    "deploy_to" => nil
+  }
+}
+
+class Options < Hash
+  def [](v)
+    get_options!
+    super(v)
+  end
+  
+  
+  
+  def inspect
+    get_options!
+    super
+  end
+  
+  private
+  
+  def get_options!
+    return if @_loaded
+    @_loaded = true
+    
+    self.update(DEFAULT_OPTIONS)
+    
+    f = File.expand_path("~/.skyline_options")    
+    if File.exist?(f)
+      opts = YAML.load(File.read(f))
+      opts.each do |k,v|
+        if self.has_key?(k)
+          self[k].update(v)
+        else
+          self[k] = v
+        end
+      end
+    end
+    
+  end
+end
+OPTIONS = Options.new
+
+namespace :gem do
   Jeweler::Tasks.new do |gemspec|
     gemspec.version = Skyline.version
     gemspec.name = "skylinecms"
@@ -11,22 +68,22 @@ begin
     gemspec.email = "info@digitpaint.nl"
     gemspec.homepage = "http://www.skylinecms.nl"
     gemspec.authors = ["DigitPaint"]
-    
+  
     gemspec.files.exclude "tasks/testing.rake"
     gemspec.files.exclude "Gemfile"
     gemspec.files.exclude ".gitignore"
     gemspec.files.exclude "test/"
-    
+  
     gemspec.test_files = []
-    
+  
     gemspec.has_rdoc = false
     gemspec.extra_rdoc_files = %w{README.md doc/MIGRATION.md}
-    
+  
     gemspec.add_dependency "thor", "0.12.0"
-    
+  
     gemspec.add_dependency "rails", "2.3.5"
     gemspec.add_dependency "rack", "1.0.1"
-        
+      
     gemspec.add_dependency "polyglot", "0.2.6"
     gemspec.add_dependency "sprockets", "1.0.2"
     gemspec.add_dependency "mime-types", "1.16"
@@ -35,8 +92,31 @@ begin
     gemspec.add_dependency "guid", "0.1.1"
     gemspec.add_dependency "will_paginate", "~>2.3.11"
     gemspec.add_dependency "seed-fu", "~>1.2.0"
+  
+  end
+end
+
+namespace :doc do
+  desc "Generate the Skyline CMS documentation (uses Yard)"
+  YARD::Rake::YardocTask.new(:generate) do |t|
+    t.options = ["-o#{OPTIONS["doc"]["output_path"]}", "--title=\"Skyline #{Skyline.version} API documentation\""]
+  end
+  
+  task :deploy do
+    raise "No Options['doc']['deploy_to'] variable set, create a ~/.skyline_options YAML file and set it there" if OPTIONS["doc"]["deploy_to"].nil?
     
+    puts "=> Generating YarDoc first."
+    Rake::Task['doc:generate'].execute
+    
+    puts "=> Uploading documentation"
+    Rake::Task['doc:upload'].execute
   end
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+  
+  task :upload do
+    system("rsync -az --delete #{OPTIONS["doc"]["output_path"]}/* #{OPTIONS["doc"]["deploy_to"]}")    
+  end
+end
+
+task :options do
+  puts OPTIONS.inspect
 end

data/app/helpers/skyline/content_helper.rb

@@ -1,3 +1,4 @@
+# @private
 module Skyline::ContentHelper
 
   # We need some preconditions to make automatic breadcrumbs work

data/app/helpers/skyline/media_files_helper.rb

@@ -1,3 +1,4 @@
+# @private
 module Skyline::MediaFilesHelper
   def skyline_media_file_path_with_session_information(media_dir)
     session_key = ActionController::Base.session_options[:session_key] || ActionController::Base.session_options[:key]

data/app/helpers/skyline/message_generator.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::MessageGenerator
   include ActionView::Helpers::JavaScriptHelper
   

data/app/helpers/skyline/tree_helper.rb

@@ -1,3 +1,4 @@
+# @private
 module Skyline::TreeHelper
   
   def page_tree(pages, roots, options = {})
@@ -58,5 +59,4 @@ module Skyline::TreeHelper
     content_tag("ul",tags.join("\n"));
   end
   
-  # content_tag("span", node.name)
 end

data/app/models/skyline/article.rb

@@ -1,4 +1,12 @@
+# Articles are container objects that contain Sections, have history and can (optional) be previewed
+# and published.
+#
+# @abstract Subclass and implement the Article interface
 class Skyline::Article < ActiveRecord::Base
+  
+  # The data object contains required structured data needed for an article.
+  # 
+  # @abstract Subclass and implement the Article::Data interface
   class Data < ActiveRecord::Base
     self.abstract_class = true
     
@@ -57,29 +65,35 @@ class Skyline::Article < ActiveRecord::Base
     
     # The prefix to use when determining rights. User#allow? uses
     # this method when called with 2 parameters.
-    # --    
+    # 
+    # @return [String] The string to prefix to the right (_create, _update, _delete)
+    # @abstract Implement the value correct value in your subclass, defaults to 'article'
     def right_prefix
       "article"      
     end
     
-    # used by SearchableItem
+    # Is this type of article publishable?
+    # 
+    # @return [true,false] Wether or not this article type can be published
+    # @abstract Implement in subclass if needed, true is a sensible default.
     def publishable?
       true
     end
   end
 
+  # Has this article been puslished?
+  #
+  # @return [true,false] True if it has a published_publication, meaning it's currently published
   def published?
     # Don't use only "self.published_publication" here, it causes way too many lookups
     # If the next test is wrong, than maybe you should wonder why it is wrong? Foreign key left behind?
     self.published_publication_id.present?
   end
 
-  # Depublish a page, removes the published_publication if keep_history? is false
-  # 
-  # ==== Raises
-  # StandardError:: if page is persistent
+  # Depublish an article, removes the published_publication if keep_history? is false
   # 
-  # --
+  # @raise [StandardError] If page is persistent and cannot be depulished
+  # @return [void] 
   def depublish
     raise StandardError, "can't be depublished because this page is persistent" if self.persistent?
     
@@ -94,31 +108,47 @@ class Skyline::Article < ActiveRecord::Base
     self.save
   end
   
+  # Depublish this article and destroy it.
+  # 
+  # @see Skylien::Article#depublish
+  # @return [false,true] True sucessfully destroyed, otherwise false
   def destroy
     depublish
     super
   end
   
+  # Can this article be depublished? 
+  # 
+  # @return [true,false]
   def depublishable?
     !self.persistent?
   end
   
+  # Can this article be destroyed? Only works if the article isn't persisntent and does not have
+  # a publication (isn't published).
+  # 
+  # @return [true,false]
   def destroyable?
     !self.persistent? && self.published_publication == nil
   end
   
+  # Can this article be rendered. This basically means wether or not there are any templates for
+  # this article.
+  # 
+  # @return [true,false]
   def renderable?
     self.renderable_scope.renderer.templates_for(self).any?
   end
   
-  def renderable_scope
-    Skyline::WildcardRenderableScope.new
-  end
-  
+  # Can this article be previewed? Delegates to Skyline::Article#renderable?
+  #
+  # @return [true,false]
+  # @see Skyline::Article#renderable?
   def previewable?
     self.renderable?
   end
   
+  
   def rollbackable?
     true
   end
@@ -142,12 +172,15 @@ class Skyline::Article < ActiveRecord::Base
 
   # Checks if the page can be edited by a certain user
   # Currently only checks on page locks.
-  # --
+  # 
+  # @param user [Skyline::User,Integer] The user or user id to check the access for.
+  # @return [true,false] True if the user can edit this page, false otherwise
   def editable_by?(user)
     user = user.kind_of?(Skyline::User) ? user : Skyline::User.find_by_id(user)    
     self.locked? && user.allow?(:page_lock) || !self.locked?
   end  
 
+  
   def set_default_variant!(variant)
     return if variant.id == self.default_variant_id && variant.data_id == self.default_variant_data_id
     self.update_attributes(:default_variant_id => variant.id, :default_variant_data_id => variant.data_id)
@@ -159,15 +192,17 @@ class Skyline::Article < ActiveRecord::Base
   end  
 
   # The class that provides our custom data fields.
-  # --
-  # Note: We can't use memoize here, because it freezes the class
+  # 
+  # @return [Class,false] False if we don't have an inner Data class, the inner Data class if there is one.
   def data_class
+    # Note: We can't use memoize here, because it freezes the class
     return @_data_class unless @_data_class.nil?
     @_data_class = (self.class.name + "::" + "Data").constantize
   rescue NameError
     @_data_class = false
   end
   
+  
   def right_prefix
     self.class.right_prefix
   end
@@ -176,7 +211,10 @@ class Skyline::Article < ActiveRecord::Base
     self.id
   end
   
-  # a subclass might return a Page in which the article (ie: NewsItem) will be rendered for previewing
+  # A subclass can return a Page in which the article (ie: NewsItem) will be rendered for previewing
+  # 
+  # @return [Skyline::Page,nil] The page to wrap this article in when previewing. Nil if no wrapping is needed.
+  # @abstract Implement this in a subclass to get the Page from Settings or from somewhere else.
   def preview_wrapper_page
     nil
   end
@@ -189,6 +227,10 @@ class Skyline::Article < ActiveRecord::Base
     Skyline::Site.new
   end  
   
+  def renderable_scope
+    Skyline::WildcardRenderableScope.new
+  end  
+  
   protected
   
   def after_initialize

data/app/models/skyline/article_version.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::ArticleVersion < ActiveRecord::Base
   set_table_name :skyline_article_versions
   

data/app/models/skyline/associated_tag.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::AssociatedTag < ActiveRecord::Base
   set_table_name :skyline_associated_tags
   

data/app/models/skyline/grant.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Grant < ActiveRecord::Base
   set_table_name :skyline_grants
   

data/app/models/skyline/image_ref.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::ImageRef < Skyline::InlineRef
   
   # Render html for specified RefObject

data/app/models/skyline/inline_ref.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::InlineRef < Skyline::RefObject  
 
   attr_accessor :previous_referable
@@ -124,7 +125,7 @@ class Skyline::InlineRef < Skyline::RefObject
         result
       end
    
-      new_ref = skyline_class.find_by_id(id) if id
+      new_ref = skyline_class.find_by_id_and_refering_type_and_refering_id(id,refering_object.class.name,refering_object.id) if id
       new_ref ||= skyline_class.new
 
       new_ref.previous_referable = new_ref.referable.dup if new_ref.referable

data/app/models/skyline/link_ref.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::LinkRef < Skyline::InlineRef
   
   # Render html start tag for specified RefObject

data/app/models/skyline/link_section_link.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::LinkSectionLink < ActiveRecord::Base
   include Skyline::ContentItem
   include Skyline::Positionable

data/app/models/skyline/media_cache.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::MediaCache < ActiveRecord::Base    
   set_table_name :skyline_media_cache  
   cattr_accessor :cache_path

data/app/models/skyline/media_dir.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::MediaDir < Skyline::MediaNode
   extend ActiveSupport::Memoizable
   include UniqueIdentifiers

data/app/models/skyline/media_file.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::MediaFile < Skyline::MediaNode    
   has_and_belongs_to_many :tags, :class_name => "Skyline::Tag", :join_table => "skyline_media_files_skyline_tags"
 	  

data/app/models/skyline/media_node.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::MediaNode < ActiveRecord::Base
   set_table_name :skyline_media_nodes
 

data/app/models/skyline/object_ref.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::ObjectRef < Skyline::RefObject	
   after_destroy :destroy_referable
   

data/app/models/skyline/page.rb

@@ -75,7 +75,8 @@ class Skyline::Page < Skyline::Article
       pages = self.connection.select_all("
         SELECT page.id,
                page.parent_id,
-               IF(ISNULL(data.navigation_title) || data.navigation_title='', data.title, data.navigation_title) AS title,
+               data.navigation_title as navigation_title,
+               data.title as title,
                page.locked,
                page.published_publication_id,
                page.default_variant_id,
@@ -93,7 +94,13 @@ class Skyline::Page < Skyline::Article
         class << o
           def id; self["id"].to_i; end
           def parent_id; self["parent_id"].blank? ? nil : self["parent_id"].to_i; end
-          def title; self["title"].blank? ? "n/a" : self["title"]; end
+          def title
+            if self["navigation_title"].blank?
+              self["title"].blank? ? "n/a" : self["title"]
+            else
+              self["navigation_title"]
+            end
+          end
           def published?; self["published_publication_id"].present?; end
           def identical_to_publication?
             self["published_publication_variant_id"] == self["default_variant_id"] && self["published_publication_version"] == self["default_variant_version"]

data/app/models/skyline/publication.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Publication < Skyline::ArticleVersion
   belongs_to :variant, :class_name => "Skyline::Variant"
   

data/app/models/skyline/ref_object.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::RefObject < ActiveRecord::Base
   belongs_to :referable, :polymorphic => true, :autosave => true
 

data/app/models/skyline/referable_uri.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::ReferableUri < ActiveRecord::Base
   set_table_name :skyline_referable_uris
   

data/app/models/skyline/right.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Right < ActiveRecord::Base
   set_table_name :skyline_rights
   

data/app/models/skyline/role.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Role < ActiveRecord::Base
   set_table_name :skyline_roles
   

data/app/models/skyline/section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Section < ActiveRecord::Base
   set_table_name :skyline_sections
   

data/app/models/skyline/sections/content_collection_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::ContentCollectionSection < ActiveRecord::Base
   include Skyline::SectionItem
   include Skyline::Taggable
@@ -18,6 +19,18 @@ class Skyline::Sections::ContentCollectionSection < ActiveRecord::Base
     end    
   end
   
+  def collection_name
+    self.content_name.pluralize.to_sym
+  end
+  
+  def collection
+    self.full_collection.scoped(:limit => self.number)
+  end
+  
+  def full_collection
+    self.content_class.published.with_tags(self.tags).scoped(:limit => self.number)
+  end
+  
   def clone
     returning super do |clone|
       clone.associated_tags = self.associated_tags.collect{|associated_tag| associated_tag.clone}

data/app/models/skyline/sections/content_item_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::ContentItemSection < ActiveRecord::Base
   include Skyline::SectionItem
 

data/app/models/skyline/sections/heading_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::HeadingSection < ActiveRecord::Base
   include Skyline::SectionItem
   

data/app/models/skyline/sections/iframe_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::IframeSection < ActiveRecord::Base
   extend Skyline::UrlValidation  
   include Skyline::SectionItem

data/app/models/skyline/sections/link_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::LinkSection < ActiveRecord::Base
   include Skyline::SectionItem
   include NestedAttributesPositioning  

data/app/models/skyline/sections/media_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::MediaSection < ActiveRecord::Base
   include Skyline::SectionItem
   include Skyline::ContentItem

data/app/models/skyline/sections/page_fragment_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::PageFragmentSection < ActiveRecord::Base
   include Skyline::SectionItem
 

data/app/models/skyline/sections/raw_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::RawSection < ActiveRecord::Base
   include Skyline::SectionItem
     

data/app/models/skyline/sections/redirect_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::RedirectSection < ActiveRecord::Base
   include Skyline::SectionItem
   include Skyline::ContentItem

data/app/models/skyline/sections/rss_section.rb

@@ -1,4 +1,6 @@
 require 'fileutils'
+
+# @private
 class Skyline::Sections::RssSection < ActiveRecord::Base
   extend ActiveSupport::Memoizable
   extend Skyline::UrlValidation  

data/app/models/skyline/sections/splitter_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::SplitterSection < ActiveRecord::Base
   include Skyline::SectionItem
   

data/app/models/skyline/sections/wysiwyg_section.rb

@@ -1,3 +1,4 @@
+# @private
 class Skyline::Sections::WysiwygSection < ActiveRecord::Base
   include Skyline::SectionItem
   include Skyline::Referable

data/app/models/skyline/variant.rb

@@ -158,12 +158,7 @@ class Skyline::Variant < Skyline::ArticleVersion
   end
   
   def update_article_default_variant
-    if !self.article.default_variant.present? ||        # no default_variant has been set yet
-       !self.article.default_variant_data.present? ||   # no default_variant has been set yet
-       !self.article.published?                         # article isn't published, so now I'm the default variant
-
-      self.article.set_default_variant!(self) 
-    end
+    self.article.set_default_variant!(self) 
   end
   
   def update_article_default_variant_on_destroy

data/app/templates/skyline/page/default/index.html.erb

@@ -13,6 +13,8 @@
 
 <body>
   <h1><%= article_version.data.title%></h1>
+  <% assign(:heading_level,1) %>
+  
   <%= render_collection(article_version.sections) %>
   <%= @body %>
 </body>

data/app/templates/skyline/sections/content_collection_section/default/index.html.erb

@@ -1,2 +1 @@
-<% proxy = content_collection_section.content_class.published.with_site(site).with_tags(content_collection_section.tags).scoped(:limit => content_collection_section.number) %>
-<%= render :partial => "#{content_collection_section.content_name.pluralize}", :locals => {content_collection_section.content_name.pluralize.to_sym => proxy} %>
+<%= render :partial => "#{content_collection_section.collection_name}", :locals => {content_collection_section.collection_name => content_collection_section.collection} %>

data/app/templates/skyline/sections/link_section/default/index.html.erb

@@ -5,7 +5,9 @@
 <% if link_section.links.any? %>
   <ul class="links">
     <% link_section.links.each do |link| %>
-      <li><%=link_to link.title, link.url%></li>
+      <% if link.present? %>
+        <li><%=link_to link.title, link.url%></li>
+      <% end %>
     <% end %>
   </ul>
 <% end %>

data/config/initializers/rails_defaults.rb

@@ -1,2 +1,6 @@
 ActionView::Base.field_error_proc = Proc.new {|html_tag, instance|  %(#{html_tag})}
-ActionView::Base.default_form_builder = Skyline::FormBuilderWithErrors
+
+# This has to happen on every request as the Constant may not be the same anymore (because of reloading)
+ActionController::Dispatcher.to_prepare(:form_builder) do
+  ActionView::Base.default_form_builder = Skyline::FormBuilderWithErrors
+end