spontaneous 0.2.0.beta5 → 0.2.0.beta6

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

@@ -0,0 +1,71 @@
+# encoding: UTF-8
+
+module Spontaneous::Model::Page
+  module Singleton
+    extend Spontaneous::Concern
+
+    module SiteMethods
+      def singletons
+        @singletons ||= {}
+      end
+
+      def singleton?(label)
+        singletons.key?(label.to_s)
+      end
+
+      def add_singleton_class(type, labels)
+        ([type.name.demodulize.underscore] + labels).map(&:to_sym).each do |label|
+          singletons[label.to_s] = true
+          define_singleton_method(label) { type.instance }
+        end
+      end
+    end
+
+    module AllowedTypeMethods
+      def exclude_type?(type)
+        return true if (type.singleton? && type.exists?)
+        super
+      end
+    end
+
+    module ContentClassMethods
+      def singleton?
+        @is_singleton || false
+      end
+    end
+
+    module ClassMethods
+      def singleton(*labels)
+        @is_singleton = true
+        extend  SingletonClassMethods
+        include SingletonInstanceMethods
+        set_singleton_aliases(labels)
+      end
+    end
+
+    module SingletonClassMethods
+      def set_singleton_aliases(labels)
+        schema.site.add_singleton_class(self, labels)
+      end
+
+      def instance
+        mapper.with_cache("#{self}_singleton_instance") { first }
+      end
+
+      def exists?
+        !instance.nil?
+      end
+
+      def export(user = nil)
+        super.merge(is_singleton: true)
+      end
+    end
+
+    module SingletonInstanceMethods
+      def before_save
+        raise Spontaneous::SingletonException.new(self) if (new? && model.exists?)
+        super
+      end
+    end
+  end
+end

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

@@ -35,7 +35,8 @@ module Spontaneous::Model::Page
         :type => self.class.ui_class,
         :type_id => self.class.schema_id,
         :children => self.children.length,
-        :depth => depth
+        :depth => depth,
+        :private => in_private_tree?
       }
     end
   end

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

@@ -7,7 +7,7 @@ module Spontaneous::Model::Page
     extend Spontaneous::Concern
 
     def before_save_field(field)
-      mark_site_modified if ((field.name == title_field) && field.modified?)
+      mark_site_modified if ((field.name == title_field_name) && field.modified?)
       super
     end
 
@@ -19,7 +19,7 @@ module Spontaneous::Model::Page
     end
 
     def after_update
-      mark_site_modified if field?(title_field) && fields[title_field].modified?
+      mark_site_modified if field?(title_field_name) && fields[title_field_name].modified?
       super
     end
 

data/lib/spontaneous/model/piece.rb

@@ -32,5 +32,15 @@ module Spontaneous::Model
         })
       end
     end
+
+    # Ensure that we map #render* to #render_inline* as this version of a page
+    # has no non-inline version
+    def render(format = :html, params = {}, parent_context = nil)
+      render_inline(format, params, parent_context)
+    end
+
+    def render_using(renderer, format = :html, params = {}, parent_context = nil)
+      render_inline_using(renderer, format, params, parent_context)
+    end
   end
 end

data/lib/spontaneous/output/context.rb

@@ -30,8 +30,8 @@ module Spontaneous::Output::Context
       site.home
     end
 
-    def site_page(path)
-      site[path]
+    def home
+      site.home
     end
 
     def asset_environment
@@ -107,6 +107,7 @@ module Spontaneous::Output::Context
       __loader.template(template_path).convert(Spontaneous::Output::Template::RequestSyntax)
     end
 
+    # 'defer' is a useful semantic way of calling 'template'
     alias_method :defer, :template
 
     def __format
@@ -121,13 +122,19 @@ module Spontaneous::Output::Context
       param.to_s
     end
 
+    RENDER_METHODS = [:render_inline_using, :render_using, :render_inline, :render].freeze
+
     # Has to be routed through the top-level renderer so as to make
     # use of shared caches that are held by it.
     def __render_content(content)
-      if content.respond_to?(:render_using)
-        content.render_using(_renderer, __format, {}, self)
-      else
-        content.render(__format, {}, self)
+      case (method = RENDER_METHODS.detect { |m| content.respond_to?(m) })
+      # use #__send__ to ensure that the method goes to any Renderable proxy object directly
+      when :render_inline_using, :render_using
+        content.__send__(method, _renderer, __format, {}, self)
+      when :render_inline, :render
+        content.__send__(method, __format, {}, self)
+      else # fallback to showing nothing
+        ""
       end
     end
   end

