proton 0.3.0.rc1

data/lib/proton/partial.rb

@@ -0,0 +1,12 @@
+class Proton
+class Partial < Layout
+protected
+  def self.root_path(project, *a)
+    project.path(:partials, *a)
+  end
+
+  def default_layout
+    nil
+  end
+end
+end

data/lib/proton/project.rb

@@ -0,0 +1,176 @@
+class Proton
+# Class: Proton::Project
+# A project.
+#
+# ## Common usage
+#
+# Instanciating:
+#
+#     project = Project.new('~/spur')
+#     project == Proton.project          # the last defined project
+#
+# Building:
+#
+#     project.build
+#     project.build { |file| puts "Building #{file}..." }
+#
+# Getting pages:
+#
+#     Proton::Page['/index.html']        # ~/spur/index.md; uses Proton.project
+#
+# Configuration:
+#
+#     project.config_file              # ~/spur/hyde.conf
+#     project.config                   # Config from above file (OpenStruct)
+#     project.config.site_path
+#
+# Paths:
+#
+#     project.path(:site)              # ~/spur/site (based on config site_path)
+#     project.path(:extensions)
+#
+#     project.root('a/b', 'c')         # ~/spur/a/b/c
+#
+# Indexing:
+#
+#     project.pages                    # [<#Page>, <#Page>, ...]
+#     project.files                    # ['/index.md', '/style.sass', ...]
+#                                      # (only site files)
+#     project.ignored_files
+#
+class Project
+  def initialize(root=Dir.pwd)
+    @root = root
+    Proton.project = self
+
+    validate_version
+    load_extensions
+
+    load File.expand_path('../compass_support.rb', __FILE__)
+  end
+
+  def validate_version
+    return unless config_file?
+    req = config.requirement.to_s
+
+    v = lambda { |version| Gem::Version.new version }
+
+    if req.empty?
+      # pass
+    elsif v[req] < v["0.1"]
+      raise LegacyError, "This is a legacy project"
+    elsif v[req] > v[Proton.version]
+      raise VersionError, "You will need Proton version >= #{req} for this project."
+    end
+  end
+
+  def load_extensions
+    path = path(:extensions)
+
+    ( Dir[path(:extensions, '*.rb')] +
+      Dir[path(:extensions, '*', '*.rb')]
+    ).sort.each { |f| require f }  if path
+  end
+
+  # Method: config_file (Proton::Project)
+  # Returns the configuration file for the project.
+
+  def config_file
+    try = lambda { |path| p = root(path); p if File.file?(p) }
+    Proton::CONFIG_FILES.inject(nil) { |acc, file| acc ||= try[file] }
+  end
+
+  def config_file?
+    config_file
+  end
+
+  # Method: config (Proton::Project)
+  # Returns a Proton::Config instance.
+
+  def config
+    @config ||= Config.load(config_file)
+  end
+
+  # Method: path (Proton::Project)
+  # Returns the path for a certain aspect.
+  #
+  # ## Example
+  #
+  #     Proton.project.path(:site)
+
+  def path(what, *a)
+    return nil unless [:output, :site, :layouts, :extensions, :partials].include?(what)
+    path = config.send(:"#{what}_path")
+    root path, *a  if path
+  end
+
+  # Method: root (Proton::Project)
+  # Returns the root path of the project.
+
+  def root(*args)
+    File.join @root, *(args.compact)
+  end
+
+  # Method: pages (Proton::Project)
+  # Returns the pages for the project.
+
+  def pages
+    files.map { |f| Page[f, self] }.compact
+  end
+
+  # Method: files (Proton::Project)
+  # Returns the site files for the project, free from the ignored files.
+
+  def files
+    files = Dir[File.join(path(:site), '**', '*')]
+    files = files.select { |f| File.file?(f) }
+    files = files.map { |f| File.expand_path(f) }
+    files - ignored_files
+  end
+
+  # Method: ignored_files (Proton::Project)
+  # Returns the files to be ignored for the project.
+
+  def ignored_files
+    specs  = [*config.ignore].map { |s| root(s) }
+    specs << config_file
+
+    # Ignore the standard files
+    [:layouts, :extensions, :partials, :output].each do |aspect|
+      specs << File.join(config.send(:"#{aspect}_path"), '**/*') if path(aspect) && path(aspect) != path(:site)
+    end
+
+    # Ignore dotfiles and hyde.conf files by default
+    specs += %w[.* _* *~ README* /config.ru]
+    specs += Proton::CONFIG_FILES.map { |s| "/#{s}" }
+
+    specs.compact.map { |s| glob(s) }.flatten.uniq
+  end
+
+  # Method: build (Proton::Project)
+  # Builds.
+
+  def build(&blk)
+    pages.each do |page|
+      yield page
+      page.write
+    end
+  ensure
+    build_cleanup
+  end
+
+protected
+  def glob(str)
+    if str[0] == '/'
+      Dir[str] + Dir[root(str)] + Dir["#{root(str)}/**"]
+    else
+      Dir[root("**/#{str}")] + Dir[root("**/#{str}/**")]
+    end
+  end
+
+  def build_cleanup
+    FileUtils.rm_rf '.sass_cache'
+  end
+end
+end
+

