skylinecms 3.0.8 → 3.1.0

data/lib/skyline/{content_item.rb → belongs_to_referable.rb}

@@ -1,94 +1,67 @@
-# Use this Module in in a class that references a Page/MediaFile etc throug an ObjectRef
+# Use this Module in in a class that references a Page/MediaFile/URL as an association.
+# It adds the class method `belongs_to_referable`. With {Skyline::Referable::ClassMethods#belongs_to_referable} you create a
+# `belongs_to` association to an Page/MediaFile/URL through a RefObject.
+# 
+# @see Skyline::BelongsToReferable::ClassMethods#belongs_to_referable
 #
+# @example Usage
 #
-# Usage: 
 # class Model < ActiveRecord::Base
-#   include Skyline::ContentItem
-# 
-#   referable_content :teaser      (column teaser_id must be crreated)
-# end
+#   include Skyline::BelongsToReferable
 #
-# 
-# 1) Gives your Model the following interface:
-# 
-#    class Model < ActiveRecord::Base
-#      before_save :set_refering_type_and_id
-#      after_create :set_refering_id
-#      named_scope :published             (scope to return only published items)
-#
-#      def referable_content(*fields)
+#   belongs_to_referable :teaser      # column teaser_id must be available
+# end
 #
-#      belongs_to :teaser, :class_name => "Skyline::ObjectRef", :foreign_key => "teaser_id", :dependent => :destroy
-#      accepts_nested_attributes_for :teaser, :reject_if => proc {|attributes| attributes['referable_type'].blank?}, :allow_destroy => true
-#      [validates_presence_of :teaser     (only if options[:allow_nil] is not set)]
-#     
-#      def teaser_with_passthrough=(obj)            (obj can be an ObjectRef or a Teaser, in which case it will be passed through)
-#      alias_method_chain :teaser=, :passthrough
-#    end
 #
+# @example Gives your Model the following interface:
 #
-# ***** OR *****
+# class Model < ActiveRecord::Base
+#   after_save :possibly_destroy_previous_referables
+#   after_destroy :possibly_destroy_referables
+#   before_save :set_refering_type_and_id
+#   after_create :set_refering_id
 #
-# it can be used to reference a Page/MediaFile etc directly when the foreign key must be serialized (or isn't available as an association)
+#   belongs_to :teaser, :class_name => "Skyline::ObjectRef", :foreign_key => "teaser_id", :dependent => :destroy
+#   accepts_nested_attributes_for :teaser, :reject_if => proc {|attributes| attributes['referable_type'].blank?}, :allow_destroy => true
+#   validates_presence_of :teaser   # only if options[:allow_nil] is not set
 #
-# Usage: 
-# class Settings < ActiveRecord::Base
-#   include Skyline::ContentItem
-# 
-#   referable_serialized_content  :results_page      (obj.results_page_id and obj.results_page_id= must be available)
+#   def teaser_with_passthrough=(obj) # obj can be an ObjectRef or a Teaser, in which case it will be passed through
+#     # ...
+#   end
+#   alias_method_chain :teaser=, :passthrough
 # end
 #
-# 
-# 1) Gives your Settings the following interface:
-# 
-#    class Settings < ActiveRecord::Base
-#      def referable_serialized_content(*fields)
-#
-#      def results_page_attributes=       (set results_page_id to the referable_id; bypassing an ObjectRef)
-#    end
-
-module Skyline::ContentItem 
+module Skyline::BelongsToReferable 
   def self.included(base)
     base.extend(ClassMethods)
 
+    # Callbacks
     base.send(:before_save, :set_refering_type_and_id)
     base.send(:after_create, :set_refering_id)
+    base.send(:after_save, :possibly_destroy_previous_referables)
+    base.send(:after_destroy, :possibly_destroy_referables)
+    
     base.send(:cattr_accessor, :referable_contents)
     base.send(:attr_accessor, :previous_referables)
     base.send(:alias_method_chain, :clone, :referable_content)
-    base.send(:after_save, :possibly_destroy_previous_referables)
-    base.send(:after_destroy, :possibly_destroy_referables)
     
-    base.send("referable_contents=", [])
     
