tension 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76c048b5004ade369c07e87cf54a73b3459f7151
-  data.tar.gz: e2494f1c0198761e2464ec130b2107ba05aa1ae4
+  metadata.gz: 6c49b89ef37d4ed27d45267db1df9515e9b21676
+  data.tar.gz: a5dda13efcd5faad5b96b7f0277789c4426d5411
 SHA512:
-  metadata.gz: 599a97dd6849f6a070d7d2cb1ac3a6c7da3e959a4046b9c6558995663fd6afe5a2d6d98138cd2aef8e89ce529ffec28c1ccf8bae42aa35e9da93d9bbd8ad4861
-  data.tar.gz: 4902abbd406722db8bd6c680630ce1285bbc6f7613dd20aeba5e12e01f4349c0fab1083394ce8839a2c4b4c0d8e422550b7c37635a702383035ea86b9954effd
+  metadata.gz: 578e77cad85ee43ece8dd8405378370f35179704d2de8679e8b7cadeea1eb1db6b2b927826d66249d53d7f55b04191bb42c37065368ac2451b18588f6039b515
+  data.tar.gz: c7816a0237d55ac4ab45422a2e70ed0cbeff586d43372e4b5c2399f3f4db2351d3094624ff8430cd847376135097986aa2d776b22c80021086f6465c900ca27c

data/lib/tension/context.rb

@@ -0,0 +1,67 @@
+module Tension
+  class Context
+    attr_reader :controller, :action
+
+    def initialize(controller_path)
+      @controller = "#{ controller_path }_controller".classify.constantize
+    end
+
+    # Locates the best stylesheet for the given action name. Aliased as,
+    # for example, `#index( Tension::CSS )` or `#show(:css)`.
+    #
+    def css(action)
+      best_asset( action, Tension::CSS )
+    end
+
+    # Locates the best JavaScript for the given action name. Aliased as,
+    # for example, `#index( Tension::JS )` or `#show(:js)`.
+    #
+    def js(action)
+      best_asset( action, Tension::JS )
+    end
+
+    # Returns the action-level asset for the given action name and type,
+    # or nil.
+    #
+    def action_asset(action, type)
+      Tension::Utils.find_asset( controller: controller.controller_path, action: action, type: type )
+    end
+
+    # Returns the controller-level asset for the given type, or nil.
+    #
+    def controller_asset(type)
+      Tension::Utils.find_asset( controller: controller.controller_path, type: type )
+    end
+
+    # Returns the global asset for the given type (application.{css,js}).
+    #
+    def global_asset(type)
+      Tension::Utils.global_asset(type)
+    end
+
+    def has_action?(action_name)
+      controller.action_methods.include?(action_name)
+    end
+
+
+    private
+
+    # Locates the best asset for the given action name and type.
+    #
+    def best_asset(action, type)
+      action_asset(action, type) || controller_asset(type) || global_asset(type)
+    end
+
+    def method_missing(method_sym, *args)
+      action = method_sym.to_s
+      type   = args.first
+
+      if has_action?(action)
+        best_asset(action, type)
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/tension/controller.rb

@@ -4,15 +4,35 @@ module Tension
   module Controller
     extend ActiveSupport::Concern
 
-    def action_assets
-      controller = request.symbolized_path_parameters[:controller]
-      action     = request.symbolized_path_parameters[:action]
+    included do
+      # Make these methods available in helpers too.
+      helper_method :asset_context, :action_javascript, :action_stylesheet
+    end
+
+    # Returns the Context for the current controller.
+    #
+    def asset_context
+      find_asset( request.symbolized_path_parameters[:controller] )
+    end
+
+    # Returns the Sprockets Asset for the current action's JavaScript
+    # to be written into the template.
+    #
+    def action_javascript
+      asset_context.js( request.symbolized_path_parameters[:action] )
+    end
 
-      Tension::Environment.find( controller, action )
+    # Returns the Sprockets Asset for the current action's stylesheet
+    # to be written into the template.
+    #
+    def action_stylesheet
+      asset_context.css( request.symbolized_path_parameters[:action] )      
     end
 
-    def assets
-      Tension::Environment
+    # Proxy to Tension::Environment.find.
+    #
+    def find_asset_context(*args)
+      Tension::Environment.find(*args)
     end
   end
 end

data/lib/tension/environment.rb

@@ -1,39 +1,59 @@
 module Tension
 
-  # Tension::Environment exposes `assets`, which describes the assets that
-  # can be automatically included in templates.
-  #
-  # It's used automatically on application load (see Tension::Railtie) to populate
-  # the asset pipeline's list of assets to precompile, and caches the result in-
-  # process for use by Tension::Tagger when templates are rendered.
+  # This class describes routes and controller contexts, and through those contexts
+  # the assets to be included in templates.
   #
   class Environment
-
     class << self
 
