spontaneous 0.1.0.alpha1

data/lib/spontaneous/field_types/image_field.rb

@@ -0,0 +1,329 @@
+# encoding: UTF-8
+
+require 'mini_magick'
+require 'delegate'
+
+module Spontaneous
+  module FieldTypes
+
+    module ImageFieldUtilities
+      attr_accessor :template_params
+
+      def render(format=:html, *args)
+        case format
+        when :html
+          to_html(*args)
+        else
+          value
+        end
+      end
+
+      def to_html(attr={})
+        default_attr = {
+          :src => src,
+          :width => width,
+          :height => height,
+          :alt => ""
+        }
+        default_attr.delete(:width) if width.nil?
+        default_attr.delete(:height) if height.nil?
+        if template_params && template_params.length > 0 && template_params[0].is_a?(Hash)
+          attr = template_params[0].merge(attr)
+        end
+        if attr.key?(:width) || attr.key?(:height)
+          default_attr.delete(:width)
+          default_attr.delete(:height)
+          if (attr.key?(:width) && !attr[:width]) || (attr.key?(:height) && !attr[:height])
+            attr.delete(:width)
+            attr.delete(:height)
+          end
+        end
+        attr = default_attr.merge(attr)
+        params = []
+        attr.each do |name, value|
+          params << %(#{name}="#{value.to_s.escape_html}")
+        end
+        %(<img #{params.join(' ')} />)
+      end
+
+      def to_s
+        src
+      end
+    end
+
+    class ImageField < Field
+      include ImageFieldUtilities
+
+      def self.accepts
+        %w{image/(png|jpeg|gif)}
+      end
+
+      def self.size(name, &process)
+        self.sizes[name.to_sym] = process
+
+        unless method_defined?(name)
+          class_eval <<-IMAGE
+            def #{name}
+              sizes[:#{name}]
+            end
+            IMAGE
+        end
+      end
+
+      def self.sizes
+        size_definitions
+      end
+
+      def self.validate_sizes(sizes)
+        sizes
+      end
+
+      def self.size_definitions
+        @size_definitions ||= {}
+      end
+
+      def image?
+        true
+      end
+
+      def sizes
+        @sizes ||= Hash.new { |hash, key| hash[key] = ImageAttributes.new(processed_values[key]) }
+      end
+
+      # value used to show conflicts between the current value and the value they're attempting to enter
+      def conflicted_value
+        value
+      end
+
+      # original is special and should always be defined
+      def original
+        @original ||= sizes[:original]
+      end
+
+      def width
+        original.width
+      end
+
+      def height
+        original.height
+      end
+
+      def filesize
+        original.filesize
+      end
+
+      def src
+        original.src
+      end
+
+      def filepath
+        unprocessed_value
+      end
+
+      # formats are irrelevant to image/file fields
+      def outputs
+        [:original].concat(self.class.size_definitions.map { |name, process| name })
+      end
+
+      def value(format=:html, *args)
+        sizes[:original].src
+      end
+
+      def generate(output, image_path)
+        return { :src => image_path } unless File.exist?(image_path)
+        image = ImageProcessor.new(image_path)
+        result = \
+          case output
+          when :original
+            image
+          else
+            process = self.class.size_definitions[output]
+            image.apply(process, output)
+          end
+        result.serialize
+      end
+
+      def preprocess(image_path)
+        filename = nil
+        case image_path
+        when Hash
+          filename = image_path[:filename]
+          image_path = image_path[:tempfile].path
+        when String
+          # return image_path unless File.exist?(image_path)
+        end
+        return image_path unless File.exist?(image_path)
+        media_path = owner.make_media_file(image_path, filename)
+        set_unprocessed_value(File.expand_path(media_path))
+        media_path
+      end
+    end
+
+
+    class ImageAttributes
+      include ImageFieldUtilities
+
+      attr_reader  :src, :width, :height, :filesize, :filepath
+
+      def initialize(params={})
+        params ||= {}
+        @src, @width, @height, @filesize, @filepath = params[:src], params[:width], params[:height], params[:filesize], params[:path]
+      end
+
+      def serialize
+        {
+          :src => src,
+          :width => width,
+          :height => height,
+          :filesize => filesize,
+          :path => filepath
+        }
+      end
+
+      def inspect
+        %(<#{self.class.name}: src=#{src.inspect} width="#{width}" height="#{height}">)
+      end
+    end
+
+    class ImageProcessor
+      include ImageFieldUtilities
+
+      class ImageDelegator < Delegator
+        attr_reader :image
+
+        def initialize(image)
+          super
+          @image = image
+        end
+
+        def __getobj__
+          @image
+        end
+
+        def __setobj__(obj)
+          @image = obj
+        end
+
+        def __run__(process)
+          combine_options do |c|
+            cb = CommandDelegator.new(c)
+            cb.__run__(process)
+          end
+        end
+      end
+
+      class CommandDelegator < Delegator
+        def initialize(command_builder)
+          super
+          @command_builder = command_builder
+        end
+
+        def __getobj__
+          @command_builder
+        end
+
+        def __setobj__(obj)
+          @command_builder = obj
+        end
+
+        def __run__(process)
+          instance_eval(&process)
+        end
+
+        def fit(width, height)
+          add(:geometry, "#{width}x#{height}>")
+        end
+
+        def crop(width, height)
+          dimensions = "#{width}x#{height}"
+          add(:geometry, "#{dimensions}^")
+          add(:gravity, "center")
+          add(:crop, "#{dimensions}+0+0!")
+        end
+
+        def width(width)
+          add(:geometry, "#{width}x>")
+        end
+
+        def height(height)
+          add(:geometry, "x#{height}>")
+        end
+
+        def greyscale
+          add(:type, "Grayscale")
+        end
+
+        def method_missing(method, *args, &block)
+          __getobj__.send(method, *args, &block)
+        end
+      end
+
+      MAX_DIM = 2 ** ([42].pack('i').size * 8) - 1 unless defined?(MAX_DIM)
+
+      attr_reader :path
+
+      def initialize(path)
+        @path = File.expand_path(path)
+      end
+
+      def src
+        @src ||= \
+          begin
+            media_dir = Spontaneous.media_dir
+            src = path.sub(%r{^#{media_dir}}, '')
+            File.join("/#{File.basename(media_dir)}", src)
+          end
+      end
+
+      def filesize
+        File.size(path)
+      end
+
+      def width
+        dimensions[0]
+      end
+
+      def height
+        dimensions[1]
+      end
+
+      def dimensions
+        @dimensions ||= Spontaneous::ImageSize.read(path)
+      end
+
+      def apply(process, name)
+        image = ::MiniMagick::Image.open(path)
+        processor = ImageProcessor::ImageDelegator.new(image)
+        processor.__run__(process)
+        file_path = filename_for_size(name)
+        image.write(file_path)
+
+        ImageProcessor.new(file_path)
+      end
+
+      def filename_for_size(name)
+        directory = File.dirname(path)
+        original_filename = File.basename(path)
+        parts = original_filename.split('.')
+        ext = parts[-1]
+        base = parts[0..-2].join('.')
+        filename = [base, name, ext].join('.')
+        File.join(directory, filename)
+      end
+
+      def serialize
+        {
+          :src => src,
+          :width => width,
+          :height => height,
+          :filesize => filesize,
+          :path => path
+        }
+      end
+    end
+
+    ImageField.register(:image, :photo)
+
+  end
+end
+

data/lib/spontaneous/field_types/markdown_field.rb

@@ -0,0 +1,37 @@
+# encoding: UTF-8
+
+require 'kramdown'
+
+module Spontaneous
+  module FieldTypes
+    class MarkdownField < Field
+      def outputs
+        [:html]
+      end
+
+      def generate_html(input)
+        input.to_html
+      end
+
+      def preprocess(input)
+        # convert lines ending with newlines into a <br/>
+        # as official Markdown syntax isn't suitable for
+        # casual users
+        # code taken from:
+        # http://github.github.com/github-flavored-markdown/
+        output = input.gsub(/^[\w\<][^\n]*\n+/) do |x|
+          x =~ /\n{2}/ ? x : (x.strip!; x << "  \n")
+        end
+
+        # prevent foo_bar_baz from ending up with an italic word in the middle
+        output.gsub!(/(^(?! {4}|\t)\w+_\w+_\w[\w_]*)/) do |x|
+          x.gsub('_', '\_') if x.split('').sort.to_s[0..1] == '__'
+        end
+        Kramdown::Document.new(output)
+      end
+    end
+
+    MarkdownField.register(:markdown, :text, :richtext)
+  end
+end
+

data/lib/spontaneous/field_types/string_field.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+
+
+module Spontaneous
+  module FieldTypes
+    class StringField < Field
+      def generate_html(value)
+        escape_html(value)
+      end
+    end
+    StringField.register
+  end
+end
+

data/lib/spontaneous/field_types.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+
+
+
+module Spontaneous
+  module FieldTypes
+
+    autoload :Field, "spontaneous/field_types/field"
+
+    @@type_map = {}
+
+    def self.register(klass, *labels)
+      labels.each do |label|
+        @@type_map[label.to_sym] = klass
+      end
+    end
+
+    def self.[](label)
+      @@type_map[label.to_sym] || StringField
+    end
+
+    def self.serialize_field(field)
+      [field.schema_id.to_s, field.version, field.unprocessed_value, field.processed_values]
+    end
+
+    def self.deserialize_field(serialized_field)
+      {
+        :id => serialized_field[0],
+        :version => serialized_field[1],
+        :unprocessed_value => serialized_field[2],
+        :processed_values => serialized_field[3]
+      }
+    end
+
+  end
+end
+
+[:string, :image, :date, :markdown].each do |type|
+  require "spontaneous/field_types/#{type}_field"
+end

data/lib/spontaneous/generators/page/inline.html.cut

@@ -0,0 +1 @@
+<li><a href="{{ page.path }}">{{ page.title }}</a></li>

data/lib/spontaneous/generators/page/page.html.cut.tt

@@ -0,0 +1,4 @@
+{% extends 'page' %}
+{% block :content %}
+<h2>{{ title }}</h2>
+{% endblock :content %}

data/lib/spontaneous/generators/page/page.rb.tt

@@ -0,0 +1,9 @@
+
+class <%= class_name %> < Page
+  # see 'templates/<%= disk_name.underscore %>/page.html.cut'
+  page_style :page
+
+  # see 'templates/<%= disk_name.underscore %>/inline.html.cut'
+  inline_style :inline
+end
+

data/lib/spontaneous/generators/page.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+
+module Spontaneous
+  module Generators
+    class Page < Generator
+      def self.banner; "spot generate page [page_type | PageType]"; end
+
+
+    def class_name
+      case type_name
+      when /^[A-Z]/
+        type_name
+      else
+        type_name.camelize
+      end
+    end
+
+    def disk_name
+      case type_name
+      when /^[A-Z]/
+        type_name.underscore
+      else
+        type_name
+      end
+    end
+
+    argument :type_name, :type => :string, :desc => "The name for this page type (page_type_name OR PageTypeName)"
+      desc "Generates a new page type"
+      def generate_page
+        self.destination_root = options[:root]
+        empty_directory "schema"
+        template 'page.rb.tt', "schema/#{disk_name}.rb"
+        copy_file 'inline.html.cut', "templates/#{disk_name}.html.#{Spontaneous::Render.extension}"
+      end
+    end
+  end
+end

data/lib/spontaneous/generators/site/.gitignore

@@ -0,0 +1,4 @@
+log/*
+tmp/*
+cache/*
+

data/lib/spontaneous/generators/site/Gemfile.tt

@@ -0,0 +1,31 @@
+source :rubygems
+
+## choose your poison:
+# gem 'pg', '~> 0.9.0'
+gem 'mysql2', '~> 0.2'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+
+## TODO: replace this path based gem with a version once the gem is live
+#gem 'spontaneous', '<%= Spontaneous::VERSION %>'
+gem 'spontaneous', :path => "/Users/garry/Dropbox/Development/spontaneous3/working"
+
+# Choose a Rack handler
+gem 'thin'
+# gem 'mongrel'
+
+# group :development, :test do
+#   gem 'webrat'
+# end
+
+# source gemfiles from Plugins & Features
+Dir['*/**/Gemfile'].each do |path|
+  gemfile = File.expand_path(path)
+  unless gemfile == File.expand_path(__FILE__)
+    dependencies = File.read(gemfile).gsub(/^\s*source.+$/, '')
+    eval(dependencies)
+  end
+end
+

data/lib/spontaneous/generators/site/Rakefile.tt

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+
+require File.expand_path('../config/boot.rb', __FILE__)
+
+require 'spontaneous/tasks'
+

data/lib/spontaneous/generators/site/config/back.ru

@@ -0,0 +1,7 @@
+ENV["SPOT_MODE"] = "back"
+
+require File.expand_path("../boot.rb", __FILE__)
+
+logger.info { "Spontaneous::Back running on port #{Spontaneous::Rack.port}" }
+
+run Spontaneous::Rack::Back.application.to_app

data/lib/spontaneous/generators/site/config/boot.rb

@@ -0,0 +1,19 @@
+SPOT_ENV = (ENV["SPOT_ENV"] ||= ENV["RACK_ENV"] ||= "development").to_sym unless defined?(SPOT_ENV)
+SPOT_MODE = (ENV["SPOT_MODE"] ||= "back").to_sym unless defined?(SPOT_MODE)
+
+Encoding.default_external = Encoding::UTF_8 if defined?(Encoding)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+
+Bundler.require(:default, SPOT_ENV, SPOT_MODE)
+
+# TODO: configuration of template engine
+# so, remove this require and move the template init into part of the ::load! method
+# using config settings to determine engine
+require 'cutaneous'
+
+Spontaneous.init(:environment => SPOT_ENV, :mode => SPOT_MODE)
+

data/lib/spontaneous/generators/site/config/database.yml.tt

@@ -0,0 +1,21 @@
+---
+:development: &defaults
+  :adapter:    mysql2
+  :database:   <%= @site_name %>
+  :user:       root
+  :host:       localhost
+
+:test:
+  <<:         *defaults
+  :database:   <%= @site_name %>_test
+
+:production:
+  <<:         *defaults
+  :database:  <%= @site_name %>
+  :user:      <%= @site_name %>
+  :password:  passw0rd
+
+:rake:
+  <<:         *defaults
+
+

data/lib/spontaneous/generators/site/config/environment.rb.tt

@@ -0,0 +1,8 @@
+
+site_domain '<%= @domain %>'
+site_id '<%= @site_name %>'
+
+
+# change this to alter the content-type encoding sent in public HTTP headers
+# TODO: enable this setting on a per-page, per-format basis
+default_charset "utf-8"

data/lib/spontaneous/generators/site/config/environments/development.rb.tt

@@ -0,0 +1,15 @@
+
+publishing_method :threaded
+
+# ensures that schema classes are reloaded with every request
+reload_classes true
+
+host 'localhost'
+
+back do
+	port 2011
+end
+
+front do
+	port 2012
+end

data/lib/spontaneous/generators/site/config/environments/production.rb.tt

@@ -0,0 +1,5 @@
+
+publishing_method :fire_and_forget
+
+# used by publishing mech to determine a restart strategy
+handler :unicorn

data/lib/spontaneous/generators/site/config/front.ru

@@ -0,0 +1,8 @@
+ENV["SPOT_MODE"] = "front"
+
+require File.expand_path("../boot.rb", __FILE__)
+
+logger.info { "Spontaneous::Front running on port #{Spontaneous::Rack.port}" }
+
+run Spontaneous::Rack::Front.application.to_app
+

data/lib/spontaneous/generators/site/config/user_levels.yml

@@ -0,0 +1,22 @@
+# User levels
+
+# Feel free to add your own
+# the 'root' user level is added automatically and
+# will always be higher than any you add here
+# Similary the 'none' level will always be lower
+# The order is important -- later leves are higher levels
+# higher levels will always be able to do everything that a lower level can do
+# 'publish' defines the particular level's access to the publishing process
+# This is set per-level -- higher levels don't inherit the value from lower levels
+
+- :name:    editor
+  :publish: false
+
+- :name:    admin
+  :publish: true
+
+- :name:    designer
+  :publish: true
+
+# - :name:    my_level
+#   :publish: true

data/lib/spontaneous/generators/site/lib/site.rb.tt

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+
+class Site < Spontaneous::Site
+end

data/lib/spontaneous/generators/site/lib/tasks/site.rake.tt

@@ -0,0 +1,8 @@
+
+namespace :<%= @site_name %> do
+  desc "Example task"
+  task :example => [ :environment ] do
+    puts "An example task"
+  end
+end
+

data/lib/spontaneous/generators/site/schema/.map

@@ -0,0 +1 @@
+# TODO: create template for schema map

data/lib/spontaneous/generators/site/schema/page.rb.tt

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+
+class Page < Spontaneous::Page
+  # pages must respond to the title method
+  # so if you remove this 'title' field, then you must replace it with
+  # a #title method
+  field :title, :string, :default => "New Page"
+end

data/lib/spontaneous/generators/site/schema/piece.rb.tt

@@ -0,0 +1,4 @@
+# encoding: UTF-8
+
+class Piece < Spontaneous::Piece
+end