seo_cache 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a029127389aa4942e27c5fbca325e56c020dfe4d35ec743034649e45700b71f
-  data.tar.gz: cb8f7123d7ef7a959e86f53d65c127b4195cfc2b3c21938bf0fb31c6fdcbf507
+  metadata.gz: 71f9d913131751f275f89dc2dfaa5efa2c7a7459b6a086c16129576bac9a202e
+  data.tar.gz: 4977d0738e9b3f2012e3759326c010be91c48d081e3f470eb4d002fc7daf9541
 SHA512:
-  metadata.gz: bd0f5a06df0b92a34304fad8893e3b708ef5142bd62509664dba5689fab503ffa1ae7a50901c3ee14f626c92a4d0b3994a017989e3024c8b2e6dd0083cbe47e5
-  data.tar.gz: 7d1e4891181adb3b9deb3cb9c7773b9328befcebfc237f4c76ce3857b6c673751a14c72403126852782726c3b2998fb3253bf7a346d3f4f4f385542b538547bf
+  metadata.gz: 6ddf8e5685420b8a12a50f81846bef821687b9d58757ceb93bc4aae6b177390bf3ca965bbcf4ace82b1407296a06e24220f66fa933162006da4e891c05fe9c2b
+  data.tar.gz: 755dd4c9e0e210e215c41eca0451c5f7c9b1385238a1169d1b739cbb1b5c25de71d55e9f6fe0119e46361b805df2e7ac769b81679b509063727e8af443c160db

data/.gitignore

@@ -7,6 +7,7 @@
 /doc/
 /pkg/
 /spec/reports/
+/spec/data/
 /tmp/
 .ruby-version
 .ruby-gemset

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.4.0
+
+- Complete README
+- Add new tests to cover disk and memory
+- Remove "disk_" prefix from disk_cache_path and disk_cache_extension
+
 ## 0.3.0
 
 - Add more examples in README

data/README.md

@@ -42,61 +42,91 @@ Rails.application.config.middleware.use SeoCache::Middleware
 
 Chrome path (**required**) (`disk` or `memory`):
 
-    SeoCache.chrome_path = Rails.env.development? ? '/usr/bin/chromium-browser' : '/usr/bin/chromium'
+```ruby
+SeoCache.chrome_path = Rails.env.development? ? '/usr/bin/chromium-browser' : '/usr/bin/chromium'
+```
 
 Choose a cache mode (`memory` (default) or `disk`):
 
-    SeoCache.cache_mode = 'memory'
+```ruby
+SeoCache.cache_mode = 'memory'
+```
 
-Disk cache path (required if disk cache):
+Cache path (**required**):
     
-    SeoCache.disk_cache_path = Rails.root.join('public', 'seo_cache')
+```ruby
+SeoCache.cache_path = Rails.root.join('public', 'seo_cache')
+```
 
-Redis URL (required if memory cache):
-    
-    SeoCache.redis_url = "redis://localhost:6379/"
+Redis URL (**required** if memory cache):
+
+```ruby
+SeoCache.redis_url = "redis://localhost:6379/"
+```
 
 Redis prefix:
-    
-    SeoCache.redis_namespace = '_my_project:seo_cache'
+
+```ruby
+SeoCache.redis_namespace = '_my_project:seo_cache'
+```
 
 Specific log file (if you want to log missed cache urls):
     
-    SeoCache.logger_path = Rails.root.join('log', 'seo_cache.log')
+```ruby
+SeoCache.logger_path = Rails.root.join('log', 'seo_cache.log')
+```
 
 Activate missed cache urls:
     
-    SeoCache.log_missed_cache = true
-    
+```ruby
+SeoCache.log_missed_cache = true
+```
+ 
 URLs to blacklist:
 
-    SeoCache.blacklist_params = %w[^/assets/.* ^/admin.*]
-    
+```ruby
+SeoCache.blacklist_params = %w[^/assets/.* ^/admin.*]
+```
+
 Params to blacklist:
 
-    SeoCache.blacklist_urls = %w[page]
-    
+```ruby
+SeoCache.blacklist_urls = %w[page]
+```
+
 URLs to whitelist:
 
-    SeoCache.whitelist_urls = []
-    
+```ruby
+SeoCache.whitelist_urls = []
+```
+
 Parameter to add manually to the URl to force page caching, if you want to cache a specific URL (e.g. `https://<my_website>/?_seo_cache_=true`):
 
-    SeoCache.force_cache_url_param = '_seo_cache_'
-    
+```ruby
+SeoCache.force_cache_url_param = '_seo_cache_'
+```
+
 URL extension to ignore when caching (already defined):
 
-    SeoCache.extensions_to_ignore = [<your_list>]
-    
+```ruby
+SeoCache.extensions_to_ignore = [<your_list>]
+```
+
 List of bot agents (already defined):
 
-    SeoCache.crawler_user_agents = [<your_list>]
+```ruby
+SeoCache.crawler_user_agents = [<your_list>]
+```
     
 Parameter added to URL when generating the page, avoid infinite rendering (override only if already used):
 
-    SeoCache.prerender_url_param = '_prerender_'
+```ruby
+SeoCache.prerender_url_param = '_prerender_'
+```
 
-Be aware, JS will be render twice: once by server rendering and once by client. For React, this not a problem but with jQuery plugins, it can duplicate elements in the page (you have to check the redundancy). 
+Be aware, JS will be render twice: once by server rendering and once by client. For React, this not a problem but with jQuery plugins, it can duplicate elements in the page (you have to check the redundancy).
+
+Disk cache is recommended by default. Nginx will directly fetch file on disk. The TTFB (time to first byte) will be under 200ms :). You can use memory cache if you have lot of RAM.
 
 ## Automatic caching
 
@@ -122,7 +152,7 @@ You can add the `force_cache: true` option to `SeoCache::PopulateCache` for over
 
 If you use disk caching, add to your Nginx configuration:
 
-```
+```nginx
 location / {
     # Ignore url with blacklisted params (e.g. page)
     if ($arg_page) {

data/lib/seo_cache/page_caching.rb

@@ -44,18 +44,18 @@ module SeoCache
     private
 
     def cache_directory
-      SeoCache.disk_cache_path
+      SeoCache.cache_path
     end
 
     def default_extension
-      SeoCache.disk_cache_extension
+      SeoCache.cache_extension
     end
 
     def cache_file(path, extension)
       name = if path.empty? || path =~ %r{\A/+\z}
                '/index'
              else
-               URI.parser.unescape(path.chomp('/'))
+               URI::Parser.new.unescape(path.chomp('/'))
              end
 
       if File.extname(name).empty?

data/lib/seo_cache/version.rb

@@ -1,3 +1,3 @@
 module SeoCache
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/lib/seo_cache.rb

@@ -20,11 +20,11 @@ module SeoCache
   mattr_accessor :cache_mode # disk or memory
   self.cache_mode = 'memory'
 
-  mattr_accessor :disk_cache_path
-  self.disk_cache_path = ''
+  mattr_accessor :cache_path
+  self.cache_path = ''
 
-  mattr_accessor :disk_cache_extension
-  self.disk_cache_extension = '.html'
+  mattr_accessor :cache_extension
+  self.cache_extension = '.html'
 
   mattr_accessor :redis_url
   self.redis_url = 'redis://localhost:6379/'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seo_cache
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - FloXcoder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-04 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport