machined 0.3.1 → 0.4.0

data/bin/machined

@@ -1,4 +1,7 @@
 #!/usr/bin/env ruby
 
+ENV["BUNDLE_GEMFILE"] ||= File.join(Dir.pwd, "Gemfile")
+require "bundler/setup" if File.exist? ENV["BUNDLE_GEMFILE"]
+
 require "machined"
 Machined::CLI.start

data/lib/machined.rb

@@ -4,6 +4,7 @@ module Machined
   autoload :CLI,                    "machined/cli"
   autoload :Context,                "machined/context"
   autoload :Environment,            "machined/environment"
+  autoload :Initializable,          "machined/initializable"
   autoload :Server,                 "machined/server"
   autoload :Sprocket,               "machined/sprocket"
   autoload :StaticCompiler,         "machined/static_compiler"

data/lib/machined/environment.rb

@@ -6,6 +6,8 @@ require "tilt"
 
 module Machined
   class Environment
+    include Initializable
+    
     # Default options for a Machined environment.
     DEFAULT_OPTIONS = {
       # Global configuration
@@ -13,6 +15,7 @@ module Machined
       :config_path    => "machined.rb",
       :output_path    => "public",
       :environment    => "development",
+      :skip_bundle    => false,
       :digest_assets  => false,
       :gzip_assets    => false,
       :layout         => "main",
@@ -96,67 +99,117 @@ module Machined
     def initialize(options = {})
       @config          = OpenStruct.new DEFAULT_OPTIONS.dup.merge(options)
       @root            = Pathname.new(config.root).expand_path
+      @output_path     = root.join config.output_path
       @sprockets       = []
       @context_helpers = []
       
-      # Create and append the default `assets` sprocket.
-      # This sprocket mimics the asset pipeline in Rails 3.1.
-      append_sprocket :assets, :assets => true
+      run_initializers self
+    end
+    
+    # If bundler is used, require all the gems in the Gemfile
+    # for this environment.
+    initializer :require_bundle do
+      next if config.skip_bundle
       
-      # Create and append the default `pages` sprocket.
-      # This sprocket is responsible for processing HTML pages,
-      # and includes processors for wrapping pages in layouts and
-      # reading YAML front matter.
+      ENV["BUNDLE_GEMFILE"] ||= root.join("Gemfile").to_s
+      if File.exist? ENV["BUNDLE_GEMFILE"]
+        require "bundler"
+        Bundler.require :default, config.environment.to_sym
+      end
+    end
+    
+    # Create and append the default `assets` sprocket.
+    # This sprocket mimics the asset pipeline in Rails 3.1.
+    initializer :create_assets_sprocket do
+      append_sprocket :assets, :assets => true
+    end
+    
+    # Create and append the default `pages` sprocket.
+    # This sprocket is responsible for processing HTML pages,
+    # and includes processors for wrapping pages in layouts and
+    # reading YAML front matter.
+    initializer :create_pages_sprocket do
       append_sprocket :pages do |pages|
         pages.register_mime_type     "text/html", ".html"
         pages.register_preprocessor  "text/html", Processors::FrontMatterProcessor
         pages.register_postprocessor "text/html", Processors::LayoutProcessor
       end
-      
-      # Create and append the default `views` sprocket.
-      # The files in this sprocket are not compiled. They are
-      # meant to be resources for the other sprockets. For instance,
-      # the layouts for the `pages` sprocket will be located here.
+    end
+    
+    # Create and append the default `views` sprocket.
+    # The files in this sprocket are not compiled. They are
+    # meant to be resources for the other sprockets. For instance,
+    # the layouts for the `pages` sprocket will be located here.
+    initializer :create_views_sprocket do
       append_sprocket :views, :compile => false do |views|
         views.register_mime_type "text/html", ".html"
       end
-      
-      # If there's a config file, execute with the scope of the
-      # newly created Machined environment. The default sprockets are
-      # available at this point, but not fully configured. This is so
-      # you can actually configure the sprockets with this file.
-      config_file = root.join(config.config_path)
+    end
+    
+    # If there's a config file, execute with the scope of the
+    # newly created Machined environment. The default sprockets are
+    # available at this point, but not fully configured. This is so
+    # you can actually configure the sprockets with this file.
+    initializer :eval_config_file do
+      config_file = root.join config.config_path
       instance_eval config_file.read if config_file.exist?
       
-      # Handle anymore configuration related setup.
-      @output_path = root.join(config.output_path)
-      
-      # Append the paths for each sprocket. The default `assets` sprocket
-      # is special, because we actually append the directories within
-      # the given paths (like the Rails 3.1 asset pipeline).
-      append_path  pages, config.pages_path
-      append_paths pages, config.pages_paths
-      append_path  views, config.views_path
-      append_paths views, config.views_paths
+      # This could be changed in the config file
+      @output_path = root.join config.output_path
+    end
+    
+    # Register all available Tilt templates to every
+    # sprocket other than the assets sprocket
+    initializer :register_all_templates do
+      sprockets.each do |sprocket|
+        sprocket.use_all_templates unless sprocket.config.assets
+      end
+    end
+    
+    # Do any configuration to the assets sprockets necessary
+    # after the config file has been evaled.
+    initializer :configure_assets_sprocket do
+      # Append the directories within the configured paths
       append_paths assets, Utils.existent_directories(root.join(config.assets_path))
       config.assets_paths.each do |asset_path|
         append_paths assets, Utils.existent_directories(root.join(asset_path))
       end
       
       # Search for Rails Engines with assets and append those
-      if defined?(Rails) && defined?(Rails::Engine)
+      if defined? Rails::Engine
         Rails::Engine.subclasses.each do |engine|
-          append_paths assets, engine.paths["vendor/assets"].existent_directories
-          append_paths assets, engine.paths["lib/assets"].existent_directories
           append_paths assets, engine.paths["app/assets"].existent_directories
+          append_paths assets, engine.paths["lib/assets"].existent_directories
+          append_paths assets, engine.paths["vendor/assets"].existent_directories
         end
       end
       
-      # Set the URLs for the compilable default sprockets.
+      # Setup the base URL for the assets (like the Rails asset_prefix)
       assets.config.url = config.assets_url
-      pages.config.url  = config.pages_url
+    end
+    
+    # Do any configuration to the pages sprockets necessary
+    # after the config file has been evaled.
+    initializer :configure_pages_sprocket do
+      # Append the configured pages paths
+      append_path  pages, config.pages_path
+      append_paths pages, config.pages_paths
       
-      # Now setup assets compression.
+      # Setup the base URL for the pages
+      pages.config.url = config.pages_url
+    end
+    
+    # Do any configuration to the views sprockets necessary
+    # after the config file has been evaled.
+    initializer :configure_views_sprocket do
+      # Append the configured views paths
+      append_path  views, config.views_path
+      append_paths views, config.views_paths
+    end
+    
+    # Setup the JavaScript and CSS compressors
+    # for the assets based on the configuration.
+    initializer :configure_assets_compression do
       if config.compress
         config.compress_js  = true
         config.compress_css = true
@@ -166,9 +219,11 @@ module Machined
       end
       assets.js_compressor  = js_compressor  if config.compress_js
       assets.css_compressor = css_compressor if config.compress_css
-      
-      # Finally, configure Sprockets::Helpers to
-      # match curernt configuration.
+    end
+    
+    # Finally, configure Sprockets::Helpers to
+    # match curernt configuration.
+    initializer :configure_sprockets_helpers do
       Sprockets::Helpers.configure do |helpers|
         helpers.environment = assets
         helpers.digest      = config.digest_assets

data/lib/machined/initializable.rb

@@ -0,0 +1,72 @@
+require "active_support/concern"
+
+module Machined
+  # Initializable is a minimal version of
+  # Rails::Initializable. Its implementation
+  # of placing initializers before or after other
+  # initializers is a bit naive, compared to the Rails
+  # version, but it suits the needs of this lib.
+  #
+  # If they move Rails::Initializable into ActiveSupport
+  # I'll remove this module and use theirs. Right now,
+  # I don't want to `require "rails"` if I don't have to.
+  module Initializable
+    extend ActiveSupport::Concern
+    
+    class Initializer < Struct.new(:name, :block)
+      # Run's the initializer's +block+ with the given
+      # +context+ and yields the given +args+
+      # to the block.
+      def run(context, *args)
+        context.instance_exec(*args, &block)
+      end
+    end
+    
+    module ClassMethods
+      # Returns an array of the initializers for
+      # this class.
+      def initializers
+        @initializers ||= []
+      end
+      
+      # Creates a new initializer with the given name.
+      # You can optionally pace initializers before or after
+      # other initializers using the `:before` and `:after`
+      # options. Otherwise the initializer is appended to the
+      # of the list.
+      def initializer(name, options = {}, &block)
+        initializer = Initializer.new(name, block)
+        
+        if after = options[:after]
+          initializers.insert initializer_index(after) + 1, initializer
+        elsif before = options[:before]
+          initializers.insert initializer_index(before), initializer
+        else
+          initializers << initializer
+        end
+      end
+      
+      protected
+      
+      # Returns the index of the initializer with
+      # the given name.
+      def initializer_index(name) # :nodoc:
+        initializers.index do |initializer|
+          initializer.name.to_sym == name.to_sym
+        end or raise "The specified initializer, #{name.inspect}, does not exist"
+      end
+    end
+    
+    module InstanceMethods
+      # Run each initializer with the given args
+      # yielded to each initializer's block.
+      def run_initializers(*args)
+        return if @initializers_run
+        self.class.initializers.each do |initializer|
+          initializer.run self, *args
+        end
+        @initializers_run = true
+      end
+    end
+  end
+end

data/lib/machined/version.rb

@@ -1,3 +1,3 @@
 module Machined
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/machined.gemspec

@@ -29,14 +29,14 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec",             "~> 2.7.0"
   s.add_development_dependency "rack-test",         "~> 0.6.1"
   s.add_development_dependency "test-construct",    "~> 1.2.0"
-  s.add_development_dependency 'unindent',          "~> 1.0"
+  s.add_development_dependency "unindent",          "~> 1.0"
+  s.add_development_dependency "railties",          "~> 3.1.1"
   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 "railties"
   s.add_development_dependency "jquery-rails"
   s.add_development_dependency "rake"
 end

data/spec/machined/environment_spec.rb

@@ -125,6 +125,7 @@ describe Machined::Environment do
       require "rails"
       require "jquery-rails"
       machined.assets.paths.first.should =~ %r(/jquery-rails-[\d\.]+/vendor/assets/javascripts)
+      Rails::Engine.subclasses.delete Jquery::Rails::Engine
     end
     
     it "compiles web assets" do

data/spec/machined/initializable_spec.rb

@@ -0,0 +1,74 @@
+require "spec_helper"
+
+describe Machined::Initializable do
+  class BasicInitializer
+    include Machined::Initializable
+    attr_accessor :count
+  end
+  
+  after(:each) do
+    BasicInitializer.instance_variable_set :@initializers, nil
+  end
+  
+  it "runs initializers in order" do
+    array = []
+    BasicInitializer.initializer(:one) { array << 1 }
+    BasicInitializer.initializer(:two) { array << 2 }
+    BasicInitializer.initializer(:three) { array << 3 }
+    BasicInitializer.new.run_initializers
+    array.should == [ 1, 2, 3 ]
+  end
+  
+  it "runs initializers only once" do
+    count = 0
+    BasicInitializer.initializer(:count) { count += 1 }
+    basic = BasicInitializer.new
+    basic.run_initializers
+    basic.run_initializers
+    count.should == 1
+  end
+  
+  it "executes in the instance scope" do
+    BasicInitializer.initializer(:init_count) { @count = 0 }
+    BasicInitializer.initializer(:one) { @count += 1 }
+    BasicInitializer.initializer(:two) { @count += 1 }
+    basic = BasicInitializer.new
+    basic.run_initializers
+    basic.count.should == 2
+  end
+  
+  it "runs the initializers with the given args" do
+    BasicInitializer.initializer(:sum) { |*args| @count = args.inject(&:+) }
+    basic = BasicInitializer.new
+    basic.run_initializers 1, 2, 3
+    basic.count.should == 6
+  end
+  
+  it "adds initializers after specific initializers" do
+    array = []
+    BasicInitializer.initializer(:one) { array << 1 }
+    BasicInitializer.initializer(:two) { array << 2 }
+    BasicInitializer.initializer(:three, :after => :one) { array << 3 }
+    BasicInitializer.new.run_initializers
+    array.should == [ 1, 3, 2 ]
+  end
+  
+  it "adds initializers before specific initializers" do
+    array = []
+    BasicInitializer.initializer(:one) { array << 1 }
+    BasicInitializer.initializer(:two) { array << 2 }
+    BasicInitializer.initializer(:three, :before => :two) { array << 3 }
+    BasicInitializer.new.run_initializers
+    array.should == [ 1, 3, 2 ]
+  end
+  
+  it "raises an error if the specified initializer doesn't exist" do
+    expect {
+      BasicInitializer.initializer(:wtf, :after => :omg) { }
+    }.to raise_error("The specified initializer, :omg, does not exist")
+    
+    expect {
+      BasicInitializer.initializer(:omg, :before => :wtf) { }
+    }.to raise_error("The specified initializer, :wtf, does not exist")
+  end
+end

data/spec/support/helpers.rb

@@ -1,10 +1,11 @@
 require "pathname"
+require "active_support/core_ext/hash/reverse_merge"
 
 module Machined
   module SpecHelpers
     # Convenience method for creating a new Machined environment
     def machined(config = {})
-      @machined ||= Machined::Environment.new(config)
+      @machined ||= Machined::Environment.new(config.reverse_merge(:skip_bundle => true))
     end
     
     # Convenience method for creating a new Machined sprocket,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: machined
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Pete Browne
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-10 00:00:00 Z
+date: 2011-11-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -30,8 +30,8 @@ dependencies:
         - 3
         version: 2.0.3
   name: sprockets
-  version_requirements: *id001
   prerelease: false
+  version_requirements: *id001
   type: :runtime
 - !ruby/object:Gem::Dependency 
   requirement: &id002 !ruby/object:Gem::Requirement 
@@ -46,8 +46,8 @@ dependencies:
         - 1
         version: 0.2.1
   name: sprockets-helpers
-  version_requirements: *id002
   prerelease: false
+  version_requirements: *id002
   type: :runtime
 - !ruby/object:Gem::Dependency 
   requirement: &id003 !ruby/object:Gem::Requirement 
@@ -62,8 +62,8 @@ dependencies:
         - 1
         version: 0.4.1
   name: sprockets-sass
-  version_requirements: *id003
   prerelease: false
+  version_requirements: *id003
   type: :runtime
 - !ruby/object:Gem::Dependency 
   requirement: &id004 !ruby/object:Gem::Requirement 
@@ -78,8 +78,8 @@ dependencies:
         - 5
         version: 0.10.5
   name: padrino-helpers
-  version_requirements: *id004
   prerelease: false
+  version_requirements: *id004
   type: :runtime
 - !ruby/object:Gem::Dependency 
   requirement: &id005 !ruby/object:Gem::Requirement 
@@ -94,8 +94,8 @@ dependencies:
         - 1
         version: 3.1.1
   name: activesupport
-  version_requirements: *id005
   prerelease: false
+  version_requirements: *id005
   type: :runtime
 - !ruby/object:Gem::Dependency 
   requirement: &id006 !ruby/object:Gem::Requirement 
@@ -110,8 +110,8 @@ dependencies:
         - 0
         version: 0.6.0
   name: i18n
-  version_requirements: *id006
   prerelease: false
+  version_requirements: *id006
   type: :runtime
 - !ruby/object:Gem::Dependency 
   requirement: &id007 !ruby/object:Gem::Requirement 
@@ -126,8 +126,8 @@ dependencies:
         - 6
         version: 0.14.6
   name: thor
-  version_requirements: *id007
   prerelease: false
+  version_requirements: *id007
   type: :runtime
 - !ruby/object:Gem::Dependency 
   requirement: &id008 !ruby/object:Gem::Requirement 
@@ -142,8 +142,8 @@ dependencies:
         - 3
         version: 0.3.3
   name: crush
-  version_requirements: *id008
   prerelease: false
+  version_requirements: *id008
   type: :runtime
 - !ruby/object:Gem::Dependency 
   requirement: &id009 !ruby/object:Gem::Requirement 
@@ -158,8 +158,8 @@ dependencies:
         - 0
         version: 2.7.0
   name: rspec
-  version_requirements: *id009
   prerelease: false
+  version_requirements: *id009
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id010 !ruby/object:Gem::Requirement 
@@ -174,8 +174,8 @@ dependencies:
         - 1
         version: 0.6.1
   name: rack-test
-  version_requirements: *id010
   prerelease: false
+  version_requirements: *id010
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id011 !ruby/object:Gem::Requirement 
@@ -190,8 +190,8 @@ dependencies:
         - 0
         version: 1.2.0
   name: test-construct
-  version_requirements: *id011
   prerelease: false
+  version_requirements: *id011
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id012 !ruby/object:Gem::Requirement 
@@ -205,22 +205,24 @@ dependencies:
         - 0
         version: "1.0"
   name: unindent
-  version_requirements: *id012
   prerelease: false
+  version_requirements: *id012
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 1
         segments: 
-        - 0
-        version: "0"
-  name: haml
-  version_requirements: *id013
+        - 3
+        - 1
+        - 1
+        version: 3.1.1
+  name: railties
   prerelease: false
+  version_requirements: *id013
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id014 !ruby/object:Gem::Requirement 
@@ -232,9 +234,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: sass
-  version_requirements: *id014
+  name: haml
   prerelease: false
+  version_requirements: *id014
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id015 !ruby/object:Gem::Requirement 
@@ -246,9 +248,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: slim
-  version_requirements: *id015
+  name: sass
   prerelease: false
+  version_requirements: *id015
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id016 !ruby/object:Gem::Requirement 
@@ -260,9 +262,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: erubis
-  version_requirements: *id016
+  name: slim
   prerelease: false
+  version_requirements: *id016
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id017 !ruby/object:Gem::Requirement 
@@ -274,9 +276,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rdiscount
-  version_requirements: *id017
+  name: erubis
   prerelease: false
+  version_requirements: *id017
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id018 !ruby/object:Gem::Requirement 
@@ -288,9 +290,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: uglifier
-  version_requirements: *id018
+  name: rdiscount
   prerelease: false
+  version_requirements: *id018
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id019 !ruby/object:Gem::Requirement 
@@ -302,9 +304,9 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: railties
-  version_requirements: *id019
+  name: uglifier
   prerelease: false
+  version_requirements: *id019
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id020 !ruby/object:Gem::Requirement 
@@ -317,8 +319,8 @@ dependencies:
         - 0
         version: "0"
   name: jquery-rails
-  version_requirements: *id020
   prerelease: false
+  version_requirements: *id020
   type: :development
 - !ruby/object:Gem::Dependency 
   requirement: &id021 !ruby/object:Gem::Requirement 
@@ -331,8 +333,8 @@ dependencies:
         - 0
         version: "0"
   name: rake
-  version_requirements: *id021
   prerelease: false
+  version_requirements: *id021
   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: 
@@ -359,6 +361,7 @@ files:
 - lib/machined/helpers/output_helpers.rb
 - lib/machined/helpers/page_helpers.rb
 - lib/machined/helpers/render_helpers.rb
+- lib/machined/initializable.rb
 - lib/machined/processors/front_matter_processor.rb
 - lib/machined/processors/layout_processor.rb
 - lib/machined/server.rb
@@ -384,6 +387,7 @@ files:
 - spec/machined/helpers/output_helpers_spec.rb
 - spec/machined/helpers/page_helpers_spec.rb
 - spec/machined/helpers/render_helpers_spec.rb
+- spec/machined/initializable_spec.rb
 - spec/machined/processors/front_matter_processor_spec.rb
 - spec/machined/processors/layout_processor_spec.rb
 - spec/machined/server_spec.rb
@@ -435,6 +439,7 @@ test_files:
 - spec/machined/helpers/output_helpers_spec.rb
 - spec/machined/helpers/page_helpers_spec.rb
 - spec/machined/helpers/render_helpers_spec.rb
+- spec/machined/initializable_spec.rb
 - spec/machined/processors/front_matter_processor_spec.rb
 - spec/machined/processors/layout_processor_spec.rb
 - spec/machined/server_spec.rb