Module: CompassRails

Extended by:
CompassRails
Included in:
CompassRails
Defined in:
lib/compass-rails.rb,
lib/compass-rails/version.rb,
lib/compass-rails/installer.rb,
lib/compass-rails/configuration/default.rb,
lib/compass-rails/patches/sprite_importer.rb,
lib/compass-rails/configuration/asset_pipeline.rb,
lib/compass-rails/railties/4_0.rb,
lib/compass-rails/railties/3_1.rb,
lib/compass-rails/railties/3_0.rb

Defined Under Namespace

Modules: Configuration Classes: Installer, Railtie, SpriteImporter

Constant Summary collapse

RAILS_4 = 
%r{^4.[0|1]}
RAILS_32 = 
%r{^3.2}
RAILS_31 = 
%r{^3.1}
RAILS_3 = 
%r{^3.0}
VERSION = 
"1.1.6"

Instance Method Summary collapse

Instance Method Details

#asset_pipeline_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


218
219
220
221
222
223
224
225
226
 
# File 'lib/compass-rails.rb', line 218

def asset_pipeline_enabled?
  return false unless rails_loaded? && ::Rails.respond_to?(:application) && !::Rails.application.nil?
  rails_config = ::Rails.application.config
  if rails_config.respond_to?(:assets)
    rails_config.assets.enabled != false
  else
    false
  end
end

#boot_config ⇒ Object 



208
209
210
211
212
213
214
215
216
 
# File 'lib/compass-rails.rb', line 208

def boot_config
  config = if (config_file = Compass.detect_configuration_file) && (config_data = Compass.configuration_for(config_file))
    config_data
  else
    Compass::Configuration::Data.new("compass_rails_boot")
  end
  config.top_level.project_type = :rails
  config
end

#booted! ⇒ Object 



115
116
117
 
# File 'lib/compass-rails.rb', line 115

def booted!
  CompassRails.const_set(:BOOTED, true)
end

#booted? ⇒ Boolean

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/compass-rails.rb', line 119

def booted?
  defined?(CompassRails::BOOTED) && CompassRails::BOOTED
end

#check_for_double_boot! ⇒ Object 



162
163
164
165
166
167
168
 
# File 'lib/compass-rails.rb', line 162

def check_for_double_boot!
  if booted?
    Compass::Util.compass_warn("Warning: Compass was booted twice. Compass-rails has got your back; please remove your compass initializer.")
  else
    booted!
  end
end

#configuration ⇒ Object 



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/compass-rails.rb', line 123

def configuration
  load_rails
  config = Compass::Configuration::Data.new('rails')
  config.extend(Configuration::Default)
  if asset_pipeline_enabled?
    require "compass-rails/configuration/asset_pipeline"
    config.extend(Configuration::AssetPipeline)
  end
  config
end

#configure_rails!(app) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/compass-rails.rb', line 186

def configure_rails!(app)
  return unless app.config.respond_to?(:sass)
  sass_config = app.config.sass
  compass_config = app.config.compass

  sass_config.load_paths.concat(compass_config.sass_load_paths)

  { :output_style => :style,
    :line_comments => :line_comments,
    :cache => :cache,
    :disable_warnings => :quiet,
    :preferred_syntax => :preferred_syntax
  }.each do |compass_option, sass_option|
    set_maybe sass_config, compass_config, sass_option, compass_option
  end
  if compass_config.sass_options
    compass_config.sass_options.each do |config, value|
      sass_config.send("#{config}=", value)
    end
  end
end

#context ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/compass-rails.rb', line 58

def context
  load_rails
  @context ||= begin
    sprockets.version = ::Rails.env + "-#{sprockets.version}"
    setup_fake_rails_env_paths(sprockets)
    context = ::Rails.application.assets.context_class
    context.extend(::Sprockets::Helpers::IsolatedHelper)
    context.extend(::Sprockets::Helpers::RailsHelper)
    context.extend(::Sass::Rails::Railtie::SassContext)
    context.sass_config = sass_config

    context
  end
end

#env ⇒ Object 



134
135
136
 
# File 'lib/compass-rails.rb', line 134

def env
  env_production? ? :production : :development
end

#env_production? ⇒ Boolean

Returns:

  • (Boolean) 


142
143
144
145
146
147
148
 
# File 'lib/compass-rails.rb', line 142

def env_production?
  if defined?(::Rails) && ::Rails.respond_to?(:env)
    ::Rails.env.production?
  elsif defined?(RAILS_ENV)
    RAILS_ENV == "production"
  end
end

#initialize!(config = nil) ⇒ Object

