machined 0.1.0

data/lib/machined/server.rb

@@ -0,0 +1,37 @@
+require "rack"
+
+module Machined
+  class Server
+    # A reference to the Machined environment which
+    # created this instance.
+    attr_reader :machined
+    
+    # Creates a new Rack server that will serve
+    # up the processed files.
+    def initialize(machined)
+      @machined = machined
+      @files    = Rack::File.new(machined.output_path)
+      remap
+    end
+    
+    # Using the URLMap, determine which sprocket
+    # should handle the request and then...let it
+    # handle it.
+    def call(env)
+      response = @url_map.call(env)
+      response = @files.call(env) if response.first == 404
+      response
+    end
+    
+    # Remaps the Machined environment's current
+    # sprockets using `Rack::URLMap`.
+    def remap
+      map = {}
+      machined.sprockets.each do |sprocket|
+        next unless sprocket.compile?
+        map[sprocket.config.url] = sprocket
+      end
+      @url_map = Rack::URLMap.new map
+    end
+  end
+end

data/lib/machined/sprocket.rb

@@ -0,0 +1,55 @@
+require "ostruct"
+require "sprockets"
+
+module Machined
+  class Sprocket < Sprockets::Environment
+    # Default options for a Machined sprocket.
+    DEFAULT_OPTIONS = {
+      :root    => ".",
+      :assets  => false,
+      :compile => true
+    }.freeze
+    
+    # A reference to the Machined environment which
+    # created this instance.
+    attr_reader :machined
+    
+    # A reference to the configuration.
+    attr_reader :config
+    
+    # Creates a new Machined sprocket. The API is
+    # a bit different than `Sprockets::Environment` to
+    # allow for per-Sprockets-environment configuration
+    # and to keep a reference to the Machined environment.
+    def initialize(machined, options = {})
+      @machined = machined
+      @config   = OpenStruct.new DEFAULT_OPTIONS.dup.merge(options)
+      
+      super config.root
+      
+      @context_class = Class.new Context
+      use_all_templates unless config.assets
+    end
+    
+    # Returns true, if this sprocket should be
+    # compiled. Nine times out of ten, you will want
+    # your sprocket compiled, but sometimes - like
+    # the default views sprocket - it is used as
+    # a uncompiled resource.
+    def compile?
+      config.compile && config.url
+    end
+    
+    # Loops through the available Tilt templates
+    # and registers them as processor engines for
+    # Sprockets. By default, Sprockets cherry picks
+    # templates that work for web assets. We need to
+    # allow use of Haml, Markdown, etc.
+    def use_all_templates
+      Utils.available_templates.each do |ext, template|
+        next if engines(ext)
+        register_engine ext, template
+      end
+    end
+  end
+end

data/lib/machined/static_compiler.rb

@@ -0,0 +1,71 @@
+require "fileutils"
+
+module Machined
+  class StaticCompiler
+    # A reference to the Machined environment which
+    # created this instance.
+    attr_reader :machined
+    
+    # Creates a new instance, which will compile
+    # the assets to the given +output_path+.
+    def initialize(machined)
+      @machined = machined
+    end
+    
+    # Loop through and compile each available
+    # asset to the appropriate output path.
+    def compile
+      compiled_assets = {}
+      machined.sprockets.each do |sprocket|
+        next unless sprocket.compile?
+        sprocket.each_logical_path do |logical_path|
+          url = File.join(sprocket.config.url, logical_path)
+          next unless compiled_assets[url].nil? && compile?(url)
+          
+          if asset = sprocket.find_asset(logical_path)
+            compiled_assets[url] = write_asset(asset)
+          end
+        end
+      end
+      compiled_assets
+    end
+    
+    # Determines if we should precompile the asset
+    # with the given url. By default, we skip over any
+    # files that begin with "_", like partials.
+    def compile?(url)
+      File.basename(url) !~ /^_/
+    end
+    
+    # Writes the asset to its destination, also
+    # writing a gzipped version if necessary.
+    def write_asset(asset)
+      filename = path_for(asset)
+      FileUtils.mkdir_p File.dirname(filename)
+      asset.write_to filename
+      asset.write_to "#{filename}.gz" if gzip?(filename)
+      asset.digest
+    end
+    
+    protected
+    
+    # Gets the full output path for the given asset.
+    # If it's supposed to include a digest, it will return the
+    # digest_path.
+    def path_for(asset) # :nodoc:
+      path = digest?(asset) ? asset.digest_path : asset.logical_path
+      File.join(machined.output_path, asset.environment.config.url, path)
+    end
+    
+    # Determines if we should use the digest_path for the given
+    # asset.
+    def digest?(asset) # :nodoc:
+      machined.config.digest_assets && asset.environment.config.assets
+    end
+    
+    # Determines if we should gzip the asset.
+    def gzip?(filename) # :nodoc:
+      machined.config.gzip_assets && filename =~ /\.(css|js)$/
+    end
+  end
+end

