wireframe-sass-rails 3.1.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.sass-cache

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in sass-rails.gemspec
+gemspec
+
+gem "sfl", "~> 2.0"
+gem "sprockets"
+gem "mocha"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'
+

data/README.markdown

@@ -0,0 +1,68 @@
+# Official Ruby-on-Rails Integration with Sass
+
+This gem provides official integration for ruby on rails projects with the Sass stylesheet language.
+
+## Installing
+
+Since rails 3.1, new rails projects will be already configured to use Sass. If you are upgrading to rails 3.1 you will need to add the following to your Gemfile:
+
+    gem 'sass-rails'
+
+## Configuration
+
+To configure Sass via rails set use `config.sass` in your
+application and/or environment files to set configuration
+properties that will be passed to Sass.
+
+### Example
+
+    MyProject::Application.configure do
+      config.sass.line_comments = false
+      config.sass.syntax = :nested
+    end
+
+### Options
+
+The [list of supported options](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#options) can be found on the Sass Website with the following  caveats:
+
+1. Output compression is now controlled via the `config.assets.compress` boolean option instead of through the `:style` option.
+2. `:never_update` - This option is not supported. Instead set `config.assets.enabled = false`
+3. `:always_update` - This option is not supported. Sprockets uses a controller to access stylesheets in development mode instead of a full scan for changed files.
+4. `:always_check` - This option is not supported. Sprockets always checks in development.
+5. `:syntax` - This is determined by the file's extensions.
+6. `:filename` - This is determined by the file's name.
+7. `:line` - This is provided by the template handler.
+
+## Features
+
+* **Glob Imports**. When in rails, there is a special import syntax that allows you to
+  glob imports relative to the folder of the stylesheet that is doing the importing.
+  E.g. `@import "mixins/*"` will import all the files in the mixins folder and
+  `@import "mixins/**/*"` will import all the files in the mixins tree.
+  Any valid ruby glob may be used. The imports are sorted alphabetically.
+  **NOTE:** It is recommended that you only use this when importing pure library
+  files (containing mixins and variables) because it is difficult to control the
+  cascade ordering for imports that contain styles using this approach.
+
+* **Asset Helpers**. When using the asset pipeline, paths to assets must be rewritten.
+  When referencing assets use the following asset helpers:
+
+  * `asset_path($relative-asset-path, $asset-class)` - Returns a string to the asset.
+    For example: `asset_path("rails.png", image)` becomes `"/assets/rails.png"`
+  * `asset_url($relative-asset-path, $asset-class)` - Returns url reference to the asset.
+    
+    For example: `asset_url("rails.png", image)` becomes `url(/assets/rails.png)`
+  * As a convenience, for each of the following asset classes there are
+    corresponding `_path` and `_url` helpers:
+    image, font, video, audio, javascript, stylesheet.
+    
+    For example: `image_url("rails.png")` becomes `url(/assets/rails.png)` and
+    `image_path("rails.png")` becomes `"/assets/rails.png"`.
+  
+
+## Running Tests
+
+    $ bundle install
+    $ bundle exec rake test
+
+If you need to test against local gems, use Bundler's gem :path option in the Gemfile and also edit `test/support/test_helper.rb` and tell the tests where the gem is checked out.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+

data/lib/rails/generators/sass/assets/assets_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators/named_base"
+
+module Sass
+  module Generators
+    class AssetsGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_sass
+        template "stylesheet.css.sass", File.join('app/assets/stylesheets', class_path, "#{file_name}.css.sass")
+      end
+    end
+  end
+end

data/lib/rails/generators/sass/assets/templates/stylesheet.css.sass

@@ -0,0 +1,3 @@
+// Place all the styles related to the <%= name %> controller here.
+// They will automatically be included in application.css.
+// You can use Sass here: http://sass-lang.com/

data/lib/rails/generators/sass/scaffold/scaffold_generator.rb

@@ -0,0 +1,9 @@
+require "rails/generators/sass_scaffold"
+
+module Sass
+  module Generators
+    class ScaffoldGenerator < ::Sass::Generators::ScaffoldBase
+      def syntax() :sass end
+    end
+  end
+end

data/lib/rails/generators/sass_scaffold.rb

@@ -0,0 +1,16 @@
+require "sass/css"
+require "rails/generators/named_base"
+
+module Sass
+  module Generators
+    class ScaffoldBase < ::Rails::Generators::NamedBase
+      def copy_stylesheet
+        dir = ::Rails::Generators::ScaffoldGenerator.source_root
+        file = File.join(dir, "scaffold.css")
+        converted_contents = ::Sass::CSS.new(File.read(file)).render(syntax)
+        create_file "app/assets/stylesheets/scaffolds.css.#{syntax}", converted_contents
+      end
+    end
+  end
+end
+

data/lib/rails/generators/scss/assets/assets_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators/named_base"
+
+module Scss
+  module Generators
+    class AssetsGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_scss
+        template "stylesheet.css.scss", File.join('app/assets/stylesheets', class_path, "#{file_name}.css.scss")
+      end
+    end
+  end
+end

data/lib/rails/generators/scss/assets/templates/stylesheet.css.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the <%= name %> controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/lib/rails/generators/scss/scaffold/scaffold_generator.rb

@@ -0,0 +1,10 @@
+require "rails/generators/sass_scaffold"
+
+module Scss
+  module Generators
+    class ScaffoldGenerator < ::Sass::Generators::ScaffoldBase
+      def syntax() :scss end
+    end
+  end
+end
+

data/lib/sass-rails.rb

@@ -0,0 +1 @@
+require 'sass/rails'

data/lib/sass/rails.rb

@@ -0,0 +1,12 @@
+module Sass
+  module Rails
+  end
+end
+
+require 'sass/rails/compressor'
+require 'sass/rails/logger'
+require 'sass/rails/railtie'
+require 'sass/rails/helpers'
+require 'sass/rails/importer'
+require 'sass/rails/template_handlers'
+require 'sass/rails/version'

data/lib/sass/rails/compressor.rb

@@ -0,0 +1,15 @@
+require 'sass'
+
+module Sass
+  module Rails
+    class CssCompressor
+      def compress(css)
+        Sass::Engine.new(css,
+                         :syntax => :scss,
+                         :cache => false,
+                         :read_cache => false,
+                         :style => :compressed).render
+      end
+    end
+  end
+end

data/lib/sass/rails/helpers.rb

@@ -0,0 +1,38 @@
+module Sass
+  module Rails
+    module Helpers
+
+      def asset_path(asset, kind)
+        Sass::Script::String.new(public_path(asset.value, kind.value), true)
+      end
+
+      def asset_url(asset, kind)
+        Sass::Script::String.new(%Q{url(#{public_path(asset.value, kind.value)})})
+      end
+
+      [:image, :font, :video, :audio, :javascript, :stylesheet].each do |asset_class|
+        class_eval %Q{
+          def #{asset_class}_path(asset)
+            asset_path(asset, Sass::Script::String.new("#{asset_class}"))
+          end
+          def #{asset_class}_url(asset)
+            asset_url(asset, Sass::Script::String.new("#{asset_class}"))
+          end
+        }, __FILE__, __LINE__ - 6
+      end
+
+    protected
+      def public_path(asset, kind)
+        options[:custom][:resolver].public_path(asset, kind.pluralize)
+      end
+    end
+  end
+end
+
+module Sass
+  module Script
+    module Functions
+      include Sass::Rails::Helpers
+    end
+  end
+end

data/lib/sass/rails/importer.rb

@@ -0,0 +1,122 @@
+require 'sprockets'
+
+module Sass::Rails
+  class Importer
+    GLOB = /\*|\[.+\]/
+    PARTIAL = /^_/
+    HAS_EXTENSION = /\.css(.s[ac]ss)?$/
+
+    SASS_EXTENSIONS = {
+      ".css.sass" => :sass,
+      ".css.scss" => :scss,
+      ".sass" => :sass,
+      ".scss" => :scss
+    }
+    attr_reader :context
+
+    def initialize(context)
+      @context = context
+      @resolver = Resolver.new(context)
+    end
+
+    def sass_file?(filename)
+      filename = filename.to_s
+      SASS_EXTENSIONS.keys.any?{|ext| filename[ext]}
+    end
+
+    def syntax(filename)
+      filename = filename.to_s
+      SASS_EXTENSIONS.each {|ext, syntax| return syntax if filename[(ext.size+2)..-1][ext]}
+      nil
+    end
+
+    def resolve(name, base_pathname = nil)
+      name = Pathname.new(name)
+      if base_pathname && base_pathname.to_s.size > 0
+        root = Pathname.new(context.root_path)
+        name = base_pathname.relative_path_from(root).join(name)
+      end
+      partial_name = name.dirname.join("_#{name.basename}")
+      @resolver.resolve(name) || @resolver.resolve(partial_name)
+    end
+
+    def find_relative(name, base, options)
+      base_pathname = Pathname.new(base)
+      if name =~ GLOB
+        glob_imports(name, base_pathname, options)
+      elsif pathname = resolve(name, base_pathname.dirname)
+        context.depend_on(pathname)
+        if sass_file?(pathname)
+          Sass::Engine.new(pathname.read, options.merge(:filename => pathname.to_s, :importer => self, :syntax => syntax(pathname)))
+        else
+          Sass::Engine.new(@resolver.process(pathname), options.merge(:filename => pathname.to_s, :importer => self, :syntax => :scss))
+        end
+      else
+        nil
+      end
+    end
+
+    def find(name, options)
+      if name =~ GLOB
+        nil # globs must be relative
+      elsif pathname = resolve(name)
+        context.depend_on(pathname)
+        if sass_file?(pathname)
+          Sass::Engine.new(pathname.read, options.merge(:filename => pathname.to_s, :importer => self, :syntax => syntax(pathname)))
+        else
+          Sass::Engine.new(@resolver.process(pathname), options.merge(:filename => pathname.to_s, :importer => self, :syntax => :scss))
+        end
+      else
+        nil
+      end
+    end
+
+    def each_globbed_file(glob, base_pathname, options)
+      Dir["#{base_pathname}/#{glob}"].sort.each do |filename|
+        next if filename == options[:filename]
+        yield filename if File.directory?(filename) || context.asset_requirable?(filename)
+      end
+    end
+
+    def glob_imports(glob, base_pathname, options)
+      contents = ""
+      each_globbed_file(glob, base_pathname.dirname, options) do |filename|
+        if File.directory?(filename)
+          context.depend_on(filename)
+        elsif context.asset_requirable?(filename)
+          context.depend_on(filename)
+          contents << "@import #{Pathname.new(filename).relative_path_from(base_pathname.dirname).to_s.inspect};\n"
+        end
+      end
+      return nil if contents.empty?
+      Sass::Engine.new(contents, options.merge(
+        :filename => base_pathname.to_s,
+        :importer => self,
+        :syntax => :scss
+      ))
+    end
+
+    def mtime(name, options)
+      if name =~ GLOB && options[:filename]
+        mtime = nil
+        each_globbed_file(name, Pathname.new(options[:filename]).dirname, options) do |p|
+          mtime ||= File.mtime(p)
+          mtime = [mtime, File.mtime(p)].max
+        end
+        mtime
+      elsif pathname = resolve(name)
+        pathname.mtime
+      end
+    end
+
+    def key(name, options)
+      ["Sprockets:" + File.dirname(File.expand_path(name)), File.basename(name)]
+    end
+
+    def to_s
+      "Sass::Rails::Importer(#{context.pathname})"
+    end
+
+  end
+
+end

data/lib/sass/rails/logger.rb

@@ -0,0 +1,21 @@
+require 'sass/logger'
+
+module Sass
+  module Rails
+    class Logger < Sass::Logger::Base
+      def _log(level, message)
+
+        case level
+          when :trace, :debug
+            ::Rails.logger.debug message
+          when :warn
+            ::Rails.logger.warn message
+          when :error
+            ::Rails.logger.error message
+          when :info
+            ::Rails.logger.info message
+        end
+      end
+    end
+  end
+end

data/lib/sass/rails/railtie.rb

@@ -0,0 +1,74 @@
+require 'sprockets/railtie'
+
+module Sass::Rails
+  class Railtie < ::Rails::Railtie
+    module SassContext
+      attr_accessor :sass_config
+    end
+    config.sass = ActiveSupport::OrderedOptions.new
+    # Establish static configuration defaults
+    # Emit scss files during stylesheet generation of scaffold
+    config.sass.preferred_syntax = :scss
+    # Use expanded output instead of the sass default of :nested
+    config.sass.style            = :expanded
+    # Write sass cache files for performance
+    config.sass.cache            = true
+    # Read sass cache files for performance
+    config.sass.read_cache       = true
+    # Display line comments above each selector as a debugging aid
+    config.sass.line_comments    = true
+    # Initialize the load paths to an empty array
+    config.sass.load_paths       = []
+    # Send Sass logs to Rails.logger
+    config.sass.logger           = Sass::Rails::Logger.new
+
+    # Set the default stylesheet engine
+    # It can be overridedden by passing:
+    #     --stylesheet_engine=sass
+    # to the rails generate command
+    config.app_generators.stylesheet_engine config.sass.preferred_syntax
+
+    config.before_initialize do |app|
+      unless app.config.assets && app.config.assets.enabled
+        raise "The sass-rails plugin requires the asset pipeline to be enabled."
+      end
+
+      require 'sass'
+      Sprockets::Engines #force autoloading
+      Sprockets.register_engine '.sass', Sass::Rails::SassTemplate
+      Sprockets.register_engine '.scss', Sass::Rails::ScssTemplate
+    end
+
+    initializer :setup_sass do |app|
+      # Only emit one kind of syntax because though we have registered two kinds of generators
+      syntax     = app.config.sass.preferred_syntax.to_sym
+      alt_syntax = syntax == :sass ? "scss" : "sass"
+      app.config.generators.hide_namespace alt_syntax
+
+      # Override stylesheet engine to the preferred syntax
+      config.app_generators.stylesheet_engine syntax
+
+      # Set the sass cache location
+      config.sass.cache_location   = File.join(Rails.root, "tmp/cache/sass")
+
+      # Establish configuration defaults that are evironmental in nature
+      if config.sass.full_exception.nil?
+        # Display a stack trace in the css output when in development-like environments.
+        config.sass.full_exception = app.config.consider_all_requests_local
+      end
+      app.assets.context_class.extend(SassContext)
+      app.assets.context_class.sass_config = app.config.sass
+    end
+
+    initializer :setup_compression do |app|
+      if app.config.assets.compress
+        # Use sass's css_compressor
+        app.config.assets.css_compressor = CssCompressor.new
+      end
+    end
+
+    config.after_initialize do |app|
+      Sass::logger = app.config.sass.logger
+    end
+  end
+end