machined 0.1.0

data/spec/machined/processors/front_matter_processor_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe Machined::Processors::FrontMatterProcessor do
+  it "parses the front matter and adds locals" do
+    within_construct do |c|
+      c.file "pages/index.html.haml", <<-CONTENT.unindent
+        ---
+        title: Hello
+        tags:
+        - 1
+        - 2
+        ---
+        = title.inspect
+        = tags.inspect
+      CONTENT
+      
+      machined.pages["index.html"].to_s.should == <<-CONTENT.unindent
+        "Hello"
+        [1, 2]
+      CONTENT
+    end
+  end
+  
+  it "ignores pages without front matter" do
+    within_construct do |c|
+      c.file "pages/index.html.md", <<-CONTENT.unindent
+        Title
+        ---
+        Another Title
+        ---
+        Content...
+      CONTENT
+      machined.pages["index.html"].to_s.should == <<-CONTENT.unindent
+        <h2>Title</h2>
+        
+        <h2>Another Title</h2>
+        
+        <p>Content...</p>
+      CONTENT
+    end
+  end
+end

data/spec/machined/processors/layout_processor_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe Machined::Processors::LayoutProcessor do
+  it "wraps the content with a layout" do
+    within_construct do |c|
+      c.file "pages/index.html", "<h1>Hello World</h1>"
+      c.file "views/layouts/main.html.haml", "#layout= yield"
+      
+      machined.pages["index.html"].to_s.should == "<div id='layout'><h1>Hello World</h1></div>\n"
+    end
+  end
+  
+  it "uses the default layout set in the configuration" do
+    within_construct do |c|
+      c.file "pages/index.html", "<h1>Hello World</h1>"
+      c.file "views/layouts/application.html.haml", "#layout= yield"
+      
+      machined :layout => "application"
+      machined.pages["index.html"].to_s.should == "<div id='layout'><h1>Hello World</h1></div>\n"
+    end
+  end
+  
+  it "does not wrap the content with a layout when layout is false" do
+    within_construct do |c|
+      c.file "pages/index.html", "<h1>Hello World</h1>"
+      c.file "views/layouts/application.html.haml", "#layout= yield"
+      
+      machined :layout => false
+      machined.pages["index.html"].to_s.should == "<h1>Hello World</h1>"
+    end
+  end
+end

data/spec/machined/server_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+
+describe Machined::Server do
+  include Rack::Test::Methods
+  
+  let(:app) { machined }
+  
+  it "serves up assets at the asset url" do
+    within_construct do |c|
+      c.file "assets/javascripts/main.js", "var app = {};\n"
+      c.file "assets/stylesheets/main.css", "body { color: red; }\n"
+      
+      get "/assets/main.js"
+      last_response.body.should == "var app = {};\n"
+      last_response.content_type.should == "application/javascript"
+      
+      get "/assets/main.css"
+      last_response.body.should == "body { color: red; }\n"
+      last_response.content_type.should == "text/css"
+    end
+  end
+  
+  it "serves up pages as the base url" do
+    within_construct do |c|
+      c.file "pages/index.html", "<h1>Hello World</h1>\n"
+      c.file "pages/about.html", "<h1>About Us</h1>\n"
+      
+      get "/"
+      last_response.body.should == "<h1>Hello World</h1>\n"
+      last_response.content_type.should == "text/html"
+      
+      get "/about"
+      last_response.body.should == "<h1>About Us</h1>\n"
+      last_response.content_type.should == "text/html"
+    end
+  end
+  
+  it "does not serve up views" do
+    within_construct do |c|
+      c.file "views/about.html", "<h1>About Us</h1>\n"
+      
+      get "/about"
+      last_response.should be_not_found
+      
+      get "/views/about"
+      last_response.should be_not_found
+    end
+  end
+  
+  it "serves up custom sprockets" do
+    within_construct do |c|
+      dir = c.directory "updates"
+      dir.file "new-site.html", "<h1>Hello World</h1>\n"
+      
+      get "/"
+      
+      machined.append_sprocket :updates, :url => "/updates" do |updates|
+        updates.append_path dir
+        updates.register_mime_type "text/html", ".html"
+      end
+      
+      get "/updates/new-site"
+      last_response.body.should == "<h1>Hello World</h1>\n"
+      last_response.content_type.should == "text/html"
+    end
+  end
+  
+  it "serves up files in the output path" do
+    within_construct do |c|
+      c.file "public/index.html", "<h1>Hello World</h1>\n"
+      
+      get "/index.html"
+      last_response.body.should == "<h1>Hello World</h1>\n"
+      last_response.content_type.should == "text/html"
+    end
+  end
+end

