seo_cache 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dde4a37e1374c8be6416313e684356041177425e0cf5c2466d4fc7c60818626d
-  data.tar.gz: 9e5879c7af42860ff332e06eb36343cd650bf8a89c634b386a8073059d9c4aa2
+  metadata.gz: 470c0f8bf9bee91e738987dd31618d612d4f8007fe5d486bce1c4d7c0f1053de
+  data.tar.gz: cc0bb416f7893fb08a97e845635c374bf8dbc846127724077729d6870ceb93ec
 SHA512:
-  metadata.gz: a391af74f2c3d9848cce8bb4b1daa228c3296e019bed8ab1126dda1b9a52825351a885bfd9c2067671f8ff645a4bb7b88d36d1fb8298790e04c48e36ab93daf5
-  data.tar.gz: 8aa95c5b23d5120b1a5848d115ed3ceb75ec2019abaf507a7bcf076fa9d391ffe750f1750bbcc4b484d497303544f68ab33788a11bd88a6d1bc5c10aae95f682
+  metadata.gz: 6057c2afeb50daf1a93c1df0e9f6c90d55be66688445a417dca2d6b434d0dfc587e487be4d4404d3897c783f0e3d3d2880d5f9b6524b35975e5c87031028e4c2
+  data.tar.gz: 5822d662fdbbf6d2c47bb21ed627697c52760e6133eff49978f11c3ad6fd984cb0b67c8b6e778e6bc43742a2ba2241bdf81d24f810333e92be60c840d159559c

data/.rubocop.yml

@@ -1,18 +1,20 @@
 # Documentation
 # https://github.com/bbatsov/rubocop/blob/master/config/default.yml
-# http://rubocop.readthedocs.io/en/latest
+# http://rubocop.readthedocs.io/en/latest
+
+require:
+  - rubocop-rails
+  - rubocop-rspec
+  - rubocop-performance
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
 
 Bundler/OrderedGems:
   Enabled: false
 
-Layout/HashAlignment:
-  Enabled: false
-
-Layout/ParameterAlignment:
-  Enabled: false
+Gemspec/DateAssignment:
+  Enabled: true
 
 Layout/CaseIndentation:
   Enabled: false
@@ -42,9 +44,15 @@ Layout/FirstArrayElementIndentation:
 Layout/FirstHashElementIndentation:
   Enabled: false
 
+Layout/HashAlignment:
+  Enabled: false
+
 Layout/LeadingCommentSpace:
   Enabled: false
 
+Layout/LineLength:
+  Enabled: false
+
 Layout/MultilineBlockLayout:
   Enabled: false
 
@@ -57,20 +65,73 @@ Layout/MultilineMethodCallIndentation:
 Layout/MultilineOperationIndentation:
   Enabled: false
 
+Layout/ParameterAlignment:
+  Enabled: false
+
 Layout/SpaceAroundOperators:
   Enabled: false
 
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
 Layout/SpaceInLambdaLiteral:
   Enabled: false
 
 Layout/TrailingWhitespace:
   Enabled: false
 
+Lint/AmbiguousAssignment:
+  Enabled: true
+
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
+Lint/DeprecatedConstants:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+Lint/NumberedParameterAssignment:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true
+
+Lint/RedundantDirGlobSort:
+  Enabled: true
+
+Lint/SymbolConversion:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/TripleQuotes:
+  Enabled: true
+
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
 Metrics/AbcSize:
-  # The ABC size is a calculated magnitude, so this number can be a Fixnum or a Float.
   Max: 240
 
 Metrics/BlockLength:
@@ -80,14 +141,14 @@ Metrics/BlockNesting:
   Max: 4
 
 Metrics/ClassLength:
-  CountComments: false  # count full line comments?
+  CountComments: false
   Max: 600
 
 Metrics/CyclomaticComplexity:
   Enabled: false
 
 Metrics/MethodLength:
-  CountComments: false  # count full line comments?
+  CountComments: false
   Max: 120
 
 Metrics/PerceivedComplexity:
