stylo 0.5

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## RubyMine
+.idea
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+tmp

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 mwagg
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= stylo
+
+Stylo aims to support server side combining of stylesheets within rails when hosted in an environment
+such as www.heroku.com where we have the problem of a read only file system.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 mwagg. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stylo"
+    gem.summary = %Q{Server side stylesheet combining for readonly hosting environments}
+    gem.description = %Q{Server side stylesheet combining for readonly hosting environments}
+    gem.email = "michael@guerillatactics.co.uk"
+    gem.homepage = "http://github.com/mwagg/stylo"
+    gem.authors = ["mwagg"]
+    gem.add_development_dependency "rspec", ">= 0"
+    gem.add_development_dependency "cucumber", ">= 0"
+    gem.add_development_dependency "rack-test", ">= 0"
+    gem.add_development_dependency "sinatra", ">= 0"
+    gem.add_runtime_dependency "haml", ">= 3.0.21"
+    gem.version = "0.5"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+desc "Run all examples"
+RSpec::Core::RakeTask.new()
+
+task :default => [:spec, :features]
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stylo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.profile = :default
+end

data/TODO

@@ -0,0 +1,4 @@
+support switching off combining (for development)
+add minification for javascript
+add minification for css
+make it so sass is only used if the sass gem is not available (without making the pipeline configuration messy)

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: features --format pretty
+

data/features/fixtures/child.css

@@ -0,0 +1,3 @@
+#child {
+    background: #000000;
+}

data/features/fixtures/child.js

@@ -0,0 +1,3 @@
+function child() {
+    alert('child');
+}

data/features/fixtures/grand_parent.css

@@ -0,0 +1,5 @@
+@import "parent.css";
+
+#grandparent {
+    background: #CCCCCC;
+}

data/features/fixtures/grand_parent.js

@@ -0,0 +1,5 @@
+///require "parent.js";
+
+function grandParent() {
+    alert('grand parent');
+}

data/features/fixtures/grand_parent_with_parent_with_child.css

@@ -0,0 +1,11 @@
+#child {
+    background: #000000;
+}
+
+#parent {
+    background: #FFFFFF;
+}
+
+#grandparent {
+    background: #CCCCCC;
+}

data/features/fixtures/grand_parent_with_parent_with_child.js

@@ -0,0 +1,11 @@
+function child() {
+    alert('child');
+}
+
+function parent() {
+    alert('parent');
+}
+
+function grandParent() {
+    alert('grand parent');
+}

data/features/fixtures/parent.css

@@ -0,0 +1,5 @@
+@import "child.css";
+
+#parent {
+    background: #FFFFFF;
+}

data/features/fixtures/parent.js

@@ -0,0 +1,5 @@
+///require "child.js";
+
+function parent() {
+    alert('parent');
+}

data/features/fixtures/parent_with_child.css

@@ -0,0 +1,7 @@
+#child {
+    background: #000000;
+}
+
+#parent {
+    background: #FFFFFF;
+}

data/features/fixtures/parent_with_child.js

@@ -0,0 +1,7 @@
+function child() {
+    alert('child');
+}
+
+function parent() {
+    alert('parent');
+}

data/features/fixtures/processed_sass_child.css

@@ -0,0 +1,2 @@
+#child {
+  background: black; }

data/features/fixtures/processed_sass_which_uses_mixin.css

@@ -0,0 +1,3 @@
+#element {
+  border: solid 1px #000000;
+  background: #FFFFFF; }

data/features/fixtures/sass_child.scss

@@ -0,0 +1,4 @@
+$black: #000000;
+#child {
+    background: $black;
+}

data/features/fixtures/sass_mixins.scss

@@ -0,0 +1,3 @@
+@mixin black-border {
+    border: solid 1px #000000;
+}

data/features/fixtures/sass_which_uses_mixin.scss

@@ -0,0 +1,6 @@
+@import "sass_mixins.scss";
+
+#element {
+    @include black-border;
+    background: #FFFFFF;
+}

data/features/fixtures.rb

@@ -0,0 +1,5 @@
+module Fixtures
+  def load_fixture(fixture_name)
+    File.read File.join(File.dirname(__FILE__), 'fixtures', fixture_name)
+  end
+end

