spontaneous 0.1.0.alpha1

data/lib/spontaneous/style.rb

@@ -0,0 +1,144 @@
+# encoding: UTF-8
+
+
+module Spontaneous
+  class Style
+    def self.to_directory_name(klass)
+      return nil if klass.name.blank?
+      klass.name.demodulize.underscore
+    end
+
+    attr_reader :owner, :prototype
+
+    def initialize(owner, prototype = nil)
+      @owner, @prototype = owner, prototype
+    end
+
+    def schema_id
+      self.prototype.schema_id
+    end
+
+    def template(format = :html)
+      unless template = inline_template(format)
+        template = find_template(format)
+      end
+      template
+    end
+
+    def find_template(format = :html)
+      unless template = local_template(format)
+        template = supertype_template(format)
+      end
+      unless template
+        logger.warn("No template file found for style #{owner}/#{name}.#{format}")
+        template = anonymous_template
+      end
+      template
+    end
+
+    alias_method :path, :template
+
+    def local_template(format)
+      template_path = nil
+      Spontaneous.template_paths.each do |template_root|
+        template_path = try_template_paths.detect do |path|
+          Spontaneous::Render.exists?(template_root, path, format)
+        end
+        return (template_root / template_path) if template_path
+      end
+      nil
+    end
+
+    def supertype_template(format)
+      supertype = owner.supertype
+      if supertype && supertype != Spontaneous::Content
+        self.class.new(supertype, prototype).template(format)
+      else
+        nil
+      end
+    end
+
+    def inline_template(format)
+      if template_string = owner.inline_templates[format.to_sym]
+        Anonymous.new(template_string).template(format)
+      end
+    end
+
+    def anonymous_template
+      Proc.new { "" }
+    end
+
+    def name
+      prototype.name
+    end
+
+    def try_template_paths
+      try_paths.map { |path| Array === path ? File.join(path.compact) : path }.uniq
+    end
+
+    def try_paths
+      name = prototype.name.to_s
+      [[owner_directory_name, name], name]
+    end
+
+    def owner_directory_name
+      self.class.to_directory_name(owner)
+    end
+
+
+    def default?
+      @options[:default]
+    end
+
+    def formats
+      Spontaneous::Render.formats(self)
+    end
+
+    # def export
+    #   {
+    #     :name => name.to_s,
+    #     :schema_id => schema_id.to_s
+    #   }
+    # end
+
+    def ==(other)
+      other.class == self.class && other.prototype == self.prototype && other.owner == self.owner
+    end
+
+    class Default < Style
+      def name
+        "<default>"
+      end
+
+      def schema_id
+        nil
+      end
+
+      def try_paths
+        [owner_directory_name]
+      end
+    end
+
+    class Anonymous
+      def initialize(template_code = "")
+        @template_code = template_code
+      end
+
+      def template(format = :html)
+        Proc.new { @template_code }
+      end
+
+      def exists?(format = :html)
+        true
+      end
+
+      def name
+        nil
+      end
+
+      def schema_id
+        nil
+      end
+    end
+  end
+end

data/lib/spontaneous/tasks/database.rake

@@ -0,0 +1,9 @@
+
+namespace :spot do
+  desc "Migrate the core Spontaneous database"
+  task :migrate do
+    Spontaneous.database.logger = Spontaneous.logger
+    Sequel.extension :migration
+    Sequel::Migrator.apply(Spontaneous.database, Spontaneous.gem_dir('db/migrations'))
+  end
+end

data/lib/spontaneous/tasks.rb

@@ -0,0 +1,5 @@
+Dir["#{File.dirname(__FILE__)}/tasks/**/*.rake"].each { |ext| load ext }
+
+# Load the custom, site-specific tasks
+Dir["#{Spontaneous.root}/lib/tasks/**/*.rake"].each { |ext| load ext }
+# TODO: load the role tasks

data/lib/spontaneous/version.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+
+module Spontaneous
+  VERSION = "0.1.0.alpha1"
+  GEM = true
+end

data/lib/spontaneous.rb