data/spec/machined/sprocket_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe Machined::Sprocket do
+  describe "#initialize" do
+    it "keeps a reference to the Machined environment" do
+      sprocket = create_sprocket
+      sprocket.machined.should be(machined)
+    end
+    
+    it "sets the root path" do
+      sprocket = create_sprocket
+      sprocket.root.should == Pathname.new(".").expand_path.to_s
+      sprocket = create_sprocket :root => "spec/machined"
+      sprocket.root.should == Pathname.new("spec/machined").expand_path.to_s
+    end
+  end
+  
+  describe "#context_class" do
+    it "subclasses Machined::Context" do
+      sprocket = create_sprocket
+      sprocket.context_class.should < Sprockets::Context
+      sprocket.context_class.should < Machined::Context
+    end
+  end
+  
+  describe "#use_all_templates" do
+    it "registers available templates as engines" do
+      sprocket = create_sprocket :assets => true
+      sprocket.engines(".haml").should be_nil
+      sprocket.engines(".md").should be_nil
+      sprocket.use_all_templates
+      sprocket.engines(".haml").should be(Tilt::HamlTemplate)
+      sprocket.engines(".md").should be(Tilt::RDiscountTemplate)
+    end
+  end
+end

data/spec/machined/static_compiler_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+describe Machined::StaticCompiler do
+  it "generates all of the static files" do
+    within_construct do |c|
+      c.file "assets/javascripts/main.js",       "//= require _dep"
+      c.file "assets/javascripts/_dep.js",       "var app = {};"
+      c.file "assets/stylesheets/main.css.scss", %(@import "dep";\nbody { color: $color; })
+      c.file "assets/stylesheets/_dep.scss",     "$color: red;"
+      c.file "assets/images/logo.jpg"
+      c.file "pages/index.html.md.erb", <<-CONTENT.unindent
+        ---
+        title: Hello World
+        ---
+        # <%= title %>
+        
+        Here's some *content*.
+      CONTENT
+      c.file "views/layouts/main.html.haml", <<-CONTENT.unindent
+        !!! 5
+        %html
+          %head
+            %title= title
+          %body
+            = yield
+      CONTENT
+    
+      machined.compile
+      
+      File.read("public/assets/main.js").should == "var app = {};\n"
+      File.read("public/assets/main.css").should == "body {\n  color: red; }\n"
+      File.exist?("public/assets/logo.jpg").should be_true
+      File.read("public/index.html").should == <<-CONTENT.unindent
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <title>Hello World</title>
+          </head>
+          <body>
+            <h1>Hello World</h1>
+            
+            <p>Here's some <em>content</em>.</p>
+          </body>
+        </html>
+      CONTENT
+    end
+  end
+  
+  it "generates digests when configured" do
+    within_construct do |c|
+      c.file "_/js/main.js", "var app = {};"
+      c.file "_/css/main.css", "body { color: red; }"
+      c.file "_/img/logo.jpg"
+      c.file "pages/index.html"
+      
+      machined(:digest_assets => true, :assets_url => "/_", :assets_path => "_").compile
+      
+      asset = machined.assets["main.js"]
+      File.read("public/_/main-#{asset.digest}.js").should == "var app = {};\n"
+      asset = machined.assets["main.css"]
+      File.read("public/_/main-#{asset.digest}.css").should == "body { color: red; }\n"
+      asset = machined.assets["logo.jpg"]
+      File.exist?("public/_/logo-#{asset.digest}.jpg").should be_true
+      asset = machined.pages["index.html"]
+      File.exist?("public/index-#{asset.digest}.html").should be_false
+      File.exist?("public/index.html").should be_true
+    end
+  end
+  
+  it "generates gzipped files when configured" do
+    within_construct do |c|
+      c.file "assets/javascripts/main.js"
+      c.file "assets/stylesheets/main.css"
+      c.file "assets/images/logo.jpg"
+      c.file "pages/index.html"
+      
+      machined(:gzip_assets => true).compile
+      
+      File.exist?("public/assets/main.js.gz").should be_true
+      File.exist?("public/assets/main.css.gz").should be_true
+      File.exist?("public/assets/logo.jpg.gz").should_not be_true
+      File.exist?("public/index.html.gz").should_not be_true
+    end
+  end
+end