data/lib/machined/templates/site/Gemfile.tt

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem "machined", "<%= Machined::VERSION %>"
+
+gem "sass", "~> 3.1"
+gem "coffee-script", "~> 2.2"
+
+group :production do
+  gem "uglifier", "~> 1.0"
+end

data/lib/machined/templates/site/config.ru

@@ -0,0 +1,2 @@
+require "machined"
+run Machined::Environment.new

data/lib/machined/templates/site/machined.rb

@@ -0,0 +1,17 @@
+require "bundler"
+Bundler.require :default, config.environment.to_sym
+
+if config.environment == "production"
+  # Compress javascripts and stylesheets
+  config.compress = true
+  
+  # Generate digests for assets URLs
+  # config.digest_assets = true
+  
+  # Create gzipped versions of javascripts and stylesheets
+  # config.gzip_assets = true
+end
+
+helpers do
+  # Define helper methods here
+end

data/lib/machined/templates/site/pages/index.html.erb

@@ -0,0 +1,5 @@
+---
+title: Home Page
+---
+<h1><%= title %></h1>
+<p>Find me in pages/index.erb</p>

data/lib/machined/templates/site/views/layouts/main.html.erb

@@ -0,0 +1,12 @@
+<!doctype html>
+<html>
+  <head lang="en">
+    <meta charset="utf-8">
+    <title><%= title %></title>
+    <%= stylesheet_link_tag "main" %>
+    <%= javascript_include_tag "main" %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/machined/utils.rb

@@ -0,0 +1,31 @@
+require "pathname"
+require "sprockets"
+require "tilt"
+
+module Machined
+  module Utils
+    # Returns a hash of the Tilt templates
+    # that are registered and available to use, where
+    # the key is the extension the template's registered for.
+    def self.available_templates
+      @available_templates ||= {}.tap do |templates|
+        Tilt.mappings.each_key do |ext|
+          begin
+            templates[Sprockets::Utils.normalize_extension(ext)] = Tilt[ext]
+          rescue LoadError
+            # safely ignore...
+          end
+        end
+      end
+    end
+    
+    # Returns an `Array` of the child directories that
+    # exist within the given +path+. If the path itself
+    # does not exist, an emtpy array is returned.
+    def self.existent_directories(path)
+      pathname = Pathname.new path
+      pathname.directory? or return []
+      pathname.children.select &:directory?
+    end
+  end
+end

data/lib/machined/version.rb

@@ -0,0 +1,3 @@
+module Machined
+  VERSION = "0.1.0"
+end

