dynamic_assets 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. data/README.rdoc +225 -0
  2. data/app/controllers/assets_controller.rb +4 -0
  3. data/app/helpers/dynamic_assets_helpers.rb +63 -0
  4. data/config/routes.rb +12 -0
  5. data/lib/dynamic_assets/config.rb +109 -0
  6. data/lib/dynamic_assets/controller.rb +40 -0
  7. data/lib/dynamic_assets/core_extensions.rb +29 -0
  8. data/lib/dynamic_assets/engine.rb +11 -0
  9. data/lib/dynamic_assets/manager.rb +10 -0
  10. data/lib/dynamic_assets/reference/javascript_reference.rb +19 -0
  11. data/lib/dynamic_assets/reference/stylesheet_reference.rb +84 -0
  12. data/lib/dynamic_assets/reference.rb +118 -0
  13. data/lib/dynamic_assets.rb +12 -0
  14. data/spec/dummy_rails_app/app/controllers/application_controller.rb +3 -0
  15. data/spec/dummy_rails_app/app/helpers/application_helper.rb +2 -0
  16. data/spec/dummy_rails_app/config/application.rb +42 -0
  17. data/spec/dummy_rails_app/config/boot.rb +6 -0
  18. data/spec/dummy_rails_app/config/environment.rb +5 -0
  19. data/spec/dummy_rails_app/config/environments/development.rb +26 -0
  20. data/spec/dummy_rails_app/config/environments/production.rb +49 -0
  21. data/spec/dummy_rails_app/config/environments/test.rb +35 -0
  22. data/spec/dummy_rails_app/config/initializers/backtrace_silencers.rb +7 -0
  23. data/spec/dummy_rails_app/config/initializers/inflections.rb +10 -0
  24. data/spec/dummy_rails_app/config/initializers/mime_types.rb +5 -0
  25. data/spec/dummy_rails_app/config/initializers/secret_token.rb +7 -0
  26. data/spec/dummy_rails_app/config/initializers/session_store.rb +8 -0
  27. data/spec/dummy_rails_app/config/routes.rb +58 -0
  28. data/spec/dummy_rails_app/db/seeds.rb +7 -0
  29. data/spec/dummy_rails_app/spec/spec_helper.rb +27 -0
  30. data/spec/dummy_rails_app/test/performance/browsing_test.rb +9 -0
  31. data/spec/dummy_rails_app/test/test_helper.rb +13 -0
  32. data/spec/helpers/dynamic_assets_helpers_spec.rb +69 -0
  33. data/spec/lib/dynamic_assets/config_spec.rb +148 -0
  34. data/spec/lib/dynamic_assets/manager_spec.rb +9 -0
  35. data/spec/lib/dynamic_assets/stylesheet_reference_spec.rb +58 -0
  36. data/spec/spec_helper.rb +26 -0
  37. data/spec/support/matchers/string_matchers.rb +61 -0
  38. metadata +219 -0
