critical-path-css-worker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e2d322301c84a22f35305396a96fdb135f27272
+  data.tar.gz: 65ec13c9eca4b7bee37b5856fef740d6d1194728
+SHA512:
+  metadata.gz: 02a0f835285c086ad548927b66c9ef615a3891fa273cfd1a5fa49203f54bc6336ab43cbe1872f0b4bbcb91405d63e11c0016fbe526b29260987120c96b096e44
+  data.tar.gz: 2abb1271b554ad3a0fa70a5874982dd6f481d6b1935fdedc4e83c5fbec8bafdbc3ba6633a3e1fb06baa0fb69a65fa65ae88f82ad77fbc99e59182417b317ec64

data/.gitignore

@@ -0,0 +1,13 @@
+/*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ddening@xogrp.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in critical-path-css-worker.gemspec
+gemspec
+
+gem 'pry-byebug', '3.4.0'
+gem 'rails'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 David Dening
+
+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,93 @@
+# Critical::Path::Css::Worker
+
+This gem provides a worker that automatically extracts a page's critical css and keeps it up to date.
+
+** Warning **
+This gem should be considered prerelease
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'critical-path-css-worker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install critical-path-css-worker
+
+Add to your application.rb
+
+```ruby
+require 'critical_path_css_worker/worker'
+```
+To test your app on development ensure that you run 
+`rake assets:precompile`
+
+and have sidekiq running locally
+`bundle exec sidekiq -c 2`
+
+
+## Usage 
+
+This gem depends on the loadcss-rails gem.  Per their instructions.
+
+The loadCSS and onloadCSS files will be added to the asset pipeline and available for you to use. Add the lines that you need to your application's JS manifest (usually app/assets/javascripts/application.js).
+
+```
+//= require loadCSS
+//= require cssrelpreload
+//= require onloadCSS
+```
+
+Setup critical_path_css.yml per the critical_path_css README
+
+[https://github.com/mudbugmedia/critical-path-css-rails]
+
+Include this gem in your application_controller.rb
+```
+include CriticalPathCssWorker
+```
+
+Add the critical css code to your application.html.haml. In the example below 'path' is the url or path for the current page and the default css file is presumed to be 'application'.
+```
+<style>
+  <%= raw critical_css(path) %>
+</style>
+<script>
+    loadCSS("<%= stylesheet_path('application') %>");
+</script>
+<link rel="preload" href="<%= stylesheet_path('application') %>" as="style" onload="this.rel='stylesheet'">
+<noscript>
+    <link rel="stylesheet" href="<%= stylesheet_path('application') %>">
+</noscript>
+```
+
+### Before deployment
+
+Make sure analytics ignore the Penthouse headless browser used to generate the css
+
+'Penthouse Critical Path CSS Generator'
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 tags, 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]/critical-path-css-worker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Critical::Path::Css::Worker project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/critical-path-css-worker/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "critical/path/css/worker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/critical-path-css-worker.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "critical_path_css_worker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "critical-path-css-worker"
+  spec.version       = CriticalPathCssWorker::VERSION
+  spec.authors       = ["David Dening"]
+  spec.email         = ["daviddening@gmail.com"]
+
+  spec.summary       = %q{A wrapper of the critical-path-css-rails gem that handles critical css generation and caching.}
+  spec.description   = %q{A wrapper of the critical-path-css-rails gem that handles critical css generation and caching.}
+  spec.homepage      = "https://github.com/daviddening"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'critical-path-css-rails', '~> 0.4'
+  spec.add_dependency 'sidekiq', '~> 4.0'
+  spec.add_dependency 'loadcss-rails', '~> 1.2'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/critical_path_css_worker.rb

@@ -0,0 +1,52 @@
+require "sidekiq"
+require "critical-path-css-rails"
+require "critical_path_css_worker/version"
+require "critical_path_css_worker/worker"
+require "critical_path_css_worker/cache_state"
+
+module CriticalPathCssWorker
+  def critical_css(url)
+    path = URI(url).path
+    css = CriticalPathCss.fetch(path)
+    Worker.cache_critical_css(url, !css.empty?)
+    css
+  end
+  module_function :critical_css
+end
+
+# Override Critical Path Css 
+#
+module CriticalPathCss
+  CACHE_NAMESPACE = "critical-path-css".freeze
+  AGENT = "Penthouse Critical Path CSS Generator".freeze
+
+  def self.generate(route)
+    Rails.cache.write(
+      route,
+      CssFetcher.new.fetch_route(route),
+      namespace: CACHE_NAMESPACE,
+      expires_in: 1.week
+    )
+  end
+
+  def self.fetch(route)
+    Rails.cache.read(route, namespace: CACHE_NAMESPACE) || ''
+  end
+
+  class CssFetcher
+    protected
+
+    def css_for_route(route)
+      url = @config.base_url + route
+
+      Phantomjs.run(
+        '--ignore-ssl-errors=true',
+        '--ssl-protocol=tlsv1',
+        PENTHOUSE_PATH,
+        '--width', '375',
+        url,
+        @config.css_path
+      )
+    end
+  end
+end

data/lib/critical_path_css_worker/cache_state.rb

@@ -0,0 +1,42 @@
+module CriticalPathCssWorker
+  class CacheState
+    CRITICAL_CSS_CACHE_HELPER_NAMESPACE = "critical-path-css-processing".freeze
+    PROCESSING = "processing".freeze
+    FRESH = "fresh".freeze
+
+    def self.processing(route)
+      set_state(route, PROCESSING)
+    end
+
+    def self.fresh(route)
+      set_state(route, FRESH, 6.days)
+    end
+
+    def self.set_state(route, state, expiry = 1.hour)
+      Rails.cache.write(
+        route,
+        state,
+        namespace: CRITICAL_CSS_CACHE_HELPER_NAMESPACE,
+        expires_in: expiry
+      )
+    end
+
+    def self.processing?(route)
+      Rails.cache.read(
+        route,
+        namespace: CRITICAL_CSS_CACHE_HELPER_NAMESPACE
+      ) == PROCESSING
+    end
+
+    def self.fresh?(route)
+      Rails.cache.read(
+        route,
+        namespace: CRITICAL_CSS_CACHE_HELPER_NAMESPACE
+      ) == FRESH
+    end
+
+    def self.clear_matched(routes)
+      Rails.cache.delete_matched(routes, namespace: CRITICAL_CSS_CACHE_HELPER_NAMESPACE)
+    end
+  end
+end

data/lib/critical_path_css_worker/tasks/critical_path_css_worker.rake

@@ -0,0 +1,10 @@
+require 'critical-path-css-rails'
+
+namespace :critical_path_css_worker do
+  desc 'Clear freshness cache so we pull latest CSS and update critical CSS cache' do
+    task set_css_stale: :environment do
+      CacheState.clear_matched('*')
+    end
+  end
+end
+

data/lib/critical_path_css_worker/version.rb

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

data/lib/critical_path_css_worker/worker.rb

@@ -0,0 +1,29 @@
+require 'sidekiq'
+require "critical-path-css-rails"
+
+module CriticalPathCssWorker
+  class Worker
+    include Sidekiq::Worker
+
+    CRITICAL_CSS_CACHE_NAMESPACE = "critical-path-css-processing".freeze
+
+    def perform(url)
+      puts "CacheCriticalCssWorker.perform(url) #{url}"
+      path = URI(url).path
+      CriticalPathCss.generate(path)
+      CacheState.fresh(path)
+    end
+
+    def self.cache_critical_css(url, critical_css_present)
+      puts "cache_critical_css(url,...) #{url}"
+      path = URI(url).path
+
+      return if critical_css_present && CacheState.fresh?(path)
+      return if CacheState.processing?(path)
+
+      CacheState.processing(path)
+      puts "CacheCriticalCssWorker.perform_async(url) #{url}"
+      Worker.perform_async(url)
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: critical-path-css-worker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Dening
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: critical-path-css-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: loadcss-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A wrapper of the critical-path-css-rails gem that handles critical css
+  generation and caching.
+email:
+- daviddening@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- critical-path-css-worker.gemspec
+- lib/critical_path_css_worker.rb
+- lib/critical_path_css_worker/cache_state.rb
+- lib/critical_path_css_worker/tasks/critical_path_css_worker.rake
+- lib/critical_path_css_worker/version.rb
+- lib/critical_path_css_worker/worker.rb
+homepage: https://github.com/daviddening
+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.2
+signing_key: 
+specification_version: 4
+summary: A wrapper of the critical-path-css-rails gem that handles critical css generation
+  and caching.
+test_files: []