data/lib/spontaneous/output/format.rb

@@ -59,8 +59,6 @@ module Spontaneous::Output
         @name
       end
 
-      alias_method :extension, :name
-
       def to_sym
         @name
       end
@@ -103,6 +101,10 @@ module Spontaneous::Output
         @options[:postprocess]
       end
 
+      def options
+        @options
+      end
+
       def context(site = Spontaneous.instance)
         site.context (helper_formats + [name]).uniq.compact
       end
@@ -114,7 +116,7 @@ module Spontaneous::Output
     attr_reader :page
     attr_accessor :content
 
-    def_delegators "self.class", :format, :dynamic?, :extension, :to_sym, :mimetype, :mime_type, :public?, :private?, :context, :name, :extension
+    def_delegators "self.class", :format, :dynamic?, :extension, :to_sym, :mimetype, :mime_type, :public?, :private?, :context, :name, :extension, :options
 
     def initialize(page, content = nil)
       @page, @content = page, content
@@ -125,13 +127,18 @@ module Spontaneous::Output
       content.model
     end
 
+    # Hook into Pages' ability to re-define the object that they render as
+    def renderable_content
+      content.renderable
+    end
+
     def render(params = {}, parent_context = nil)
       render_using(default_renderer, params, parent_context)
     end
 
     def render_using(renderer, params = {}, parent_context = nil)
       before_render
-      output = render_page(renderer, params, parent_context)
+      output = render_content(renderer, params, parent_context)
       output = postprocess(output)
       after_render(output)
       output
@@ -154,7 +161,7 @@ module Spontaneous::Output
       output
     end
 
-    def render_page(renderer, params = {}, parent_context = nil)
+    def render_content(renderer, params = {}, parent_context = nil)
       renderer.render(self, params, parent_context)
     end
 
@@ -172,6 +179,24 @@ module Spontaneous::Output
       FileUtils.mkdir_p(dir) unless File.exist?(dir)
       path
     end
+
+    def ==(other)
+      eql?(other)
+    end
+
+    def eql?(other)
+      other.class == self.class && other.page == self.page
+    end
+
+    def hash
+      [self.class, page, options].hash
+    end
+
+    def url_path
+      path = page.path
+      path = "/index" if path == "/"
+      [path, name].join(".")
+    end
   end
 end
 

data/lib/spontaneous/output/helpers/script_helper.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 require 'coffee-script'
+require 'simultaneous'
 
 module Spontaneous::Output::Helpers
   module ScriptHelper
@@ -13,6 +14,13 @@ module Spontaneous::Output::Helpers
     end
 
     def script_urls(*args)
+      unless site.model.mapper.editable?
+        begin
+          ::Simultaneous.send_event('publish_progress', {:state => "compiling assets", :progress => "*"}.to_json)
+        rescue Errno::ECONNREFUSED
+        rescue Errno::ENOENT
+        end
+      end
       options = args.extract_options!
       options.update(:development => development?)
       asset_environment.js(args.flatten, options)

data/lib/spontaneous/output/helpers/stylesheet_helper.rb

@@ -13,6 +13,13 @@ module Spontaneous::Output::Helpers
     end
 
     def stylesheet_urls(*args)
+      unless site.model.mapper.editable?
+        begin
+          ::Simultaneous.send_event('publish_progress', {:state => "compiling assets", :progress => "*"}.to_json)
+        rescue Errno::ECONNREFUSED
+        rescue Errno::ENOENT
+        end
+      end
       options = args.extract_options!
       options.update(:development => development?)
       asset_environment.css(args.flatten, options)

data/lib/spontaneous/output/renderable.rb

@@ -80,6 +80,22 @@ module Spontaneous::Output
       @target.render_using(renderer, format, __render_locals__(locals), parent_context)
     end
 
+    def render_inline(format = :html, locals = {}, parent_context = nil)
+      @target.render_inline(format, __render_locals__(locals), parent_context)
+    end
+
+    def render_inline_using(renderer, format = :html, locals = {}, parent_context = nil)
+      @target.render_inline_using(renderer, format, __render_locals__(locals), parent_context)
+    end
+
+    def to_ary
+      @target.to_ary
+    end
+
+    def renderable
+      ::Spontaneous::Output::Renderable(@target.renderable, locals)
+    end
+
     private
 
     def __render_locals__(locals)

data/lib/spontaneous/output/store.rb

@@ -14,7 +14,7 @@ module Spontaneous::Output
     def self.new(backend_class, options = {})
       backend = case backend_class
       when :File
