wovnrb 2.5.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1667b83e9b8a2a2a79d1c152c71fac66ecc1acfe98b53f062e6929dda1d267c
-  data.tar.gz: 6fe79d1445f3e87ebd65e9d5beca3c173da6e3ae25e92de97c9b85bed95c8547
+  metadata.gz: ceba766ab6d122f9c54e48ab267ada742f7efabb4fc19e1f9c0a7f5e5ba47983
+  data.tar.gz: dfde93503c625a1bed27cd4b65b44a5cff3adff0d883a0f0824546eb02bd111f
 SHA512:
-  metadata.gz: 560317e910fdf2966f10919126b8e7ec255ce07a9325bcd24c610eda52bb2686347e76e7123e9ffe0c22d7373220aab5e270b3d63a324dda1acec6c5a1c0d9cb
-  data.tar.gz: dbcb9693c55eb8a5b7e77d1b98e53d1bd8ae15989d498e585505a2b04137bf068ab20f4efedf4205c1c412d2882e33774875ffa14294635e2e0f1772efbda08a
+  metadata.gz: b0af38a90017f6e69f344fa9304c5c79dcf242796d57de31b44900534263673e94910109535783272ba7ad8ebfac399389ca20894d8f1a0e50d6ecd99e921b1b
+  data.tar.gz: adfce2cdbb1b99aeeb2612d68eda7e115018186d1cea1d602dd16754532326288610cf1c5db8f1b77a44c044b2a52d35e398135f7a07cef9c19a836c627bb74e

data/.circleci/config.yml

@@ -1,18 +1,29 @@
-version: 2
+version: 2.1
+
+orbs:
+  # https://github.com/CircleCI-Public/ruby-orb
+  ruby: circleci/ruby@1.1
 
 jobs:
-  build:
+  test:
+    parameters:
+      ruby-version:
+        type: string
     docker:
-      - image: circleci/ruby:2.3-jessie
+      - image: cimg/ruby:<< parameters.ruby-version >>
     steps:
       - checkout
-      - restore_cache:
-          keys:
-            - bundler-
       - run: bundle install --path vendor/bundle --jobs=4
-      - save_cache:
-          key: bundler-{{ checksum "Gemfile.lock" }}
-          paths:
-            - vendor/bundle
       - run: bundle exec rubocop
       - run: bundle exec rake test
+
+# https://circleci.com/blog/circleci-matrix-jobs/
+workflows:
+  build_and_test:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              # https://github.com/CircleCI-Public/cimg-ruby
+              # only supports the last three ruby versions
+              ruby-version: ["2.5", "2.6", "2.7"]

data/.rubocop_todo.yml

@@ -6,17 +6,8 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Layout/EmptyLinesAroundAccessModifier:
-  Exclude:
-    - 'lib/wovnrb/text_caches/memory_cache.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Layout/EmptyLinesAroundMethodBody:
-  Exclude:
-    - 'test/lib/text_caches/memory_cache_test.rb'
+Gemspec/RequiredRubyVersion:
+  Enabled: false
 
 # Offense count: 11
 # Cop supports --auto-correct.
@@ -25,13 +16,9 @@ Layout/ExtraSpacing:
   Exclude:
     - 'lib/wovnrb/lang.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: special_inside_parentheses, consistent, align_braces
-Layout/FirstHashElementIndentation:
+Style/HashEachMethods:
   Exclude:
-    - 'lib/wovnrb/text_caches/cache_base.rb'
+    - 'lib/wovnrb/store.rb'
 
 # Offense count: 4
 # Cop supports --auto-correct.
@@ -42,13 +29,6 @@ Layout/HeredocIndentation:
     - 'test/lib/lang_test.rb'
     - 'test/lib/wovnrb_test.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AllowForAlignment.
-Layout/SpaceAroundOperators:
-  Exclude:
-    - 'lib/wovnrb/text_caches/memory_cache.rb'
-
 # Offense count: 3
 # Configuration parameters: AllowSafeAssignment.
 Lint/AssignmentInCondition:
@@ -70,13 +50,6 @@ Lint/ImplicitStringConcatenation:
   Exclude:
     - 'test/lib/lang_test.rb'
 
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'lib/wovnrb/text_caches/cache_base.rb'
-
 # Offense count: 5
 Lint/UselessAssignment:
   Exclude:
@@ -116,12 +89,13 @@ Metrics/MethodLength:
 # Offense count: 12
 Metrics/PerceivedComplexity:
   Max: 22
+  Exclude:
+    - 'lib/wovnrb/headers.rb'
 
 # Offense count: 3
 Naming/AccessorMethodName:
   Exclude:
     - 'lib/wovnrb/services/wovn_logger.rb'
-    - 'lib/wovnrb/text_caches/cache_base.rb'
 
 # Offense count: 120
 # Configuration parameters: .
@@ -153,12 +127,6 @@ Style/ClassCheck:
   Exclude:
     - 'lib/wovnrb/store.rb'
 
-# Offense count: 6
-Style/ClassVars:
-  Exclude:
-    - 'lib/wovnrb/text_caches/cache_base.rb'
-    - 'lib/wovnrb/text_caches/memory_cache.rb'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: Keywords.
@@ -183,8 +151,6 @@ Style/Documentation:
     - 'lib/wovnrb/services/wovn_logger.rb'
     - 'lib/wovnrb/settings.rb'
     - 'lib/wovnrb/store.rb'
