yuzu 0.2.1.pre

data/lib/yuzu/preprocessors/insert_contents.rb

@@ -0,0 +1,57 @@
+require 'preprocessors/base'
+require 'helpers/path'
+
+module Yuzu::PreProcessors
+  class InsertContentsPreProcessor < PreProcessor
+    include Helpers
+
+    def initialize
+      @name = :insert_contents
+      @directive = "INSERTCONTENTS"
+    end
+
+    def default(website_file=nil)
+      nil
+    end
+
+    def value(website_file)
+      match_path = match(website_file.raw_contents)
+      raw_path = match_path.nil? ? default(website_file) : match_path
+      Path.new(match_path)
+    end
+
+    def replacement(website_file, new_contents="")
+      # Get the next match.
+      match_path = match(new_contents)
+      raw_path = match_path.nil? ? default(website_file) : match_path
+      file_path = Path.new(raw_path)
+
+      siteroot = website_file.root
+      file_to_insert = siteroot.find_file_by_path(file_path)
+
+      if not file_to_insert.nil?
+        "\n" + file_to_insert.prefiltered_contents
+      else
+        insert_file(file_path)
+      end
+    end
+
+    # A raw file insert. Load the file from disk and insert the contents directly.
+    #
+    # @param [Path] path refers to the file on disk.
+    # @return [String] The contents of the file.
+    def insert_file(path)
+      if path.exists?
+        f = File.open(path.absolute, "r")
+        contents = f.read
+        f.close
+        contents
+      else
+        ""
+      end
+    end
+  end
+
+  PreProcessor.register(:insert_contents => InsertContentsPreProcessor)
+end
+

data/lib/yuzu/renderers/base.rb

@@ -0,0 +1,23 @@
+
+module Yuzu::Renderers
+  include Yuzu::Registrar
+
+  class Renderer < Register
+    @@renderers = {}
+    def self.registry
+      :renderers
+    end
+    def self.renderers
+      @@renderers
+    end
+
+    def initialize
+    end
+
+    def render(website_file)
+      ""
+    end
+  end
+
+end
+

data/lib/yuzu/renderers/breadcrumb.rb