@@ -96,6 +157,168 @@ Metrics/PerceivedComplexity:
 Naming/RescuedExceptionsVariableName:
   Enabled: false
 
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: true
+
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+
+Performance/ConstantRegexp:
+  Enabled: true
+
+Performance/MapCompact:
+  Enabled: true
+
+Performance/MethodObjectAsBlock:
+  Enabled: true
+
+Performance/RedundantEqualityComparisonBlock:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantSplitRegexpArgument:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Performance/Sum:
+  Enabled: true
+
+Rails/ActiveRecordCallbacksOrder:
+  Enabled: true
+
+Rails/AfterCommitOverride:
+  Enabled: true
+
+Rails/AttributeDefaultBlockValue:
+  Enabled: true
+
+Rails/DynamicFindBy:
+  Enabled: false
+
+Rails/FindBy:
+  Enabled: false
+
+Rails/FindById:
+  Enabled: true
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: false
+
+Rails/Inquiry:
+  Enabled: true
+
+Rails/InverseOf:
+  Enabled: false
+
+Rails/MailerName:
+  Enabled: true
+
+Rails/MatchRoute:
+  Enabled: true
+
+Rails/NegateInclude:
+  Enabled: true
+
+Rails/Pluck:
+  Enabled: true
+
+Rails/OutputSafety:
+  Enabled: false
+
+Rails/PluckInWhere:
+  Enabled: true
+
+Rails/RenderInline:
+  Enabled: true
+
+Rails/RenderPlainText:
+  Enabled: true
+
+Rails/ShortI18n:
+  Enabled: true
+
+Rails/SkipsModelValidations:
+  Enabled: false
+
+Rails/SquishedSQLHeredocs:
+  Enabled: true
+
+Rails/UnknownEnv:
+  Enabled: false
+
+Rails/Validation:
+  Enabled: false
+
+Rails/WhereEquals:
+  Enabled: true
+
+Rails/WhereExists:
+  Enabled: true
+
+Rails/WhereNot:
+  Enabled: true
+
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/DescribedClass:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/Capybara:
+  Enabled: false
+
+RSpec/ImplicitExpect:
+  Enabled: false
+
+RSpec/ImplicitSubject:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/LeadingSubject:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 8
+
+RSpec/NestedGroups:
+  Max: 4
+
+Style/ArgumentsForwarding:
+  Enabled: true
+
 Style/AsciiComments:
   Enabled: false
 
@@ -105,24 +328,63 @@ Style/BlockDelimiters:
 Style/ClassAndModuleChildren:
   Enabled: false
 
+Style/CollectionCompact:
+  Enabled: true
+
 Style/ColonMethodCall:
   Enabled: false
 
 Style/CommandLiteral:
   Enabled: false
 
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
 Style/DoubleNegation:
   Enabled: false
 
+Style/EndlessMethod:
+  Enabled: true
+
 Style/GlobalVars:
   Enabled: false
 
+Style/HashConversion:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashExcept:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+
 Style/Lambda:
   Enabled: false
 
 Style/MultilineIfModifier:
   Enabled: false
 
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/NilLambda:
+  Enabled: true
+
 Style/NumericPredicate:
   Enabled: false
 
@@ -130,6 +392,9 @@ Style/RedundantReturn:
   Enabled: false
   AllowMultipleReturnValues: true
 
+Style/RedundantArgument:
+  Enabled: true
+
 Style/RedundantSelf:
   Enabled: false
 
@@ -139,5 +404,11 @@ Style/RegexpLiteral:
 Style/RescueModifier:
   Enabled: false
 
+Style/StringChars:
+  Enabled: true
+
+Style/SwapValues:
+  Enabled: true
+
 Style/SymbolArray:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.0.6
+
+- Logs only missed cache for success response
+
+## 1.0.5
+
+- Use correct path for index page with multiple domain names
+
+## 1.0.4
+
+- Add option to populate seo cache for multi-domains
+
+## 1.0.3
+
+- Ensure page rendered status is present after head element 
+
 ## 1.0.2
 
 - Do not log missed cache for ignored statuses

data/README.md

@@ -227,6 +227,8 @@ end
 
 You can add the `force_cache: true` option to `SeoCache::PopulateCache` for overwrite cached data.
 
+If your website has several domains (.com, .fr, ...), you need to generate your urls for each locale (each key is the locale). And use the `with_locale_keys: true` option.
+
 If you want to execute only through a rake task, you can comment the line which include the middleware. keep all options configured and remove only the middleware. Thus all pages will be cached and SeoCache isn't called for pages not in cache.
 It's useful if you have a script which generates all website pages (based on sitemap for instance) and you run script every day.
 