-    - 'lib/wovnrb/text_caches/cache_base.rb'
-    - 'lib/wovnrb/text_caches/memory_cache.rb'
 
 # Offense count: 2
 Style/DoubleNegation:
@@ -224,7 +190,6 @@ Style/IfUnlessModifier:
     - 'Rakefile'
     - 'lib/wovnrb/helpers/nokogumbo_helper.rb'
     - 'lib/wovnrb/store.rb'
-    - 'lib/wovnrb/text_caches/memory_cache.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
@@ -241,7 +206,6 @@ Style/NegatedIf:
 Style/PreferredHashMethods:
   Exclude:
     - 'lib/wovnrb/store.rb'
-    - 'lib/wovnrb/text_caches/memory_cache.rb'
 
 # Offense count: 2
 # Cop supports --auto-correct.
@@ -297,7 +261,7 @@ Style/ZeroLengthPredicate:
 # Offense count: 1436
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   Max: 1424
 
 Style/FrozenStringLiteralComment:
@@ -308,3 +272,9 @@ Style/NumericPredicate:
 
 Style/SafeNavigation:
   Enabled: false
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'docker/**/*'
+    - 'vendor/**/*'

data/Gemfile

@@ -1,7 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in wovn.gemspec
-if RUBY_VERSION < '2.2.2'
-  gem 'activesupport', '< 5.0.0'
-end
 gemspec

data/README.en.md

@@ -47,6 +47,8 @@ config.wovnrb = {
 ...
 ```
 
+The WOVN.rb Rails middleware must also be installed. See [2.10 - install_middleware](#2.10-install_middleware)
+
 * If you're using Sinatra
 
 Insert the following into either the Application File or config.ru.
@@ -83,6 +85,7 @@ query              |          | []
 ignore_class       |          | []
 translate_fragment |          | true
 ignore_paths       |          | []
+install_middleware |          | true
 
 ### 2.1. project_token
 
@@ -172,3 +175,24 @@ For instance, if you want to not localize the admin directory of your website, y
 ```
 'ignore_paths' => ['/admin/']
 ```
+
+### 2.10 install_middleware
+
+When using WOVN.rb in a Rails environment, this parameter controls whether the WOVN.rb middleware will be automatically installed or not.
+
+By default, WOVN.rb is automatically installed as the first middleware.
+If you are using Rack::Deflater or other middleware that needs to be executed first, set this parameter to `false` and manually insert the middleware appropriately.
+WOVN.rb needs to be added after any compression middleware.
+
+```ruby
+  config.middleware.use Rack::Deflater
+  config.middleware.insert_after Rack::Deflater, Wovnrb::Interceptor
+
+  config.wovnrb = {
+    :project_token => 'EnS!t3',
+    :default_lang => 'en',
+    :supported_langs => ['en'],
+    :url_pattern => 'path',
+    :install_middleware => false
+  }
+```

data/docker/docker-compose.yml

@@ -0,0 +1,16 @@
+version: '3'
+services:
+  rails:
+    container_name: wovntest-rails
+    build:
+      context: ./rails
+      dockerfile: Dockerfile
+    ports:
+      - 4000:4000
+    volumes:
+      - ../:/usr/src/app/wovnrb
+    networks:
+      - backend-network
+networks:
+  backend-network:
+    name: 'backend-network'

data/docker/rails/Dockerfile

@@ -0,0 +1,6 @@
+FROM ruby:2.6.5
+
+WORKDIR /usr/src/app
+
+COPY ./TestSite/ .
+CMD ["/bin/bash", "start.sh"]

data/docker/rails/TestSite/.browserslistrc

@@ -0,0 +1 @@
+defaults

data/docker/rails/TestSite/.gitignore

@@ -0,0 +1,63 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+/tmp/pids/*
+!/tmp/pids/
+!/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+/storage/*
+!/storage/.keep
+
+/public/assets
+.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key
+
+/public/packs
+/public/packs-test
+/node_modules
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+/.bundle/
+/vendor
+.yardoc/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.swp
+mkmf.log
+.idea/
+*.iml
+.ruby-version
+/*.gem
+wovn_error.log
+.byebug_history

data/docker/rails/TestSite/Gemfile

@@ -0,0 +1,56 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.6.5'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 6.0.3', '>= 6.0.3.2'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3', '~> 1.4'
+# Use Puma as the app server
+gem 'puma', '~> 4.1'
+# Use SCSS for stylesheets
+gem 'sass-rails', '>= 6'
+# Transpile app-like JavaScript. Read more: https://github.com/rails/webpacker
+gem 'webpacker', '~> 4.0'
+# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
+gem 'turbolinks', '~> 5'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.7'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use Active Model has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Active Storage variant
+# gem 'image_processing', '~> 1.2'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.4.2', require: false
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '~> 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+group :test do
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara', '>= 2.15'
+  gem 'selenium-webdriver'
+  # Easy installation and use of web drivers to run system tests with browsers
+  gem 'webdrivers'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+gem 'wovnrb', path: './wovnrb'

data/docker/rails/TestSite/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/docker/rails/TestSite/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/docker/rails/TestSite/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/docker/rails/TestSite/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/docker/rails/TestSite/app/assets/stylesheets/redirects.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the redirects controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: https://sass-lang.com/