-        File.new(options[:root])
+        File.new(options[:root] || options[:dir])
       else
         Moneta.new(backend_class, options)
       end

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

@@ -19,7 +19,7 @@ module Spontaneous::Output::Template
 
     def render(output, params = {}, parent_context = nil)
       output.model.with_visible do
-        engine.render(output.content, context(output, params, parent_context), output.name)
+        engine.render(output.renderable_content, context(output, params, parent_context), output.name)
       end
     end
 
@@ -30,7 +30,7 @@ module Spontaneous::Output::Template
     end
 
     def context(output, params, parent)
-      context_class(output).new(Spontaneous::Output::Renderable.new(output.content), params, parent).tap do |context|
+      context_class(output).new(Spontaneous::Output::Renderable.new(output.renderable_content), params, parent).tap do |context|
         context.site = @site
         context._renderer = renderer_for_context
       end

data/lib/spontaneous/page_piece.rb

@@ -5,6 +5,7 @@ require 'delegate'
 module Spontaneous
   class PagePiece < DelegateClass(Page)
     include Spontaneous::Model::Core::Render
+    include Spontaneous::Model::Core::ContentHash::PagePieceMethods
 
     attr_accessor :owner
     attr_reader   :style_id
@@ -26,6 +27,11 @@ module Spontaneous
       owner.page
     end
 
+    # This is used to unwrap pages from their entries within boxes
+    def to_page
+      target
+    end
+
     def id
       target.id
     end
@@ -42,7 +48,7 @@ module Spontaneous
       self
     end
 
-    def export(user)
+    def export(user = nil)
       target.shallow_export(user).merge(export_styles).merge({
         :depth => self.depth
       })
@@ -75,5 +81,23 @@ module Spontaneous
     def template(format = :html, renderer = Spontaneous::Output.default_renderer)
       style.template(format, renderer)
     end
+
+    def inspect
+      %(#<PagePiece target=#{target.inspect}>)
+    end
+
+    def renderable
+      self
+    end
+
+    # Ensure that we map #render* to #render_inline* as this version of a page
+    # has no non-inline version
+    def render(format = :html, params = {}, parent_context = nil)
+      render_inline(format, params, parent_context)
+    end
+
+    def render_using(renderer, format = :html, params = {}, parent_context = nil)
+      render_inline_using(renderer, format, params, parent_context)
+    end
   end
 end

data/lib/spontaneous/prototypes/box_prototype.rb

@@ -84,6 +84,7 @@ module Spontaneous::Prototypes
         owner.const_set("#{name.to_s.camelize}Box", instance_class)
         box_owner = owner
         box_name = name
+        marked_as_generated = generated?
         instance_class.instance_eval do
           singleton_class.__send__(:define_method, :schema_name) do
             "box/#{box_owner.schema_id}/#{box_name}"
@@ -94,6 +95,11 @@ module Spontaneous::Prototypes
           singleton_class.__send__(:define_method, :owner_sid) do
             box_owner.schema_id
           end
+          singleton_class.__send__(:define_method, :method_added) do |method|
+            if [:contents].include?(method) # maybe need to expand the list of 'dangerous' methods
+              logger.warn("#{box_owner} box '#{box_name}': redefining the #contents method. You should set 'generated: true' in the box options unless the box contents are entirely under user control")
+            end
+          end unless marked_as_generated
         end
         @extend.each { |block|
           instance_class.class_eval(&block) if block
@@ -134,6 +140,13 @@ module Spontaneous::Prototypes
       @options[:style]
     end
 
+    # If a box is marked as 'generated' then its contents
+    # are not under user control & it should be skipped when
+    # calculating the owner's content hash
+    def generated?
+      @options[:generated] || false
+    end
+
     def default_title
       name.to_s.titleize.gsub(/\band\b/i, '&')
     end

data/lib/spontaneous/prototypes/field_prototype.rb

@@ -129,15 +129,19 @@ module Spontaneous::Prototypes
       instance_class
     end
 
-    def default(_instance = nil)
-      case default = @options[:default]
+    def default(instance = nil)
+      case (default = @options[:default])
       when Proc
-        default[_instance]
+        default[instance]
       else
         default
       end
     end
 
+    def dynamic_default?
+      @options[:default].is_a?(Proc)
+    end
+
     def comment
       @options[:comment]
     end
@@ -183,7 +187,6 @@ module Spontaneous::Prototypes
 
     def inherit_schema_id(schema_id)
       @_inherited_schema_id = schema_id.to_s
-      # instance_class.schema_id = schema_id
     end
 
     def merge(subclass_owner, field_type, subclass_options, &subclass_block)