data/features/javascripts.feature

@@ -0,0 +1,19 @@
+Feature: Javascript serving
+
+  Scenario: Simple javascript serving
+    Given "child.js" is located at "javascripts" in the asset location
+    When a request is made for "javascripts/child.js"
+    Then the response body should look like "child.js"
+
+  Scenario: Simple javascript combining
+    Given "parent.js" is located at "javascripts" in the asset location
+    And "child.js" is located at "javascripts" in the asset location
+    When a request is made for "javascripts/parent.js"
+    Then the response body should look like "parent_with_child.js"
+
+  Scenario: Nested stylesheet combining
+    Given "grand_parent.js" is located at "javascripts" in the asset location
+    And "parent.js" is located at "javascripts" in the asset location
+    And "child.js" is located at "javascripts" in the asset location
+    When a request is made for "javascripts/grand_parent.js"
+    Then the response body should look like "grand_parent_with_parent_with_child.js"

data/features/response_headers.feature

@@ -0,0 +1,13 @@
+Feature: Response headers
+
+  Scenario: Responses should have the correct headers
+    Given "child.js" is located at "javascripts" in the asset location
+    When a request is made for "javascripts/child.js"
+    Then the response code should be "200"
+    And the "Content-Length" header should be "40"
+    And the "Content-Type" header should be "text/javascript"
+
+  Scenario: Content should be cached
+    Given "child.js" is located at "javascripts" in the asset location
+    When a request is made for "javascripts/child.js"
+    Then the "Cache-Control" header should be "public, max-age=86400"

data/features/sass_integration.feature

@@ -0,0 +1,13 @@
+Feature: Sass integration
+
+  Scenario: Simple sass stylesheet serving
+    Given "sass_child.scss" is located at "stylesheets" in the asset location
+    When a request is made for "stylesheets/sass_child.css"
+    Then the response body should look like "processed_sass_child.css"
+
+  Scenario: Combined sass stylesheet serving
+    Given "sass_mixins.scss" is located at "stylesheets" in the asset location
+    And "sass_which_uses_mixin.scss" is located at "stylesheets" in the asset location
+    When a request is made for "stylesheets/sass_which_uses_mixin.css"
+    Then the response body should look like "processed_sass_which_uses_mixin.css"
+

data/features/step_definitions/stylo_steps.rb

@@ -0,0 +1,24 @@
+Given /^"([^"]*)" is located at "([^"]*)" in the asset location$/ do |filename, folder|
+  cp fixture_path(filename), temp_path(folder)
+end
+
+When /^a request is made for "([^"]*)"$/ do |path|
+  get path
+end
+
+Then /^the response body should look like "([^"]*)"$/ do |filename|
+  last_response.body.should == load_fixture(filename)
+end
+
+Then /^the response code should be "([^\"]*)"$/ do |response_code|
+  last_response.status.should == response_code.to_i
+end
+
+When /^the "([^\"]*)" header should be "([^\"]*)"$/ do |header_key, expected_value|
+  last_response.headers[header_key].should == expected_value
+end
+
+Then /^the response should be from a call back into rack$/ do
+  last_response.status.should == 404
+  last_response.body.should include("Sinatra doesn't know this ditty.")
+end

data/features/stylesheets.feature

@@ -0,0 +1,31 @@
+Feature: Stylesheet serving
+
+  Scenario: Simple stylesheet serving
+    Given "child.css" is located at "stylesheets" in the asset location
+    When a request is made for "stylesheets/child.css"
+    Then the response body should look like "child.css"
+
+  Scenario: Simple stylesheet combining
+    Given "parent.css" is located at "stylesheets" in the asset location
+    And "child.css" is located at "stylesheets" in the asset location
+    When a request is made for "stylesheets/parent.css"
+    Then the response body should look like "parent_with_child.css"
+
+  Scenario: Nested stylesheet combining
+    Given "grand_parent.css" is located at "stylesheets" in the asset location
+    And "parent.css" is located at "stylesheets" in the asset location
+    And "child.css" is located at "stylesheets" in the asset location
+    When a request is made for "stylesheets/grand_parent.css"
+    Then the response body should look like "grand_parent_with_parent_with_child.css"
+
+  Scenario: Stylesheet responses should have the correct headers
+    Given "child.css" is located at "stylesheets" in the asset location
+    When a request is made for "stylesheets/child.css"
+    Then the response code should be "200"
+    And the "Content-Length" header should be "35"
+    And the "Content-Type" header should be "text/css"
+
+  Scenario: Stylesheets should be cached
+    Given "child.css" is located at "stylesheets" in the asset location
+    When a request is made for "stylesheets/child.css"
+    Then the "Cache-Control" header should be "public, max-age=86400"

