spontaneous 0.2.0.alpha7 → 0.2.0.beta1

data/lib/spontaneous/model/core.rb

@@ -0,0 +1,143 @@
+# encoding: UTF-8
+
+module Spontaneous::Model
+  module Core
+    autoload :Aliases,          "spontaneous/model/core/aliases"
+    autoload :Boxes,            "spontaneous/model/core/boxes"
+    autoload :ContentGroups,    "spontaneous/model/core/content_groups"
+    autoload :EditorClass,      "spontaneous/model/core/editor_class"
+    autoload :Entries,          "spontaneous/model/core/entries"
+    autoload :Entry,            "spontaneous/model/core/entry"
+    autoload :Fields,           "spontaneous/model/core/fields"
+    autoload :InstanceCode,     "spontaneous/model/core/instance_code"
+    autoload :Media,            "spontaneous/model/core/media"
+    autoload :Modifications,    "spontaneous/model/core/modifications"
+    autoload :PageSearch,       "spontaneous/model/core/page_search"
+    autoload :Permissions,      "spontaneous/model/core/permissions"
+    autoload :Prototypes,       "spontaneous/model/core/prototypes"
+    autoload :Publishing,       "spontaneous/model/core/publishing"
+    autoload :Render,           "spontaneous/model/core/render"
+    autoload :SchemaHierarchy,  "spontaneous/model/core/schema_hierarchy"
+    autoload :SchemaId,         "spontaneous/model/core/schema_id"
+    autoload :SchemaTitle,      "spontaneous/model/core/schema_title"
+    autoload :Serialisation,    "spontaneous/model/core/serialisation"
+    autoload :Styles,           "spontaneous/model/core/styles"
+    autoload :Supertype,        "spontaneous/model/core/supertype"
+    autoload :Visibility,       "spontaneous/model/core/visibility"
+
+    extend Spontaneous::Concern
+
+    module ClassMethods
+      def page?
+        false
+      end
+
+      def is_page?
+        page?
+      end
+
+      # terminate the supertype chain here
+      def supertype
+        nil
+      end
+
+      def supertype?
+        !supertype.nil?
+      end
+
+      def root
+        content_model::Page.root
+      end
+
+      def log_sql(io = $stdout)
+        mapper.logger = ::Logger.new(io)
+        yield if block_given?
+      ensure
+        mapper.logger = nil
+      end
+    end
+
+    include Enumerable
+
+    include SchemaId
+    include Entry
+    include Boxes
+    include Fields
+    include Entries
+    include Styles
+    include SchemaTitle
+    include Render
+    include InstanceCode
+    include Serialisation
+    include Media
+    include Publishing
+    include Modifications
+    include Aliases
+    include Visibility
+    include Prototypes
+    include Permissions
+    include ContentGroups
+    include SchemaHierarchy
+    include PageSearch
+
+    # marker method enabling a simple test for "cms content" vs "everything else"
+    def spontaneous_content?
+      true
+    end
+
+    def alias?
+      false
+    end
+
+    def root
+      content_model::Page.root
+    end
+
+    def content_instance
+      self
+    end
+
+    # Provides consistency between aliases & non-aliases
+    # so that a mixed list of both can be treated the same
+    # (for instance when ensuring uniqueness)
+    def target
+      self
+    end
+
+    def page?
+      false
+    end
+
+    alias_method :is_page?, :page?
+
+    def start_inline_edit_marker
+      "spontaneous:previewedit:start:content id:#{id}"
+    end
+
+    def end_inline_edit_marker
+      "spontaneous:previewedit:end:content id:#{id}"
+    end
+
+    def to_s
+      %(#<#{self.class.name} id=#{id}>)
+    end
+
+    def each
+      iterable.each do |i|
+        yield i if block_given?
+      end
+    end
+
+    def formats
+      return page.formats if page
+      [:html]
+    end
+
+    def log_sql(io = $stdout)
+      mapper.logger = ::Logger.new(io)
+      yield if block_given?
+    ensure
+      mapper.logger = nil
+    end
+  end
+end

data/lib/spontaneous/{plugins → model/page}/controllers.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
-module Spontaneous::Plugins
+module Spontaneous::Model::Page
   module Controllers
-    extend ActiveSupport::Concern
+    extend Spontaneous::Concern
 
     ACTION_SEPARATOR = "@".freeze
 
@@ -17,7 +17,7 @@ module Spontaneous::Plugins
       end
 
       def default_controller_base_class
-        Spontaneous::PageController
+        Spontaneous::Rack::PageController
       end
 
       def controller(namespace, base_class = controller_base_class, &block)

data/lib/spontaneous/{plugins → model}/page/formats.rb

@@ -2,9 +2,9 @@
 
 require 'rack'
 
-module Spontaneous::Plugins::Page
+module Spontaneous::Model::Page
   module Formats
-    extend ActiveSupport::Concern
+    extend Spontaneous::Concern
 
     module ClassMethods
       def outputs(*outputs)

data/lib/spontaneous/{plugins → model/page}/layouts.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
-module Spontaneous::Plugins
+module Spontaneous::Model::Page
   module Layouts
-    extend ActiveSupport::Concern
+    extend Spontaneous::Concern
 
     module ClassMethods
       def layout(name = nil, options = {}, &block)

data/lib/spontaneous/model/page/locks.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+
+module Spontaneous::Model::Page
+  module Locks
+    extend Spontaneous::Concern
+
+    included do
+      one_to_many :update_locks, :model => Spontaneous::PageLock, :key => :page_id
+    end
+    def locked_for_update?
+      !update_locks.empty?
+    end
+  end
+end

data/lib/spontaneous/{plugins → model/page}/page_tree.rb

@@ -1,13 +1,13 @@
 # encoding: UTF-8
 
-module Spontaneous::Plugins
+module Spontaneous::Model::Page
   module PageTree
-    extend ActiveSupport::Concern
+    extend Spontaneous::Concern
 
     # InstanceMethods
 
     def ancestors
-      @ancestors ||= ancestor_path.map { |id| Spontaneous::Content[id] }
+      @ancestors ||= ancestor_path.map { |id| content_model[id] }
     end
 
     def ancestor(depth)

data/lib/spontaneous/{plugins → model/page}/paths.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
-module Spontaneous::Plugins
+module Spontaneous::Model::Page
   module Paths
-    extend ActiveSupport::Concern
+    extend Spontaneous::Concern
 
     module ClassMethods
       def generate_default_slug
@@ -28,17 +28,39 @@ module Spontaneous::Plugins
       super
     end
 
+    # Test for title changes and update the slug to match if it hasn't already
+    # been set.
+    #
+    # This doesn't happen when the item is created (i.e. #new? => true)
+    # because otherwise the slug would always take on the title fields
+    # default value.
     def before_save
       unless new?
-        if title = self.fields[:title]
-          if title.modified? and !title.blank? and self.class.is_default_slug?(slug)
-            self.slug = title.value
-          end
+        if (title = self.fields[title_field])
+          set_slug_from_title(title)
         end
       end
       super
     end
 
+    # Syncing the slug with the title is made more difficult because the field
+    # update mechanism works differently from the more direct, console version.
+    # This is called by the field updater before re-serializing each modified field.
+    def before_save_field(field)
+      set_slug_from_title(field) if (field.name == title_field)
+      super
+    end
+
+    def set_slug_from_title(title)
+      if title.modified? and !title.blank? and has_generated_slug?
+        self.slug = title.value
+      end
+    end
+
+    def has_generated_slug?
+      self.class.is_default_slug?(slug)
+    end
+
     def after_save
       super
       check_for_path_changes
@@ -56,9 +78,7 @@ module Spontaneous::Plugins
 
     def place_in_page_tree
       if self.parent_id.nil?
-        if Spontaneous::Page.root.nil?
-          make_root
-        end
+        make_root unless content_model.has_root?
       else
         update_path
       end
@@ -77,11 +97,9 @@ module Spontaneous::Plugins
     def root?
       path == Spontaneous::SLASH
     end
+
     alias_method :is_root?, :root?
 
-    def root
-      Spontaneous::Page.root
-    end
 
     def update_path
       self.path = calculate_path

data/lib/spontaneous/{plugins → model}/page/request.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
-module Spontaneous::Plugins::Page
+module Spontaneous::Model::Page
   module Request
-    extend ActiveSupport::Concern
+    extend Spontaneous::Concern
 
     # liked this but it didn't work particularly well so wasn't used in the end
     # perhaps, when I re-write the bloody Public handler i can use it

data/lib/spontaneous/{plugins → model/page}/site_map.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
-module Spontaneous::Plugins
+module Spontaneous::Model::Page
   module SiteMap
-    extend ActiveSupport::Concern
+    extend Spontaneous::Concern
 
     # InstanceMethods
     def map_children

data/lib/spontaneous/model/page/site_timestamps.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+
+module Spontaneous::Model::Page
+  # Various scenarios where we need to Update the Site's modification
+  # time to force clients to reload their map data
+  module SiteTimestamps
+    extend Spontaneous::Concern
+
+    def before_save_field(field)
+      mark_site_modified if ((field.name == title_field) && field.modified?)
+      super
+    end
+
+    # The UI map uses the slugs for the pulldown values so changes to the
+    # slug must force a reload or things get very odd.
+    def before_update
+      mark_site_modified if changed_columns.include?(:slug)
+      super
+    end
+
+    def after_update
+      mark_site_modified if field?(title_field) && fields[title_field].modified?
+      super
+    end
+
+    def after_create
+      mark_site_modified
+      super
+    end
+
+    # Update the Site's modification time to force clients
+    # to reload their map data
+    def after_destroy
+      mark_site_modified
+      super
+    end
+
+    protected
+
+    def mark_site_modified
+      ::Spontaneous::State.site_modified!
+    end
+  end
+end

data/lib/spontaneous/{page.rb → model/page.rb}

@@ -1,36 +1,50 @@
 # encoding: UTF-8
 
-module Spontaneous
-  class Page < Content
-    include Plugins::Supertype
-    include Plugins::Page::Formats
-    include Plugins::Layouts
-    include Plugins::Paths
-    include Plugins::PageTree
-    include Plugins::SiteMap
-    include Plugins::PageSearch
-    include Plugins::Controllers
-    include Plugins::Page::Request
-    include Plugins::Page::SiteTimestamps
-
-    many_to_one :parent,   :class => Content, :reciprocal => :children
-    one_to_many :children, :class => Content, :key => :parent_id, :reciprocal => :parent
-    one_to_many :content,  :class => Content, :key => :page_id,   :reciprocal => :page
+require "spontaneous/model/page/controllers"
+require "spontaneous/model/page/formats"
+require "spontaneous/model/page/layouts"
+require "spontaneous/model/page/locks"
+require "spontaneous/model/page/page_tree"
+require "spontaneous/model/page/paths"
+require "spontaneous/model/page/request"
+require "spontaneous/model/page/site_map"
+require "spontaneous/model/page/site_timestamps"
+
+module Spontaneous::Model
+  module Page
+    extend Spontaneous::Concern
+
+    include Spontaneous::Model::Core::Supertype
+    include Controllers
+    include Formats
+    include Layouts
+    include PageTree
+    include Paths
+    include Request
+    include SiteMap
+    include SiteTimestamps
+    include Locks
+
+    included do
+      many_to_one :parent, :model => self,   :key => :parent_id, :reciprocal => :unordered_children
+      one_to_many :unordered_children, :model => self, :key => :parent_id, :reciprocal => :parent
+      one_to_many :content, :model => self, :key => :page_id,   :reciprocal => :page
+    end
 
     # field :title, :string, :default => "New Page"
 
-    set_inheritance_root
-
-    def self.page?
-      true
-    end
+    module ClassMethods
+      def page?
+        true
+      end
 
-    def self.export(user = nil)
-      super(user).merge(:title_field => self.title_field.to_s)
-    end
+      def export(user = nil)
+        super(user).merge(:title_field => self.title_field.to_s)
+      end
 
-    def self.title_field
-      :title
+      def title_field
+        :title
+      end
     end
 
     def page?
@@ -39,10 +53,17 @@ module Spontaneous
 
     alias_method :is_page?, :page?
 
-    alias_method :unordered_children, :children
+    def parent
+      # Test for the common case where a page's owner is also its parent
+      if (owner_id == parent_id)
+        owner
+      else
+        super
+      end
+    end
 
     def children
-      @ordered_children ||= generate_ordered_children(super)
+      @ordered_children ||= generate_ordered_children(unordered_children)
     end
 
     def generate_ordered_children(unordered_children)

data/lib/spontaneous/{piece.rb → model/piece.rb}

@@ -1,18 +1,19 @@
 # encoding: UTF-8
 
+module Spontaneous::Model
+  module Piece
+    extend Spontaneous::Concern
 
-module Spontaneous
-  class Piece < Content
-    include Plugins::Supertype
+    include Spontaneous::Model::Core::Supertype
 
     # Public: for Pieces #parent is the same as the #owner
     # whereas for pages, parent is the next page up in the
     # page hierarchy.
     #
     # Returns: Content node one up in the page hierarchy
-    alias_method :parent,     :owner
-
-    set_inheritance_root
+    def parent
+      owner
+    end
 
     def export(user = nil)
       super(user).merge(export_styles)

data/lib/spontaneous/model.rb

@@ -0,0 +1,97 @@
+module Spontaneous
+
+  module Model
+    autoload :Core,  "spontaneous/model/core"
+    autoload :Page,  "spontaneous/model/page"
+    autoload :Piece, "spontaneous/model/piece"
+    autoload :Box,   "spontaneous/model/box"
+  end
+
+  def self.models
+    @models ||= {}
+  end
+
+  def self.Model(table_name, database = Spontaneous.database, schema = Site.schema)
+    define_content_model(table_name, database, schema)
+  end
+
+  def self.define_content_model(table_name, database = Spontaneous.database, schema = Site.schema)
+    model = Spontaneous::DataMapper::Model(table_name, database, schema) do
+      serialize_columns :field_store, :entry_store, :box_store, :serialized_modifications
+      include_all_types
+    end
+    model.class_eval do
+      many_to_one :owner,      :key => :owner_id, :model => self, :reciprocal => :_pieces
+      one_to_many :_pieces,    :key => :owner_id, :model => self, :reciprocal => :owner
+      many_to_one :page,       :key => :page_id,  :model => self, :reciprocal => :content
+      many_to_one :created_by, :key => :created_by_id, :model => Spontaneous::Permissions::User
+      # '__target' rather than 'target' because we want to override the behaviour of the
+      # Content#target method only on classes that are aliases, and this is defined dynamically
+      many_to_one :__target,   :key => :target_id, :model => self, :reciprocal => :aliases
+      one_to_many :aliases,    :key => :target_id, :model => self, :reciprocal => :__target, :dependent => :destroy
+    end
+    model.send :extend,  ContentModelClassMethods
+    model.send :include, ContentModelInstanceMethods
+    model
+  end
+
+  module ContentModelClassMethods
+    # Can't just use the @@ syntax here because it gets scoped to the
+    # enclosing module rather than the generated class...
+    def content_model
+      class_variable_get(:@@content_model)
+    end
+
+    # This is fiddly because we want the Content.content_model to refer to the
+    # first subclass of the Spontaneous::Content call as that is going to be our
+    # ::Content model. In this particular instance I want the behaviour of Ruby's
+    # class variables -- I want a single value to be shared across all subclasses
+    # Use this moment to include the core functionality because this is the first
+    # access to the subclass derived from the base model.
+    def inherited(subclass)
+      unless class_variable_defined?(:@@content_model)
+        class_variable_set(:@@content_model, subclass)
+        subclass.send :include, Spontaneous::Model::Core
+      end
+      super
+    end
+
+    def const_missing(name)
+      # Only the top-level content model has the auto generated
+      # Page & Piece models
+      return super unless content_model == self
+      case name
+      when :Page, :Piece
+        klass = Class.new(self) do
+          include_types { subclasses }
+          def self.inherited(subclass, real_caller = nil)
+            __determine_source_file(subclass, real_caller || caller[0])
+            subclass.include_types { [self] }
+            super
+          end
+        end
+        klass.send :include, ::Spontaneous::Model.const_get(name)
+        const_set(name, klass)
+        klass
+      when :Box
+        klass = Class.new(Spontaneous::Box)
+        klass.send :include, ::Spontaneous::Model.const_get(name)
+        klass.instance_variable_set(:"@mapper", mapper)
+        const_set(name, klass)
+        klass
+      else
+        super
+      end
+    end
+
+    def pages
+      content_model::Page.all
+    end
+  end
+
+  module ContentModelInstanceMethods
+    def content_model
+      model.content_model
+    end
+  end
+end

data/lib/spontaneous/output/context.rb

@@ -68,7 +68,7 @@ module Spontaneous::Output::Context
     def render_content
       __target.map do |c|
         __render_content(c)
-      end.join("\n")
+      end.reject(&:blank?).join("\n")
     end
 
     def first

data/lib/spontaneous/output/format.rb

@@ -117,6 +117,10 @@ module Spontaneous::Output
       @content ||= page
     end
 
+    def model
+      content.model
+    end
+
     def render(params = {}, *args)
       render_using(default_renderer, params, *args)
     end

data/lib/spontaneous/output/template/renderer.rb

@@ -17,13 +17,13 @@ module Spontaneous::Output::Template
     end
 
     def render(output, params = {})
-      Spontaneous::Content.with_visible do
+      output.model.with_visible do
         engine.render(output.content, context(output, params), output.name.to_s)
       end
     end
 
     def render_string(template_string, output, params = {})
-      Spontaneous::Content.with_visible do
+      output.model.with_visible do
         engine.render_string(template_string, context(output, params), output.name.to_s)
       end
     end

data/lib/spontaneous/output.rb

@@ -76,11 +76,11 @@ module Spontaneous
 
     # TODO: Is this ever used? Delete it & see what breaks
     def self.revision_dir(revision=nil, root = nil)
-      Site.instance.revision_dir(revision, root)
+      Spontaneous::Site.instance.revision_dir(revision, root)
     end
 
     def self.revision_root(revision)
-      Site.instance.revision_dir(revision)
+      Spontaneous::Site.instance.revision_dir(revision)
     end
 
     def self.context_class