asset_ram 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 201c96bf0cd23662ec2b7b3f68ebc17935a38a2ade97c1d3c025e7efe1492f28
-  data.tar.gz: 0640c99917e1d5bd6d064f34ecffee34d34e9459ae529c787c89ea02c1b1d449
+  metadata.gz: 05464224fe91ef9aeb8784b87a9331802f9f1625f13e75969f672dccd4548dcd
+  data.tar.gz: 1c5c4845548975b31204a71da7cdd8410b69c4806b191adc8c2047669a6cfd56
 SHA512:
-  metadata.gz: 6e259782f7f9b0bbc2129cf453b43d7e3889f35fe0ca6f5b98ed737977ccd21a46f773fdfaf8abdab62f67b2218557ee211038c22aca08454e9b378fcf4e0482
-  data.tar.gz: a7a2c855608200a56146ab8aed9f8c0994e01a452c41b72e45073bfa0bcd9b955bb2f6d32e748aa41632c58d61c29ee6c6765e5cc9826ea6c09c750421023aaf
+  metadata.gz: 553e142c91b2dc4a5d4f1ff379524c65be3400d17498bba2cd549f81d4970077f037e4d329a3ec1d327e67e18d39f61b0ae946bf3e7e053c4f15ecef1c38f384
+  data.tar.gz: cd10e4447bdbaeeb29d795f7862b33dea15320a5fc240a165850785be2d53da04da1d96979eb628edfecb01bd5e692f26c6dacc10230083a0e1401a83f4970a4

data/README.md

@@ -1,8 +1,102 @@
 # AssetRam
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/asset_ram`. To experiment with that code, run `bin/console` for an interactive prompt.
+In a nutshell, for [a typical dynamic page](https://texas.public.law/statutes/tex._fam._code_section_1.001) in my Rails app, I get:
+
+* 71% reduction in execution time
+* 83% reduction in allocations
+
+My app has been amazingly efficient since using these: memory usage stays flat at just 50% usage (512MB) for 4 Puma workers. It's very quick, with production response times averaging 37ms on a Heroku 1GB Standard-2x Dyno.
+
+
+## Example stats for [the page](https://texas.public.law/statutes/tex._fam._code_section_1.001)
+
+Without AssetRam:
+
+```
+Completed 200 OK in 38ms (Views: 34.2ms | ActiveRecord: 0.9ms | Allocations: 30332)
+```
+
+With AssetRam:
+
+```
+Completed 200 OK in 11ms (Views: 5.1ms | ActiveRecord: 1.3ms | Allocations: 5208)
+```
+
+
+## Usage
+
+Wrap every asset helper call with `#cache`, like this:
+
+### Before
+
+```ruby
+<%= favicon_link_tag('favicon/favicon.ico', rel: 'icon') %>
+```
+
+### After
+
+```ruby
+<%= AssetRam::Helper.cache { favicon_link_tag('favicon/favicon.ico', rel: 'icon') } %>
+```
+
+After booting up, messages like these will appear _once_ in the log. They show the 
+full cache key.
+
+```
+Caching ["/Users/robb/src/PublicLaw/public-law-website/app/views/application/_html_head.haml", 16, "texas"]
+Caching ["/Users/robb/src/PublicLaw/public-law-website/app/views/application/_favicon.haml", 8]
+Caching ["/Users/robb/src/PublicLaw/public-law-website/app/views/application/_favicon.haml", 11]
+```
+
+I use it in my footer for social icons as well: (HAML syntax)
+
+```ruby
+= link_to asset.cache { image_tag("social/instagram-logo.svg", alt: 'Instagram', loading: 'lazy', decoding: 'async') },    "https://www.instagram.com/law.is.code/"
+= link_to asset.cache { image_tag("social/facebook-logo-button.svg", alt: 'Facebook', loading: 'lazy', decoding: 'async') }, "https://www.facebook.com/PublicDotLaw"
+= link_to asset.cache { image_tag("social/twitter-logo-button.svg", alt: 'Twitter', loading: 'lazy', decoding: 'async') },   "https://twitter.com/law_is_code"
+= link_to asset.cache { image_tag("social/github-logo.svg", alt: 'Our GitHub Page', loading: 'lazy', decoding: 'async') },   "https://www.github.com/public-law/"
+```
+
+
+
+
+### In some cases, the cache key can't be inferred.
+
+RamCache creates the cache key automatically using the view source filename and line number.
+This works for most uses. 
+
+Some of my app's views are an exception, however. It's multi-tenant and the views serve content
+for several sub-domains. And so the call to `#cache` allows extra key info to be passed.
+In my HTML HEAD view, I have a `site` variable for choosing the CSS file for the domain:
+
+```ruby
+<%= AssetRam::Helper.cache(key: site) { stylesheet_link_tag("themes/#{site}", media: nil) } %>
+```
+
+## Background: I was looking for ways to reduce allocations in my Rails app
+
+In an effort to help my app run in a small 512MB virtual server, I looked through every view
+invocation in the logs. After I optimized a bunch of my code, I realized that the asset helpers
+create a relatively large amount of objects. The code is pretty complex too implying some amount
+of CPU overhead. Moreover, this work is done over **on every request**.
+
+These asset fingerprints are potentially re-generated on every deploy. So they can't be stored in
+the usual Rails cache. I realized that storing the computed paths in a simple hash (in RAM only)
+would be fast and never return stale data: The RAM cache goes away on a deploy/restart, which is
+when asset fingerprints could change.
+
+And so one-by-one I started storing the computed asset paths in a hash, and saw pretty dramatic results.
+
+## How it works: Block-based code executed in the view's context and inferred cache keys
+
+Rails has some magic around when the asset helpers are able to create the fingerprint path. I found
+that the caching needs to be done within the context of a view. This is why the lib's API looks
+the way it does. 
+
+To make it as easy as possible to use, the lib finds the view's source filename and the line number of
+the code being cached. This has been working well and in production for four months in a large Rails app.
+
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,9 +114,6 @@ Or install it yourself as:
 
     $ gem install asset_ram
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Development
 
@@ -30,10 +121,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/asset_ram.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/asset_ram/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AssetRam
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/asset_ram.rb

@@ -5,7 +5,7 @@ require_relative "asset_ram/version"
 #
 # Use in views to cache the asset path computation.
 #
-# For example, in an ERB file:
+# For example, in a HAML file:
 #
 # = AssetRam::Helper.cache { favicon_link_tag('favicon/favicon.ico', rel: 'icon') }
 #
@@ -17,6 +17,9 @@ require_relative "asset_ram/version"
 #
 # = AssetRam::Helper.cache(key: site) { stylesheet_link_tag("themes/#{site}", media: nil) }
 #
+# To test and compare if this lib actually improves performance,
+# set the ASSET_RAM_DISABLE env var and it will transparently never cache.
+#
 #
 module AssetRam
   class Error < StandardError; end
@@ -25,16 +28,10 @@ module AssetRam
   # Our own asset helper which memoizes Rails' asset helper calls.
   class Helper
 
-    ##
-    # For testing the gains from caching with this library.
-    # Set to true to disable caching.
-    NO_CACHE = false
-
     @@_cache = {}
 
-
     def self.cache(key: '', &blk)
-      return yield if NO_CACHE
+      return yield if ENV['ASSET_RAM_DISABLE']
 
       cache_key = blk.source_location
       cache_key << key if key.present?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asset_ram
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robb Shecter