data/features/stylo_cannot_serve_asset.feature

@@ -0,0 +1,5 @@
+Feature: Stylo cannot serve an asset
+
+  Scenario: Stylo calls back into rack
+    When a request is made for "javascripts/i-dont-exist.js"
+    Then the response should be from a call back into rack

data/features/support/env.rb

@@ -0,0 +1,24 @@
+require 'rack/test'
+require 'sinatra'
+
+require File.join(File.dirname(__FILE__), '../../spec/spec_helper')
+
+class MyApp < Sinatra::Application
+
+end
+
+World do
+  include Rack::Test::Methods
+  include StyloSpecHelpers
+  include FileUtils
+
+  def app
+    @app ||= Rack::Builder.new do
+      use Stylo::Rack
+      run MyApp
+    end
+  end
+
+  reset_paths
+end
+

data/lib/stylo/asset_loader.rb

@@ -0,0 +1,9 @@
+module Stylo
+  class AssetLoader
+    def self.load_content(path)
+      path = File.join(Stylo::Config.asset_location, path)
+
+      File.read(path) if File.exist?(path)
+    end
+  end
+end

data/lib/stylo/combiner.rb

@@ -0,0 +1,14 @@
+module Stylo
+  class Combiner
+    def initialize(asset_directory, require_pattern)
+      @require_pattern = require_pattern
+      @asset_directory = asset_directory
+    end
+
+    def process(content)
+      content.gsub @require_pattern do |match|
+        process(AssetLoader.load_content(File.join(@asset_directory, $1)))
+      end
+    end
+  end
+end

data/lib/stylo/config.rb

@@ -0,0 +1,14 @@
+module Stylo
+  class Config
+    class << self
+      attr_accessor :asset_location
+
+      def pipeline
+        [Stylo::PipelineSteps::Stylesheet.new,
+         Stylo::PipelineSteps::Javascript.new,
+         Stylo::PipelineSteps::Sass.new,
+         Stylo::PipelineSteps::Caching.new]
+      end
+    end
+  end
+end

data/lib/stylo/pipeline_steps/caching.rb

@@ -0,0 +1,11 @@
+module Stylo
+  module PipelineSteps
+    class Caching
+      def call(response)
+        if response.has_content?
+          response.set_header('Cache-Control', 'public, max-age=86400')
+        end
+      end
+    end
+  end
+end

data/lib/stylo/pipeline_steps/javascript.rb

@@ -0,0 +1,15 @@
+module Stylo
+  module PipelineSteps
+    class Javascript
+      REQUIRE_PATTERN = /\/\/\/require "(.*)";/
+
+      def call(response)
+        return if response.has_content? || response.extension != '.js'
+        return unless content = AssetLoader.load_content(response.path)
+        combined_content = Combiner.new(File.dirname(response.path), REQUIRE_PATTERN).process(content)
+
+        response.set_body combined_content, :javascript
+      end
+    end
+  end
+end

data/lib/stylo/pipeline_steps/sass.rb

@@ -0,0 +1,18 @@
+require 'sass'
+
+module Stylo
+  module PipelineSteps
+    class Sass
+      def call(response)
+        return if response.has_content? || response.extension != '.css'
+        content = AssetLoader.load_content(response.path.gsub('.css', '.scss'))
+        return if content.nil?
+
+        combined_content = Combiner.new(File.dirname(response.path), REQUIRE_PATTERN).process(content)
+        processed_content = ::Sass::Engine.new(combined_content, {:syntax => :scss}).render
+
+        response.set_body(processed_content, :css)
+      end
+    end
+  end
+end