@@ -0,0 +1,179 @@
+# encoding: UTF-8
+
+
+if RUBY_VERSION < '1.9'
+  $KCODE='u'
+else
+  Encoding.default_external = Encoding::UTF_8
+  Encoding.default_internal = Encoding::UTF_8
+end
+
+require "home_run"
+require "stringex"
+require "sequel"
+require "yajl"
+
+require 'logger'
+require 'fileutils'
+require 'active_support/core_ext/date_time/conversions'
+require 'active_support/core_ext/file'
+
+Sequel.extension :inflector
+
+Dir[File.join(File.dirname(__FILE__), 'spontaneous/extensions/*.rb')].each { |file|
+  require file
+}
+
+require 'spontaneous/logger'
+require 'spontaneous/plugins'
+require 'spontaneous/constants'
+require 'spontaneous/errors'
+require 'spontaneous/json'
+
+Dir[File.expand_path('../spontaneous/plugins/application/*.rb', __FILE__)].each do |file|
+  require file
+end
+
+module Spontaneous
+  extend Plugins
+  include Constants
+
+  def self.gem_root
+    @gem_root ||= File.expand_path(File.dirname(__FILE__) / '..')
+  end
+
+  def self.reload!
+    Spontaneous::Schema.reload!
+    Spontaneous::Loader.reload!
+    Spontaneous::Schema.validate!
+  end
+
+  plugin Plugins::Application::State
+  plugin Plugins::Application::Paths
+  plugin Plugins::Application::Render
+  plugin Plugins::Application::Facets
+  plugin Plugins::Application::Serialisation
+
+  autoload :ProxyObject, "spontaneous/proxy_object"
+
+  autoload :Config, "spontaneous/config"
+  autoload :Paths, "spontaneous/paths"
+  autoload :Facet, "spontaneous/facet"
+
+  autoload :Content, "spontaneous/content"
+  autoload :Page, "spontaneous/page"
+  autoload :Piece, "spontaneous/piece"
+  autoload :Box, "spontaneous/box"
+
+  autoload :FieldTypes, "spontaneous/field_types"
+
+  autoload :PagePiece, "spontaneous/page_piece"
+
+
+  autoload :Style, "spontaneous/style"
+  autoload :BoxStyle, "spontaneous/box_style"
+  autoload :Layout, "spontaneous/layout"
+
+  autoload :Site, "spontaneous/site"
+  autoload :State, "spontaneous/state"
+  autoload :Schema, "spontaneous/schema"
+
+  autoload :ImageSize, "spontaneous/image_size"
+
+  autoload :Rack, "spontaneous/rack"
+
+  autoload :Render, "spontaneous/render"
+  autoload :Media, "spontaneous/media"
+
+  autoload :Change, "spontaneous/change"
+  autoload :Revision, "spontaneous/revision"
+  autoload :Publishing, "spontaneous/publishing"
+
+  autoload :Generators, "spontaneous/generators"
+
+  autoload :Server, "spontaneous/server"
+
+  autoload :Permissions, "spontaneous/permissions"
+  autoload :ContentQuery, "spontaneous/content_query"
+
+  autoload :PageController, "spontaneous/page_controller"
+
+  autoload :Application, "spontaneous/application"
+
+  module Prototypes
+    autoload :FieldPrototype, "spontaneous/prototypes/field_prototype"
+    autoload :BoxPrototype, "spontaneous/prototypes/box_prototype"
+    autoload :StylePrototype, "spontaneous/prototypes/style_prototype"
+    autoload :LayoutPrototype, "spontaneous/prototypes/layout_prototype"
+  end
+
+  module Collections
+    autoload :PrototypeSet, "spontaneous/collections/prototype_set"
+    autoload :ChangeSet, "spontaneous/collections/change_set"
+    autoload :EntrySet, "spontaneous/collections/entry_set"
+    autoload :FieldSet, "spontaneous/collections/field_set"
+    autoload :BoxSet, "spontaneous/collections/box_set"
+    autoload :StyleSet, "spontaneous/collections/style_set"
+  end
+
+  module Plugins
+    autoload :Supertype, "spontaneous/plugins/supertype"
+    autoload :Boxes, "spontaneous/plugins/boxes"
+    autoload :Fields, "spontaneous/plugins/fields"
+    autoload :Entries, "spontaneous/plugins/entries"
+    autoload :Entry, "spontaneous/plugins/entry"
+    autoload :Styles, "spontaneous/plugins/styles"
+    autoload :Layouts, "spontaneous/plugins/layouts"
+    autoload :SchemaTitle, "spontaneous/plugins/schema_title"
+    autoload :SchemaId, "spontaneous/plugins/schema_id"
+    autoload :Render, "spontaneous/plugins/render"
+    autoload :SchemaHierarchy, "spontaneous/plugins/schema_hierarchy"
+    autoload :InstanceCode, "spontaneous/plugins/instance_code"
+    autoload :Paths, "spontaneous/plugins/paths"
+    autoload :PageTree, "spontaneous/plugins/page_tree"
+    autoload :AllowedTypes, "spontaneous/plugins/allowed_types"
+    autoload :Serialisation, "spontaneous/plugins/serialisation"
+    autoload :SiteMap, "spontaneous/plugins/site_map"
+    autoload :PageSearch, "spontaneous/plugins/page_search"
+    autoload :Media, "spontaneous/plugins/media"
+    autoload :Publishing, "spontaneous/plugins/publishing"
+    autoload :Aliases, "spontaneous/plugins/aliases"
+    autoload :Visibility, "spontaneous/plugins/visibility"
+    autoload :Prototypes, "spontaneous/plugins/prototypes"
+    autoload :Permissions, "spontaneous/plugins/permissions"
+    autoload :Controllers, "spontaneous/plugins/controllers"
+
+
+    module Page
+      autoload :Formats, "spontaneous/plugins/page/formats"
+      autoload :Request, "spontaneous/plugins/page/request"
+    end
+
+    module Site
+      autoload :Publishing, "spontaneous/plugins/site/publishing"
+      autoload :Revisions,  "spontaneous/plugins/site/revisions"
+      autoload :Selectors,  "spontaneous/plugins/site/selectors"
+      autoload :Map,        "spontaneous/plugins/site/map"
+      autoload :Instance,   "spontaneous/plugins/site/instance"
+    end
+  end
+
+
+  class UnknownTypeException < Exception
+    def initialize(parent, type)
+      super("Unknown content type '#{type}' requested in class #{parent}")
+    end
+  end
+  class UnknownStyleException < Exception
+    def initialize(style_name, klass)
+      super("Unknown style '#{style_name}' for class #{klass}")
+    end
+  end
+
+end
+
+require 'spontaneous/loader'
+require 'spontaneous/version'
+
+
+Spot = S = Spontaneous unless defined?(Spot)

