wovnrb 2.6.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87e1de8bb4d4e0aacac97628ff3f02cc52756f710897e92124d9c05019125fe3
-  data.tar.gz: 4cfa377c062238076d77f77e1dc4d8b4a1f539fb78751b8b3a846e0fe70b3269
+  metadata.gz: 4d23f8ac05cb8fbefe04b2c8ae96f9932b280762e2491c80552bd20314d17e6d
+  data.tar.gz: 44118f0db0276085f492b631eeba2af8fe349f6b9d7ef96627590dda63793d80
 SHA512:
-  metadata.gz: eb76b8e1d6049620933f25f7921940fd6006b04fda13fba82f86f414906878c6c6c84d93918935a9ab2548c525fb116000e8480cac5c444265f92bdffaf38b5f
-  data.tar.gz: 1771496f33d419c64fdf3b3be112db32e5dc8d788c3f4cd3dc14ee3e25e272106dc8d93cd86df5e8fe56dde2ec1e2ba1efa60575b5054fb6223a674f1f833af3
+  metadata.gz: a71cbbd14782608c0c445d146bc262d5dfcf6bd7fca9cbfb467aad6f62caf9f979a98ae29a3e0fee38d77202217960b39e5ac9755975ba1fbd5e3899d5d7e69b
+  data.tar.gz: 9576ec7bd9d7053be56a116286ee9fe45df7a1f0c9e826dc114b0c77963d5e7c4ae53245655269fa8287cb45aa2ea0e56fdeecdf4cb81e4ce397d7f5595c31ef

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/

data/docker/rails/TestSite/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/docker/rails/TestSite/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/docker/rails/TestSite/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/docker/rails/TestSite/app/controllers/custom_response_controller.rb

@@ -0,0 +1,16 @@
+class CustomResponseController < ApplicationController
+  skip_before_action :verify_authenticity_token2
+
+  def make_response
+    response_args_json = params[:response]
+    raise ActionController::BadRequest unless response_args_json
+
+    (response_args_json[:headers] || {}).each do |name, value|
+      response.headers[name] = value
+    end
+
+    render inline: response_args_json[:body],
+           status: response_args_json[:status],
+           content_type: response_args_json[:content_type]
+  end
+end

data/docker/rails/TestSite/app/controllers/pages_controller.rb

@@ -0,0 +1,7 @@
+class PagesController < ApplicationController
+  skip_before_action :verify_authenticity_token
+
+  def show
+    render file: "#{Rails.root}/public/#{params[:page]}.html", layout: false
+  end
+end

data/docker/rails/TestSite/app/controllers/redirects_controller.rb

@@ -0,0 +1,5 @@
+class RedirectsController < ApplicationController
+  def show
+    redirect_to '/redirection_target'
+  end
+end

data/docker/rails/TestSite/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/docker/rails/TestSite/app/helpers/pages_helper.rb

@@ -0,0 +1,2 @@
+module PagesHelper
+end

data/docker/rails/TestSite/app/helpers/redirects_helper.rb

@@ -0,0 +1,2 @@
+module RedirectsHelper
+end

data/docker/rails/TestSite/app/javascript/channels/consumer.js

@@ -0,0 +1,6 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+
+import { createConsumer } from "@rails/actioncable"
+
+export default createConsumer()

data/docker/rails/TestSite/app/javascript/channels/index.js

@@ -0,0 +1,5 @@
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+const channels = require.context('.', true, /_channel\.js$/)
+channels.keys().forEach(channels)

data/docker/rails/TestSite/app/javascript/packs/application.js

@@ -0,0 +1,17 @@
+// This file is automatically compiled by Webpack, along with any other files
+// present in this directory. You're encouraged to place your actual application logic in
+// a relevant structure within app/javascript and only use these pack files to reference
+// that code so it'll be compiled.
+
+require("@rails/ujs").start()
+require("turbolinks").start()
+require("@rails/activestorage").start()
+require("channels")
+
+
+// Uncomment to copy all static images under ../images to the output folder and reference
+// them with the image_pack_tag helper in views (e.g <%= image_pack_tag 'rails.png' %>)
+// or the `imagePath` JavaScript helper below.
+//
+// const images = require.context('../images', true)
+// const imagePath = (name) => images(name, true)

data/docker/rails/TestSite/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/docker/rails/TestSite/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/docker/rails/TestSite/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/docker/rails/TestSite/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>TestSite</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_pack_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/docker/rails/TestSite/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/docker/rails/TestSite/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>