@@ -275,6 +277,8 @@ location / {
     rewrite ^/(.*)/$ /$1 last;
     
     try_files /seo_cache/$uri/index$cache_extension /seo_cache/$uri$cache_extension /seo_cache/$uri $uri @rubyproxy;
+    # Or for multi-domains:
+    # try_files /seo_cache/fr/$uri/index$cache_extension /seo_cache/fr/$uri$cache_extension /seo_cache/fr/$uri $uri @rubyproxy;
 }
 
 location @rubyproxy {

data/lib/seo_cache/middleware.rb

@@ -36,9 +36,15 @@ module SeoCache
         else
           Thread.new do
             prerender_data = page_render(env)
-            # Extract status from render page or return 404
-            status = prerender_data&.scan(/<!--status:(\d+)-->/)&.last&.first || 404
-            after_render(env, prerender_data, status || 200)
+            # Extract status from render page or return success (200)
+            status = prerender_data&.scan(/<!--status:(\d+)-->/)&.last&.first || 200
+
+            if SeoCache.log_missed_cache && status.to_s.start_with?('2')
+              env_request = Rack::Request.new(env)
+              SeoCache.log("missed cache : #{env_request.path} (User agent: #{env_request.user_agent})")
+            end
+
+            after_render(env, prerender_data, status)
           end
         end
       elsif prerender_params?(env)
@@ -48,7 +54,7 @@ module SeoCache
         status_code               = "<!--status:#{status}-->"
         # Cannot add at the top of file, Chrome removes leading comments...
         begin
-          body_code = response.body.sub('<head>', "<head>#{status_code}")
+          body_code = response.body.sub(/<head( ?)(.*?)>/i, "<head\\1\\2>#{status_code}")
           return [status, headers, [body_code]]
         rescue
           return [status, headers, [nil]]
@@ -94,7 +100,7 @@ module SeoCache
       return false if SeoCache.blacklist_params.present? && SeoCache.blacklist_params.any? { |param| query_params.has_key?(param) }
 
       # if it is a bot and is requesting a resource...don't prerender
-      return false if @extensions_to_ignore.any? { |extension| request.fullpath.include? extension }
+      return false if @extensions_to_ignore.any? { |extension| request.fullpath.include?(extension) }
 
       # if it is a bot and not requesting a resource and is not whitelisted...don't prerender
       return false if SeoCache.whitelist_urls.present? && SeoCache.whitelist_urls.all? { |whitelisted| !Regexp.new(whitelisted).match(request.fullpath) }

data/lib/seo_cache/page_caching.rb

@@ -17,12 +17,12 @@ module SeoCache
       @redis.get(cache_path(path, extension)) if SeoCache.memory_cache? && @redis
     end
 
-    def cache(content, path, extension = nil, gzip = Zlib::BEST_COMPRESSION)
+    def cache(content, path, locale_domain = nil, extension = nil, gzip = Zlib::BEST_COMPRESSION)
       instrument :write_page, path do
         if SeoCache.memory_cache? && @redis
-          write_to_memory(content, cache_path(path, extension))
+          write_to_memory(content, cache_path(path, extension, locale_domain))
         else
-          write_to_disk(content, cache_path(path, extension), gzip)
+          write_to_disk(content, cache_path(path, extension, locale_domain), gzip)
         end
       end
     end
@@ -51,22 +51,22 @@ module SeoCache
       SeoCache.cache_extension
     end
 
-    def cache_file(path, extension)
+    def cache_file(path, extension, locale_domain)
       name = if path.empty? || path =~ %r{\A/+\z}
                '/index'
              else
                URI::Parser.new.unescape(path.chomp('/'))
              end
 
-      if File.extname(name).empty?
-        name + (extension || default_extension)
-      else
-        name
-      end
+      name = "#{locale_domain}/#{name}" if locale_domain
+
+      name += extension || default_extension if File.extname(name).empty?
+
+      name
     end
 
-    def cache_path(path, extension = nil)
-      File.join(cache_directory, cache_file(path, extension))
+    def cache_path(path, extension = nil, locale_domain = nil)
+      File.join(cache_directory, cache_file(path, extension, locale_domain))
     end
 
     def write_to_memory(content, path)

data/lib/seo_cache/populate_cache.rb

@@ -11,27 +11,40 @@ module SeoCache
       @page_render  = PageRender.new
       @page_caching = PageCaching.new
 
-      @force_cache = options.fetch(:force_cache, false)
+      @force_cache      = options.fetch(:force_cache, false)
+      @with_locale_keys = options.fetch(:with_locale_keys, false)
     end
 
     def perform
-      @paths.each do |path|
-        next if @page_caching.cache_exists?(path) && !@force_cache
-
-        url = @host + path
-        url += if path.include?('?')
-                 '&'
-               else
-                 '?'
-               end
-        url += "#{SeoCache.prerender_url_param}=true"
-
-        page_source = @page_render.get(url, false)
-        @page_caching.cache(page_source, path) if page_source
+      if @with_locale_keys
+        @paths.each do |locale, paths|
+          paths.each do |path|
+            generate_cache(path, locale)
+          end
+        end
+      else
+        @paths.each do |path|
+          generate_cache(path)
+        end
       end
 
     ensure
       @page_render.close_connection
     end
+
+    private
+
+    def generate_cache(path, locale_domain = nil)
+      return if @page_caching.cache_exists?(path) && !@force_cache
+
+      url = @host + path
+      url += path.include?('?') ? '&' : '?'
+      url += "#{SeoCache.prerender_url_param}=true"
+
+      page_source = @page_render.get(url, false)
+      return unless page_source
+
+      @page_caching.cache(page_source, path, locale_domain)
+    end
   end
 end

data/lib/seo_cache/version.rb

@@ -1,3 +1,3 @@
 module SeoCache
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seo_cache
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.6
 platform: ruby
 authors:
 - FloXcoder
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-06 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Cache dedicated for SEO with Javascript rendering