data/lib/proton/server.rb

@@ -0,0 +1,99 @@
+require 'cuba'
+require 'rack'
+require 'proton'
+
+# Module: Proton::Server
+# The Proton server rack application.
+
+class Proton
+  Server = Cuba.dup
+
+  module Server; end
+
+  module Server::PageHelpers
+    def not_found
+      show_status nil
+      res.status = 404
+      res.write "<h1>File Not Found</h1><p>The path <code>#{env['PATH_INFO']}</code> was not found." + " "*1024
+    end
+
+    def options
+      @options ||= Hash.new
+    end
+
+    def show_status(page)
+      return if options[:quiet]
+      path = env['PATH_INFO']
+      return  if path == '/favicon.ico'
+
+      status = page ? "\033[0;32m[ OK ]" : "\033[0;31m[404 ]"
+      verb = get ? 'GET ' : (post ? 'POST' : '')
+      puts "%s\033[0;m %s %s" % [ status, verb, env['PATH_INFO'] ]
+      puts "       src: #{page.filepath} (#{page.tilt_engine_name})"  if page && page.tilt?
+    end
+
+    def mime_type_for(page)
+      type   = page.mime_type
+      type ||= Rack::Mime::MIME_TYPES[File.extname(page.file)]
+      type
+    end
+
+    def server
+      Proton::Server
+    end
+  end
+
+  module Proton::Server
+    Ron.send :include, PageHelpers
+
+    define do
+      on default do
+        begin
+          page = Proton::Page[env['PATH_INFO']]  or break not_found
+
+          # Make the clients use If-Modified-Since
+          res['Cache-Control'] = 'max-age=86400, public, must-revalidate'
+
+          mtime = [server.options[:last_modified].to_i, File.mtime(page.file).to_i].compact.max
+          res['Last-Modified'] = mtime.to_s  if mtime
+
+          # Get the MIME type from Proton, then fallback to Rack
+          type = mime_type_for(page)
+          res['Content-Type'] = type  if type
+
+          # Okay, we're done
+          res.write page.to_html
+          show_status page
+        rescue => e
+          res['Content-Type'] = 'text/html'
+          res.write "<h1>#{e.class}: #{e.message}</h1><ul>#{e.backtrace.map{|l|"<li>#{l}</li>"}.join('')}</ul>"
+        end
+      end
+    end
+  end
+end
+
+module Proton::Server
+  # Available options:
+  #   :last_modified  -- timestamp for all files
+  def self.options
+    @options ||= Hash.new 
+  end
+
+  # :Host, :Port
+  def self.run!(options={})
+    self.options.merge options
+    handler = rack_handler  or return false
+    handler.run self, options
+  end
+
+  def self.rack_handler
+    %w(thin mongrel webrick).each do |svr|
+      begin
+        return Rack::Handler.get(svr)
+      rescue LoadError
+      rescue NameError
+      end
+    end
+  end
+end

data/lib/proton/set.rb

