conservative_etags 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6273480c5ca392d1bd41c5928604bb39ee356ab9
+  data.tar.gz: d91ae5b54c56744f31b1094c34016a4dad4a0b6a
+SHA512:
+  metadata.gz: fbb190c423dca56d389bdf2caa1b5f9e054578325788680c06a4c2f553382d26f5b1e32cc4e108c1a293d1539b6441150d8e4e9d14784994d487d263f0357e81
+  data.tar.gz: 6d830227629de2ba6e659e76bc20c9066956897ca75595f743d2bdb80b21cce79c3a8ee69bdc3a52090eef7da95298b2bfbac90d3c5b7f347264315fd3b9276a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Tyler Gannon
+
+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,88 @@
+# ConservativeEtags
+
+Use of browser cache for pages that have already been loaded has great performance benefits,
+but it doesn't take into account things like Flash messages, which should only be
+shown the first time that a page is loaded.
+
+Also, I found it annoyingly easy to wind up with pages that never refresh...
+
+What I needed was something that was a little more quick to expire ETags.
+
+This gem will only send a `304 NOT_MODIFIED` if:
+
+* The page has already been loaded during this user session
+* The requested resources has not been modified
+* AND the application has not been restarted since the last time the resource was loaded.
+
+This eases development while still getting some pretty decent use of browser cache.
+
+### How does it work?
+
+#### Within CoffeeScript:
+A comparison of the current URL and csrf token tells the script whether this version of the page has already been loaded.
+
+This means that it works with Turbolinks, which loads pages in the background.  It's not possible to just check for a `304 NOT_MODIFIED` because of how Ajax works in browsers.  It replaces a 304 response with the cached `200 SUCCESS`, which means you get no real info about the cache behavior from the XHR.
+
+#### Inside the controller
+
+A wrapper around the stale? method adds to the items being serialized into an ETag,
+
+* Whatever is later:
+  * The application's start time (which will invalidate any page loaded before the last app restart)
+  * The session start time (invalidate any page loaded before the session was created)
+  * Or in development mode, the current time (always invalidate)
+
+## Usage
+
+### In your controller:
+
+```ruby
+# Creates an ETag based on whatever objects you pass it
+# Automatically expired based on application start time, session start time, etc.
+if conservative_stale? Batch.all, params[:page], @active_link
+  render :index
+end
+```
+
+### Inside your CoffeScript:
+```coffeescript
+
+if ConservativeEtags.pageIsOld()
+  # set up ajax to get any new notifications that should be shown to the user
+else
+  # Do stuff that should only happen the first time a page is loaded,
+  # Such as displaying the flash messages.
+  $('.alert.hidden-xs-up').removeClass('hidden-xs-up')
+
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'conservative_etags'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+### Create an initializer file, `config/initializers/conservative_etags.rb`, like this:
+
+```ruby
+::ActionController::Base.send :include, ConservativeEtags::ApplicationControllerExtension
+```
+
+### Edit `production.rb` to contain the following:
+
+```
+Rails.application.config.x.app_start_time = DateTime.now
+```
+
+## Contributing
+
+Make a pull request.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'ConservativeEtags'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/conservative_etags.coffee

@@ -0,0 +1,27 @@
+class ConservativeEtags
+  @_checked: () ->
+    @_lastPageChecked == location.href
+
+  @_lastPageChecked = null
+  @_tokenKey: () ->
+    'csrf_token_' + location.href
+
+  @_old = false
+
+  @_checkPage: ->
+    unless @_checked()
+      window.new_csrf_token = $('meta[name=csrf-token]').attr('content')
+      window.old_csrf_token = sessionStorage.getItem(@_tokenKey())
+      if new_csrf_token == old_csrf_token
+        @_old = true
+      else
+        @_old = false
+
+      sessionStorage.setItem(@_tokenKey(), new_csrf_token)
+
+
+  @pageIsOld: ->
+    @_checkPage()
+    @_old
+
+window.ConservativeEtags = ConservativeEtags

data/lib/conservative_etags.rb

@@ -0,0 +1,39 @@
+require "conservative_etags/engine"
+
+module ConservativeEtags
+  module ApplicationControllerExtension
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_session_start, :set_last_modified
+    end
+
+    def set_session_start
+      unless session.key? :start_time
+        session[:start_time] = Time.zone.now.iso8601
+      end
+      @session_start_time = Time.zone.parse(session[:start_time])
+    end
+
+    def set_last_modified
+      app_start_time = Rails.application.config.x.app_start_time
+      if app_start_time.present?
+        @app_modified = [app_start_time, @session_start_time].max
+      else
+        @app_modified = Time.zone.now
+      end
+    end
+
+    def conservative_stale?(*args)
+      args << @app_modified
+      if stale? etag: args
+        true
+      else
+        false
+      end
+    end
+
+  end
+
+
+end

data/lib/conservative_etags/engine.rb

@@ -0,0 +1,5 @@
+module ConservativeEtags
+  class Engine < ::Rails::Engine
+    isolate_namespace ConservativeEtags
+  end
+end

data/lib/conservative_etags/version.rb

@@ -0,0 +1,3 @@
+module ConservativeEtags
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: conservative_etags
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Gannon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Gem for helping to manage page staleness, compatible with Turbolinks
+  5.
+email:
+- tyler@aprilseven.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/conservative_etags.coffee
+- lib/conservative_etags.rb
+- lib/conservative_etags/engine.rb
+- lib/conservative_etags/version.rb
+homepage: http://github.com/tylergannon/conservative_etags
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A Gem for helping to manage page staleness, compatible with Turbolinks 5.
+test_files: []