@@ -0,0 +1,163 @@
+require 'renderers/base'
+require 'helpers/path'
+require 'html/base'
+
+module Yuzu::Renderers
+  class BreadcrumbRenderer < Renderer
+    def render(website_file)
+      Breadcrumb.new(website_file).to_s
+    end
+  end
+  Renderer.register(:breadcrumb => BreadcrumbRenderer)
+
+  class Breadcrumb
+    def initialize(website_obj, level=0)
+      @website_obj = website_obj
+      @level = level
+    end
+
+    def to_s
+      @website_obj.nil? ? "" : crumbs_to_s
+    end
+
+    def crumbs_to_s
+      ordered_crumbs.collect {|crumb| crumb.to_s}.join(separator)
+    end
+
+    def separator
+      "&nbsp;#{config.breadcrumb_separator}&nbsp;"
+    end
+
+    def reverse?
+      true        # TODO make configurable
+    end
+
+    def ordered_crumbs
+      crumbs
+      #reverse? ? crumbs.reverse : crumbs
+    end
+
+    def crumbs
+      tr = []
+      level_correct = 0
+      ordered_structure.each_index do |i|
+        crumb_tag = ordered_structure[i]
+        crumb = crumb_for(crumb_tag, @level + i + level_correct)
+        if crumb.nil?
+          level_correct -= 1
+        end
+        tr.push(crumb)
+      end
+      tr.reject {|el| el.nil?}
+    end
+
+    def crumb_for(crumb_tag, level)
+      case crumb_tag
+      when :home
+        Crumb.new(@website_obj.root, level)
+
+      when :blog
+        Crumb.new(@website_obj.blog_folder, level)
+
+      when :category
+        folder? ? nil : CategoryCrumb.new(@website_obj, level)
+
+      when :post
+        if index?
+          # Defer to parent.
+          nil
+        else
+          Crumb.new(@website_obj, level)
+        end
+
+      when :parent
+        @website_obj.parent.nil? ? nil : Breadcrumb.new(@website_obj.parent, level)
+
+      else
+        nil
+
+      end
+    end
+
+    def ordered_structure
+      reverse? ? structure.reverse : structure
+    end
+
+    def structure
+      if file? and in_blog? and not is_blog? and not index?
+        [:home, :blog, :category, :post]
+
+      else
+        [:parent, :post]
+
+      end
+    end
+
+    def in_blog?
+      @website_obj.in_blog?
+    end
+
+    def is_blog?
+      @website_obj.is_blog?
+    end
+
+    def config
+      @website_obj.config
+    end
+
+    def index?
+      @website_obj.index?
+    end
+
+    def folder?
+      @website_obj.folder?
+    end
+
+    def file?
+      @website_obj.file?
+    end
+  end
+
+
+  class Crumb
+    def initialize(website_obj, level=0)
+      @website_obj = website_obj
+      @level = level
+    end
+
+    def to_s
+      Html::Link.new(
+        :href => @website_obj.link_url,
+        :class => "breadcrumb_#{@level}"
+      ) << @website_obj.name
+    end
+  end
+
+
+  # A crumb for blog categories. For multiple categories, this currently adds links for all of them,
+  # separated by a slash.
+  class CategoryCrumb < Crumb
+    include Helpers
+
+    def initialize(website_file, level=0)
+      @website_file = website_file
+      @categories = website_file.categories
+      @level = level
+    end
+
+    def to_s
+      Html::Span.new(:class => "breadcrumb_#{@level}") << links.join(separator)
+    end
+
+    def links
+      @categories.collect {|cat| cat.link}
+    end
+
+    def separator
+      "&nbsp;/&nbsp;"
+    end
+  end
+
+end
+
+

data/lib/yuzu/renderers/gallery.rb

@@ -0,0 +1,24 @@
+require 'renderers/base'
+require 'html/base'
+
+module Yuzu::Renderers
+  class GalleryRenderer < Renderer
+    def template_name
+      "_gallery.haml"
+    end
+
+    def gallery_template
+      @template ||= Yuzu::Core::HamlTemplate.new(template_name)
+    end
+
+    def render(website_file)
+      if gallery_template.exists?
+        gallery_template.render(website_file, {:images => website_file.images})
+      else
+        Html::Comment.new << "Couldn't find gallery template #{gallery_template.path.absolute}"
+      end
+    end
+  end
+  Renderer.register(:gallery => GalleryRenderer)
+end
+

data/lib/yuzu/renderers/title.rb

@@ -0,0 +1,21 @@
+require 'renderers/base'
+
+module Yuzu
+
+  module Renderers
+    # Renders the html <title> tag.
+    class TitleRenderer < Renderer
+      def render(website_file)
+        config = website_file.config
+        if website_file.root? or website_file.home?
+          config.site_name
+        else
+          "#{website_file.post_title} | #{config.site_name}"
+        end
+      end
+    end
+    Renderer.register(:title => TitleRenderer)
+  end
+
+end
+

data/lib/yuzu/translators/base.rb