@@ -0,0 +1,32 @@
+# Class: Proton::Set
+# A set of pages.
+
+class Proton
+class Set < Array
+  # Method: find (Proton::Set)
+  # Filters a set by given metadata criteria.
+  #
+  # ##  Example
+  #     Page['/'].children.find(layout: 'default')
+  #
+  def find(by={})
+    self.class.new(select do |page|
+      by.inject(true) { |b, (field, value)| b &&= (page.meta.send(field) == value) }
+    end)
+  end
+
+  # Method: except (Proton::Set)
+  # Filters a set by removing items matching the given metadata criteria.
+  #
+  # This is the opposite of {Proton::Set::find}.
+  #
+  # ##  Example
+  #     Page['/'].children.find(layout: 'default')
+  #
+  def except(by={})
+    self.class.new(reject do |page|
+      by.inject(true) { |b, (field, value)| b &&= (page.meta.send(field) == value) }
+    end)
+  end
+end
+end

data/lib/proton/version.rb

@@ -0,0 +1,13 @@
+class Proton
+  VERSION = "0.3.0.rc1"
+
+  # Attribute: version (Proton)
+  # Returns the version.
+  #
+  # ##  Example
+  #     Proton.version    #=> "0.2.0"
+
+  def self.version
+    VERSION
+  end
+end

data/test/fixture/build_options/control/style.css

@@ -0,0 +1 @@
+div a{color:red}

data/test/fixture/build_options/hyde.conf

@@ -0,0 +1,18 @@
+hyde_requirement: 0.1
+site_path: site
+extensions_path: extensions
+output_path: public
+ignore:
+- **/*~
+- **/compass/**/*
+- **/_*.scss
+
+tilt_options:
+  haml:
+    x: 2
+  scss:
+    :line_numbers: true
+
+tilt_build_options:
+  scss:
+    :line_numbers: false

data/test/fixture/build_options/site/style.scss

@@ -0,0 +1 @@
+div { a { color: red; } }

data/test/fixture/compass/hyde.conf

@@ -0,0 +1,4 @@
+output_path: public
+site_path: site
+ignore:
+ - control

data/test/fixture/compass/site/style.scss

@@ -0,0 +1,5 @@
+@import 'compass/css3';
+
+#foo {
+    @include border-radius(4px);
+}

data/test/fixture/extensions/control/index.html

@@ -0,0 +1 @@
+<h1>hey</h1>

data/test/fixture/extensions/extensions/a/a.rb

@@ -0,0 +1 @@
+$extension_loaded = 'aoeu'

data/test/fixture/extensions/extensions/hi.rb

@@ -0,0 +1 @@
+$hi = 1

data/test/fixture/extensions/hyde.conf

@@ -0,0 +1,8 @@
+hyde_requirement: 0.1
+site_path: site
+extensions_path: extensions
+output_path: public
+ignore:
+- **/*~
+- **/compass/**/*
+- **/_*.scss

data/test/fixture/extensions/site/index.haml

@@ -0,0 +1 @@
+%h1 hey

data/test/fixture/fail_type/control/about/index.html

@@ -0,0 +1,2 @@
+Parent:
+<a href='/index.html'>Back to parent</a>

data/test/fixture/fail_type/control/about/us.html

@@ -0,0 +1,2 @@
+Parent:
+<a href='/about/index.html'>Back to parent</a>

data/test/fixture/fail_type/control/index.html

@@ -0,0 +1 @@
+<h1>Yo</h1>

data/test/fixture/fail_type/hyde.conf

@@ -0,0 +1,8 @@
+hyde_requirement: 0.1
+site_path: site
+extensions_path: extensions
+output_path: public
+ignore:
+- **/*~
+- **/compass/**/*
+- **/_*.scss

data/test/fixture/fail_type/site/index.haml

@@ -0,0 +1,4 @@
+title: Hello there
+type: nonexistent
+--
+#ok

data/test/fixture/high_version/hyde.conf

@@ -0,0 +1 @@
+hyde_requirement: 9000.0

data/test/fixture/high_version_2/hyde.conf

@@ -0,0 +1 @@
+requirement: 9000.0

data/test/fixture/html/control/index.html

@@ -0,0 +1,2 @@
+<h1>Welcome.</h1>
+Hello