@@ -0,0 +1,118 @@
1
+
2
+ module DynamicAssets
3
+ class Reference
4
+
5
+ attr_accessor :name
6
+
7
+ #
8
+ # Class Methods
9
+ #
10
+
11
+ def self.new_for_type(type, attrs = {})
12
+ case type
13
+ when :stylesheets then StylesheetReference
14
+ when :javascripts then JavascriptReference
15
+ else raise "unknown type: #{type}"
16
+ end.new attrs
17
+ end
18
+
19
+ def initialize(attrs = {})
20
+ @name = attrs[:name]
21
+ @member_names = attrs[:member_names]
22
+ end
23
+
24
+
25
+ #
26
+ # Instance Methods
27
+ #
28
+
29
+ def formats
30
+ raise "subclasses of #{self.class} should implement this method to return an array of formats"
31
+ end
32
+
33
+ def member_names=(some_names)
34
+ @member_names = some_names
35
+ end
36
+
37
+ def member_names
38
+ @member_names ||= [name]
39
+ end
40
+
41
+ def paths
42
+ member_names.map { |member_name| path_for_member_name member_name }
43
+ end
44
+
45
+ def member_root
46
+ "#{Rails.root}/app/views/#{type.to_s}"
47
+ end
48
+
49
+ # Optionally pass context from which ERB can pull instance variables.
50
+ def content(context = nil)
51
+ @context = context
52
+ s = combine_content
53
+ s = minify s if DynamicAssets::Manager.minify?
54
+ s
55
+ end
56
+
57
+ def mtime
58
+ paths.map { |p| File.mtime p }.max
59
+ end
60
+
61
+ def minify(content_string)
62
+ raise "subclasses of #{self.class} should implement this method"
63
+ end
64
+
65
+
66
+ protected
67
+
68
+ def path_for_member_name(member_name)
69
+ formats.each do |format|
70
+ path = "#{member_root}/#{member_name}.#{format}"
71
+ return path if raw_content_exists? path
72
+
73
+ path = "#{member_root}/#{member_name}.#{format}.erb"
74
+ return path if raw_content_exists? path
75
+ end
76
+
77
+ raise "Couldn't find #{type} asset named #{member_name} in #{member_root} with " +
78
+ "one of these formats: #{formats.join ','}"
79
+ end
80
+
81
+ def format_for_member_name(name)
82
+ format_for_path path_for_member_name(name)
83
+ end
84
+
85
+ def format_for_path(path)
86
+ ext = File.extname path
87
+ ext = File.extname(File.basename path, ext) if ext == ".erb"
88
+
89
+ ext[1..-1].to_sym # Remove the dot, symbolize
90
+ end
91
+
92
+ def path_is_erb?(path)
93
+ File.extname(path) == ".erb"
94
+ end
95
+
96
+ def combine_content
97
+ member_names.map do |member_name|
98
+ read_member member_name
99
+ end.join "\n"
100
+ end
101
+
102
+ def read_member(member_name)
103
+ path = path_for_member_name member_name
104
+ content_string = get_raw_content path
105
+ content_string = ERB.new(content_string).result(@context) if path_is_erb?(path)
106
+ content_string
107
+ end
108
+
109
+ def raw_content_exists?(path)
110
+ File.exists? path
111
+ end
112
+
113
+ def get_raw_content(path)
114
+ File.open(path, "r") { |f| f.read }
115
+ end
116
+
117
+ end
118
+ end
@@ -0,0 +1,12 @@
1
+
2
+ module DynamicAssets
3
+ require 'dynamic_assets/engine' if defined? Rails
4
+ end
5
+
6
+ require 'dynamic_assets/core_extensions'
7
+ require 'dynamic_assets/config'
8
+ require 'dynamic_assets/controller'
9
+ require 'dynamic_assets/manager'
10
+ require 'dynamic_assets/reference'
11
+ require 'dynamic_assets/reference/javascript_reference'
12
+ require 'dynamic_assets/reference/stylesheet_reference'
@@ -0,0 +1,3 @@
1
+ class ApplicationController < ActionController::Base
2
+ protect_from_forgery
3
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,42 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ require 'rails/all'
4
+
5
+ # If you have a Gemfile, require the gems listed there, including any gems
6
+ # you've limited to :test, :development, or :production.
7
+ Bundler.require(:default, Rails.env) if defined?(Bundler)
8
+
9
+ module DummyRailsApp
10
+ class Application < Rails::Application
11
+ # Settings in config/environments/* take precedence over those specified here.
12
+ # Application configuration should go into files in config/initializers
13
+ # -- all .rb files in that directory are automatically loaded.
14
+
15
+ # Custom directories with classes and modules you want to be autoloadable.
16
+ # config.autoload_paths += %W(#{config.root}/extras)
17
+
18
+ # Only load the plugins named here, in the order given (default is alphabetical).
19
+ # :all can be used as a placeholder for all plugins not explicitly named.
20
+ # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
21
+
22
+ # Activate observers that should always be running.
23
+ # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
24
+
25
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
26
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
27
+ # config.time_zone = 'Central Time (US & Canada)'
28
+
29
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
30
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
31
+ # config.i18n.default_locale = :de
32
+
33
+ # JavaScript files you want as :defaults (application.js is always included).
34
+ # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
35
+
36
+ # Configure the default encoding used in templates for Ruby 1.9.
37
+ config.encoding = "utf-8"
38
+
39
+ # Configure sensitive parameters which will be filtered from the log file.
40
+ config.filter_parameters += [:password]
41
+ end
42
+ end
@@ -0,0 +1,6 @@
1
+ require 'rubygems'
2
+
3
+ # Set up gems listed in the Gemfile.
4
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
5
+
6
+ require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
@@ -0,0 +1,5 @@
1
+ # Load the rails application
2
+ require File.expand_path('../application', __FILE__)
3
+
4
+ # Initialize the rails application
5
+ DummyRailsApp::Application.initialize!
@@ -0,0 +1,26 @@
1
+ DummyRailsApp::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # In the development environment your application's code is reloaded on
5
+ # every request. This slows down response time but is perfect for development
6
+ # since you don't have to restart the webserver when you make code changes.
7
+ config.cache_classes = false
8
+
9
+ # Log error messages when you accidentally call methods on nil.
10
+ config.whiny_nils = true
11
+
12
+ # Show full error reports and disable caching
13
+ config.consider_all_requests_local = true
14
+ config.action_view.debug_rjs = true
15
+ config.action_controller.perform_caching = false
16
+
17
+ # Don't care if the mailer can't send
18
+ config.action_mailer.raise_delivery_errors = false
19
+
20
+ # Print deprecation notices to the Rails logger
21
+ config.active_support.deprecation = :log
22
+
23
+ # Only use best-standards-support built into browsers
24
+ config.action_dispatch.best_standards_support = :builtin
25
+ end
26
+
@@ -0,0 +1,49 @@
1
+ DummyRailsApp::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # The production environment is meant for finished, "live" apps.
5
+ # Code is not reloaded between requests
6
+ config.cache_classes = true
7
+
8
+ # Full error reports are disabled and caching is turned on
9
+ config.consider_all_requests_local = false
10
+ config.action_controller.perform_caching = true
11
+
12
+ # Specifies the header that your server uses for sending files
13
+ config.action_dispatch.x_sendfile_header = "X-Sendfile"
14
+
15
+ # For nginx:
16
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
17
+
18
+ # If you have no front-end server that supports something like X-Sendfile,
19
+ # just comment this out and Rails will serve the files
20
+
21
+ # See everything in the log (default is :info)
22
+ # config.log_level = :debug
23
+
24
+ # Use a different logger for distributed setups
25
+ # config.logger = SyslogLogger.new
26
+
27
+ # Use a different cache store in production
28
+ # config.cache_store = :mem_cache_store
29
+
30
+ # Disable Rails's static asset server
31
+ # In production, Apache or nginx will already do this
32
+ config.serve_static_assets = false
33
+
34
+ # Enable serving of images, stylesheets, and javascripts from an asset server
35
+ # config.action_controller.asset_host = "http://assets.example.com"
36
+
37
+ # Disable delivery errors, bad email addresses will be ignored
38
+ # config.action_mailer.raise_delivery_errors = false
39
+
40
+ # Enable threaded mode
41
+ # config.threadsafe!
42
+
43
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
44
+ # the I18n.default_locale when a translation can not be found)
45
+ config.i18n.fallbacks = true
46
+
47
+ # Send deprecation notices to registered listeners
48
+ config.active_support.deprecation = :notify
49
+ end
@@ -0,0 +1,35 @@
1
+ DummyRailsApp::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb
3
+
4
+ # The test environment is used exclusively to run your application's
5
+ # test suite. You never need to work with it otherwise. Remember that
6
+ # your test database is "scratch space" for the test suite and is wiped
7
+ # and recreated between test runs. Don't rely on the data there!
8
+ config.cache_classes = true
9
+
10
+ # Log error messages when you accidentally call methods on nil.
11
+ config.whiny_nils = true
12
+
13
+ # Show full error reports and disable caching
14
+ config.consider_all_requests_local = true
15
+ config.action_controller.perform_caching = false
16
+
17
+ # Raise exceptions instead of rendering exception templates
18
+ config.action_dispatch.show_exceptions = false
19
+
20
+ # Disable request forgery protection in test environment
21
+ config.action_controller.allow_forgery_protection = false
22
+
23
+ # Tell Action Mailer not to deliver emails to the real world.
24
+ # The :test delivery method accumulates sent emails in the
25
+ # ActionMailer::Base.deliveries array.
26
+ config.action_mailer.delivery_method = :test
27
+
28
+ # Use SQL instead of Active Record's schema dumper when creating the test database.
29
+ # This is necessary if your schema can't be completely dumped by the schema dumper,
30
+ # like if you have constraints or database-specific column types
31
+ # config.active_record.schema_format = :sql
32
+
33
+ # Print deprecation notices to the stderr
34
+ config.active_support.deprecation = :stderr
35
+ end
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4
+ # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
5
+
6
+ # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
7
+ # Rails.backtrace_cleaner.remove_silencers!
@@ -0,0 +1,10 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new inflection rules using the following format
4
+ # (all these examples are active by default):
5
+ # ActiveSupport::Inflector.inflections do |inflect|
6
+ # inflect.plural /^(ox)$/i, '\1en'
7
+ # inflect.singular /^(ox)en/i, '\1'
8
+ # inflect.irregular 'person', 'people'
9
+ # inflect.uncountable %w( fish sheep )
10
+ # end
@@ -0,0 +1,5 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new mime types for use in respond_to blocks:
4
+ # Mime::Type.register "text/richtext", :rtf
5
+ # Mime::Type.register_alias "text/html", :iphone
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Your secret key for verifying the integrity of signed cookies.
4
+ # If you change this key, all old signed cookies will become invalid!
5
+ # Make sure the secret is at least 30 characters and all random,
6
+ # no regular words or you'll be exposed to dictionary attacks.
7
+ DummyRailsApp::Application.config.secret_token = '9c84a3a25344a4bb6033fb01225d7af245dc5f965cadf01502ca1badd308b46940020af7a9d1986005e4b3d02472356d49e62cc87f4c3320e6fcf3a8dbaa94e0'
@@ -0,0 +1,8 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ DummyRailsApp::Application.config.session_store :cookie_store, :key => '_dummy_rails_app_session'
4
+
5
+ # Use the database for sessions instead of the cookie-based default,
6
+ # which shouldn't be used to store highly confidential information
7
+ # (create the session table with "rails generate session_migration")
8
+ # DummyRailsApp::Application.config.session_store :active_record_store
@@ -0,0 +1,58 @@
1
+ DummyRailsApp::Application.routes.draw do
2
+ # The priority is based upon order of creation:
3
+ # first created -> highest priority.
4
+
5
+ # Sample of regular route:
6
+ # match 'products/:id' => 'catalog#view'
7
+ # Keep in mind you can assign values other than :controller and :action
8
+
9
+ # Sample of named route:
10
+ # match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
11
+ # This route can be invoked with purchase_url(:id => product.id)
12
+
13
+ # Sample resource route (maps HTTP verbs to controller actions automatically):
14
+ # resources :products
15
+
16
+ # Sample resource route with options:
17
+ # resources :products do
18
+ # member do
19
+ # get 'short'
20
+ # post 'toggle'
21
+ # end
22
+ #
23
+ # collection do
24
+ # get 'sold'
25
+ # end
26
+ # end
27
+
28
+ # Sample resource route with sub-resources:
29
+ # resources :products do
30
+ # resources :comments, :sales
31
+ # resource :seller
32
+ # end
33
+
34
+ # Sample resource route with more complex sub-resources
35
+ # resources :products do
36
+ # resources :comments
37
+ # resources :sales do
38
+ # get 'recent', :on => :collection
39
+ # end
40
+ # end
41
+
42
+ # Sample resource route within a namespace:
43
+ # namespace :admin do
44
+ # # Directs /admin/products/* to Admin::ProductsController
45
+ # # (app/controllers/admin/products_controller.rb)
46
+ # resources :products
47
+ # end
48
+
49
+ # You can have the root of your site routed with "root"
50
+ # just remember to delete public/index.html.
51
+ # root :to => "welcome#index"
52
+
53
+ # See how all your routes lay out with "rake routes"
54
+
55
+ # This is a legacy wild controller route that's not recommended for RESTful applications.
56
+ # Note: This route will make all actions in every controller accessible via GET requests.
57
+ # match ':controller(/:action(/:id(.:format)))'
58
+ end
@@ -0,0 +1,7 @@
1
+ # This file should contain all the record creation needed to seed the database with its default values.
2
+ # The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
3
+ #
4
+ # Examples:
5
+ #
6
+ # cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
7
+ # Mayor.create(:name => 'Daley', :city => cities.first)
@@ -0,0 +1,27 @@
1
+ # This file is copied to spec/ when you run 'rails generate rspec:install'
2
+ ENV["RAILS_ENV"] ||= 'test'
3
+ require File.expand_path("../../config/environment", __FILE__)
4
+ require 'rspec/rails'
5
+
6
+ # Requires supporting ruby files with custom matchers and macros, etc,
7
+ # in spec/support/ and its subdirectories.
8
+ Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
9
+
10
+ RSpec.configure do |config|
11
+ # == Mock Framework
12
+ #
13
+ # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
14
+ #
15
+ # config.mock_with :mocha
16
+ # config.mock_with :flexmock
17
+ # config.mock_with :rr
18
+ config.mock_with :rspec
19
+
20
+ # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
21
+ config.fixture_path = "#{::Rails.root}/spec/fixtures"
22
+
23
+ # If you're not using ActiveRecord, or you'd prefer not to run each of your
24
+ # examples within a transaction, remove the following line or assign false
25
+ # instead of true.
26
+ config.use_transactional_fixtures = true
27
+ end
@@ -0,0 +1,9 @@
1
+ require 'test_helper'
2
+ require 'rails/performance_test_help'
3
+
4
+ # Profiling results for each test method are written to tmp/performance.
5
+ class BrowsingTest < ActionDispatch::PerformanceTest
6
+ def test_homepage
7
+ get '/'
8
+ end
9
+ end
@@ -0,0 +1,13 @@
1
+ ENV["RAILS_ENV"] = "test"
2
+ require File.expand_path('../../config/environment', __FILE__)
3
+ require 'rails/test_help'
4
+
5
+ class ActiveSupport::TestCase
6
+ # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
7
+ #
8
+ # Note: You'll currently still have to declare fixtures explicitly in integration tests
9
+ # -- they do not yet inherit this setting
10
+ fixtures :all
11
+
12
+ # Add more helper methods to be used by all tests here...
13
+ end
@@ -0,0 +1,69 @@
1
+ require 'spec_helper'
2
+
3
+ describe DynamicAssetsHelpers do
4
+
5
+ describe "#stylesheet_asset_tag" do
6
+ subject { helper.stylesheet_asset_tag group_key }
7
+
8
+ context "when the DynamicAssets::Manager says the given group key is associated with 3 stylesheets" do
9
+ let(:group_key) { :base }
10
+
11
+ before do
12
+ DynamicAssets::Manager.stub(:asset_references_for_group_key).with(:stylesheets, group_key).
13
+ and_return [
14
+ double(DynamicAssets::Reference, :name => "a", :mtime => 123),
15
+ double(DynamicAssets::Reference, :name => "b", :mtime => 456),
16
+ double(DynamicAssets::Reference, :name => "c", :mtime => 789)
17
+ ]
18
+ end
19
+
20
+ it "is three link tags" do
21
+ subject.scan('<link ').length.should == 3
22
+ end
23
+
24
+ it 'is three tags with type="text/css"' do
25
+ subject.scan('type="text/css"').length.should == 3
26
+ end
27
+
28
+ it 'is three tags with rel"stylesheet"' do
29
+ subject.scan('rel="stylesheet"').length.should == 3
30
+ end
31
+
32
+ it 'is three tags with media="screen"' do
33
+ subject.scan('media="screen"').length.should == 3
34
+ end
35
+
36
+ context "when config.asset_host is nil" do
37
+ before { helper.config.asset_host.should be_nil }
38
+
39
+ it "is three tags with hrefs derived from the asset name and mtime" do
40
+ should contain_string 'href="/assets/stylesheets/a.css?123"'
41
+ should contain_string 'href="/assets/stylesheets/b.css?456"'
42
+ should contain_string 'href="/assets/stylesheets/c.css?789"'
43
+ end
44
+ end
45
+
46
+ context "when config.asset_host is set to a.example.com" do
47
+ before { helper.config.stub(:asset_host).and_return "http://a.example.com" }
48
+
49
+ it "is three tags with hrefs whose host is a.example.com" do
50
+ should contain_string 'href="http://a.example.com/assets/stylesheets/a.css?123"'
51
+ should contain_string 'href="http://a.example.com/assets/stylesheets/b.css?456"'
52
+ should contain_string 'href="http://a.example.com/assets/stylesheets/c.css?789"'
53
+ end
54
+ end
55
+
56
+ context "when config.asset_host is set to a%d.example.com" do
57
+ before { helper.config.stub(:asset_host).and_return "http://a%d.example.com" }
58
+
59
+ it "is three tags with hrefs whose host is a[0-3].example.com" do
60
+ should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/a.css\?123"/
61
+ should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/b.css\?456"/
62
+ should =~ /href="http:\/\/a[0-3].example.com\/assets\/stylesheets\/c.css\?789"/
63
+ end
64
+ end
65
+ end
66
+
67
+ end
68
+
69
+ end