staticmatic2 2.0.2 → 2.1.0

data/Gemfile

@@ -1,13 +1,16 @@
 source "http://rubygems.org"
 
-gem "haml", ">= 2.0.0"
+gem "haml", "~> 3"
+gem "sass", "~> 3"
+gem "tilt", ">= 1.3"
 gem "compass"
+
 gem "rack", ">= 1.0"
 gem "thor", ">=0.14.6"
 gem "aws-s3"
 
 group :development do
-  gem "bundler", ">= 1.0.10"
-  gem "jeweler", ">= 1.5.2"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.6"
   gem "rspec", "~> 1.3.1"
 end

data/Gemfile.lock

@@ -10,15 +10,17 @@ GEM
       haml (>= 3.0.4)
     git (1.2.5)
     haml (3.0.25)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
       git (>= 1.2.5)
       rake
     mime-types (1.16)
     rack (1.2.1)
-    rake (0.8.7)
+    rake (0.9.2)
     rspec (1.3.1)
+    sass (3.1.7)
     thor (0.14.6)
+    tilt (1.3.3)
     xml-simple (1.0.14)
 
 PLATFORMS
@@ -26,10 +28,12 @@ PLATFORMS
 
 DEPENDENCIES
   aws-s3
-  bundler (>= 1.0.10)
+  bundler (~> 1.0)
   compass
-  haml (>= 2.0.0)
-  jeweler (>= 1.5.2)
+  haml (~> 3)
+  jeweler (~> 1.6)
   rack (>= 1.0)
   rspec (~> 1.3.1)
+  sass (~> 3)
   thor (>= 0.14.6)
+  tilt (>= 1.3)

data/{README.markdown → README.md}