@@ -0,0 +1,57 @@
+# Translators translate one markup language to another, e.g. markdown to html.
+
+module Yuzu::Translators
+  include Yuzu::Registrar
+
+  class Translator < Register
+    @@translators = {}
+    def self.registry
+      :translators
+    end
+    def self.translators
+      @@translators
+    end
+
+    def self.translate(contents, file_extension)
+      filetype = identify_filetype(file_extension)
+      if not filetype.nil?
+        Translator.translators[filetype].translate(contents)
+      else
+        contents
+      end
+    end
+
+    def self.can_translate?(website_file)
+      source_extension = website_file.path.extension
+      # TODO map source -> output extensions, e.g. haml-to-xml, etc.
+      #target_extension = website_file.extension
+      filetype = identify_filetype(source_extension)
+      not filetype.nil?
+    end
+
+    def self.identify_filetype(file_extension)
+      Translator.translators.each_pair do |filetype, translator|
+        return filetype if translator.translates?(file_extension)
+      end
+      return nil
+    end
+
+    def self.filetypes
+      Translator.translators.keys
+    end
+
+    def translates?(file_extension)
+      extensions.include?(file_extension)
+    end
+
+    def extensions
+      []
+    end
+
+    def translate(contents)
+      contents
+    end
+  end
+
+end
+

data/lib/yuzu/translators/markdown.rb

@@ -0,0 +1,21 @@
+require 'translators/base'
+require 'kramdown'
+
+module Yuzu::Translators
+
+  class MarkdownTranslator < Translator
+    def extensions
+      %w(.md .mdown .mkd .markdown .markd)
+    end
+
+    def translate(contents)
+      rendered = Kramdown::Document.new(contents).to_html
+      rendered = rendered.gsub("<p><noscript></p>", "<noscript>").gsub("<p></noscript></p>", "</noscript>")
+      rendered.gsub(/\n\s*<\/code>/, "</code>").gsub(/<code>(?!\s)/, "<code>  ")
+    end
+  end
+  Translator.register(:markdown => MarkdownTranslator)
+
+end
+
+

data/lib/yuzu/translators/plaintext.rb

@@ -0,0 +1,17 @@
+require 'translators/base'
+
+module Yuzu::Translators
+
+  class PlaintextTranslator < Translator
+    def extensions
+      %(txt text)
+    end
+
+    def translate(contents)
+      contents
+    end
+  end
+  Translator.register(:plaintext => PlaintextTranslator)
+
+end
+

data/lib/yuzu/version.rb

@@ -0,0 +1,12 @@
+
+module Yuzu
+  module Version
+    MAJOR = 0
+    MINOR = 2
+    PATCH = 1
+    BUILD = "pre"
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join(".")
+  end
+end
+

data/resources/config/compass.rb

@@ -0,0 +1,6 @@
+http_path = "/"
+css_dir = "css"
+sass_dir = "_sass"
+images_dir = "img"
+javascripts_dir = "js"
+preferred_syntax = :sass

data/resources/config/yuzu.yml