-    base.class_eval do
-      
-      named_scope :published, lambda {
-        if self.respond_to?(:publishable?) && self.publishable?
-          {:conditions => {:published => true}}
-        elsif self.ancestors.include?(Skyline::Article::Data)
-          {:include => self.table_name.sub("_data", "").to_sym,
-           :conditions => "skyline_articles.published_publication_data_id = #{self.table_name}.id"}
-        else
-          {}
-        end
-      }
-
-      named_scope :with_site, lambda {|site|
-        if site && self.ancestors.include?(Skyline::Article::Data)
-          site.named_scope_with_site_for(self)
-        else
-          {}
-        end
-      }
-    end
+    base.send("referable_contents=", [])
   end  
   
   module ClassMethods   
 
-    # accepts options as the last parameter
-    #   options[:allow_nil] = true/false    (default: true)
-    def referable_content(*fields)
+    # Defines a relationship to a referable.
+    # 
+    # @see Skyline::BelongsToReferable For a usage example.
+    # 
+    # @overload belongs_to_referable(*fields, options = {})
+    #   @param *fields [String,Symbol] The referable(s) to create associations to.
+    # 
+    #   @option options :allow_nil [true, false] (true) Allow this association to be empty?
+    # 
+    # @return [void]
+    def belongs_to_referable(*fields)
       options = fields.extract_options!.reverse_merge(:allow_nil => true)
       fields.each do |f|
         self.referable_contents << f
@@ -136,22 +109,31 @@ module Skyline::ContentItem
       end
     end
     
-    def referable_serialized_content(*fields)
-      fields.each do |f|
-        self.class_eval <<-END
-          def #{f}_attributes=(attr)
-            self.#{f}_id = attr[:referable_id]
+  end
+  
+  # @private
+  def clone_with_referable_content
+    returning clone_without_referable_content do |clone|      
+      if self.referable_contents.any?
+        self.referable_contents.each do |field|
+          if self.send(field).present?
+            clone.send("#{field}_id=", nil)
+            clone.send("#{field}=", self.send(field).clone)
           end
-        END
+        end
       end
     end
   end
   
+  protected
+
   def set_refering_type_and_id
     self.referable_contents.each do |field|
-      if object_ref = self.send(field)
-        object_ref.refering_type = self.class.name
-        object_ref.refering_id = self.id unless self.new_record?
+      if object_ref = self.send(field) 
+        unless object_ref.marked_for_destruction?
+          object_ref.refering_type = self.class.name
+          object_ref.refering_id = self.id unless self.new_record?
+        end
       end
     end
   end
@@ -164,19 +146,6 @@ module Skyline::ContentItem
     end
   end
   
-  def clone_with_referable_content
-    returning clone_without_referable_content do |clone|      
-      if self.referable_contents.any?
-        self.referable_contents.each do |field|
-          if self.send(field).present?
-            clone.send("#{field}_id=", nil)
-            clone.send("#{field}=", self.send(field).clone)
-          end
-        end
-      end
-    end
-  end
-  
   def possibly_destroy_previous_referables
     return unless self.previous_referables
     self.previous_referables.each do |field, previous_referable|

data/lib/skyline/configuration.rb

@@ -1,8 +1,8 @@
 # Contains the default skyline configuration. Currently this is also
 # the place to look for available configuration options.
 #
-# @todo This configuration class will soon change as it's not flexible enough
-#   for out purposes.
+# @todo This configuration class will someday change as it's not flexible enough
+#   for our purposes.
 class Skyline::Configuration < Configure
   
   defaults do |config|
@@ -29,12 +29,12 @@ class Skyline::Configuration < Configure
     
     config.rss_section_cache_timeout = 1.hour  
     
-    config.solr_indexing = false
-    
     config.custom_logo = false
     config.skyline_logo = "/skyline/images/logo.png"
     config.branding_name = ""
     
+    config.locale = "en-US"
+    
     # ie: [{:path => "/stylesheets/skyline.css", :if => "lte IE 7"}]
     config.custom_stylesheets = []
     
@@ -55,7 +55,11 @@ class Skyline::Configuration < Configure
       end    
     end
     
+    # Default URL admin prefix (default = /skyline/...)
+    config.url_prefix = "/skyline"
+    
     # enable/disable 'modules'
+    config.enable_pages = true
     config.enable_multiple_variants = true
     config.enable_locking = true
     config.enable_enforce_only_one_user_editing = true
@@ -72,10 +76,8 @@ class Skyline::Configuration < Configure
     Skyline::Sections::RssSection.cache_path = self["rss_section_cache_path"]
     Skyline::Sections::RssSection.cache_timeout = self["rss_section_cache_timeout"]
     
