massimo 0.5.5 → 0.5.6

data/VERSION

@@ -1 +1 @@
-0.5.5
+0.5.6

data/lib/massimo/config.rb

@@ -14,6 +14,8 @@ module Massimo
       :stylesheets_url => '/stylesheets'
     }.freeze
     
+    # Creates a new configuration. Takes either a hash of options
+    # or a file path to a .yaml file.
     def initialize(options = nil)
       hash = DEFAULT_OPTIONS.dup
       
@@ -23,14 +25,18 @@ module Massimo
       super hash
     end
     
+    # The full, expanded path to the source path.
     def source_path
       File.expand_path(super)
     end
     
+    # The full, expanded path to the output path.
     def output_path
       File.expand_path(super)
     end
     
+    # Get a full, expanded path for the given resource name. This is either set
+    # in the configuration or determined dynamically based on the name.
     def path_for(resource_name)
       path_method = "#{resource_name}_path"
       if resource_path = (respond_to?(path_method) and send(path_method))
@@ -40,6 +46,7 @@ module Massimo
       end
     end
     
+    # Get the configured URL for th given resource name.
     def url_for(resource_name)
       url_method   = "#{resource_name}_url"
       resource_url = respond_to?(url_method) && send(url_method)
@@ -47,6 +54,8 @@ module Massimo
       File.join(base_url, resource_url)
     end
     
+    # Get an array of all the file paths found in the given resource name's path,
+    # restricted to the given extension.
     def files_in(resource_name, extension = '*')
       Dir.glob(File.join(path_for(resource_name), "**/*.#{extension}"))
     end

data/lib/massimo/helpers.rb

@@ -9,10 +9,12 @@ module Massimo
     include SinatraMore::FormHelpers
     include SinatraMore::FormatHelpers
     
+    # Returns an instance of the Site
     def site
       Massimo.site
     end
     
+    # Renders a view with the given locals. Kind of like `render :partial` in Rails
     def render(view_name, locals = {})
       view = Massimo::View.find(view_name)
       view && view.render(locals)

data/lib/massimo/page.rb

@@ -1,19 +1,24 @@
 require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/string/starts_ends_with'
 require 'active_support/inflector'
 require 'tilt'
 require 'yaml'
 
-Tilt.register 'html', Tilt::StringTemplate
-
 module Massimo
   class Page < Resource
     def render
-      template  = Tilt.new(source_path.basename.to_s, @line || 1) { content }
-      meta_data = @meta_data.merge(self.class.resource_name.singularize.to_sym => self)
-      output    = template.render(Massimo.site.template_scope, meta_data)
+      output = content
+      
+      if template_type = Tilt[source_path.basename.to_s]
+        template  = template_type.new(nil, @line || 1) { output }
+        meta_data = @meta_data.merge(self.class.resource_name.singularize.to_sym => self)
+        output    = template.render(Massimo.site.template_scope, meta_data)
+      end
+        
       if found_layout = Massimo::View.find("layouts/#{layout}")
         output = found_layout.render(:page => self) { output }
       end
+      
       output
     end
     
@@ -42,7 +47,7 @@ module Massimo
     def output_path
       @output_path ||= begin
         output_path = super.to_s
-        output_path << "index.html" if output_path =~ /\/$/
+        output_path << "index.html" if output_path.ends_with? '/'
         Pathname.new output_path
       end
     end

data/lib/massimo/resource.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/string/starts_ends_with'
 require 'active_support/inflector'
 require 'fileutils'
 require 'pathname'
@@ -5,29 +6,35 @@ require 'pathname'
 module Massimo
   class Resource
     class << self
