Skip to content
This repository has been archived by the owner on Mar 31, 2022. It is now read-only.

Latest commit

 

History

History
57 lines (42 loc) · 3.38 KB

README.markdown

File metadata and controls

57 lines (42 loc) · 3.38 KB
Raw

IncludeCombiner

IncludeCombiner on my blog

Description

IncludeCombiner is a resuable component written for ASP.NET MVC that is for handling static file-includes like CSS and Javascript in a best-practise way, that can be dropped into your own ASP.NET MVC web project, configured, and used with a minimum of effort.

It:

  • Mashes together the includes on a page to a single request, following YSlow! guideline for same (minimise number of requests necessary to load page)
  • Minifies the include-combination (using the YUICompressor); strips comments and whitespace to reduce file-weight on the wire
  • If the browser accepts compression, compresses (gzip/deflate) the response
  • Appends cache-policy headers to the response to control client-side caching
  • Does all this at run-time with no configuration or build complexity overhead

Also:

  • (TODO) It's configurable so you can control:

    • The path that the combiner-controller's action happens at, per include-type (CSS/JS)
    • The minification options, per include-type
    • The default length of time to cache the include-combination at the client-side for
    • Which compression to pick when a choice is accepted

  • There's a DebugFilterAttribute responsible for switching operation between debug and release-mode, and an HtmlHelper extension method to test whether we're in debug-mode (it reacts to a debug=1 or debug=0 in the querystring, and sets a debug cookie if debug=1; removes it if debug=0)

  • It's pluggable, so you can replace collaborating components (for example if you wanted to replace the in-memory static storage with a cache-backed IIncludeStorage)

  • It has a demo

  • It has benchmarks (see Demo.Site)

  • It's highly covered in unit-tests - see http://teamcity.codebetter.com -> IncludeCombiner

  • It has a page that tells you which includes and combinations are registered; the index action on IncludeController

How to use it

  • Unzip the distribution

  • Reference Nrws.dll in your web-project

  • Register services in your IoC container:

    • IHttpContextProvider -> Nrws.Web.HttpContextProvider
    • IKeyGenerator -> Nrws.KeyGenerator
    • IIncludeReader -> Nrws.Web.FilesystemIncludeReader
    • IIncludeStorage -> Nrws.Web.StaticIncludeStorage
    • IIncludeCombiner -> Nrws.Web.IncludeCombiner

  • Ensure your web-project's ControllerFactory can create the IncludeController when it's required to

    • This may require replacing the default ControllerFactory with an IoC-aware one; see Nrws.Web.CommonServiceLocatorControllerFactory

  • (optional) Create ~/Views/Include/Index.aspx and copy Demo.Site/Views/Include/Index.aspx's content to it (TODO: make embedded into Nrws dll or similar)

  • (optional) Configure it via web.config via following options (where more than one choice exists, default value is given first):