-    Skyline::Renderer.register_renderables(:sections,self["sections"])
-    Skyline::Renderer.register_renderables(:articles,self["articles"] + ["Skyline::Page"])  
-    
-    load_dependencies
+    Skyline::Rendering::Renderer.register_renderables(:sections,self["sections"])
+    Skyline::Rendering::Renderer.register_renderables(:articles,self["articles"] + ["Skyline::Page"])      
   end  
   
   def articles
@@ -86,15 +88,12 @@ class Skyline::Configuration < Configure
     self["content_classes"].map(&:constantize)
   end
   
-  protected
-  
-  def load_dependencies
-    if self.solr_indexing
-      require "rsolr"
-      require "rsolr-ext"      
-    end
+  def url_prefix
+    self["url_prefix"].gsub(/\A\//, "")
   end
   
+  protected
+    
   # Check if a path is set, and if we're in production made raise an assertion
   # if the path does not exist. It just creates the path in development mode.
   def check_or_create_path(path, key="assets_path")

data/lib/skyline/content/content.rb

@@ -5,8 +5,20 @@ module Skyline::Content
       obj.extend(KlassMethods)
      
        if obj.ancestors.include?( ::ActiveRecord::Base)
-         obj.send(:after_save, "process_after_save")
-       end    
+         obj.class_eval do 
+           after_save :process_after_save
+           
+           named_scope :published, lambda {
+             if obj.publishable?
+               {:conditions => {:published => true}}
+             else
+               {}
+             end
+           }
+
+           named_scope :with_site, {}
+         end         
+       end
      end 
      
      module KlassMethods  #:nodoc:

data/lib/skyline/deprecated/version3_0_8.rb

@@ -0,0 +1,106 @@
+module Skyline
+
+  # @deprecated  Don't use Skyline::ContentItem anymore, use Skyline::BelongsToReferable (will be removed in 3.1.0)
+  module ContentItem
+    
+    def self.included(base)
+      warn "[DEPRECATION] Don't use Skyline::ContentItem anymore, use Skyline::BelongsToReferable (will be removed in 3.1.0) [#{caller[1]}]"
+      
+      base.send(:include, Skyline::BelongsToReferable)
+      
+      base.class_eval do
+        named_scope(:published, {}) unless method_defined?(:published)
+        
+        named_scope(:with_site, {}) unless method_defined?(:with_site)
+      end
+      
+      class << base 
+        alias_method :referable_content, :belongs_to_referable
+      end
+    
+    end    
+  end
+  
+  # @deprecated Don't use Skyline::Referable anymore, use Skyline::HasManyReferablesIn (will be removed in 3.1.0)
+  module Referable
+    def self.included(base)
+      warn "[DEPRECATION] Don't use Skyline::Referable anymore, use Skyline::HasManyReferablesIn (will be removed in 3.1.0) [#{caller[1]}]"
+            
+      base.send(:include, Skyline::HasManyReferablesIn)
+      class << base 
+        alias_method :referable_field, :has_many_referables_in
+      end      
+    end
+  end
+  
+  # @deprecated Don't use Skyline::SectionItem anymore, use Skyline::Sections::Interface (will be removed in 3.1.0)
+  module SectionItem
+    def self.included(base)
+      warn "[DEPRECATION] Don't use Skyline::SectionItem anymore, use Skyline::Sections::Interface (will be removed in 3.1.0) [#{caller[1]}]"
+      
+      base.send(:include, Skyline::Sections::Interface)
+    end
+  end
+  
+  # @deprecated Don't use Skyline::FormBuilderWithErrors anymore, use Skyline::FormBuilder (will be removed in 3.1.0)
+  module FormBuilderWithErrors
+    def self.included(base)
+      warn "[DEPRECATION] Don't use Skyline::FormBuilderWithErrors anymore, use Skyline::FormBuilder (will be removed in 3.1.0) [#{caller[1]}]"
+      
+      base.send(:include, Skyline::FormBuilder)
+    end
+  end
+  
+  # @deprecated Don't use Skyline::Renderer anymore, use Skyline::Rendering::Renderer (will be removed in 3.1.0)
+  class Skyline::Renderer < Skyline::Rendering::Renderer
+    class << self
+      %w{renderables register_renderables renderable_types helper}.each do |m|
+        define_method(m) do |*args|
+          deprecate!
+          super
+        end
+      end
+      
+      def deprecate!
+        warn "[DEPRECATION] Don't use Skyline::Renderer anymore, use Skyline::Rendering::Renderer (will be removed in 3.1.0) [#{caller[1]}]"
+      end
+    end
+    
+    def initialize(*args)
+      self.class.deprecate!
+      super
+    end
+    
+  end
+
+  # @deprecated Don't use Skyline::UrlValidation anymore, use UrlValidation (will be removed in 3.1.0)
+  module UrlValidation
+    def self.extended(base)
+      warn "[DEPRECATION] Don't use Skyline::UrlValidation anymore, use UrlValidation (will be removed in 3.1.0) [#{caller[1]}]"
+      
+      base.send(:extend, ::UrlValidation)
+    end
+  end
+  
+  
+  module Rendering
+    module Helpers
+      module SettingsHelper
+        # @deprecated Will be removed 3.1 in favour of {Skyline::Settings::KlassMethods#get}
+        def setting(setting_identifier, field)
+          warn "[DEPRECATION] Don't use #setting anymore, use Settings#get (will be removed in 3.1.0) [#{caller[1]}]"
+          ::Settings.get(setting_identifier,field)
+        end
+
+        # @deprecated Will be removed 3.1 in favour of {Skyline::Settings::KlassMethods#get_page}  
+        def page_from_setting(setting_identifier, field)
+          warn "[DEPRECATION] Don't use #page_from_setting anymore, use Settings#get_page (will be removed in 3.1.0) [#{caller[1]}]"
+          ::Settings.get_page(setting_identifier,field)
+        end
+      end
+    end
+  end
+  
+  # Include it in the RendererHelper for now, RendererHelper will always exist.
+  Rendering::Helpers::RendererHelper.send(:include, Rendering::Helpers::SettingsHelper)
+end

data/lib/skyline/{form_builder_with_errors.rb → form_builder.rb}

@@ -3,9 +3,9 @@
 #
 # Apart from adding new helper methods, this class overwrites the standard *_field 
 # and *_select helpers. If one of the fields has an error, the validation errors for 
-# that method are added just after the field. See {Skyline::FormBuilderWithErrors#wrap_with_error} 
+# that method are added just after the field. See {Skyline::FormBuilder#wrap_with_error} 
 # for more information on what get's added.
-class Skyline::FormBuilderWithErrors < ActionView::Helpers::FormBuilder
+class Skyline::FormBuilder < ActionView::Helpers::FormBuilder
 
   # Custom InstanceTag class from which we can extract the ID
   # @private
@@ -20,7 +20,7 @@ class Skyline::FormBuilderWithErrors < ActionView::Helpers::FormBuilder
   end
   
   unless ActiveSupport::Dependencies.load_once_path?(__FILE__)
-    ActiveSupport::Dependencies.autoloaded_constants << "Skyline::FormBuilderWithErrors::CustomInstanceTag"
+    ActiveSupport::Dependencies.autoloaded_constants << "Skyline::FormBuilder::CustomInstanceTag"
   end  
   
   # Overwrite all standard helpers with a wrapped version.
@@ -50,7 +50,7 @@ class Skyline::FormBuilderWithErrors < ActionView::Helpers::FormBuilder
   
   # Same as label but automatically translates the field name
   # 
-  # @see Skyline::FormBuilderWithErrors#t
+  # @see Skyline::FormBuilder#t
   # 
   # @return [String]
   def label_with_text(method, options = {})
@@ -103,7 +103,7 @@ class Skyline::FormBuilderWithErrors < ActionView::Helpers::FormBuilder
   end
   
   # Wrap an input element with errors, also appends "invalid" to the helpers
-  # class. See {Skyline::FormBuilderWithErrors#fieldset_errors} on how
+  # class. See {Skyline::FormBuilder#fieldset_errors} on how
   # the errors are added. 
   #
   # @param method [Symbol,String] The method/attribuet to check for errors

data/lib/skyline/{referable.rb → has_many_referables_in.rb}

@@ -1,12 +1,14 @@
-# Use this module in all models that have references to MediaFiles/Pages etc via WYSWIWYG-editors
-# It adds the class method `referable_field`. With {Skyline::Referable::ClassMethods#referable_field} you can use any
+# Use this module in all models that have references to MediaFiles/Page/URL etc via WYSWIWYG-editors
+# It adds the class method `has_many_referables_in`. With {Skyline::HasManyReferablesIn::ClassMethods#has_many_referables_in} you can use any
 # text/string database field to have links/images that will refer correctly to their respective
 # targets through RefObject
+# 
+# @see Skyline::BelongsToReferable If you want to use a reference to a MediaFile/Page/URL directly as an association.
 #
 # @example Usage: 
 #   class Model < ActiveRecord::Base
-#     include Skyline::Referable
-#     referable_field :body # :body is a database text/string field
+#     include Skyline::HasManyReferablesIn
+#     has_many_referables_in :body # :body is a database text/string field
 #   end
 #
 # @example Defines:
@@ -16,15 +18,21 @@
 #   @model.body #=> Evertyhing is converted back to it's original state
 #   @model.body(true) #=> The HTML includes extra attributes used for editing in the WYSIWYG-editor
 #
-module Skyline::Referable 
+module Skyline::HasManyReferablesIn 
  
   def self.included(base)
     base.extend(ClassMethods)
     base.send(:before_save, :parse_referable_fields)
+    
+    # Attention! We have to call it twice so it won't muck up when you create your own after_create/after_save
+    # callbacks.
+    base.send(:after_create, :update_referable_objects)    
     base.send(:after_save, :update_referable_objects)
+    
     base.send(:cattr_accessor, :referable_fields)
-    base.send(:has_many, :image_refs, :class_name => "Skyline::ImageRef", :foreign_key => :refering_id, :source_type => base.name, :dependent => :destroy)
-    base.send(:has_many, :link_refs, :class_name => "Skyline::LinkRef", :foreign_key => :refering_id, :source_type => base.name, :dependent => :destroy)
+    
+    base.send(:has_many, :image_refs, :class_name => "Skyline::ImageRef", :conditions => {:refering_type => base.name}, :foreign_key => :refering_id, :source_type => base.name, :dependent => :destroy)
+    base.send(:has_many, :link_refs, :class_name => "Skyline::LinkRef", :conditions => {:refering_type => base.name}, :foreign_key => :refering_id, :source_type => base.name, :dependent => :destroy)
     
     base.send :alias_method_chain, :clone, :referables    
   end
@@ -39,7 +47,7 @@ module Skyline::Referable
     # an options string which is passed to {Skyline::InlineRef#convert}
     #
     # @param fields [String,Symbol] The field(s) to enable the referable content for.
-    def referable_field(*fields)      
+    def has_many_referables_in(*fields)      
       self.referable_fields ||= []
       
       fields.each do |f|
@@ -47,6 +55,7 @@ module Skyline::Referable
         
         self.class_eval <<-END
           def #{f}=(body)
+            self.send("#{f}_will_change!")
             self.referable_field_bodies[:#{f}] = body            
           end
           def #{f}_before_typecast
@@ -64,7 +73,7 @@ module Skyline::Referable
   # Implementation of the clone interface
   # @private
   def clone_with_referables
-    returning clone_without_referables do |clone|      
+    clone_without_referables.tap do |clone|      
       if !self.referable_fields.nil?
         self.referable_fields.each do |field|         
           clone.send("#{field}=".to_sym, self.send(field,true,{:nullify => true}))
@@ -83,7 +92,7 @@ module Skyline::Referable
   # @todo Shouldn't this be protected?    
   def parse_referable_fields  
     return if self.referable_fields.nil?    
-      
+
     updated_refs = []
     self.referable_fields.each do |col|      
       if new_body = self.referable_field_bodies.delete(col)
@@ -98,8 +107,9 @@ module Skyline::Referable
   # @private
   # @todo Shouldn't this be protected?  
   def update_referable_objects
-    return if self.referable_fields.nil?
-    Skyline::InlineRef.update_all({:refering_id => self.id}, "id IN(#{@updated_ids})") unless @updated_ids.blank?
+    return if self.referable_fields.nil? || @updated_ids.blank?
+    Skyline::InlineRef.update_all({:refering_id => self.id}, "id IN(#{@updated_ids})")
+    @updated_ids = ""
   end
   
 end

data/lib/skyline/javascript_generator_methods.rb

@@ -8,6 +8,6 @@ module Skyline::JavascriptGeneratorMethods
   end
   
   def notification(type,message,options={})
-    record Skyline::MessageGenerator.new(type,message,options={})    
+    record Skyline::NotificationGenerator.new(type,message,options={})    
   end  
 end