+      # The underscored, pluralized name of the resource.
       def resource_name
         self.name.underscore.sub(/.*\//, '').pluralize
       end
       
+      # The path to the resource's directory.
       def path
         Massimo.config.path_for resource_name
       end
       
+      # The base url for the resource.
       def url
         Massimo.config.url_for resource_name
       end
       
+      # Finds a Resource by the given name.
       def find(name)
         resource_path = Dir.glob(File.join(path, "#{name}.*")).first
         resource_path && self.new(resource_path)
       end
       
+      # Finds all the Resources in the resource's directory.
       def all
         files = Massimo.config.files_in resource_name
-        files.reject! { |file| File.basename(file) =~ /^_/ }
+        files.reject! { |file| File.basename(file).starts_with?('_') }
         files.map { |file| self.new(file) }
       end
       
+      # Whether or not massimo should process the resource's files.
       def processable?
         true
       end
@@ -42,24 +49,30 @@ module Massimo
     
     attr_reader :source_path, :content
     
+    # Creates a new resource for the given source file.
+    # The contents of the file will automatically be read.
     def initialize(source)
       @source_path = source.is_a?(Pathname) ? source.expand_path : Pathname.new(source).expand_path
       read_source
     end
     
+    # The basename of the source file.
     def filename
       @filename ||= source_path.basename.to_s
     end
     
+    # The extension to output with.
     def extension
       @extension ||= source_path.extname
     end
     
+    # The url to the resource. This is created by swiching the base path
+    # of the source file with the base url.
     def url
       @url ||= begin
         url = source_path.to_s.sub(/^#{Regexp.escape(self.class.path)}/, '')
         url = url.sub(/\.[^\.]+$/, extension)
-        url = File.join(self.class.url, url) unless url.include? self.class.url
+        url = File.join(self.class.url, url) unless url.starts_with? self.class.url
         url = url.dasherize
         url
       end

data/lib/massimo/site.rb

@@ -5,6 +5,8 @@ module Massimo
   class Site
     attr_accessor :config
     
+    # Creates a new Site, passing the given options to a new configuration.
+    # If a block is given, it is evaluated in the scope of the new Site.
     def initialize(options = nil, &block)
       @config                    = Config.new(options)
       @template_scope_blocks     = []
@@ -14,10 +16,15 @@ module Massimo
       instance_eval(&block) if block_given?
     end
     
+    # The resources used in this Site.
     def resources
       @resources ||= [ Massimo::Page, Massimo::Javascript, Massimo::Stylesheet, Massimo::View ]
     end
     
+    # Adds a new, custom resource to the Site. If a Class constant is given,
+    # it is added to directly to the `#resources`. If a Symbol or String is given, a new
+    # Class (inheriting from Massimo::Page) is created using that name
+    # with the given block used as the Class body.
     def resource(name_or_class, &block)
       resource = case name_or_class
         when Class
@@ -28,6 +35,8 @@ module Massimo
       resources << resource
     end
     
+    # The scope used for templating. It includes helpers from Massimo::Helpers along
+    # with any custom helpers.
     def template_scope
       @template_scope ||= begin
         scope = Object.new.extend(Massimo::Helpers, Tilt::CompileSite)
@@ -38,11 +47,15 @@ module Massimo
       end
     end
     
+    # Adds custom helpers to the `#template_scope`. Takes either an array of Modules
+    # that will extend the scope, or a block of method definitions that will be added
+    # to the scope.
     def helpers(*extensions, &block)
       @template_scope_blocks     << block if block_given?
       @template_scope_extensions += extensions
     end
     
+    # Processes all the current resources.
     def process
       @template_scope = nil
       reload_libs

data/lib/massimo/watcher.rb

@@ -11,6 +11,7 @@ module Massimo
       @files = []
     end
     
+    # Runs a loop, processing the whenever files have changed.
     def run
       loop do
         process
@@ -18,6 +19,7 @@ module Massimo
       end
     end
     
+    # Processes the Site if any of the files have changed.
     def process
       if changed?
         begin
@@ -31,6 +33,7 @@ module Massimo
       end
     end
     
+    # Determine if any of the Site's files have changed.
     def changed?
       @files != files
     end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 5
-  version: 0.5.5
+  - 6
+  version: 0.5.6
 platform: ruby
 authors: 
 - Pete Browne