Rails projects without asset pipeline use this in their compass initializer.



177
178
179
180
181
182
183
184
 
# File 'lib/compass-rails.rb', line 177

def initialize!(config = nil)
  check_for_double_boot!
  config ||= Compass.detect_configuration_file(root)
  Compass.add_project_configuration(config, :project_type => :rails)
  Compass.discover_extensions!
  Compass.configure_sass_plugin!
  Compass.handle_configuration_change! if sass_plugin_enabled?
end

#installer(*args) ⇒ Object 



73
74
75
 
# File 'lib/compass-rails.rb', line 73

def installer(*args)
  CompassRails::Installer.new(*args)
end

#load_rails ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/compass-rails.rb', line 14

def load_rails
  return true if rails_loaded?
  return if defined?(::Rails) && ::Rails.respond_to?(:application) && !::Rails.application.nil?

  rails_config_path = Dir.pwd
  until File.exists?(File.join(rails_config_path, 'config', 'application.rb')) do
    raise 'Rails application not found' if rails_config_path == '/'
    rails_config_path = File.join(rails_config_path, '..')
  end
  #load the rails config
  require "#{rails_config_path}/config/application.rb"
  if rails31? || rails32? || rails4?
    require 'sass-rails'
    require 'sprockets/railtie'
    require 'rails/engine'
    @app ||= ::Rails.application.initialize!
  end
end

#prefix ⇒ Object 



138
139
140
 
# File 'lib/compass-rails.rb', line 138

def prefix
  ::Rails.application.config.assets.prefix
end

#rails31? ⇒ Boolean

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'lib/compass-rails.rb', line 92

def rails31?
  return false unless defined?(::Rails)
  version_match RAILS_31
end

#rails32? ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'lib/compass-rails.rb', line 97

def rails32?
  return false unless defined?(::Rails)
  version_match RAILS_32
end

#rails3? ⇒ Boolean

Returns:

  • (Boolean) 


87
88
89
90
 
# File 'lib/compass-rails.rb', line 87

def rails3?
  return false unless defined?(::Rails)
  version_match RAILS_3
end

#rails4? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
105
 
# File 'lib/compass-rails.rb', line 102

def rails4?
  return false unless defined?(::Rails)
  version_match RAILS_4
end

#rails_loaded? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/compass-rails.rb', line 77

def rails_loaded?
  defined?(::Rails)
end

#rails_version ⇒ Object 



81
82
83
84
85
 
# File 'lib/compass-rails.rb', line 81

def rails_version
  rails_spec = (Gem.loaded_specs["railties"] || Gem.loaded_specs["rails"])
  raise "You have to require Rails before compass" unless rails_spec
  rails_spec.version.to_s
end

#root ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/compass-rails.rb', line 150

def root
  @root ||= begin
    if defined?(::Rails) && ::Rails.respond_to?(:root)
      ::Rails.root
    elsif defined?(RAILS_ROOT)
      Pathname.new(RAILS_ROOT)
    else
      Pathname.new(Dir.pwd)
    end
  end
end

#sass_config ⇒ Object 



48
49
50
51
 
# File 'lib/compass-rails.rb', line 48

def sass_config
  load_rails
  ::Rails.application.config.sass
end

#sass_plugin_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


170
171
172
173
174
 
# File 'lib/compass-rails.rb', line 170

def sass_plugin_enabled?
  unless rails31?
    defined?(Sass::Plugin) && !Sass::Plugin.options[:never_update]
  end
end

#setup_fake_rails_env_paths(sprockets_env) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/compass-rails.rb', line 34

def setup_fake_rails_env_paths(sprockets_env)
  return unless rails_loaded?
  keys = ['app/assets', 'lib/assets', 'vendor/assets']
  local = keys.map {|path| ::Rails.root.join(path) }.map { |path| [File.join(path, 'images'), File.join(path, 'stylesheets')] }.flatten!
  sprockets_env.send(:trail).paths.unshift(*local)
  paths = []
  ::Rails::Engine.subclasses.each do |subclass|
    paths = subclass.paths
    keys.each do |key|
      sprockets_env.send(:trail).paths.unshift(*paths[key].existent_directories)
    end
  end
end

#sprockets ⇒ Object 



53
54
55
56
 
# File 'lib/compass-rails.rb', line 53

def sprockets
  load_rails
  @sprockets ||= ::Rails.application.assets
end

#version_match(version) ⇒ Object 



107
108
109
110
111
112
113
 
# File 'lib/compass-rails.rb', line 107

def version_match(version)
  if (rails_version =~ version).nil?
    return false
  end

  true
end