data/lib/stylo/pipeline_steps/stylesheet.rb

@@ -0,0 +1,15 @@
+module Stylo
+  module PipelineSteps
+    REQUIRE_PATTERN = /@import "(.*)";/
+
+    class Stylesheet
+      def call(response)
+        return if response.has_content? || response.extension != '.css'
+        return unless content = AssetLoader.load_content(response.path)
+        combined_content = Combiner.new(File.dirname(response.path), REQUIRE_PATTERN).process(content)
+
+        response.set_body combined_content, :css
+      end
+    end
+  end
+end

data/lib/stylo/processor.rb

@@ -0,0 +1,47 @@
+module Stylo
+  class Processor
+    def initialize
+    end
+
+    def get_stylesheet_path(asset)
+      File.join(Stylo::Config.asset_location, asset)
+    end
+
+    def process_asset(asset)
+      asset_path = get_stylesheet_path(asset)
+      asset_extension = File.extname(asset_path)
+
+      file_content = get_file_content(asset_path)
+      if !file_content.nil?
+        asset_dir = File.dirname(asset_path)
+
+        import_regex = asset_extension == '.css' ? /@import "(.*)";/ : /\/\/\/require "(.*)";/
+
+        process_requires file_content, asset_dir, import_regex
+      else
+        nil
+      end
+    end
+
+    def get_file_content(asset_path)
+      return nil if !File.exist?(asset_path)
+
+      File.read(asset_path)
+    end
+
+    private
+
+    def process_requires(contents, base_path, import_regex)
+      contents.gsub import_regex do |match|
+        import_path = File.join(base_path, $1)
+        import_content = get_file_content(import_path)
+
+        if !import_content.nil?
+          process_requires(import_content, base_path, import_regex)
+        else
+          raise "Cannot find file to import '#{$1}'."
+        end
+      end
+    end
+  end
+end

data/lib/stylo/rack.rb

@@ -0,0 +1,20 @@
+module Stylo
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      path = env["PATH_INFO"]
+
+      response = Response.new(path)
+      Stylo::Config.pipeline.each { |step| step.call(response) }
+
+      if response.has_content?
+        response.build
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/stylo/railtie.rb

@@ -0,0 +1,13 @@
+begin
+  require 'rails'
+
+  module Stylo
+    class Railtie < Rails::Railtie
+      initializer "stylo.initialize" do |app|
+        Stylo::Config.asset_location ||= File.join(app.root, 'public')
+        app.middleware.insert_before ActionDispatch::Static, Stylo::Rack
+      end
+    end
+  end
+rescue LoadError
+end

data/lib/stylo/response.rb

@@ -0,0 +1,41 @@
+module Stylo
+  class Response
+    def initialize(path)
+      @headers = {}
+      @path = path
+    end
+
+    attr_reader :body, :headers, :path
+
+    def has_content?
+      !body.nil?
+    end
+
+    def extension
+      File.extname @path
+    end
+
+    def set_body(content, content_type)
+      @body = content
+
+      set_header 'Content-Length', content.length.to_s
+      set_header "Content-Type", case content_type
+                                   when :css
+                                     'text/css'
+                                   when :javascript
+                                     'text/javascript'
+                                   else
+                                     raise "Unknown content type #{content_type}"
+                                 end
+    end
+
+    def set_header(name, value)
+      @headers[name] = value
+    end
+
+    def build
+      [200, headers, body]
+    end
+  end
+
+end

data/lib/stylo.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+Dir.glob(File.join(File.dirname(__FILE__), '**/*.rb')).each { |f| require f }
+
+

data/spec/asset_loader_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Stylo::AssetLoader do
+  describe "load_content" do
+    it "should return nil if the content does not exist" do
+      Stylo::AssetLoader.load_content('javascripts/i_dont_exist.js').should be_nil
+    end
+
+    it "should return the file content if the content exists" do
+      content = "alert('hello');"
+      write_content(temp_path('javascripts/i_exist.js'), content)
+
+      Stylo::AssetLoader.load_content('javascripts/i_exist.js').should == content
+    end
+  end
+end