data/spontaneous.gemspec.tmpl

@@ -0,0 +1,66 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'NAME'
+  s.version           = '0.0'
+  s.date              = '2010-01-01'
+  s.rubyforge_project = 'NAME'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Spontaneous is a next-generation Ruby CMS"
+  s.description = "Spontaneous is a next-generation Ruby CMS"
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Garry Hill"]
+  s.email    = 'garry@magnetised.net'
+  s.homepage = 'http://spontaneouscms.org'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %%w[lib]
+
+  # ## This sections is only necessary if you have C extensions.
+  # s.require_paths << 'ext'
+  # s.extensions = %%w[ext/extconf.rb]
+
+  ## If your gem includes any executables, list them here.
+  s.executables = ["spot"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %%w[README LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  %s
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  %s
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %%w[]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/test/disabled/test_slots.rb

@@ -0,0 +1,287 @@
+# encoding: UTF-8
+
+require 'test_helper'
+
+
+class SlotsTest < MiniTest::Spec
+  include Spontaneous
+
+  context "Slot containers" do
+    setup do
+      class ::SlotClass < Content; end
+      class ::ContentClass < Content; end
+      ContentClass.field :description
+    end
+
+    teardown do
+      Object.send(:remove_const, :SlotClass)
+      Object.send(:remove_const, :ContentClass)
+    end
+
+    should "start empty" do
+      SlotClass.slots.length.should == 0
+    end
+
+    should "have a flag showing there are no defined slots" do
+      SlotClass.has_slots?.should be_false
+    end
+
+    should "be definable with a name" do
+      SlotClass.slot :images0
+      SlotClass.slots.length.should == 1
+      SlotClass.slots.first.name.should == :images0
+      SlotClass.has_slots?.should be_true
+    end
+
+    should "accept a custom instance class" do
+      SlotClass.slot :images1, :type => SlotClass
+      SlotClass.slots.first.instance_class.superclass.should == SlotClass
+    end
+
+    should "accept a custom instance class as a string" do
+      SlotClass.slot :images2, :type => 'SlotClass'
+      SlotClass.slots.first.instance_class.superclass.should == SlotClass
+    end
+
+    should "accept a custom instance class as a symbol" do
+      SlotClass.slot :images3, :type => :SlotClass
+      SlotClass.slots.first.instance_class.superclass.should == SlotClass
+    end
+
+    should "have 'title' option" do
+      SlotClass.slot :images4, :title => "Custom Title"
+      @instance = SlotClass.new
+      @instance.pieces.first.slot_name.should == "Custom Title"
+    end
+
+    should "accept values for the slot's fields" do
+      SlotClass.slot :images4, :type => :ContentClass, :fields => { :description => "Neato" }
+
+      @instance = SlotClass.new
+      @instance.images4.fields.description.value.should == "Neato"
+    end
+
+    should "allow access to groups of slots" do
+      SlotClass.slot :images5, :tag => :main
+      SlotClass.slot :posts, :tag => :main
+      SlotClass.slot :comments
+      SlotClass.slot :last, :tag => :main
+      @instance = SlotClass.new
+      @instance.slots.tagged(:main).length.should == 3
+      @instance.slots.tagged('main').map {|e| e.label.to_sym }.should == [:images5, :posts, :last]
+    end
+
+    context "with superclasses" do
+      setup do
+        SlotClass.slot :images6, :tag => :main
+
+        @subclass1 = Class.new(SlotClass) do
+          slot :monkeys, :tag => :main
+          slot :apes
+        end
+        @subclass2 = Class.new(@subclass1) do
+          slot :peanuts
+        end
+      end
+      should "inherit slots from its superclass" do
+        @subclass2.slots.length.should == 4
+        @subclass2.slots.map { |s| s.name }.should == [:images6, :monkeys, :apes, :peanuts]
+        @subclass2.slots.tagged(:main).length.should == 2
+        instance = @subclass2.new
+        instance.slots.length.should == 4
+      end
+
+      should "allow customisation of the slot order" do
+        new_order = [:peanuts, :apes, :images6, :monkeys]
+        @subclass2.slot_order *new_order
+        @subclass2.slots.map { |s| s.name }.should == new_order
+      end
+
+      should "take order of instance slots from class defn" do
+        new_order = [:peanuts, :apes, :images6, :monkeys]
+        instance = @subclass2.create
+        @subclass2.slot_order *new_order
+        instance = @subclass2[instance.id]
+        instance.slots.map { |e| e.label.to_sym }.should == new_order
+      end
+    end
+
+    # should "default to the name of the slot for the style name" do
+    #   SlotClass.slot :images
+    #   instance = SlotClass.new
+    #   instance.images.style.filename.should == "images.html.cut"
+    # end
+    should "default to a template-less style for slots without a style" do
+      SlotClass.slot :images7
+      instance = SlotClass.new
+      instance.images7.style.class.should == Spontaneous::Plugins::Styles::AnonymousStyle
+    end
+
+    should "accept a custom template name" do
+      SlotClass.slot :images8, :style => :anonymous_slot
+      instance = SlotClass.new
+      instance.images8.style.filename.should == "anonymous_slot.html.cut"
+    end
+
+    should "take template path from slot's parent for anonymous slots" do
+      SlotClass.slot :images9, :style => :anonymous_slot
+      SlotClass.slot :posts
+      instance = SlotClass.new
+      instance.images9.style.path.should == "slot_class/anonymous_slot"
+      # instance.posts.style.path.should #== "#{Spontaneous.template_root}/slot_class/posts.html.cut"
+    end
+
+    context "anonymous slots" do
+      setup do
+        class ::AllowedType < Content; end
+        SlotClass.slot :images10 do
+          allow AllowedType
+
+          def monkey
+            "magic"
+          end
+        end
+      end
+
+      teardown do
+        Object.send(:remove_const, :AllowedType)
+      end
+
+      should "allow configuration of allowed types for anonymous slots" do
+        SlotClass.slots.first.instance_class.allowed.length.should == 1
+      end
+
+      should "allow methods in slot definitions" do
+        instance = SlotClass.new
+        instance.images10.monkey.should == "magic"
+      end
+
+      should "correctly save pieces" do
+        instance = SlotClass.new
+        c1 = AllowedType.new
+        c2 = AllowedType.new
+        c3 = AllowedType.new
+        instance.images10 << c1
+        instance.images10 << c2
+        instance.images10 << c3
+
+        instance.save
+        instance.images10.save
+        c1.save
+        c2.save
+        c3.save
+
+        instance = SlotClass[instance.id]
+        instance.images10.pieces.length.should == 3
+      end
+    end
+
+    context "slots with definied classes" do
+      setup do
+        class ::AllowedType < Content; end
+        SlotClass.slot :images11, :type => AllowedType do
+          allow AllowedType
+
+          def monkey
+            "magic"
+          end
+        end
+      end
+
+      teardown do
+        Object.send(:remove_const, :AllowedType)
+      end
+
+      should "allow per-slot definitions" do
+        SlotClass.slots.first.instance_class.allowed.length.should == 1
+        instance = SlotClass.new
+        instance.images11.monkey.should == "magic"
+        instance = SlotClass[instance.id]
+        instance.images11.monkey.should == "magic"
+      end
+    end
+    context "" do
+      setup do
+        SlotClass.slot :images12
+        @instance = SlotClass.new
+      end
+
+      should "provide a test for existance of named slot" do
+        @instance.slot?(:images12).should be_true
+        @instance.slot?(:none).should be_false
+      end
+
+      should "instantiate a corresponding piece in new instances" do
+        @instance.pieces.length.should == 1
+        # @instance.pieces.first.class.should == Piece
+        @instance.pieces.first.label.should == :images12
+        @instance.pieces.first.slot_name.should == "Images12"
+      end
+
+      should "have a #slots method for accessing slots" do
+        @instance.slots.length.should == 1
+        @instance.slots.first.label.should == :images12
+        @instance.slots.first.slot_id.should == "images12"
+        @instance.slots[:images12].should == @instance.slots.first
+      end
+
+      should "have shortcut methods for accessing slots by name" do
+        @instance.slots.images12.should == @instance.slots.first
+        @instance.images12.should == @instance.slots.first
+      end
+
+      should "persist slots" do
+        @instance.save
+        @instance = SlotClass[@instance.id]
+        @instance.slots.length.should == 1
+        @instance.slots.first.label.should == :images12
+        @instance.slots[:images12].should == @instance.slots.first
+        @instance.slots.images12.should == @instance.slots.first
+        @instance.images12.should == @instance.slots.first
+      end
+
+      should "update list of slots on instance if slot added after creation" do
+        @instance.save
+        SlotClass.slot :posts
+        @instance = SlotClass[@instance.id]
+        @instance.slots.length.should == 2
+        @instance.slots.first.label.should == :images12
+        @instance.slots.last.label.should == :posts
+        @instance.slots[:images12].should == @instance.slots.first
+        @instance.slots[:posts].should == @instance.slots.last
+        @instance.slots.images12.should == @instance.slots.first
+        @instance.slots.posts.should == @instance.slots.last
+        @instance.images12.should == @instance.slots.first
+        @instance.posts.should == @instance.slots.last
+      end
+
+      ## waiting on entry deletion routines
+      should "update list of slots on instance if slot removed after creation"
+      # should "update list of slots on instance if slot removed after creation" do
+      #   @instance.save
+      #   SlotClass.slot :posts
+      #   @instance = SlotClass[@instance.id]
+      #   @instance.slots.length.should == 2
+      #   SlotClass.slots.shift
+      #   p SlotClass.slots
+      #   @instance = SlotClass[@instance.id]
+      #   @instance.slots.length.should == 1
+      #   @instance.slots.first.label.should == "posts"
+      #   @instance.slots[:posts].should == @instance.slots.first
+      #   @instance.slots.posts.should == @instance.slots.first
+      #   @instance.posts.should == @instance.slots.first
+      # end
+    end
+
+    context "addition of slots" do
+      should "be possible after creation" do
+        SlotClass.slot :posts
+        instance = SlotClass.new
+        instance.save
+        SlotClass.slot :images
+        instance = SlotClass[instance.id]
+        instance.images.should_not be_nil
+      end
+    end
+  end
+end