-      def [](key, action = nil)
-        fetch( AssetGroup.path_for(key, action) )
+      # Loads a Context for the specified controller path.
+      #
+      def find(key)
+        fetch( Tension::Utils.controller_path(key) )
+      end
+      alias_method :[], :find
+
+      # A Hash mapping controller paths to Contexts.
+      #
+      def contexts
+        @contexts ||= Hash.new
       end
-      alias_method :find, :[]
 
+      # Preloads all Contexts. Useful in environments where assets and controller
+      # actions don't change without an app reboot (production, staging).
+      #
       def eager_load!
         configured_get_defaults.each do |default|
-          find( default[:controller], default[:action] )
+          find(default[:controller])
         end
+
+        true
       end
 
-      def assets
-        @assets ||= Hash.new
+      # Determines whether or not a given path refers to an asset that requires
+      # precompilation.
+      #
+      def precompilation_needed?(path)
+        if context = find(path)
+          context.has_action?( Tension::Utils.action_name(path) )
+        end
       end
 
+
       private
 
       def fetch(path)
-        assets[path] || store(path)
+        contexts[path] || store(path)
       end
 
       def store(path)
-        assets[path] = AssetGroup.new( path )
+        contexts[path] ||= Context.new(path) if valid_route?(path)
+      end
+
+      def valid_route?(controller)
+        configured_get_defaults.find do |default|
+          default[:controller] == controller
+        end
       end
 
       # Routing defaults (including controller path and action name) for all
@@ -52,7 +72,7 @@ module Tension
           @configured_get_defaults.compact!
         end
       end
-    end
 
+    end
   end
 end

data/lib/tension/helper.rb

@@ -7,10 +7,16 @@ module Tension
   module Helper
     extend ActiveSupport::Concern
 
+    # Determines the best stylesheet to be included in a template based
+    # on the current controller and action.
+    #
     def best_stylesheet(*args)
       asset_for( Tension::CSS, *args )
     end
 
+    # Determines the best JavaScript to be included in a template based
+    # on the current controller and action.
+    #
     def best_javascript(*args)
       asset_for( Tension::JS, *args )
     end
@@ -18,10 +24,10 @@ module Tension
     private
 
     def asset_for(type, *args)
-      controller = request.params[:controller]
-      action     = request.params[:action]
+      controller = request.symbolized_path_parameters[:controller]
+      action     = request.symbolized_path_parameters[:action]
 
-      asset = Tension::Environment.find( controller, action ).send( type )
+      asset = Tension::Environment.find( controller ).send( action, type )
 
       include_method = case type.to_s
       when "js"

data/lib/tension/railtie.rb

@@ -5,21 +5,19 @@ module Tension
 
   class Railtie < Rails::Railtie
     initializer "tension.add_assets_to_precompile_list" do |app|
-      ActiveSupport.on_load :after_initialize do
 
-        if app.config.cache_classes
-          app.reload_routes!
-          Tension::Environment.eager_load!
-        end
-
-        ActionView::Base.send(:include, Tension::Helper)
-        ActionController::Base.send(:include, Tension::Controller)
+      if app.config.cache_classes
+        app.reload_routes!
+        Tension::Environment.eager_load!
+      end
 
-        app.config.assets.precompile << lambda do |path, filename|
-          Tension::Environment.asset_paths.include?( filename )
-        end
+      ActionView::Base.send(:include, Tension::Helper)
+      ActionController::Base.send(:include, Tension::Controller)
 
+      Rails.application.config.assets.precompile << lambda do |path, filename|
+        Tension::Environment.precompilation_needed?(path)
       end
+
     end
   end
 end

data/lib/tension/utils.rb