data/machined.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "machined/version"
+
+Gem::Specification.new do |s|
+  s.name        = "machined"
+  s.version     = Machined::VERSION
+  s.authors     = ["Pete Browne"]
+  s.email       = ["me@petebrowne.com"]
+  s.homepage    = ""
+  s.summary     = %q{A static site generator and Rack server built using Sprockets 2.0}
+  s.description = %q{Why another static site generator? Machined is for the developers who know and love the asset pipeline of Rails 3.1 and want to develop blazingly fast static websites. It's built from the ground up using Sprockets 2.0.}
+
+  s.rubyforge_project = "machined"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency             "sprockets",       "~> 2.0"
+  s.add_dependency             "sprockets-sass",  "~> 0.3"
+  s.add_dependency             "padrino-helpers", "~> 0.10"
+  s.add_dependency             "activesupport",   "~> 3.1"
+  s.add_dependency             "i18n",            "~> 0.6"
+  s.add_dependency             "thor",            "~> 0.14"
+  s.add_dependency             "crush",           "~> 0.3"
+  s.add_development_dependency "rspec",           "~> 2.6"
+  s.add_development_dependency "rack-test",       "~> 0.6"
+  s.add_development_dependency "test-construct",  "~> 1.2"
+  s.add_development_dependency 'unindent',        "~> 1.0"
+  s.add_development_dependency "haml"
+  s.add_development_dependency "sass"
+  s.add_development_dependency "slim"
+  s.add_development_dependency "erubis"
+  s.add_development_dependency "rdiscount"
+  s.add_development_dependency "uglifier"
+  s.add_development_dependency "rake"
+end

data/spec/machined/cli_spec.rb

@@ -0,0 +1,154 @@
+require "spec_helper"
+
+describe Machined::CLI do
+  describe "#compile" do
+    it "compiles the site" do
+      machined.should_receive(:compile)
+      Machined::Environment.should_receive(:new).with(:root => ".", :output_path => "public", :environment => "production", :config_path => "machined.rb").and_return(machined)
+      machined_cli "compile -e production"
+    end
+  end
+  
+  describe "#new" do
+    it "creates a machined site directory" do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.directory?("my_site").should be_true
+      end
+    end
+    
+    it "creates source directories" do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.directory?("my_site/pages").should be_true
+        File.directory?("my_site/views").should be_true
+        File.directory?("my_site/assets/images").should be_true
+        File.directory?("my_site/assets/javascripts").should be_true
+        File.directory?("my_site/assets/stylesheets").should be_true
+      end
+    end
+    
+    it "creates an output path" do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.directory?("my_site/public").should be_true
+      end
+    end
+    
+    it "creates an default index page" do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.read("my_site/pages/index.html.erb").should == <<-CONTENT.unindent
+          ---
+          title: Home Page
+          ---
+          <h1><%= title %></h1>
+          <p>Find me in pages/index.erb</p>
+        CONTENT
+      end
+    end
+    
+    it 'creates a default layout' do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.read("my_site/views/layouts/main.html.erb").should == <<-CONTENT.unindent
+          <!doctype html>
+          <html>
+            <head lang="en">
+              <meta charset="utf-8">
+              <title><%= title %></title>
+              <%= stylesheet_link_tag "main" %>
+              <%= javascript_include_tag "main" %>
+            </head>
+            <body>
+              <%= yield %>
+            </body>
+          </html>
+        CONTENT
+      end
+    end
+    
+    it "creates a default javascript file" do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.exist?("my_site/assets/javascripts/main.js.coffee").should be_true
+      end
+    end
+    
+    it "creates a default stylesheet file" do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.exist?("my_site/assets/stylesheets/main.css.scss").should be_true
+      end
+    end
+    
+    it "creates a default Gemfile" do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.read("my_site/Gemfile").should == <<-CONTENT.unindent
+          source :rubygems
+          
+          gem "machined", "#{Machined::VERSION}"
+          
+          gem "sass", "~> 3.1"
+          gem "coffee-script", "~> 2.2"
+          
+          group :production do
+            gem "uglifier", "~> 1.0"
+          end
+        CONTENT
+      end
+    end
+    
+    it "creates a default config file" do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.read("my_site/machined.rb").should == <<-CONTENT.unindent
+          require "bundler"
+          Bundler.require :default, config.environment.to_sym
+          
+          if config.environment == "production"
+            # Compress javascripts and stylesheets
+            config.compress = true
+            
+            # Generate digests for assets URLs
+            # config.digest_assets = true
+            
+            # Create gzipped versions of javascripts and stylesheets
+            # config.gzip_assets = true
+          end
+          
+          helpers do
+            # Define helper methods here
+          end
+        CONTENT
+      end
+    end
+    
+    it "creates a default rackup file" do
+      within_construct do |c|
+        machined_cli "new my_site"
+        File.read("my_site/config.ru").should == <<-CONTENT.unindent
+          require "machined"
+          run Machined::Environment.new
+        CONTENT
+      end
+    end
+  end
+  
+  describe "#server" do
+    it "should start a Rack server" do
+      app = machined
+      Machined::Environment.should_receive(:new).with(:root => ".", :output_path => "site", :environment => "production", :config_path => "machined.rb").and_return(app)
+      Rack::Server.should_receive(:start).with(hash_including(:app => app, :environment => "production", :Port => 5000))
+      machined_cli "server -o site -e production -p 5000"
+    end
+  end
+  
+  describe "#version" do
+    it "prints out the current version number" do
+      output = machined_cli "version"
+      output.strip.should == Machined::VERSION
+    end
+  end
+end