data/spec/machined/utils_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe Machined::Utils do
+  describe ".avialable_templates" do
+    it "returns the available Tilt templates" do
+      Machined::Utils.instance_variable_set "@available_templates", nil
+      available_templates = Machined::Utils.available_templates
+      available_templates[".markdown"].should be(Tilt::RDiscountTemplate)
+      available_templates[".md"].should be(Tilt::RDiscountTemplate)
+      available_templates[".haml"].should be(Tilt::HamlTemplate)
+    end
+  end
+  
+  describe ".existent_directories" do
+    it "returns directories that exist in the given path" do
+      within_construct do |c|
+        c.directory "dir1"
+        c.directory "dir2"
+        c.directory "dir3"
+        
+        Machined::Utils.existent_directories(c).should match_paths(%w(dir1 dir2 dir3)).with_root(c)
+      end
+    end
+    
+    it "returns an empty array when the path is not a directory" do
+      within_construct do |c|
+        Machined::Utils.existent_directories(c.join("blank")).should == []
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "construct"
+require "rack/test"
+require "unindent"
+require "machined"
+require "sprockets"
+require "crush"
+require "slim"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.include Construct::Helpers
+  config.include Machined::SpecHelpers
+end

data/spec/support/helpers.rb

@@ -0,0 +1,59 @@
+module Machined
+  module SpecHelpers
+    # Convenience method for creating a new Machined environment
+    def machined(config = {})
+      @machined ||= Machined::Environment.new(config)
+    end
+    
+    # Convenience method for creating a new Machined sprocket,
+    # with an automatic reference to the current Machined
+    # environment instance.
+    def create_sprocket(config = {})
+      Machined::Sprocket.new machined, config
+    end
+  
+    # Yields a real context instance, created from
+    # a file with the given +content+. The processed
+    # output from the file is the second yielded param.
+    def with_context(content = "")
+      within_construct do |c|
+        # Create the necessary files
+        path = c.directory "context"
+        path.file "machined.css.erb", content
+        
+        # Create a sprocket that points to the correct dir
+        sprocket = create_sprocket
+        sprocket.append_path path
+        
+        # Find the asset and yield the context and output
+        asset = sprocket["machined.css"]
+        yield asset.send(:blank_context), asset.to_s
+      end
+    end
+    
+    # Runs the CLI with the given args.
+    def machined_cli(args, silence = true)
+      capture(:stdout) {
+        Machined::CLI.start args.split(" ")
+      }
+    end
+    
+    # Captures the given stream and returns it:
+    #
+    #   stream = capture(:stdout) { puts "Cool" }
+    #   stream # => "Cool\n"
+    #
+    def capture(stream)
+      begin
+        stream = stream.to_s
+        eval "$#{stream} = StringIO.new"
+        yield
+        result = eval("$#{stream}").string
+      ensure
+        eval "$#{stream} = #{stream.upcase}"
+      end
+  
+      result
+    end
+  end
+end

data/spec/support/match_paths_matcher.rb

@@ -0,0 +1,20 @@
+# Determines if the given `Array` of paths
+# matches the expected `Array` of paths. For consistency,
+# each path is converted to a string for comparison. Also,
+# the expected paths can be joined with a root path, using
+# the `with_root` method.
+RSpec::Matchers.define :match_paths do |expected|
+  match do |actual|
+    expected.map!(&:to_s)
+    actual.map!(&:to_s)
+    expected.map! { |path| File.join(@root, path) } if @root
+    
+    actual == expected
+  end
+  
+  chain :with_root do |root|
+    @root = root.to_s
+  end
+  
+  diffable
+end