@@ -0,0 +1,102 @@
+module Tension
+  module Utils
+    class << self
+
+      SHARED_SUFFIX   = "_common".freeze
+      EXTENSION_REGEX = /(#{SHARED_SUFFIX})?\..*\z/.freeze
+
+      # Matches strings like "blog/comments".
+      CONTROLLER_REGEX = /([\w\/]+[^\.])/.freeze
+
+      # Attempts to build a valid controller path from the given path String.
+      #   ARGS: path: a String path like "admin/blog_common.css"
+      #
+      def controller_path(path)
+        if asset_path?(path)
+          return controller_for_asset_path(path)
+
+        elsif matches = path.split("#").first.match(CONTROLLER_REGEX)
+          return matches[0]
+
+        else
+          return nil
+        end
+      end
+
+      # Attempts to find an action name for a given asset path.
+      #
+      def action_name(path)
+        strip_file_extension( path.split("/").last ) if asset_path?(path)
+      end
+
+      # Attempts to load an Asset from the Sprockets index. Uses the given
+      # Hash argument to build an asset path.
+      #   ARGS: options: a Hash containing e.g.
+      #     controller: "blog/comments"
+      #     action: "index"
+      #     type: Tension::CSS
+      #
+      def find_asset(options)
+        assets[ logical_asset_path(options) ]
+      end
+
+      # Returns the application-wide Sprockets Asset for the given type.
+      #   ARGS: type: Tension::JS or Tension::CSS
+      #
+      def global_asset(type)
+        assets[ "application.#{type}" ]
+      end
+
+      private
+
+      # Builds a String path for an asset based on the given hash params.
+      #   ARGS: options: a Hash containing e.g.
+      #     controller: "blog/comments"
+      #     action: "index"
+      #     type: Tension::CSS
+      #
+      def logical_asset_path(options)
+        if options[:action].nil?
+          "#{options[:controller]}#{SHARED_SUFFIX}.#{options[:type]}"
+        else
+          "#{options[:controller]}/#{options[:action]}.#{options[:type]}"
+        end
+      end
+
+      # Alias for Sprockets' asset index.
+      #
+      def assets
+        Rails.application.assets
+      end
+
+      # Takes an asset path like "comments/base/index.js" and determines
+      # the controller ("comments/base") that should serve that asset.
+      #   ARGS: path: a String path like "admin/blog_common.css"
+      #
+      def controller_for_asset_path(path)
+        parts = path.split("/")
+
+        if parts.last.match(SHARED_SUFFIX)
+          strip_file_extension( parts.last )
+        else
+          parts.pop
+        end
+
+        return parts.any? ? parts.join("/") : nil
+      end
+
+      def strip_file_extension(path)
+        path.gsub(EXTENSION_REGEX, "")
+      end
+
+      # Returns whether or not the given path represents an asset file
+      # for which Tension is useful: JavaScript or CSS.
+      #   ARGS: path: a String path like "admin/blog_common.css"
+      #
+      def asset_path?(path)
+        path.match(/\.(#{ Tension::CSS }|#{ Tension::JS })\z/)
+      end
+
+    end
+  end
+end

data/lib/tension/version.rb

@@ -1,3 +1,3 @@
 module Tension
-  VERSION = "0.9.5".freeze
+  VERSION = "0.9.6".freeze
 end

data/lib/tension.rb

@@ -1,4 +1,5 @@
-require 'tension/asset_group'
+require 'tension/utils'
+require 'tension/context'
 require 'tension/controller'
 require 'tension/helper'
 require 'tension/environment'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tension
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Piers Mainwaring
@@ -34,11 +34,12 @@ files:
 - LICENSE
 - README.md
 - lib/tension.rb
-- lib/tension/asset_group.rb
+- lib/tension/context.rb
 - lib/tension/controller.rb
 - lib/tension/environment.rb
 - lib/tension/helper.rb
 - lib/tension/railtie.rb
+- lib/tension/utils.rb
 - lib/tension/version.rb
 - tension.gemspec
 homepage: https://github.com/piersadrian/tension

data/lib/tension/asset_group.rb

@@ -1,82 +0,0 @@
-module Tension
-  class AssetGroup
-
-    class << self
-      # Builds a valid routing Path.
-      def path_for(key, action = nil)
-        if key.match( path_regex )
-          return key
-
-        elsif key.include?("#")
-          key, action = key.split("#") 
-        end
-
-        unless key.try(:match, controller_regex) && action.try(:match, action_regex)
-          raise ArgumentError, "[Tension] Couldn't build valid controller path!"
-        end
-
-        "#{ key }##{ action }"
-      end
-
-      # Matches strings like "blog/comments#show".
-      def path_regex
-        /([\w\/]+[^#])#(\w+)/
-      end
-
-      # Matches strings like "blog/comments".
-      def controller_regex
-        /([\w\/]+[^#])/
-      end
-
-      # Matches strings like "show".
-      def action_regex
-        /(\w+)/
-      end
-      
-      def global_asset(type)
-        assets[ "application.#{type}" ]
-      end
-
-      def assets
-        Rails.application.assets
-      end
-    end
-
-
-    attr_reader :controller, :action
-
-    def initialize(key, action = nil)
-      @controller, @action = self.class.path_for( key, action ).split("#")
-    end
-
-    def css
-      best_asset( Tension::CSS )
-    end
-
-    def js
-      best_asset( Tension::JS )
-    end
-
-    def action_asset(type)
-      self.class.assets[ "#{controller}/#{action}.#{type}" ]
-    end
-
-    def controller_asset(type)
-      self.class.assets[ "#{controller}_common.#{type}" ]
-    end
-
-    private
-
-    def best_asset(type)
-      action_asset(type) || controller_asset(type) || self.class.global_asset(type)
-    end
-
-    def method_missing(method_sym, *args)
-      degree, type = method_sym.to_s.split("_")
-      asset_method = "#{degree}_asset"
-
-      respond_to?(asset_method) ? send(asset_method, type) : super
-    end
-
-  end
-end