@@ -7,7 +7,7 @@
 - [Coffeescript](http://jashkenas.github.com/coffee-script/)
 - [Compass](compass-style.org)
 - [Amazon S3 Websites](http://aws.typepad.com/aws/2011/02/host-your-static-website-on-amazon-s3.html)
-- And more to come
+- [And many, many more!](https://github.com/rtomayko/tilt#readme)
 
 2: Deploy to Amazon S3:
 
@@ -32,7 +32,7 @@
 
 ## Quick Start
 
-Instantly setup a new project:
+Setup a new project:
 
     $ staticmatic init my-project
 
@@ -63,13 +63,24 @@ To build & convert your haml/sass/whatever files into plain html, css, and javas
     
 This will convert everything into a freshly generated `build/` folder, 100% static.
 
-If you have an Amazon S3 account and want to deploy to your bucket, run the following command:
+If you have an [Amazon S3 account](http://aws.amazon.com/s3/) and want to deploy to your bucket, run the following command:
 
     # NOTE: You must be in the root folder of your project
     $ staticmatic s3_deploy
 
 If you haven't deployed your current project to Amazon yet, it will prompt you to create a config file. Edit this file to include your credentials, run the command again, and you're set.
 
+## Super Special Awesome Quick Start Booster
+
+Want to use a [Javascript App Starter](https://github.com/mindeavor/staticmatic-js-app-starter) or a skeleton of your own? Check this out!
+
+    $ staticmatic add js-app git://github.com/mindeavor/staticmatic-js-app-starter.git
+    $ staticmatic init my-new-project --skeleton=js-app
+
+The first line stores a named reference to a repository of your choosing. You only need to do this once.
+
+The second line clones the referenced repository into a freshly created `my-new-project` folder, as well as removes the `.git/` folder so you can do your own `git init`. Convenient!
+
 ## Special Folders
 
     <my-project>/
@@ -95,7 +106,7 @@ Partials are searched for in the following order:
 
 Examples:
 
-    # Searches for the default rendering engine file type
+    # Searches for the default rendering engine file type (by default, it is haml)
     = partial 'sidebar'
     
     # Equivalent to the above statement
@@ -105,7 +116,7 @@ Examples:
     = partial 'help-content.html'
     
     # Use your own directory structure
-    = partial 'blog-content/2011/vacation.html'
+    = partial 'blog-content/2011/vacation.markdown'
 
 ## Anti-Cache
 
@@ -122,3 +133,11 @@ Force the browser to ignore its cache whenever you damn well feel like it:
     javascripts :app, :qstring => '2.0.6'
 
     <script language="javascript" src="js/app.js?_=2.0.6" type="text/javascript"></script>
+
+# Roadmap / TODO list
+
+- Fix slowness of executable (built on [Thor](https://github.com/wycats/thor); maybe reconsider?)
+- Create a cache that monitors what files have changed in between Amazon S3 uploads to reduce unnecessary uploads
+- Integrate sprockets both for building and for previewing (probably as an option flag)
+- Change rendering and yielding syntax to rails syntax
+- Create a command that converts a staticmatic project to a rails project

data/Rakefile

@@ -18,13 +18,13 @@ Jeweler::Tasks.new do |gem|
   gem.name        = "staticmatic2"
   gem.email       = "gilbertbgarza@gmail.com"
   gem.license     = "MIT"
-  gem.summary     = "Build static websites using modern dynamic tools"
-  gem.homepage    = "http://github.com/mindeavor/staticmatic"
+  gem.summary     = "Build Amazon S3 static websites using modern dynamic tools"
+  gem.homepage    = "http://github.com/mindeavor/staticmatic2"
   gem.executables = "staticmatic"
   gem.authors     = ["Stephen Bartholomew", "Gilbert B Garza"]
 
   gem.description = <<-EOF
-    StaticMatic helps you quickly create maintainable static websites using
+    StaticMatic helps you quickly create maintainable Amazon S3 static websites using
     tools such as Haml and Sass.
     
     Quickly deploy to services such as Amazon S3 in a single command.
@@ -36,7 +36,7 @@ Jeweler::Tasks.new do |gem|
   gem.files.exclude "spec/sandbox/tmp", "spec/sandbox/test_site/site/*"
 end
 
-# Jeweler::RubygemsDotOrgTasks.new
+Jeweler::RubygemsDotOrgTasks.new
 
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'

data/VERSION.yml

@@ -1,5 +1,5 @@
 ---
 :major: 2
-:minor: 0
-:patch: 2
+:minor: 1
+:patch: 0
 :build: !!null 

data/bin/staticmatic

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 require 'rubygems'
+require 'pathname'
 require 'thor'
 
-lib_dir = File.dirname(__FILE__) + '/../lib/staticmatic'
+$lib_dir = Pathname.new(__FILE__).realpath.dirname.join('../lib/staticmatic').to_s
 
-require lib_dir
-Dir[File.join lib_dir,'deployers','*.rb'].each do |deployer|
+Dir[File.join $lib_dir,'deployers','*.rb'].each do |deployer|
   require deployer
 end
 
@@ -56,6 +56,7 @@ class StaticExe < Thor
   desc "preview DIRECTORY", "Start a web server to preview your project"
   def preview(directory = '.')
     say 'Launching preview server...', :cyan
+    require $lib_dir
     staticmatic = StaticMatic::Base.new(directory)
     $:.push File.join(directory, "lib")
     staticmatic.run('preview')
@@ -64,7 +65,8 @@ class StaticExe < Thor
   desc "build DIRECTORY", "Build your project into a freshly generated build/ folder"
   def build(directory = '.')
     say 'Building website...', :cyan
-    staticmatic = StaticMatic::Base.new(directory)
+    require $lib_dir
+    staticmatic = StaticMatic::Base.new(directory, :build)
     $:.push File.join(directory, "lib")
     staticmatic.run('build')
   end

data/lib/staticmatic/ambiguous_template_error.rb

@@ -0,0 +1,19 @@
+class StaticMatic::AmbiguousTemplateError < StandardError
+  attr_reader :template_name
+  
+  def initialize(template_name, ambiguous_templates)
+    @template_name = template_name
+    @ambiguous_templates = ambiguous_templates
+  end
+  
+  def message
+<<-MESSAGE
+Ambiguous request when searching for a template for filename `#{@template_name}`:
+There is more than one type of template available for rendering.
+
+Templates causing the ambiguity:
+#{@ambiguous_templates.join "\n"}
+MESSAGE
+  end
+
+end

data/lib/staticmatic/base.rb

@@ -8,62 +8,65 @@ module StaticMatic
     include StaticMatic::ServerMixin    
     include StaticMatic::RescueMixin    
   
-    attr_accessor :configuration
-    attr_reader :current_page, :src_dir, :site_dir
+    attr_accessor :configuration, :mode
+    attr_reader :src_dir, :site_dir
 
     def current_file
       @current_file_stack[0] || ""
     end
-    
-    def initialize(base_dir, configuration = Configuration.new)
-      @configuration = configuration
-      @current_page = nil
+
+    def self.extensions
+      @extensions ||= (Tilt.mappings.map { |k,v| k } << "slim")
+    end
+
+    def extensions
+      self.class.extensions
+    end
+
+    def ensure_extension(filename)
+      ext = File.extname(filename)
+      ext.length > 0 ? filename : "#{filename}.#{configuration.default_template_engine}"
+    end
+
+    def initialize(base_dir, mode = :preview)
+      @configuration = Configuration.new
       @current_file_stack = []
+      @mode = mode
+
       @base_dir = base_dir
       @src_dir = File.join(@base_dir, "src")
       @site_dir = File.join(@base_dir, "build")
-      
-      if File.exists?(File.join(@src_dir, "_layouts", "application.haml"))
-        puts "DEPRECATION: _layouts/application.haml will be renamed to _layouts/default.haml in 0.12.0"
-        @default_layout = "application"
-      else
-        @default_layout = "default"
-      end
-      
+
+      @default_layout_name = "default"
+
       @scope = Object.new
       @scope.instance_variable_set("@staticmatic", self)
+      @scope.instance_eval do
+        extend StaticMatic::Helpers
+      end
       
       load_configuration      
       configure_compass
 
       load_helpers
     end
-    
+
     def load_configuration
       configuration = StaticMatic::Configuration.new
       config_file = File.join(@base_dir, "config", "site.rb")
-
-      if !File.exists?(config_file)
-        config_file = File.join(@base_dir, "src", "configuration.rb")
-
-        if File.exists?(config_file)
-          puts "DEPRECATION: #{@base_dir}/src/configuration.rb will be moved to #{@base_dir}/config/site.rb in 0.12.0"
-        end
-      end
       
       if File.exists?(config_file)
         config = File.read(config_file)
         eval(config)
       end
 
-      # Compass.sass_engine_options.merge!(configuration.sass_options)
       @configuration = configuration
     end
-    
+
     def base_dir
       @base_dir
     end
-  
+
     def run(command)
       puts "Site root is: #{@base_dir}"
       
@@ -73,39 +76,65 @@ module StaticMatic
         puts "#{command} is not a valid StaticMatic command"
       end
     end
-      
-    # TODO: DRY this _exists? section up
-    def template_exists?(name, ext, dir = '')
-      if ext == 'html'
-        src_file_names('haml').include? "#{name}.haml"
-      elsif ext == 'css'
-        (src_file_names('sass').include? "#{name}.sass") ||
-        (src_file_names('scss').include? "#{name}.scss")
-      elsif ext == 'js'
-        src_file_names('coffee').include? "#{name}.coffee"
+
+    def determine_template_path(name, ext, dir = '')
+      # remove src path if present
+      dir.gsub! /^#{@src_dir}\//, ''
+
+      default_template_name = "#{name}.#{configuration.default_template_engine}"
+      default_template = File.join(@src_dir, dir, default_template_name)
+
+      if File.exists? default_template
+        default_template
+      else
+        context = File.join(@src_dir, dir, name)
+        possible_templates = Dir[context + '.*'].select do |fname|
+          extensions.include? File.extname(fname).sub(/^\./, '')
+        end
+
+        if possible_templates.count > 1
+          raise StaticMatic::AmbiguousTemplateError.new("#{name}#{ext}", possible_templates)
+        end
+
+        possible_templates.first
       end
     end
-    
-    def layout_exists?(name)
-      File.exists? full_layout_path(name)
-    end
-    
-    def full_layout_path(name)
-      File.join(@src_dir, "_layouts", "#{name}.haml")
+
+    def expand_path(path_info)
+      dirname, basename = File.split(path_info)
+
+      extname = File.extname(path_info).sub(/^\./, '')
+      filename = basename.chomp(".#{extname}")
+
+      if extname.empty?
+        dir = File.join(dirname, filename)
+        is_dir = path_info[-1, 1] == '/'
+        if is_dir
+          dirname = dir
+          filename = 'index'
+        end
+        extname = 'html'
+      end
+
+      [ dirname, filename, extname ]
     end
-    
+
     def configure_compass
       Compass.configuration.project_path = @base_dir 
 
       compass_config_path = File.join(@base_dir, "config", "compass.rb")
       
       if File.exists?(compass_config_path)
-        Compass.add_configuration(compass_config_path)         
+        Compass.add_configuration(compass_config_path)
       end
 
-      configuration.sass_options.merge!(Compass.configuration.to_sass_engine_options)
+      options = configuration.engine_options
+      compass_options = Compass.configuration.to_sass_engine_options
+
+      options['sass'] = compass_options.merge(options['sass'] || {})
+      options['scss'] = compass_options.merge(options['scss'] || {})
     end
-    
+
     # TODO OPTIMIZE: caching, maybe?
     def src_file_paths(*exts)
       Dir["#{@src_dir}/**/*.{#{ exts.join(',') }}"].reject do |path|
@@ -114,10 +143,6 @@ module StaticMatic
         path.split('/').map {|x| x.match('^\_')}.any?
       end
     end
-    
-    def src_file_names(*exts)
-      src_file_paths(*exts).map {|p| File.split(p)[1]}
-    end
-    
+
   end
 end

data/lib/staticmatic/configuration.rb

@@ -1,20 +1,43 @@
 module StaticMatic
   class Configuration
-    attr_accessor :preview_server_port
-
     attr_accessor :preview_server_host
+    attr_accessor :preview_server_port
     
     attr_accessor :use_extensions_for_page_links
-    attr_accessor :sass_options
-    attr_accessor :haml_options 
-    attr_accessor :coffee_options
+    attr_accessor :default_template_engine
+
+    attr_accessor :engine_options, :preview_engine_options
+    attr_accessor :reverse_ext_mappings
     
     def initialize
+      self.preview_server_host = "localhost"
       self.preview_server_port = 3000
+
       self.use_extensions_for_page_links = true
-      self.sass_options = {}
-      self.haml_options = {}
-      self.coffee_options = ''
+      self.default_template_engine = 'haml'
+
+      self.preview_engine_options = self.engine_options = {
+        'haml' => {}, 'sass' => {}, 'scss' => {},
+      }
+      # TODO: discover a way of auto-detecting these. one can hope.
+      self.reverse_ext_mappings = {
+        'sass' => 'css',
+        'scss' => 'css',
+        'less' => 'css',
+
+        'coffee' => 'js',
+
+        'builder' => 'xml',
+        'yajl' => 'json'
+      }
+
+      %w{
+        creole erb haml liquid radius mab markdown md
+        mediawiki mkd mw nokogiri rdoc rhtml slim textile wiki
+      }.each do |ext|
+        @reverse_ext_mappings[ext] = 'html'
+      end
     end
+
   end
-end
+end

data/lib/staticmatic/helpers/assets_helper.rb

@@ -39,7 +39,7 @@ module StaticMatic
       
       # Generate javascript source tags for the specified files
       #
-      # javascripts('test')   ->   <script language="javascript" src="javascripts/test.js"></script>
+      # javascripts('test')   ->   <script language="javascript" src="path/to/test.js"></script>
       #    
       def javascripts(*files)
         options = (files.last.is_a? Hash) ? files.pop : {}
@@ -83,10 +83,11 @@ module StaticMatic
           filename_without_extension = File.basename(path).chomp(File.extname(path))
       
           path = path.gsub(/^#{@staticmatic.src_dir}/, "").
-                      gsub(/^#{@staticmatic.site_dir}/, "").
-                      gsub(/#{filename_without_extension}\.(sass|scss|css|js|coffee)/, "")
-
-          src = File.join(current_page_relative_path, path, "#{filename_without_extension}")
+                     gsub(/^#{@staticmatic.site_dir}/, "").
+                     gsub(/#{filename_without_extension}\.(sass|scss|css|js|coffee)/, "").
+                     gsub(/^\//, "")
+          paths = [current_page_relative_path, path, "#{filename_without_extension}"].compact
+          src = File.join(*paths)
         end
         
         if tag_type == :link

data/lib/staticmatic/helpers/current_path_helper.rb

@@ -4,17 +4,17 @@ module StaticMatic
       self.extend self
       
       def current_page
-        @staticmatic.current_page
+        @staticmatic.current_file
       end
 
       private
 
       def current_page_relative_path(current_path = nil)
         if current_path.nil? || current_path.match(/^((\.\.?)?\/|\#|.+?\:)/) == nil
-          current_page_depth = current_page.split('/').length - 2;
-          (current_page_depth > 0) ? ([ '..' ] * current_page_depth).join('/') + '/' : ''
+          current_page_depth = current_page.split('/').length - 3;
+          (current_page_depth > 0) ? ([ '..' ] * current_page_depth).join('/') + '/' : nil
         else
-          ''
+          nil
         end
       end
     end

data/lib/staticmatic/helpers/render_helper.rb

@@ -4,20 +4,9 @@ module StaticMatic
     module RenderHelper
       self.extend self
       
-      def content_hash
-        @content_hash ||= {}
-      end
-      
-      def yield_for(index)
-        self.content_hash[index.to_sym] || ""
-      end
-      
-      def content_for(index,&block)
-        content_hash[:sidebar] = capture_haml &block
-      end
-      
       # Include a partial template
       def partial(name, options = {})
+        name = @staticmatic.ensure_extension(name)
         @staticmatic.generate_partial(name, options)
       end
     end

data/lib/staticmatic/helpers/tag_helper.rb

@@ -20,7 +20,7 @@ module StaticMatic
           output << yield
           output << "</#{name}>"
         else
-          format = @staticmatic.configuration.haml_options[:format]
+          format = @staticmatic.configuration.engine_options['haml'][:format]
           
           if format.nil? || format == :xhtml
             output << "/>"

data/lib/staticmatic/mixins/build.rb

@@ -1,77 +1,41 @@
 module StaticMatic::BuildMixin
     
   def build
-    build_css
-    build_js
-    build_html
-    copy_images
-  end
-    
-  # Build HTML from the source files
-  def build_html
-    src_file_paths('haml').each do |path|
-      file_dir, template = source_template_from_path(path.sub(/^#{@src_dir}/, ''))
-      save_page(File.join(file_dir, template), generate_html_with_layout(template, file_dir))
-    end
-  end
+    src_file_paths('*').each do |src_path|
+      ext = File.extname(src_path).sub(/^\./, '')
 
-  # Build CSS from the source files
-  def build_css
-    src_file_paths('sass','scss').each do |path|
-      file_dir, template = source_template_from_path(path.sub(/^#{@src_dir}/, ''))
-      
-      if !template.match(/(^|\/)\_/)
-        save_stylesheet(File.join(file_dir, template), generate_css(template, file_dir))
+      if Tilt.mappings[ext].length > 0
+        generate_site_file(src_path)
+      else
+        copy_file_from_src_to_site(src_path)
       end
     end
   end
-  
-  def build_js
-    coffee_found = ENV['PATH'].split(':').inject(false) { |found, folder| found |= File.exists?("#{folder}/coffee") }
-    if coffee_found
-      src_file_paths('coffee').each do |path|
-        file_dir, template = source_template_from_path(path.sub(/^#{@src_dir}/, ''))
-        save_javascript(File.join(file_dir, template), generate_js(template, file_dir))
-      end
-    end
-    # copy normal javascript files over
-    src_file_paths('js').each do |path|
-      file_dir, template = source_template_from_path(path.sub(/^#{@src_dir}/, ''))
-      copy_file(path, File.join(@site_dir, file_dir, "#{template}.js"))
-    end
-  end
-  
-  def copy_images
-    src_file_paths(*%w{gif jpg jpef png tiff}).each do |path|
-      file_dir, file_name = File.split(path.sub(/^#{@src_dir}/, ''))
-      copy_file(path, File.join(@site_dir, file_dir, file_name))
-    end
-  end
 
-  def copy_file(from, to)
-    FileUtils.mkdir_p(File.dirname(to))
-    FileUtils.cp(from, to)
-  end
+  private
 
-  def save_page(filename, content)
-    generate_site_file(filename, 'html', content)
-  end
+  def copy_file_from_src_to_site(src_path)
+    site_path = src_path.gsub /^#{@src_dir}/, @site_dir
 
-  def save_stylesheet(filename, content)
-    generate_site_file(filename, 'css', content)
+    FileUtils.mkdir_p(File.dirname site_path)
+    FileUtils.cp src_path, site_path
   end
 
-  def save_javascript(filename, content)
-    generate_site_file(filename, 'js', content)
-  end
+  def generate_site_file(src_path)
+    dir, name, ext = expand_path(src_path.gsub /^#{@src_dir}/, @site_dir)
+    target_ext = configuration.reverse_ext_mappings[ext]
+    site_path = File.join(dir, "#{name}.#{target_ext}")
 
-  def generate_site_file(filename, extension, content)
-    path = File.join(@site_dir,"#{filename}.#{extension}")
-    FileUtils.mkdir_p(File.dirname(path))
-    File.open(path, 'w+') do |f|
-      f << content
+    puts "  Rendered #{src_path} => #{site_path}"
+
+    FileUtils.mkdir_p(File.dirname site_path)
+    File.open(site_path, 'w+') do |f|
+      if target_ext == 'html'
+        f << render_template_with_layout(src_path)
+      else
+        f << render_template(src_path)
+      end
     end
-    
-    puts "created #{path}"
   end
+
 end