metadata

@@ -0,0 +1,389 @@
+--- !ruby/object:Gem::Specification 
+name: machined
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Pete Browne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  requirement: *id001
+  name: sprockets
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  requirement: *id002
+  name: sprockets-sass
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 10
+        version: "0.10"
+  requirement: *id003
+  name: padrino-helpers
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  requirement: *id004
+  name: activesupport
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  requirement: *id005
+  name: i18n
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 14
+        version: "0.14"
+  requirement: *id006
+  name: thor
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  requirement: *id007
+  name: crush
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  requirement: *id008
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  requirement: *id009
+  name: rack-test
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  requirement: *id010
+  name: test-construct
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  requirement: *id011
+  name: unindent
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id012
+  name: haml
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id013
+  name: sass
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id014
+  name: slim
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id015
+  name: erubis
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id016 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id016
+  name: rdiscount
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id017 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id017
+  name: uglifier
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id018 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id018
+  name: rake
+  prerelease: false
+  type: :development
+description: 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.
+email: 
+- me@petebrowne.com
+executables: 
+- machined
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/machined
+- lib/machined.rb
+- lib/machined/cli.rb
+- lib/machined/context.rb
+- lib/machined/environment.rb
+- lib/machined/helpers/asset_tag_helpers.rb
+- lib/machined/helpers/locals_helpers.rb
+- lib/machined/helpers/output_helpers.rb
+- lib/machined/helpers/render_helpers.rb
+- lib/machined/processors/front_matter_processor.rb
+- lib/machined/processors/layout_processor.rb
+- lib/machined/server.rb
+- lib/machined/sprocket.rb
+- lib/machined/static_compiler.rb
+- lib/machined/templates/site/Gemfile.tt
+- lib/machined/templates/site/assets/images/.empty_directory
+- lib/machined/templates/site/assets/javascripts/main.js.coffee
+- lib/machined/templates/site/assets/stylesheets/main.css.scss
+- lib/machined/templates/site/config.ru
+- lib/machined/templates/site/machined.rb
+- lib/machined/templates/site/pages/index.html.erb
+- lib/machined/templates/site/public/.empty_directory
+- lib/machined/templates/site/views/layouts/main.html.erb
+- lib/machined/utils.rb
+- lib/machined/version.rb
+- machined.gemspec
+- spec/machined/cli_spec.rb
+- spec/machined/context_spec.rb
+- spec/machined/environment_spec.rb
+- spec/machined/helpers/asset_tag_helpers_spec.rb
+- spec/machined/helpers/locals_helper_spec.rb
+- spec/machined/helpers/output_helpers_spec.rb
+- spec/machined/helpers/render_helpers_spec.rb
+- spec/machined/processors/front_matter_processor_spec.rb
+- spec/machined/processors/layout_processor_spec.rb
+- spec/machined/server_spec.rb
+- spec/machined/sprocket_spec.rb
+- spec/machined/static_compiler_spec.rb
+- spec/machined/utils_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/match_paths_matcher.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: machined
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A static site generator and Rack server built using Sprockets 2.0
+test_files: 
+- spec/machined/cli_spec.rb
+- spec/machined/context_spec.rb
+- spec/machined/environment_spec.rb
+- spec/machined/helpers/asset_tag_helpers_spec.rb
+- spec/machined/helpers/locals_helper_spec.rb
+- spec/machined/helpers/output_helpers_spec.rb
+- spec/machined/helpers/render_helpers_spec.rb
+- spec/machined/processors/front_matter_processor_spec.rb
+- spec/machined/processors/layout_processor_spec.rb
+- spec/machined/server_spec.rb
+- spec/machined/sprocket_spec.rb
+- spec/machined/static_compiler_spec.rb
+- spec/machined/utils_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
+- spec/support/match_paths_matcher.rb