@@ -0,0 +1,166 @@
+# Yuzu Config
+
+site_name: Yuzu Starter Site
+author: First Last
+
+blog_dir: blog
+template_dir: _templates
+
+# Connection Configurations
+
+# Yuzu uses the project's folder structure as a template for the website structure.
+# In the process of producing the site, it must resolve to problems:
+#
+#    1. Where to place the actual files in the destination
+#    2. How to resolve the URL links so they point at the correct files.
+#
+# Yuzu provides two ways of resolving these: remote_root_path and link_root.
+# 
+# remote_root_path determines where the remote folder is located on the server, relative 
+# to the FTP user's home directory. If the FTP user is configured to place files directly 
+# into the root of the site, leave this blank.
+# 
+# link_root is a string that can be prepended to all links. This enables you to place
+# files wherever you want to in the destination and still get the URLs right.
+# For example, in posts, you can specify links URLs like this:
+# 
+#     LINKROOT/images/my_image.png
+# 
+# If link_root is blank, the URL defaults to the site root. This is especially
+# useful for local setups where the root path isn't localhost, for example:
+# link_root: http://localhost/~awmartin/my_site
+
+# Which connection to use for publication. This should be set to s3, ftp, or 
+# filesystem. For publishing a site to this service use 'publish'.
+#
+# e.g. yuzu publish:all
+#
+connection: filesystem
+
+services:
+  # The preview folder is used to support local design and development before
+  # publishing to a remote server.
+  #
+  # e.g. yuzu preview:all
+  preview:
+    destination: HOME/Sites/yuzu-preview
+    link_root: file://HOME/Sites/yuzu-preview
+
+  # The stage is used to produce a copy of the actual site on the file system
+  # for manual FTP-ing to a web server. This gives you the opportunity to get
+  # all the paths right for the server.
+  #
+  # e.g. yuzu stage:all
+  stage:
+    destination: HOME/Sites/yuzu-staging
+    link_root: /~USERNAME/yuzu-staging
+  
+  # All the file system needs is the absolute path of the destination parent folder.
+  filesystem:
+    destination: HOME/Sites/yuzu-published
+    link_root: file://HOME/Sites/yuzu-published
+
+  # For FTP service to a web server or file server.
+  ftp:
+    domain: site.example.com
+    host: example.com
+    username: test%example.com
+    password: 123456
+    link_root: 
+    remote_root_path: 
+
+  # For service at Amazon S3. By default, this is configured to get the access_key and 
+  # secret_key from environment variables, like ENV['AMAZON_ACCESS_KEY_ID']. Just put 
+  # the name of the environment variable in those two fields.
+  s3:
+    domain: mybucket.s3.amazonaws.com
+    bucket: mybucket
+    access_key: AMAZON_ACCESS_KEY_ID
+    secret_key: AMAZON_SECRET_ACCESS_KEY
+    link_root: 
+    remote_root_path: 
+    
+    # Proxy configuration if needed. This only works for S3 right now. Not needed for filesystem.
+    # Put 'yes' next to use_proxy: to turn on the proxy settings.
+    proxy:
+      use_proxy: no
+      host: proxy.nyit.edu
+      port: 80
+      username: 
+      password: 
+
+# This is a list of the local folders to ignore completely, so the recursive updates
+# won't traverse them. The SASS 'src' folder is a good one to exclude.
+folder_blacklist:
+  - _sass
+  - _templates
+  - .sass-cache
+  - .yardoc
+
+# Some folders have to be traversed to update resources, but we don't want to create
+# auto-generated index.html files for them. This is the list of such folders.
+no_index_folders:
+  - js
+  - sass
+  - css
+  - img
+
+# These files will not be rendered, even if they have a processable extension.
+no_render:
+  - robots.txt
+
+# Files with these extensions will be ignored.
+extension_blacklist:
+  - .rb
+  - .sassc
+  - .yml
+
+# Files with these extensions will be put through the Textile or HAML markup generators.
+processable_extensions:
+  - .text
+  - .textile
+  - .haml
+  - .txt
+  - .markdown
+  - .mdown
+  - .md
+
+# Images.
+image_extensions:
+  - .png
+  - .gif
+  - .jpg
+  - .jpeg
+
+# Assets are files that rarely change, like PDFs and Java archives, that should be uploaded
+# once and then ignored. Assets are generally ignored unless you ask them to be uploaded,
+# since they can also be uploaded more easily with a graphic FTP client.
+asset_extensions:
+  - .pdf
+  - .jar
+  - .pde
+  - .java
+  - .html
+
+# Resources are files like CSS and Javascript that still may change when 
+# adding functionality or changing the styling of the site. These aren't put 
+# through the markup processors and are just uploaded when asked to.
+resource_extensions:
+  - .css
+  - .js
+
+# Thumbnail image names and widths.
+# Every entry here will cause the generate:thumbnails command to produce a
+# resized image with the key appended to the name. For example, an entry of
+# small: 320 will cause the command to take "my-photo.png" and produce a new
+# image, "my-photo-small.png" with a width of 320 pixels. "medium: 600" will 
+# produce "my-photo-medium.png" with a width of 600 pixels.
+thumbnails:
+  small: 350
+  medium: 700
+  large: 1050
+
+# Config under development.
+remove_h1_tags: true
+breadcrumb_separator: "·"
+