rails-controller-assets 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 81055161486ff2971a4e360f78ca1322a1c3d16f
+  data.tar.gz: c95aa373cc72d0e50096fdaa65a3a4a9487ad01b
+SHA512:
+  metadata.gz: dc341a48218318768182404e0f265715544028dc52395af6ea85935afcc627d737460892987fe174dfc430f9e6aea3bc7fd8eafa0e2938089b829227843a551d
+  data.tar.gz: af5cdf8b9ffce841445aaf25f027319a57c3709a7b52eb3a9cc3a5b13af0ba341db8bdb6676ee98465adf6072b5f297b072bcc3089480a5052f08eab7537a499

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Piotr Usewicz
+
+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.md

@@ -0,0 +1,35 @@
+# RailsControllerAssets
+
+This gems allows to automatically precompile bundles of assets per controller or controller/action pair.
+
+It's great when you want to keep action or controller specific CSS/JavaScript in a separate file.
+
+## Usage
+
+In your Gemfile:
+
+```ruby
+gem 'rails-controller-assets'
+```
+
+Create new bundle files (eg. like application.css) for a `PostsController`:
+
+In `app/assets/stylesheets/posts.css`:
+
+```css
+.post-title { color: red }
+```
+
+In your application layout add to your stylesheets definition:
+
+```erb
+<%= stylesheets_link_tag 'application', *controller_stylesheets %>
+<%= javascript_include_tag 'application', *controller_javascripts %>
+```
+
+And that's it!
+
+The gem will look for bundle files that match:
+
+* `{controller_name}.{js|css}`
+* `{controller_name}_{action_name}.{js|css}`

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsControllerAssets'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rails-controller-assets.rb

@@ -0,0 +1 @@
+require 'rails_controller_assets'

data/lib/rails_controller_assets/controller_assets_helper.rb

@@ -0,0 +1,71 @@
+module RailsControllerAssets::ControllerAssetsHelper
+  def controller_stylesheets
+    styles = []
+    styles << controller_stylesheet if controller_stylesheet?
+    styles << controller_and_action_stylesheet if controller_and_action_stylesheet?
+    styles
+  end
+
+  def controller_and_action
+    [controller_path, action_name].join('_')
+  end
+
+  def controller_stylesheet?
+    controller_asset?(:css)
+  end
+
+  def controller_and_action_stylesheet?
+    controller_and_action_asset?(:css)
+  end
+
+  def controller_javascripts
+    scripts = []
+    scripts << controller_javascript if controller_javascript?
+    scripts << controller_and_action_javascript if controller_and_action_javascript?
+    scripts
+  end
+
+  def controller_javascript?
+    controller_asset?(:js)
+  end
+
+  def controller_and_action_javascript?
+    controller_and_action_asset?(:js)
+  end
+
+  def controller_asset?(type)
+    Rails.application.assets.find_asset(controller_asset(type))
+  end
+
+  def controller_and_action_asset?(type)
+    Rails.application.assets.find_asset(controller_and_action_asset(type))
+  end
+
+  def controller_asset(type)
+    "#{controller_path}.#{type}"
+  end
+
+  def controller_and_action_asset(type)
+    "#{controller_and_action}.#{type}"
+  end
+
+  def controller_javascript
+    controller_asset(:js)
+  end
+
+  def controller_and_action_javascript
+    controller_and_action_asset(:js)
+  end
+
+  def controller_stylesheet
+    controller_asset(:css)
+  end
+
+  def controller_and_action_stylesheet
+    controller_and_action_asset(:css)
+  end
+
+  def skip_controller_stylesheet!
+    stylesheet_bundles.delete(controller_stylesheet)
+  end
+end

data/lib/rails_controller_assets/engine.rb

@@ -0,0 +1,12 @@
+require 'rails_controller_assets/precompiler'
+require 'rails_controller_assets/controller_assets_helper'
+
+module RailsControllerAssets
+  class Engine < ::Rails::Engine
+    config.assets.precompile << RailsControllerAssets::Precompiler.new
+
+    config.to_prepare do
+      ApplicationController.helper(RailsControllerAssets::ControllerAssetsHelper)
+    end
+  end
+end

data/lib/rails_controller_assets/precompiler.rb

@@ -0,0 +1,63 @@
+class RailsControllerAssets::Precompiler
+  def call(asset, filename)
+    return false unless filename =~ /\/app\/assets/
+    if include?(asset)
+      puts "Including #{asset}"
+      true
+    else
+      false
+    end
+  end
+
+  def arity
+    2
+  end
+
+  protected
+
+  def controller_paths
+    @controller_paths ||= find_controller_paths
+  end
+
+  def controller_actions
+    @controller_actions ||= find_controller_actions
+  end
+
+  def include?(asset)
+    return false unless asset =~ /\.(css|js)\z/
+    return false if partial?(asset)
+
+    controller_asset?(asset) || action_asset?(asset)
+  end
+
+  def partial?(asset)
+    asset.split('/').last.start_with?('_')
+  end
+
+  def controller_asset?(asset)
+    controller_paths.any? { |path| asset.include?(path) }
+  end
+
+  def action_asset?(asset)
+    controller_actions.any? { |action| asset.include?(action) }
+  end
+
+  def controllers
+    @eager_load  ||= Rails.application.eager_load!
+    @controllers ||= ::ActionController::Base.descendants
+  end
+
+  def find_controller_actions
+    controllers.map do |controller|
+      controller.action_methods.map do |action|
+        "#{controller.controller_path}_#{action}"
+      end
+    end.flatten
+  end
+
+  def find_controller_paths
+    controllers.map do |controller|
+      controller.controller_path
+    end
+  end
+end

data/lib/rails_controller_assets/version.rb

@@ -0,0 +1,3 @@
+module RailsControllerAssets
+  VERSION = "0.0.1"
+end

data/lib/rails_controller_assets.rb

@@ -0,0 +1,4 @@
+require "rails_controller_assets/engine"
+
+module RailsControllerAssets
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1 @@
+// Nothing to watch here

data/spec/dummy/app/assets/javascripts/comments_index.js

@@ -0,0 +1 @@
+CommentsIndex = function() {};

data/spec/dummy/app/assets/javascripts/posts.js

@@ -0,0 +1 @@
+Posts = function() {};

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/assets/stylesheets/comments_index.css

@@ -0,0 +1 @@
+body#comments-index {}

data/spec/dummy/app/assets/stylesheets/posts.css

@@ -0,0 +1 @@
+body#posts {}

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/comments_controller.rb

@@ -0,0 +1,3 @@
+class CommentsController < ApplicationController
+  def index; end
+end

data/spec/dummy/app/controllers/posts_controller.rb

@@ -0,0 +1,2 @@
+class PostsController < ApplicationController
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", *controller_stylesheets, media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", *controller_javascripts, "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config/application.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'action_controller/railtie'
+require 'sprockets/railtie'
+
+Bundler.require(*Rails.groups)
+require 'rails_controller_assets'
+
+module Dummy
+  class Application < Rails::Application
+    config.assets.digest = false
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  # config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,12 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure your secret_key_base is kept private
+# if you're sharing your code publicly.
+Dummy::Application.config.secret_key_base = '7c1650c3a83bb6dc05d3b96a370facd237af7e59b768663a7a6c2c20846e3178dc0ae11a6baaf9f0c75a00b231946cb935f4623323ded000ac6c68d80b264338'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end