From 6a36de037edc14ff1b445af93d4c07d99b6f6fe6 Mon Sep 17 00:00:00 2001 From: Richard Smedley Date: Mon, 8 Jun 2026 13:56:06 +0100 Subject: [PATCH 1/2] DOC-14417 Ruby samples in devguide module --- Rakefile | 2 +- .../examples/ruby}/analytics.rb | 0 .../examples/ruby}/auth.rb | 0 .../examples/ruby}/cas.rb | 0 .../examples/ruby}/cloud.rb | 0 .../examples/ruby}/collections.rb | 0 .../examples/ruby}/documents.rb | 0 .../examples/ruby}/error_handling.rb | 0 .../examples/ruby}/kv_counter.rb | 0 .../examples/ruby}/kv_operations.rb | 0 .../examples/ruby}/managing_connections.rb | 0 .../examples/ruby}/managing_users.rb | 0 .../ruby}/provisioning-resources-buckets.rb | 0 .../provisioning-resources-collections.rb | 0 .../examples/ruby}/queries.rb | 0 .../examples/ruby}/search.rb | 0 .../examples/ruby}/start_using.rb | 0 .../examples/ruby}/subdoc.rb | 0 .../examples/ruby}/test.rb | 0 .../examples/ruby}/views.rb | 0 modules/hello-world/pages/overview.adoc | 2 +- .../hello-world/pages/start-using-sdk.adoc | 4 +- .../rails-caching-example/.dockerignore | 45 --- .../rails-caching-example/.gitattributes | 9 - .../examples/rails-caching-example/.gitignore | 35 -- .../rails-caching-example/.rubocop.yml | 8 - .../rails-caching-example/.ruby-version | 1 - .../examples/rails-caching-example/Dockerfile | 65 ---- .../examples/rails-caching-example/Gemfile | 30 -- .../rails-caching-example/Gemfile.lock | 336 ------------------ .../examples/rails-caching-example/README.md | 24 -- .../examples/rails-caching-example/Rakefile | 6 - .../app/assets/config/manifest.js | 2 - .../app/assets/images/.keep | 0 .../app/assets/stylesheets/application.css | 15 - .../app/controllers/application_controller.rb | 4 - .../app/controllers/concerns/.keep | 0 .../app/controllers/wall_clock_controller.rb | 44 --- .../app/helpers/application_helper.rb | 2 - .../app/models/application_record.rb | 3 - .../app/models/concerns/.keep | 0 .../app/views/layouts/application.html.erb | 22 -- .../app/views/pwa/manifest.json.erb | 22 -- .../app/views/pwa/service-worker.js | 26 -- .../app/views/wall_clock/now.html.erb | 20 -- .../rails-caching-example/bin/brakeman | 7 - .../examples/rails-caching-example/bin/bundle | 109 ------ .../bin/docker-entrypoint | 13 - .../examples/rails-caching-example/bin/rails | 4 - .../examples/rails-caching-example/bin/rake | 4 - .../rails-caching-example/bin/rubocop | 8 - .../examples/rails-caching-example/bin/setup | 37 -- .../examples/rails-caching-example/config.ru | 6 - .../config/application.rb | 42 --- .../rails-caching-example/config/boot.rb | 3 - .../config/credentials.yml.enc | 1 - .../rails-caching-example/config/database.yml | 32 -- .../config/environment.rb | 5 - .../config/environments/development.rb | 73 ---- .../config/environments/production.rb | 82 ----- .../config/environments/test.rb | 51 --- .../config/initializers/assets.rb | 12 - .../initializers/content_security_policy.rb | 25 -- .../initializers/filter_parameter_logging.rb | 8 - .../config/initializers/inflections.rb | 16 - .../config/initializers/permissions_policy.rb | 13 - .../config/locales/en.yml | 31 -- .../rails-caching-example/config/puma.rb | 34 -- .../rails-caching-example/config/routes.rb | 14 - .../rails-caching-example/db/seeds.rb | 9 - .../rails-caching-example/lib/assets/.keep | 0 .../rails-caching-example/lib/tasks/.keep | 0 .../examples/rails-caching-example/log/.keep | 0 .../rails-caching-example/public/404.html | 67 ---- .../public/406-unsupported-browser.html | 66 ---- .../rails-caching-example/public/422.html | 67 ---- .../rails-caching-example/public/500.html | 66 ---- .../rails-caching-example/public/icon.png | Bin 5599 -> 0 bytes .../rails-caching-example/public/icon.svg | 3 - .../rails-caching-example/public/robots.txt | 1 - .../rails-caching-example/storage/.keep | 0 .../examples/rails-caching-example/tmp/.keep | 0 .../rails-caching-example/tmp/pids/.keep | 0 .../rails-caching-example/tmp/storage/.keep | 0 .../rails-caching-example/vendor/.keep | 0 modules/howtos/pages/analytics-using-sdk.adoc | 20 +- modules/howtos/pages/caching-example.adoc | 6 +- .../pages/concurrent-document-mutations.adoc | 2 +- modules/howtos/pages/error-handling.adoc | 12 +- 89 files changed, 24 insertions(+), 1652 deletions(-) rename modules/{howtos/examples => devguide/examples/ruby}/analytics.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/auth.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/cas.rb (100%) rename modules/{hello-world/examples => devguide/examples/ruby}/cloud.rb (100%) rename modules/{concept-docs/examples => devguide/examples/ruby}/collections.rb (100%) rename modules/{concept-docs/examples => devguide/examples/ruby}/documents.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/error_handling.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/kv_counter.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/kv_operations.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/managing_connections.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/managing_users.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/provisioning-resources-buckets.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/provisioning-resources-collections.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/queries.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/search.rb (100%) rename modules/{hello-world/examples => devguide/examples/ruby}/start_using.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/subdoc.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/test.rb (100%) rename modules/{howtos/examples => devguide/examples/ruby}/views.rb (100%) delete mode 100644 modules/howtos/examples/rails-caching-example/.dockerignore delete mode 100644 modules/howtos/examples/rails-caching-example/.gitattributes delete mode 100644 modules/howtos/examples/rails-caching-example/.gitignore delete mode 100644 modules/howtos/examples/rails-caching-example/.rubocop.yml delete mode 100644 modules/howtos/examples/rails-caching-example/.ruby-version delete mode 100644 modules/howtos/examples/rails-caching-example/Dockerfile delete mode 100644 modules/howtos/examples/rails-caching-example/Gemfile delete mode 100644 modules/howtos/examples/rails-caching-example/Gemfile.lock delete mode 100644 modules/howtos/examples/rails-caching-example/README.md delete mode 100644 modules/howtos/examples/rails-caching-example/Rakefile delete mode 100644 modules/howtos/examples/rails-caching-example/app/assets/config/manifest.js delete mode 100644 modules/howtos/examples/rails-caching-example/app/assets/images/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/app/assets/stylesheets/application.css delete mode 100644 modules/howtos/examples/rails-caching-example/app/controllers/application_controller.rb delete mode 100644 modules/howtos/examples/rails-caching-example/app/controllers/concerns/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/app/controllers/wall_clock_controller.rb delete mode 100644 modules/howtos/examples/rails-caching-example/app/helpers/application_helper.rb delete mode 100644 modules/howtos/examples/rails-caching-example/app/models/application_record.rb delete mode 100644 modules/howtos/examples/rails-caching-example/app/models/concerns/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/app/views/layouts/application.html.erb delete mode 100644 modules/howtos/examples/rails-caching-example/app/views/pwa/manifest.json.erb delete mode 100644 modules/howtos/examples/rails-caching-example/app/views/pwa/service-worker.js delete mode 100644 modules/howtos/examples/rails-caching-example/app/views/wall_clock/now.html.erb delete mode 100755 modules/howtos/examples/rails-caching-example/bin/brakeman delete mode 100755 modules/howtos/examples/rails-caching-example/bin/bundle delete mode 100755 modules/howtos/examples/rails-caching-example/bin/docker-entrypoint delete mode 100755 modules/howtos/examples/rails-caching-example/bin/rails delete mode 100755 modules/howtos/examples/rails-caching-example/bin/rake delete mode 100755 modules/howtos/examples/rails-caching-example/bin/rubocop delete mode 100755 modules/howtos/examples/rails-caching-example/bin/setup delete mode 100644 modules/howtos/examples/rails-caching-example/config.ru delete mode 100644 modules/howtos/examples/rails-caching-example/config/application.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/boot.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/credentials.yml.enc delete mode 100644 modules/howtos/examples/rails-caching-example/config/database.yml delete mode 100644 modules/howtos/examples/rails-caching-example/config/environment.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/environments/development.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/environments/production.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/environments/test.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/initializers/assets.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/initializers/content_security_policy.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/initializers/inflections.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/initializers/permissions_policy.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/locales/en.yml delete mode 100644 modules/howtos/examples/rails-caching-example/config/puma.rb delete mode 100644 modules/howtos/examples/rails-caching-example/config/routes.rb delete mode 100644 modules/howtos/examples/rails-caching-example/db/seeds.rb delete mode 100644 modules/howtos/examples/rails-caching-example/lib/assets/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/lib/tasks/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/log/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/public/404.html delete mode 100644 modules/howtos/examples/rails-caching-example/public/406-unsupported-browser.html delete mode 100644 modules/howtos/examples/rails-caching-example/public/422.html delete mode 100644 modules/howtos/examples/rails-caching-example/public/500.html delete mode 100644 modules/howtos/examples/rails-caching-example/public/icon.png delete mode 100644 modules/howtos/examples/rails-caching-example/public/icon.svg delete mode 100644 modules/howtos/examples/rails-caching-example/public/robots.txt delete mode 100644 modules/howtos/examples/rails-caching-example/storage/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/tmp/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/tmp/pids/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/tmp/storage/.keep delete mode 100644 modules/howtos/examples/rails-caching-example/vendor/.keep diff --git a/Rakefile b/Rakefile index 8628b7c..37177b3 100644 --- a/Rakefile +++ b/Rakefile @@ -4,7 +4,7 @@ task :check_syntax do fail_count = 0 errors = [] - Dir.glob("modules/**/*.rb").sort.each do |file| + Dir.glob("modules/devguide/examples/ruby/*.rb").sort.each do |file| source = File.read(file) RubyVM::InstructionSequence.compile(source, file) pass += 1 diff --git a/modules/howtos/examples/analytics.rb b/modules/devguide/examples/ruby/analytics.rb similarity index 100% rename from modules/howtos/examples/analytics.rb rename to modules/devguide/examples/ruby/analytics.rb diff --git a/modules/howtos/examples/auth.rb b/modules/devguide/examples/ruby/auth.rb similarity index 100% rename from modules/howtos/examples/auth.rb rename to modules/devguide/examples/ruby/auth.rb diff --git a/modules/howtos/examples/cas.rb b/modules/devguide/examples/ruby/cas.rb similarity index 100% rename from modules/howtos/examples/cas.rb rename to modules/devguide/examples/ruby/cas.rb diff --git a/modules/hello-world/examples/cloud.rb b/modules/devguide/examples/ruby/cloud.rb similarity index 100% rename from modules/hello-world/examples/cloud.rb rename to modules/devguide/examples/ruby/cloud.rb diff --git a/modules/concept-docs/examples/collections.rb b/modules/devguide/examples/ruby/collections.rb similarity index 100% rename from modules/concept-docs/examples/collections.rb rename to modules/devguide/examples/ruby/collections.rb diff --git a/modules/concept-docs/examples/documents.rb b/modules/devguide/examples/ruby/documents.rb similarity index 100% rename from modules/concept-docs/examples/documents.rb rename to modules/devguide/examples/ruby/documents.rb diff --git a/modules/howtos/examples/error_handling.rb b/modules/devguide/examples/ruby/error_handling.rb similarity index 100% rename from modules/howtos/examples/error_handling.rb rename to modules/devguide/examples/ruby/error_handling.rb diff --git a/modules/howtos/examples/kv_counter.rb b/modules/devguide/examples/ruby/kv_counter.rb similarity index 100% rename from modules/howtos/examples/kv_counter.rb rename to modules/devguide/examples/ruby/kv_counter.rb diff --git a/modules/howtos/examples/kv_operations.rb b/modules/devguide/examples/ruby/kv_operations.rb similarity index 100% rename from modules/howtos/examples/kv_operations.rb rename to modules/devguide/examples/ruby/kv_operations.rb diff --git a/modules/howtos/examples/managing_connections.rb b/modules/devguide/examples/ruby/managing_connections.rb similarity index 100% rename from modules/howtos/examples/managing_connections.rb rename to modules/devguide/examples/ruby/managing_connections.rb diff --git a/modules/howtos/examples/managing_users.rb b/modules/devguide/examples/ruby/managing_users.rb similarity index 100% rename from modules/howtos/examples/managing_users.rb rename to modules/devguide/examples/ruby/managing_users.rb diff --git a/modules/howtos/examples/provisioning-resources-buckets.rb b/modules/devguide/examples/ruby/provisioning-resources-buckets.rb similarity index 100% rename from modules/howtos/examples/provisioning-resources-buckets.rb rename to modules/devguide/examples/ruby/provisioning-resources-buckets.rb diff --git a/modules/howtos/examples/provisioning-resources-collections.rb b/modules/devguide/examples/ruby/provisioning-resources-collections.rb similarity index 100% rename from modules/howtos/examples/provisioning-resources-collections.rb rename to modules/devguide/examples/ruby/provisioning-resources-collections.rb diff --git a/modules/howtos/examples/queries.rb b/modules/devguide/examples/ruby/queries.rb similarity index 100% rename from modules/howtos/examples/queries.rb rename to modules/devguide/examples/ruby/queries.rb diff --git a/modules/howtos/examples/search.rb b/modules/devguide/examples/ruby/search.rb similarity index 100% rename from modules/howtos/examples/search.rb rename to modules/devguide/examples/ruby/search.rb diff --git a/modules/hello-world/examples/start_using.rb b/modules/devguide/examples/ruby/start_using.rb similarity index 100% rename from modules/hello-world/examples/start_using.rb rename to modules/devguide/examples/ruby/start_using.rb diff --git a/modules/howtos/examples/subdoc.rb b/modules/devguide/examples/ruby/subdoc.rb similarity index 100% rename from modules/howtos/examples/subdoc.rb rename to modules/devguide/examples/ruby/subdoc.rb diff --git a/modules/howtos/examples/test.rb b/modules/devguide/examples/ruby/test.rb similarity index 100% rename from modules/howtos/examples/test.rb rename to modules/devguide/examples/ruby/test.rb diff --git a/modules/howtos/examples/views.rb b/modules/devguide/examples/ruby/views.rb similarity index 100% rename from modules/howtos/examples/views.rb rename to modules/devguide/examples/ruby/views.rb diff --git a/modules/hello-world/pages/overview.adoc b/modules/hello-world/pages/overview.adoc index 1a4a7e2..f1f8c17 100644 --- a/modules/hello-world/pages/overview.adoc +++ b/modules/hello-world/pages/overview.adoc @@ -7,7 +7,7 @@ [source,ruby] ---- -include::howtos:example$kv_operations.rb[tag=named-collection-upsert] +include::devguide:example$ruby/kv_operations.rb[tag=named-collection-upsert] ---- The Couchbase Ruby SDK allows you to connect to a Couchbase cluster from Ruby. diff --git a/modules/hello-world/pages/start-using-sdk.adoc b/modules/hello-world/pages/start-using-sdk.adoc index 42daa58..9abbe2c 100644 --- a/modules/hello-world/pages/start-using-sdk.adoc +++ b/modules/hello-world/pages/start-using-sdk.adoc @@ -36,7 +36,7 @@ If you are connecting to https://docs.couchbase.com/cloud/index.html[Couchbase C [source,ruby] ---- -include::hello-world:example$cloud.rb[tags=**] +include::devguide:example$ruby/cloud.rb[tags=**] ---- The Couchbase Capella free tier version comes with the Travel Sample Bucket, and its Query indexes, loaded and ready. @@ -47,7 +47,7 @@ Local Couchbase Server:: -- [source,ruby] ---- -include::hello-world:example$start_using.rb[tags=**] +include::devguide:example$ruby/start_using.rb[tags=**] ---- As well as the Ruby SDK (see below), and a running instance of Couchbase Server, you will need to load up the Travel Sample Bucket diff --git a/modules/howtos/examples/rails-caching-example/.dockerignore b/modules/howtos/examples/rails-caching-example/.dockerignore deleted file mode 100644 index 3219d20..0000000 --- a/modules/howtos/examples/rails-caching-example/.dockerignore +++ /dev/null @@ -1,45 +0,0 @@ -# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files. - -# Ignore git directory. -/.git/ -/.gitignore - -# Ignore bundler config. -/.bundle - -# Ignore all environment files (except templates). -/.env* -!/.env*.erb - -# Ignore all default key files. -/config/master.key -/config/credentials/*.key - -# Ignore all logfiles and tempfiles. -/log/* -/tmp/* -!/log/.keep -!/tmp/.keep - -# Ignore pidfiles, but keep the directory. -/tmp/pids/* -!/tmp/pids/.keep - -# Ignore storage (uploaded files in development and any SQLite databases). -/storage/* -!/storage/.keep -/tmp/storage/* -!/tmp/storage/.keep - -# Ignore assets. -/node_modules/ -/app/assets/builds/* -!/app/assets/builds/.keep -/public/assets - -# Ignore development files -/.devcontainer - -# Ignore Docker-related files -/.dockerignore -/Dockerfile* diff --git a/modules/howtos/examples/rails-caching-example/.gitattributes b/modules/howtos/examples/rails-caching-example/.gitattributes deleted file mode 100644 index 8dc4323..0000000 --- a/modules/howtos/examples/rails-caching-example/.gitattributes +++ /dev/null @@ -1,9 +0,0 @@ -# See https://git-scm.com/docs/gitattributes for more about git attribute files. - -# Mark the database schema as having been generated. -db/schema.rb linguist-generated - -# Mark any vendored files as having been vendored. -vendor/* linguist-vendored -config/credentials/*.yml.enc diff=rails_credentials -config/credentials.yml.enc diff=rails_credentials diff --git a/modules/howtos/examples/rails-caching-example/.gitignore b/modules/howtos/examples/rails-caching-example/.gitignore deleted file mode 100644 index 4aaf102..0000000 --- a/modules/howtos/examples/rails-caching-example/.gitignore +++ /dev/null @@ -1,35 +0,0 @@ -# See https://help.github.com/articles/ignoring-files for more about ignoring files. -# -# Temporary files generated by your text editor or operating system -# belong in git's global ignore instead: -# `$XDG_CONFIG_HOME/git/ignore` or `~/.config/git/ignore` - -# Ignore bundler config. -/.bundle - -# Ignore all environment files (except templates). -/.env* -!/.env*.erb - -# 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 storage (uploaded files in development and any SQLite databases). -/storage/* -!/storage/.keep -/tmp/storage/* -!/tmp/storage/ -!/tmp/storage/.keep - -/public/assets - -# Ignore master key for decrypting credentials and more. -/config/master.key diff --git a/modules/howtos/examples/rails-caching-example/.rubocop.yml b/modules/howtos/examples/rails-caching-example/.rubocop.yml deleted file mode 100644 index f9d86d4..0000000 --- a/modules/howtos/examples/rails-caching-example/.rubocop.yml +++ /dev/null @@ -1,8 +0,0 @@ -# Omakase Ruby styling for Rails -inherit_gem: { rubocop-rails-omakase: rubocop.yml } - -# Overwrite or add rules to create your own house style -# -# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]` -# Layout/SpaceInsideArrayLiteralBrackets: -# Enabled: false diff --git a/modules/howtos/examples/rails-caching-example/.ruby-version b/modules/howtos/examples/rails-caching-example/.ruby-version deleted file mode 100644 index 6d5369b..0000000 --- a/modules/howtos/examples/rails-caching-example/.ruby-version +++ /dev/null @@ -1 +0,0 @@ -ruby-3.3.4 diff --git a/modules/howtos/examples/rails-caching-example/Dockerfile b/modules/howtos/examples/rails-caching-example/Dockerfile deleted file mode 100644 index 7120e63..0000000 --- a/modules/howtos/examples/rails-caching-example/Dockerfile +++ /dev/null @@ -1,65 +0,0 @@ -# syntax = docker/dockerfile:1 - -# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand: -# docker build -t my-app . -# docker run -d -p 80:80 -p 443:443 --name my-app -e RAILS_MASTER_KEY= my-app - -# Make sure RUBY_VERSION matches the Ruby version in .ruby-version -ARG RUBY_VERSION=3.3.4 -FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base - -# Rails app lives here -WORKDIR /rails - -# Install base packages -RUN apt-get update -qq && \ - apt-get install --no-install-recommends -y curl libjemalloc2 sqlite3 && \ - rm -rf /var/lib/apt/lists /var/cache/apt/archives - -# Set production environment -ENV RAILS_ENV="production" \ - BUNDLE_DEPLOYMENT="1" \ - BUNDLE_PATH="/usr/local/bundle" \ - BUNDLE_WITHOUT="development" - -# Throw-away build stage to reduce size of final image -FROM base AS build - -# Install packages needed to build gems -RUN apt-get update -qq && \ - apt-get install --no-install-recommends -y build-essential git pkg-config && \ - rm -rf /var/lib/apt/lists /var/cache/apt/archives - -# Install application gems -COPY Gemfile Gemfile.lock ./ -RUN bundle install && \ - rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git - -# Copy application code -COPY . . - -# Precompiling assets for production without requiring secret RAILS_MASTER_KEY -RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile - - - - -# Final stage for app image -FROM base - -# Copy built artifacts: gems, application -COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}" -COPY --from=build /rails /rails - -# Run and own only the runtime files as a non-root user for security -RUN groupadd --system --gid 1000 rails && \ - useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \ - chown -R rails:rails db log storage tmp -USER 1000:1000 - -# Entrypoint prepares the database. -ENTRYPOINT ["/rails/bin/docker-entrypoint"] - -# Start the server by default, this can be overwritten at runtime -EXPOSE 3000 -CMD ["./bin/rails", "server"] diff --git a/modules/howtos/examples/rails-caching-example/Gemfile b/modules/howtos/examples/rails-caching-example/Gemfile deleted file mode 100644 index 232365f..0000000 --- a/modules/howtos/examples/rails-caching-example/Gemfile +++ /dev/null @@ -1,30 +0,0 @@ -source "https://rubygems.org" - -# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main" -gem "rails", "~> 7.2.1" -# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails] -gem "sprockets-rails" -# Use sqlite3 as the database for Active Record -gem "sqlite3", ">= 1.4" -# Use the Puma web server [https://github.com/puma/puma] -gem "puma", ">= 5.0" - -# tag::add_dependency[] -gem "couchbase" -# end::add_dependency[] - -# Windows does not include zoneinfo files, so bundle the tzinfo-data gem -gem "tzinfo-data", platforms: %i[ windows jruby ] - -group :development, :test do - # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem - gem "debug", platforms: %i[ mri windows ], require: "debug/prelude" - - # Static analysis for security vulnerabilities [https://brakemanscanner.org/] - gem "brakeman", require: false - - # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/] - gem "rubocop-rails-omakase", require: false - - gem "ruby-lsp" -end diff --git a/modules/howtos/examples/rails-caching-example/Gemfile.lock b/modules/howtos/examples/rails-caching-example/Gemfile.lock deleted file mode 100644 index 972137c..0000000 --- a/modules/howtos/examples/rails-caching-example/Gemfile.lock +++ /dev/null @@ -1,336 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - actioncable (7.2.1) - actionpack (= 7.2.1) - activesupport (= 7.2.1) - nio4r (~> 2.0) - websocket-driver (>= 0.6.1) - zeitwerk (~> 2.6) - actionmailbox (7.2.1) - actionpack (= 7.2.1) - activejob (= 7.2.1) - activerecord (= 7.2.1) - activestorage (= 7.2.1) - activesupport (= 7.2.1) - mail (>= 2.8.0) - actionmailer (7.2.1) - actionpack (= 7.2.1) - actionview (= 7.2.1) - activejob (= 7.2.1) - activesupport (= 7.2.1) - mail (>= 2.8.0) - rails-dom-testing (~> 2.2) - actionpack (7.2.1) - actionview (= 7.2.1) - activesupport (= 7.2.1) - nokogiri (>= 1.8.5) - racc - rack (>= 2.2.4, < 3.2) - rack-session (>= 1.0.1) - rack-test (>= 0.6.3) - rails-dom-testing (~> 2.2) - rails-html-sanitizer (~> 1.6) - useragent (~> 0.16) - actiontext (7.2.1) - actionpack (= 7.2.1) - activerecord (= 7.2.1) - activestorage (= 7.2.1) - activesupport (= 7.2.1) - globalid (>= 0.6.0) - nokogiri (>= 1.8.5) - actionview (7.2.1) - activesupport (= 7.2.1) - builder (~> 3.1) - erubi (~> 1.11) - rails-dom-testing (~> 2.2) - rails-html-sanitizer (~> 1.6) - activejob (7.2.1) - activesupport (= 7.2.1) - globalid (>= 0.3.6) - activemodel (7.2.1) - activesupport (= 7.2.1) - activerecord (7.2.1) - activemodel (= 7.2.1) - activesupport (= 7.2.1) - timeout (>= 0.4.0) - activestorage (7.2.1) - actionpack (= 7.2.1) - activejob (= 7.2.1) - activerecord (= 7.2.1) - activesupport (= 7.2.1) - marcel (~> 1.0) - activesupport (7.2.1) - base64 - bigdecimal - concurrent-ruby (~> 1.0, >= 1.3.1) - connection_pool (>= 2.2.5) - drb - i18n (>= 1.6, < 2) - logger (>= 1.4.2) - minitest (>= 5.1) - securerandom (>= 0.3) - tzinfo (~> 2.0, >= 2.0.5) - ast (2.4.2) - base64 (0.2.0) - bigdecimal (3.1.8) - brakeman (6.2.1) - racc - builder (3.3.0) - concurrent-ruby (1.3.4) - connection_pool (2.4.1) - couchbase (3.5.3) - grpc (~> 1.59) - couchbase (3.5.3-arm64-darwin) - grpc (~> 1.59) - couchbase (3.5.3-x86_64-darwin) - grpc (~> 1.59) - couchbase (3.5.3-x86_64-linux) - grpc (~> 1.59) - couchbase (3.5.3-x86_64-linux-musl) - grpc (~> 1.59) - crass (1.0.6) - date (3.3.4) - debug (1.9.2) - irb (~> 1.10) - reline (>= 0.3.8) - drb (2.2.1) - erubi (1.13.0) - globalid (1.2.1) - activesupport (>= 6.1) - google-protobuf (4.28.0) - bigdecimal - rake (>= 13) - google-protobuf (4.28.0-aarch64-linux) - bigdecimal - rake (>= 13) - google-protobuf (4.28.0-arm64-darwin) - bigdecimal - rake (>= 13) - google-protobuf (4.28.0-x86-linux) - bigdecimal - rake (>= 13) - google-protobuf (4.28.0-x86_64-darwin) - bigdecimal - rake (>= 13) - google-protobuf (4.28.0-x86_64-linux) - bigdecimal - rake (>= 13) - googleapis-common-protos-types (1.15.0) - google-protobuf (>= 3.18, < 5.a) - grpc (1.66.0) - google-protobuf (>= 3.25, < 5.0) - googleapis-common-protos-types (~> 1.0) - grpc (1.66.0-aarch64-linux) - google-protobuf (>= 3.25, < 5.0) - googleapis-common-protos-types (~> 1.0) - grpc (1.66.0-arm64-darwin) - google-protobuf (>= 3.25, < 5.0) - googleapis-common-protos-types (~> 1.0) - grpc (1.66.0-x86-linux) - google-protobuf (>= 3.25, < 5.0) - googleapis-common-protos-types (~> 1.0) - grpc (1.66.0-x86_64-darwin) - google-protobuf (>= 3.25, < 5.0) - googleapis-common-protos-types (~> 1.0) - grpc (1.66.0-x86_64-linux) - google-protobuf (>= 3.25, < 5.0) - googleapis-common-protos-types (~> 1.0) - i18n (1.14.5) - concurrent-ruby (~> 1.0) - io-console (0.7.2) - irb (1.14.0) - rdoc (>= 4.0.0) - reline (>= 0.4.2) - json (2.7.2) - language_server-protocol (3.17.0.3) - logger (1.6.0) - loofah (2.22.0) - crass (~> 1.0.2) - nokogiri (>= 1.12.0) - mail (2.8.1) - mini_mime (>= 0.1.1) - net-imap - net-pop - net-smtp - marcel (1.0.4) - mini_mime (1.1.5) - minitest (5.25.1) - net-imap (0.4.15) - date - net-protocol - net-pop (0.1.2) - net-protocol - net-protocol (0.2.2) - timeout - net-smtp (0.5.0) - net-protocol - nio4r (2.7.3) - nokogiri (1.16.7-aarch64-linux) - racc (~> 1.4) - nokogiri (1.16.7-arm-linux) - racc (~> 1.4) - nokogiri (1.16.7-arm64-darwin) - racc (~> 1.4) - nokogiri (1.16.7-x86-linux) - racc (~> 1.4) - nokogiri (1.16.7-x86_64-darwin) - racc (~> 1.4) - nokogiri (1.16.7-x86_64-linux) - racc (~> 1.4) - parallel (1.26.3) - parser (3.3.4.2) - ast (~> 2.4.1) - racc - prism (1.0.0) - psych (5.1.2) - stringio - puma (6.4.2) - nio4r (~> 2.0) - racc (1.8.1) - rack (3.1.7) - rack-session (2.0.0) - rack (>= 3.0.0) - rack-test (2.1.0) - rack (>= 1.3) - rackup (2.1.0) - rack (>= 3) - webrick (~> 1.8) - rails (7.2.1) - actioncable (= 7.2.1) - actionmailbox (= 7.2.1) - actionmailer (= 7.2.1) - actionpack (= 7.2.1) - actiontext (= 7.2.1) - actionview (= 7.2.1) - activejob (= 7.2.1) - activemodel (= 7.2.1) - activerecord (= 7.2.1) - activestorage (= 7.2.1) - activesupport (= 7.2.1) - bundler (>= 1.15.0) - railties (= 7.2.1) - rails-dom-testing (2.2.0) - activesupport (>= 5.0.0) - minitest - nokogiri (>= 1.6) - rails-html-sanitizer (1.6.0) - loofah (~> 2.21) - nokogiri (~> 1.14) - railties (7.2.1) - actionpack (= 7.2.1) - activesupport (= 7.2.1) - irb (~> 1.13) - rackup (>= 1.0.0) - rake (>= 12.2) - thor (~> 1.0, >= 1.2.2) - zeitwerk (~> 2.6) - rainbow (3.1.1) - rake (13.2.1) - rbs (3.5.3) - logger - rdoc (6.7.0) - psych (>= 4.0.0) - regexp_parser (2.9.2) - reline (0.5.9) - io-console (~> 0.5) - rexml (3.3.6) - strscan - rubocop (1.65.1) - json (~> 2.3) - language_server-protocol (>= 3.17.0) - parallel (~> 1.10) - parser (>= 3.3.0.2) - rainbow (>= 2.2.2, < 4.0) - regexp_parser (>= 2.4, < 3.0) - rexml (>= 3.2.5, < 4.0) - rubocop-ast (>= 1.31.1, < 2.0) - ruby-progressbar (~> 1.7) - unicode-display_width (>= 2.4.0, < 3.0) - rubocop-ast (1.32.1) - parser (>= 3.3.1.0) - rubocop-minitest (0.35.1) - rubocop (>= 1.61, < 2.0) - rubocop-ast (>= 1.31.1, < 2.0) - rubocop-performance (1.21.1) - rubocop (>= 1.48.1, < 2.0) - rubocop-ast (>= 1.31.1, < 2.0) - rubocop-rails (2.26.0) - activesupport (>= 4.2.0) - rack (>= 1.1) - rubocop (>= 1.52.0, < 2.0) - rubocop-ast (>= 1.31.1, < 2.0) - rubocop-rails-omakase (1.0.0) - rubocop - rubocop-minitest - rubocop-performance - rubocop-rails - ruby-lsp (0.17.17) - language_server-protocol (~> 3.17.0) - prism (~> 1.0) - rbs (>= 3, < 4) - sorbet-runtime (>= 0.5.10782) - ruby-progressbar (1.13.0) - securerandom (0.3.1) - sorbet-runtime (0.5.11551) - sprockets (4.2.1) - concurrent-ruby (~> 1.0) - rack (>= 2.2.4, < 4) - sprockets-rails (3.5.2) - actionpack (>= 6.1) - activesupport (>= 6.1) - sprockets (>= 3.0.0) - sqlite3 (2.0.4-aarch64-linux-gnu) - sqlite3 (2.0.4-aarch64-linux-musl) - sqlite3 (2.0.4-arm-linux-gnu) - sqlite3 (2.0.4-arm-linux-musl) - sqlite3 (2.0.4-arm64-darwin) - sqlite3 (2.0.4-x86-linux-gnu) - sqlite3 (2.0.4-x86-linux-musl) - sqlite3 (2.0.4-x86_64-darwin) - sqlite3 (2.0.4-x86_64-linux-gnu) - sqlite3 (2.0.4-x86_64-linux-musl) - stringio (3.1.1) - strscan (3.1.0) - thor (1.3.2) - timeout (0.4.1) - tzinfo (2.0.6) - concurrent-ruby (~> 1.0) - unicode-display_width (2.5.0) - useragent (0.16.10) - webrick (1.8.1) - websocket-driver (0.7.6) - websocket-extensions (>= 0.1.0) - websocket-extensions (0.1.5) - zeitwerk (2.6.17) - -PLATFORMS - aarch64-linux - aarch64-linux-gnu - aarch64-linux-musl - arm-linux - arm-linux-gnu - arm-linux-musl - arm64-darwin-23 - x86-linux - x86-linux-gnu - x86-linux-musl - x86_64-darwin - x86_64-linux - x86_64-linux-gnu - x86_64-linux-musl - -DEPENDENCIES - brakeman - couchbase - debug - puma (>= 5.0) - rails (~> 7.2.1) - rubocop-rails-omakase - ruby-lsp - sprockets-rails - sqlite3 (>= 1.4) - tzinfo-data - -BUNDLED WITH - 2.5.14 diff --git a/modules/howtos/examples/rails-caching-example/README.md b/modules/howtos/examples/rails-caching-example/README.md deleted file mode 100644 index 598127a..0000000 --- a/modules/howtos/examples/rails-caching-example/README.md +++ /dev/null @@ -1,24 +0,0 @@ -# README - -This project demonstrate usage of Couchbase as a caching provider for Rails -project. - -Install all dependencies and configure the project: - - ./bin/setup - -Enable caching for development environment (find more details at -`config/environments/development.rb`) - - bundle exec rails dev:cache - -Configure Couchbase cluster and export environment variables as it is configured -in `config/environments/development.rb`: - - export COUCHBASE_CONNECTION_STRING=couchbase://192.168.107.128 - -Start the server: - - bundle exec rails server - -Navigate to http://localhost:3000 diff --git a/modules/howtos/examples/rails-caching-example/Rakefile b/modules/howtos/examples/rails-caching-example/Rakefile deleted file mode 100644 index 9a5ea73..0000000 --- a/modules/howtos/examples/rails-caching-example/Rakefile +++ /dev/null @@ -1,6 +0,0 @@ -# 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 diff --git a/modules/howtos/examples/rails-caching-example/app/assets/config/manifest.js b/modules/howtos/examples/rails-caching-example/app/assets/config/manifest.js deleted file mode 100644 index 5918193..0000000 --- a/modules/howtos/examples/rails-caching-example/app/assets/config/manifest.js +++ /dev/null @@ -1,2 +0,0 @@ -//= link_tree ../images -//= link_directory ../stylesheets .css diff --git a/modules/howtos/examples/rails-caching-example/app/assets/images/.keep b/modules/howtos/examples/rails-caching-example/app/assets/images/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/app/assets/stylesheets/application.css b/modules/howtos/examples/rails-caching-example/app/assets/stylesheets/application.css deleted file mode 100644 index 288b9ab..0000000 --- a/modules/howtos/examples/rails-caching-example/app/assets/stylesheets/application.css +++ /dev/null @@ -1,15 +0,0 @@ -/* - * This is a manifest file that'll be compiled into application.css, which will include all the files - * listed below. - * - * Any CSS (and SCSS, if configured) 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 - * 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 - */ diff --git a/modules/howtos/examples/rails-caching-example/app/controllers/application_controller.rb b/modules/howtos/examples/rails-caching-example/app/controllers/application_controller.rb deleted file mode 100644 index 0d95db2..0000000 --- a/modules/howtos/examples/rails-caching-example/app/controllers/application_controller.rb +++ /dev/null @@ -1,4 +0,0 @@ -class ApplicationController < ActionController::Base - # Only allow modern browsers supporting webp images, web push, badges, import maps, CSS nesting, and CSS :has. - allow_browser versions: :modern -end diff --git a/modules/howtos/examples/rails-caching-example/app/controllers/concerns/.keep b/modules/howtos/examples/rails-caching-example/app/controllers/concerns/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/app/controllers/wall_clock_controller.rb b/modules/howtos/examples/rails-caching-example/app/controllers/wall_clock_controller.rb deleted file mode 100644 index b3aeaa3..0000000 --- a/modules/howtos/examples/rails-caching-example/app/controllers/wall_clock_controller.rb +++ /dev/null @@ -1,44 +0,0 @@ -# tag::cache_time_for_3_seconds[] -class WallClockController < ApplicationController - def now - @current_time = Rails.cache.fetch("current_time", expires_in: 3.seconds) do - Time.now - end - end - # end::cache_time_for_3_seconds[] - - private - - before_action :fetch_cached_document - - # This method fetches the representation of the cache entry as it is stored in - # Couchbase - def fetch_cached_document - require "pp" - - @cache_entry = cache_collection.get( - "current_time", - Couchbase::Options::Get(transcoder: nil, with_expiry: true)) - rescue Couchbase::Error::DocumentNotFound - end - - def cache_collection - @collection ||= - begin - type, options = Rails.application.config.cache_store - if type != :couchbase_store - raise "Unexpected cache store configured: #{type}" - end - - cluster = Couchbase::Cluster.connect( - options[:connection_string], - options[:username], - options[:password] - ) - cluster - .bucket(options[:bucket]) - .scope(options[:scope]) - .collection(options[:collection]) - end - end -end diff --git a/modules/howtos/examples/rails-caching-example/app/helpers/application_helper.rb b/modules/howtos/examples/rails-caching-example/app/helpers/application_helper.rb deleted file mode 100644 index de6be79..0000000 --- a/modules/howtos/examples/rails-caching-example/app/helpers/application_helper.rb +++ /dev/null @@ -1,2 +0,0 @@ -module ApplicationHelper -end diff --git a/modules/howtos/examples/rails-caching-example/app/models/application_record.rb b/modules/howtos/examples/rails-caching-example/app/models/application_record.rb deleted file mode 100644 index b63caeb..0000000 --- a/modules/howtos/examples/rails-caching-example/app/models/application_record.rb +++ /dev/null @@ -1,3 +0,0 @@ -class ApplicationRecord < ActiveRecord::Base - primary_abstract_class -end diff --git a/modules/howtos/examples/rails-caching-example/app/models/concerns/.keep b/modules/howtos/examples/rails-caching-example/app/models/concerns/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/app/views/layouts/application.html.erb b/modules/howtos/examples/rails-caching-example/app/views/layouts/application.html.erb deleted file mode 100644 index 569de6b..0000000 --- a/modules/howtos/examples/rails-caching-example/app/views/layouts/application.html.erb +++ /dev/null @@ -1,22 +0,0 @@ - - - - <%= content_for(:title) || "Rails Caching Example" %> - - - <%= csrf_meta_tags %> - <%= csp_meta_tag %> - - <%= yield :head %> - - - - - - <%= stylesheet_link_tag "application" %> - - - - <%= yield %> - - diff --git a/modules/howtos/examples/rails-caching-example/app/views/pwa/manifest.json.erb b/modules/howtos/examples/rails-caching-example/app/views/pwa/manifest.json.erb deleted file mode 100644 index 9413c10..0000000 --- a/modules/howtos/examples/rails-caching-example/app/views/pwa/manifest.json.erb +++ /dev/null @@ -1,22 +0,0 @@ -{ - "name": "RailsCachingExample", - "icons": [ - { - "src": "/icon.png", - "type": "image/png", - "sizes": "512x512" - }, - { - "src": "/icon.png", - "type": "image/png", - "sizes": "512x512", - "purpose": "maskable" - } - ], - "start_url": "/", - "display": "standalone", - "scope": "/", - "description": "RailsCachingExample.", - "theme_color": "red", - "background_color": "red" -} diff --git a/modules/howtos/examples/rails-caching-example/app/views/pwa/service-worker.js b/modules/howtos/examples/rails-caching-example/app/views/pwa/service-worker.js deleted file mode 100644 index b3a13fb..0000000 --- a/modules/howtos/examples/rails-caching-example/app/views/pwa/service-worker.js +++ /dev/null @@ -1,26 +0,0 @@ -// Add a service worker for processing Web Push notifications: -// -// self.addEventListener("push", async (event) => { -// const { title, options } = await event.data.json() -// event.waitUntil(self.registration.showNotification(title, options)) -// }) -// -// self.addEventListener("notificationclick", function(event) { -// event.notification.close() -// event.waitUntil( -// clients.matchAll({ type: "window" }).then((clientList) => { -// for (let i = 0; i < clientList.length; i++) { -// let client = clientList[i] -// let clientPath = (new URL(client.url)).pathname -// -// if (clientPath == event.notification.data.path && "focus" in client) { -// return client.focus() -// } -// } -// -// if (clients.openWindow) { -// return clients.openWindow(event.notification.data.path) -// } -// }) -// ) -// }) diff --git a/modules/howtos/examples/rails-caching-example/app/views/wall_clock/now.html.erb b/modules/howtos/examples/rails-caching-example/app/views/wall_clock/now.html.erb deleted file mode 100644 index c647578..0000000 --- a/modules/howtos/examples/rails-caching-example/app/views/wall_clock/now.html.erb +++ /dev/null @@ -1,20 +0,0 @@ -

Wall Clock

- -

- Realtime time is <%= Time.now %> -

- -

Cached Time

-

- Current time is <%= @current_time %> -

-

- <%= @current_time.to_f %> seconds since Unix Epoch -

- -<% if @cache_entry %> -

Cache Entry

- 
<%= @cache_entry.pretty_inspect %>
-<% else %> -

Cache Miss

-<% end %> diff --git a/modules/howtos/examples/rails-caching-example/bin/brakeman b/modules/howtos/examples/rails-caching-example/bin/brakeman deleted file mode 100755 index ace1c9b..0000000 --- a/modules/howtos/examples/rails-caching-example/bin/brakeman +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/env ruby -require "rubygems" -require "bundler/setup" - -ARGV.unshift("--ensure-latest") - -load Gem.bin_path("brakeman", "brakeman") diff --git a/modules/howtos/examples/rails-caching-example/bin/bundle b/modules/howtos/examples/rails-caching-example/bin/bundle deleted file mode 100755 index 50da5fd..0000000 --- a/modules/howtos/examples/rails-caching-example/bin/bundle +++ /dev/null @@ -1,109 +0,0 @@ -#!/usr/bin/env ruby -# frozen_string_literal: true - -# -# This file was generated by Bundler. -# -# The application 'bundle' is installed as part of a gem, and -# this file is here to facilitate running it. -# - -require "rubygems" - -m = Module.new do - module_function - - def invoked_as_script? - File.expand_path($0) == File.expand_path(__FILE__) - end - - def env_var_version - ENV["BUNDLER_VERSION"] - end - - def cli_arg_version - return unless invoked_as_script? # don't want to hijack other binstubs - return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update` - bundler_version = nil - update_index = nil - ARGV.each_with_index do |a, i| - if update_index && update_index.succ == i && a.match?(Gem::Version::ANCHORED_VERSION_PATTERN) - bundler_version = a - end - next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/ - bundler_version = $1 - update_index = i - end - bundler_version - end - - def gemfile - gemfile = ENV["BUNDLE_GEMFILE"] - return gemfile if gemfile && !gemfile.empty? - - File.expand_path("../Gemfile", __dir__) - end - - def lockfile - lockfile = - case File.basename(gemfile) - when "gems.rb" then gemfile.sub(/\.rb$/, ".locked") - else "#{gemfile}.lock" - end - File.expand_path(lockfile) - end - - def lockfile_version - return unless File.file?(lockfile) - lockfile_contents = File.read(lockfile) - return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/ - Regexp.last_match(1) - end - - def bundler_requirement - @bundler_requirement ||= - env_var_version || - cli_arg_version || - bundler_requirement_for(lockfile_version) - end - - def bundler_requirement_for(version) - return "#{Gem::Requirement.default}.a" unless version - - bundler_gem_version = Gem::Version.new(version) - - bundler_gem_version.approximate_recommendation - end - - def load_bundler! - ENV["BUNDLE_GEMFILE"] ||= gemfile - - activate_bundler - end - - def activate_bundler - gem_error = activation_error_handling do - gem "bundler", bundler_requirement - end - return if gem_error.nil? - require_error = activation_error_handling do - require "bundler/version" - end - return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION)) - warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`" - exit 42 - end - - def activation_error_handling - yield - nil - rescue StandardError, LoadError => e - e - end -end - -m.load_bundler! - -if m.invoked_as_script? - load Gem.bin_path("bundler", "bundle") -end diff --git a/modules/howtos/examples/rails-caching-example/bin/docker-entrypoint b/modules/howtos/examples/rails-caching-example/bin/docker-entrypoint deleted file mode 100755 index 840d093..0000000 --- a/modules/howtos/examples/rails-caching-example/bin/docker-entrypoint +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/bash -e - -# Enable jemalloc for reduced memory usage and latency. -if [ -z "${LD_PRELOAD+x}" ] && [ -f /usr/lib/*/libjemalloc.so.2 ]; then - export LD_PRELOAD="$(echo /usr/lib/*/libjemalloc.so.2)" -fi - -# If running the rails server then create or migrate existing database -if [ "${1}" == "./bin/rails" ] && [ "${2}" == "server" ]; then - ./bin/rails db:prepare -fi - -exec "${@}" diff --git a/modules/howtos/examples/rails-caching-example/bin/rails b/modules/howtos/examples/rails-caching-example/bin/rails deleted file mode 100755 index efc0377..0000000 --- a/modules/howtos/examples/rails-caching-example/bin/rails +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env ruby -APP_PATH = File.expand_path("../config/application", __dir__) -require_relative "../config/boot" -require "rails/commands" diff --git a/modules/howtos/examples/rails-caching-example/bin/rake b/modules/howtos/examples/rails-caching-example/bin/rake deleted file mode 100755 index 4fbf10b..0000000 --- a/modules/howtos/examples/rails-caching-example/bin/rake +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env ruby -require_relative "../config/boot" -require "rake" -Rake.application.run diff --git a/modules/howtos/examples/rails-caching-example/bin/rubocop b/modules/howtos/examples/rails-caching-example/bin/rubocop deleted file mode 100755 index 40330c0..0000000 --- a/modules/howtos/examples/rails-caching-example/bin/rubocop +++ /dev/null @@ -1,8 +0,0 @@ -#!/usr/bin/env ruby -require "rubygems" -require "bundler/setup" - -# explicit rubocop config increases performance slightly while avoiding config confusion. -ARGV.unshift("--config", File.expand_path("../.rubocop.yml", __dir__)) - -load Gem.bin_path("rubocop", "rubocop") diff --git a/modules/howtos/examples/rails-caching-example/bin/setup b/modules/howtos/examples/rails-caching-example/bin/setup deleted file mode 100755 index 6e98acf..0000000 --- a/modules/howtos/examples/rails-caching-example/bin/setup +++ /dev/null @@ -1,37 +0,0 @@ -#!/usr/bin/env ruby -require "fileutils" - -APP_ROOT = File.expand_path("..", __dir__) -APP_NAME = "rails-caching-example" - -def system!(*args) - system(*args, exception: true) -end - -FileUtils.chdir APP_ROOT do - # This script is a way to set up or update your development environment automatically. - # This script is idempotent, so that you can run it at any time and get an expectable outcome. - # Add necessary setup steps to this file. - - puts "== Installing dependencies ==" - system! "gem install bundler --conservative" - system("bundle check") || system!("bundle install") - - # puts "\n== Copying sample files ==" - # unless File.exist?("config/database.yml") - # FileUtils.cp "config/database.yml.sample", "config/database.yml" - # end - - puts "\n== Preparing database ==" - system! "bin/rails db:prepare" - - puts "\n== Removing old logs and tempfiles ==" - system! "bin/rails log:clear tmp:clear" - - puts "\n== Restarting application server ==" - system! "bin/rails restart" - - # puts "\n== Configuring puma-dev ==" - # system "ln -nfs #{APP_ROOT} ~/.puma-dev/#{APP_NAME}" - # system "curl -Is https://#{APP_NAME}.test/up | head -n 1" -end diff --git a/modules/howtos/examples/rails-caching-example/config.ru b/modules/howtos/examples/rails-caching-example/config.ru deleted file mode 100644 index 4a3c09a..0000000 --- a/modules/howtos/examples/rails-caching-example/config.ru +++ /dev/null @@ -1,6 +0,0 @@ -# This file is used by Rack-based servers to start the application. - -require_relative "config/environment" - -run Rails.application -Rails.application.load_server diff --git a/modules/howtos/examples/rails-caching-example/config/application.rb b/modules/howtos/examples/rails-caching-example/config/application.rb deleted file mode 100644 index bf779b2..0000000 --- a/modules/howtos/examples/rails-caching-example/config/application.rb +++ /dev/null @@ -1,42 +0,0 @@ -require_relative "boot" - -require "rails" -# Pick the frameworks you want: -require "active_model/railtie" -# require "active_job/railtie" -require "active_record/railtie" -# require "active_storage/engine" -require "action_controller/railtie" -# require "action_mailer/railtie" -# require "action_mailbox/engine" -# require "action_text/engine" -require "action_view/railtie" -# require "action_cable/engine" -# require "rails/test_unit/railtie" - -# Require the gems listed in Gemfile, including any gems -# you've limited to :test, :development, or :production. -Bundler.require(*Rails.groups) - -module RailsCachingExample - class Application < Rails::Application - # Initialize configuration defaults for originally generated Rails version. - config.load_defaults 7.2 - - # Please, add to the `ignore` list any other `lib` subdirectories that do - # not contain `.rb` files, or that should not be reloaded or eager loaded. - # Common ones are `templates`, `generators`, or `middleware`, for example. - config.autoload_lib(ignore: %w[assets tasks]) - - # Configuration for the application, engines, and railties goes here. - # - # These settings can be overridden in specific environments using the files - # in config/environments, which are processed later. - # - # config.time_zone = "Central Time (US & Canada)" - # config.eager_load_paths << Rails.root.join("extras") - - # Don't generate system test files. - config.generators.system_tests = nil - end -end diff --git a/modules/howtos/examples/rails-caching-example/config/boot.rb b/modules/howtos/examples/rails-caching-example/config/boot.rb deleted file mode 100644 index 2820116..0000000 --- a/modules/howtos/examples/rails-caching-example/config/boot.rb +++ /dev/null @@ -1,3 +0,0 @@ -ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) - -require "bundler/setup" # Set up gems listed in the Gemfile. diff --git a/modules/howtos/examples/rails-caching-example/config/credentials.yml.enc b/modules/howtos/examples/rails-caching-example/config/credentials.yml.enc deleted file mode 100644 index 05c626d..0000000 --- a/modules/howtos/examples/rails-caching-example/config/credentials.yml.enc +++ /dev/null @@ -1 +0,0 @@ -Qrzg9PAULNX+6f3b/jcI1u7WmPKSoh+rCVnRmswAE/twzFqx5E0DS2Q5PxLae+81wlcLHD0SSqiVj+FX8fNW8Z6/AboemXzPBJHF8swZvbIEWyksV5vOd4lCwQf067voMa5oowvv4ho5gjv5YqS0MQuruAyVsIfAdDJWF21+PfcJKR/X1C8ByGUg98XAvbNFeAc9NUsrDw3eG9+VzaBoNWbqtfwlNuwa59RF7rOn6myf4kAZTV9UPqoIr1jf++LR3b8PoM2o4dvK1tx+6ISTJwVzULuO9wq54RTagoxLmt9peDgke3xDqvv5Wa0IXywOc5bSgcPx1/u4N4DEC1qTrbRv0cG0biHgHoVKpcmObeGhoa6OxVDy8yU7p/gcscldzr3GM8M5nBf1VQl1+Z6lXj2w2rcR--EE54pBY7hGPg8bY4--wq86yoO4ud0VtLonsAw32g== \ No newline at end of file diff --git a/modules/howtos/examples/rails-caching-example/config/database.yml b/modules/howtos/examples/rails-caching-example/config/database.yml deleted file mode 100644 index 01bebb5..0000000 --- a/modules/howtos/examples/rails-caching-example/config/database.yml +++ /dev/null @@ -1,32 +0,0 @@ -# SQLite. Versions 3.8.0 and up are supported. -# gem install sqlite3 -# -# Ensure the SQLite 3 gem is defined in your Gemfile -# gem "sqlite3" -# -default: &default - adapter: sqlite3 - pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> - timeout: 5000 - -development: - <<: *default - database: storage/development.sqlite3 - -# Warning: The database defined as "test" will be erased and -# re-generated from your development database when you run "rake". -# Do not set this db to the same as development or production. -test: - <<: *default - database: storage/test.sqlite3 - - -# SQLite3 write its data on the local filesystem, as such it requires -# persistent disks. If you are deploying to a managed service, you should -# make sure it provides disk persistence, as many don't. -# -# Similarly, if you deploy your application as a Docker container, you must -# ensure the database is located in a persisted volume. -production: - <<: *default - # database: path/to/persistent/storage/production.sqlite3 diff --git a/modules/howtos/examples/rails-caching-example/config/environment.rb b/modules/howtos/examples/rails-caching-example/config/environment.rb deleted file mode 100644 index cac5315..0000000 --- a/modules/howtos/examples/rails-caching-example/config/environment.rb +++ /dev/null @@ -1,5 +0,0 @@ -# Load the Rails application. -require_relative "application" - -# Initialize the Rails application. -Rails.application.initialize! diff --git a/modules/howtos/examples/rails-caching-example/config/environments/development.rb b/modules/howtos/examples/rails-caching-example/config/environments/development.rb deleted file mode 100644 index 7064c43..0000000 --- a/modules/howtos/examples/rails-caching-example/config/environments/development.rb +++ /dev/null @@ -1,73 +0,0 @@ -require "active_support/core_ext/integer/time" - -Rails.application.configure do - # Settings specified here will take precedence over those in config/application.rb. - - # In the development environment your application's code is reloaded any time - # it changes. This slows down response time but is perfect for development - # since you don't have to restart the web server when you make code changes. - config.enable_reloading = true - - # Do not eager load code on boot. - config.eager_load = false - - # Show full error reports. - config.consider_all_requests_local = true - - # Enable server timing. - config.server_timing = true - - # Enable/disable caching. By default caching is disabled. - # Run rails dev:cache to toggle caching. - if Rails.root.join("tmp/caching-dev.txt").exist? - config.action_controller.perform_caching = true - config.action_controller.enable_fragment_cache_logging = true - - # tag::cache_store_config[] - config.cache_store = :couchbase_store, { - connection_string: ENV.fetch("COUCHBASE_CONNECTION_STRING", "couchbase://localhost"), - username: ENV.fetch("COUCHBASE_USERNAME", "Administrator"), - password: ENV.fetch("COUCHBASE_PASSWORD", "password"), - bucket: ENV.fetch("COUCHBASE_BUCKET", "default"), - scope: ENV.fetch("COUCHBASE_SCOPE", "_default"), - collection: ENV.fetch("COUCHBASE_COLLECTION", "_default") - } - # end::cache_store_config[] - - config.public_file_server.headers = { "Cache-Control" => "public, max-age=#{2.days.to_i}" } - else - config.action_controller.perform_caching = false - - config.cache_store = :null_store - end - - # Print deprecation notices to the Rails logger. - config.active_support.deprecation = :log - - # Raise exceptions for disallowed deprecations. - config.active_support.disallowed_deprecation = :raise - - # Tell Active Support which deprecation messages to disallow. - config.active_support.disallowed_deprecation_warnings = [] - - # Raise an error on page load if there are pending migrations. - config.active_record.migration_error = :page_load - - # Highlight code that triggered database queries in logs. - config.active_record.verbose_query_logs = true - - # Suppress logger output for asset requests. - config.assets.quiet = true - - # Raises error for missing translations. - # config.i18n.raise_on_missing_translations = true - - # Annotate rendered view with file names. - config.action_view.annotate_rendered_view_with_filenames = true - - # Raise error when a before_action's only/except options reference missing actions. - config.action_controller.raise_on_missing_callback_actions = true - - # Apply autocorrection by RuboCop to files generated by `bin/rails generate`. - # config.generators.apply_rubocop_autocorrect_after_generate! -end diff --git a/modules/howtos/examples/rails-caching-example/config/environments/production.rb b/modules/howtos/examples/rails-caching-example/config/environments/production.rb deleted file mode 100644 index 8daf273..0000000 --- a/modules/howtos/examples/rails-caching-example/config/environments/production.rb +++ /dev/null @@ -1,82 +0,0 @@ -require "active_support/core_ext/integer/time" - -Rails.application.configure do - # Settings specified here will take precedence over those in config/application.rb. - - # Code is not reloaded between requests. - config.enable_reloading = false - - # Eager load code on boot. This eager loads most of Rails and - # your application in memory, allowing both threaded web servers - # and those relying on copy on write to perform better. - # Rake tasks automatically ignore this option for performance. - config.eager_load = true - - # Full error reports are disabled and caching is turned on. - config.consider_all_requests_local = false - config.action_controller.perform_caching = true - - # Ensures that a master key has been made available in ENV["RAILS_MASTER_KEY"], config/master.key, or an environment - # key such as config/credentials/production.key. This key is used to decrypt credentials (and other encrypted files). - # config.require_master_key = true - - # Disable serving static files from `public/`, relying on NGINX/Apache to do so instead. - # config.public_file_server.enabled = false - - # Compress CSS using a preprocessor. - # config.assets.css_compressor = :sass - - # Do not fall back to assets pipeline if a precompiled asset is missed. - config.assets.compile = false - - # Enable serving of images, stylesheets, and JavaScripts from an asset server. - # config.asset_host = "http://assets.example.com" - - # Specifies the header that your server uses for sending files. - # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache - # config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX - - # Assume all access to the app is happening through a SSL-terminating reverse proxy. - # Can be used together with config.force_ssl for Strict-Transport-Security and secure cookies. - # config.assume_ssl = true - - # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. - config.force_ssl = true - - # Skip http-to-https redirect for the default health check endpoint. - # config.ssl_options = { redirect: { exclude: ->(request) { request.path == "/up" } } } - - # Log to STDOUT by default - config.logger = ActiveSupport::Logger.new(STDOUT) - .tap { |logger| logger.formatter = ::Logger::Formatter.new } - .then { |logger| ActiveSupport::TaggedLogging.new(logger) } - - # Prepend all log lines with the following tags. - config.log_tags = [ :request_id ] - - # "info" includes generic and useful information about system operation, but avoids logging too much - # information to avoid inadvertent exposure of personally identifiable information (PII). If you - # want to log everything, set the level to "debug". - config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info") - - # Use a different cache store in production. - # config.cache_store = :mem_cache_store - - # Enable locale fallbacks for I18n (makes lookups for any locale fall back to - # the I18n.default_locale when a translation cannot be found). - config.i18n.fallbacks = true - - # Don't log any deprecations. - config.active_support.report_deprecations = false - - # Do not dump schema after migrations. - config.active_record.dump_schema_after_migration = false - - # Enable DNS rebinding protection and other `Host` header attacks. - # config.hosts = [ - # "example.com", # Allow requests from example.com - # /.*\.example\.com/ # Allow requests from subdomains like `www.example.com` - # ] - # Skip DNS rebinding protection for the default health check endpoint. - # config.host_authorization = { exclude: ->(request) { request.path == "/up" } } -end diff --git a/modules/howtos/examples/rails-caching-example/config/environments/test.rb b/modules/howtos/examples/rails-caching-example/config/environments/test.rb deleted file mode 100644 index 999db70..0000000 --- a/modules/howtos/examples/rails-caching-example/config/environments/test.rb +++ /dev/null @@ -1,51 +0,0 @@ -require "active_support/core_ext/integer/time" - -# The test environment is used exclusively to run your application's -# test suite. You never need to work with it otherwise. Remember that -# your test database is "scratch space" for the test suite and is wiped -# and recreated between test runs. Don't rely on the data there! - -Rails.application.configure do - # Settings specified here will take precedence over those in config/application.rb. - - # While tests run files are not watched, reloading is not necessary. - config.enable_reloading = false - - # Eager loading loads your entire application. When running a single test locally, - # this is usually not necessary, and can slow down your test suite. However, it's - # recommended that you enable it in continuous integration systems to ensure eager - # loading is working properly before deploying your code. - config.eager_load = ENV["CI"].present? - - # Configure public file server for tests with Cache-Control for performance. - config.public_file_server.headers = { "Cache-Control" => "public, max-age=#{1.hour.to_i}" } - - # Show full error reports and disable caching. - config.consider_all_requests_local = true - config.action_controller.perform_caching = false - config.cache_store = :null_store - - # Render exception templates for rescuable exceptions and raise for other exceptions. - config.action_dispatch.show_exceptions = :rescuable - - # Disable request forgery protection in test environment. - config.action_controller.allow_forgery_protection = false - - # Print deprecation notices to the stderr. - config.active_support.deprecation = :stderr - - # Raise exceptions for disallowed deprecations. - config.active_support.disallowed_deprecation = :raise - - # Tell Active Support which deprecation messages to disallow. - config.active_support.disallowed_deprecation_warnings = [] - - # Raises error for missing translations. - # config.i18n.raise_on_missing_translations = true - - # Annotate rendered view with file names. - # config.action_view.annotate_rendered_view_with_filenames = true - - # Raise error when a before_action's only/except options reference missing actions. - config.action_controller.raise_on_missing_callback_actions = true -end diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/assets.rb b/modules/howtos/examples/rails-caching-example/config/initializers/assets.rb deleted file mode 100644 index bd5bcd2..0000000 --- a/modules/howtos/examples/rails-caching-example/config/initializers/assets.rb +++ /dev/null @@ -1,12 +0,0 @@ -# Be sure to restart your server when you modify this file. - -# Version of your assets, change this if you want to expire all your assets. -Rails.application.config.assets.version = "1.0" - -# Add additional assets to the asset load path. -# Rails.application.config.assets.paths << Emoji.images_path - -# Precompile additional assets. -# application.js, application.css, and all non-JS/CSS in the app/assets -# folder are already added. -# Rails.application.config.assets.precompile += %w[ admin.js admin.css ] diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/content_security_policy.rb b/modules/howtos/examples/rails-caching-example/config/initializers/content_security_policy.rb deleted file mode 100644 index b3076b3..0000000 --- a/modules/howtos/examples/rails-caching-example/config/initializers/content_security_policy.rb +++ /dev/null @@ -1,25 +0,0 @@ -# Be sure to restart your server when you modify this file. - -# Define an application-wide content security policy. -# See the Securing Rails Applications Guide for more information: -# https://guides.rubyonrails.org/security.html#content-security-policy-header - -# Rails.application.configure do -# config.content_security_policy do |policy| -# policy.default_src :self, :https -# policy.font_src :self, :https, :data -# policy.img_src :self, :https, :data -# policy.object_src :none -# policy.script_src :self, :https -# policy.style_src :self, :https -# # Specify URI for violation reports -# # policy.report_uri "/csp-violation-report-endpoint" -# end -# -# # Generate session nonces for permitted importmap, inline scripts, and inline styles. -# config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s } -# config.content_security_policy_nonce_directives = %w(script-src style-src) -# -# # Report violations without enforcing the policy. -# # config.content_security_policy_report_only = true -# end diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb b/modules/howtos/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb deleted file mode 100644 index c010b83..0000000 --- a/modules/howtos/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb +++ /dev/null @@ -1,8 +0,0 @@ -# Be sure to restart your server when you modify this file. - -# Configure parameters to be partially matched (e.g. passw matches password) and filtered from the log file. -# Use this to limit dissemination of sensitive information. -# See the ActiveSupport::ParameterFilter documentation for supported notations and behaviors. -Rails.application.config.filter_parameters += [ - :passw, :email, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn -] diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/inflections.rb b/modules/howtos/examples/rails-caching-example/config/initializers/inflections.rb deleted file mode 100644 index 3860f65..0000000 --- a/modules/howtos/examples/rails-caching-example/config/initializers/inflections.rb +++ /dev/null @@ -1,16 +0,0 @@ -# Be sure to restart your server when you modify this file. - -# Add new inflection rules using the following format. Inflections -# are locale specific, and you may define rules for as many different -# locales as you wish. All of these examples are active by default: -# ActiveSupport::Inflector.inflections(:en) do |inflect| -# inflect.plural /^(ox)$/i, "\\1en" -# inflect.singular /^(ox)en/i, "\\1" -# inflect.irregular "person", "people" -# inflect.uncountable %w( fish sheep ) -# end - -# These inflection rules are supported but not enabled by default: -# ActiveSupport::Inflector.inflections(:en) do |inflect| -# inflect.acronym "RESTful" -# end diff --git a/modules/howtos/examples/rails-caching-example/config/initializers/permissions_policy.rb b/modules/howtos/examples/rails-caching-example/config/initializers/permissions_policy.rb deleted file mode 100644 index 7db3b95..0000000 --- a/modules/howtos/examples/rails-caching-example/config/initializers/permissions_policy.rb +++ /dev/null @@ -1,13 +0,0 @@ -# Be sure to restart your server when you modify this file. - -# Define an application-wide HTTP permissions policy. For further -# information see: https://developers.google.com/web/updates/2018/06/feature-policy - -# Rails.application.config.permissions_policy do |policy| -# policy.camera :none -# policy.gyroscope :none -# policy.microphone :none -# policy.usb :none -# policy.fullscreen :self -# policy.payment :self, "https://secure.example.com" -# end diff --git a/modules/howtos/examples/rails-caching-example/config/locales/en.yml b/modules/howtos/examples/rails-caching-example/config/locales/en.yml deleted file mode 100644 index 6c349ae..0000000 --- a/modules/howtos/examples/rails-caching-example/config/locales/en.yml +++ /dev/null @@ -1,31 +0,0 @@ -# Files in the config/locales directory are used for internationalization and -# are automatically loaded by Rails. If you want to use locales other than -# English, add the necessary files in this directory. -# -# To use the locales, use `I18n.t`: -# -# I18n.t "hello" -# -# In views, this is aliased to just `t`: -# -# <%= t("hello") %> -# -# To use a different locale, set it with `I18n.locale`: -# -# I18n.locale = :es -# -# This would use the information in config/locales/es.yml. -# -# To learn more about the API, please read the Rails Internationalization guide -# at https://guides.rubyonrails.org/i18n.html. -# -# Be aware that YAML interprets the following case-insensitive strings as -# booleans: `true`, `false`, `on`, `off`, `yes`, `no`. Therefore, these strings -# must be quoted to be interpreted as strings. For example: -# -# en: -# "yes": yup -# enabled: "ON" - -en: - hello: "Hello world" diff --git a/modules/howtos/examples/rails-caching-example/config/puma.rb b/modules/howtos/examples/rails-caching-example/config/puma.rb deleted file mode 100644 index 03c166f..0000000 --- a/modules/howtos/examples/rails-caching-example/config/puma.rb +++ /dev/null @@ -1,34 +0,0 @@ -# This configuration file will be evaluated by Puma. The top-level methods that -# are invoked here are part of Puma's configuration DSL. For more information -# about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html. - -# Puma starts a configurable number of processes (workers) and each process -# serves each request in a thread from an internal thread pool. -# -# The ideal number of threads per worker depends both on how much time the -# application spends waiting for IO operations and on how much you wish to -# to prioritize throughput over latency. -# -# As a rule of thumb, increasing the number of threads will increase how much -# traffic a given process can handle (throughput), but due to CRuby's -# Global VM Lock (GVL) it has diminishing returns and will degrade the -# response time (latency) of the application. -# -# The default is set to 3 threads as it's deemed a decent compromise between -# throughput and latency for the average Rails application. -# -# Any libraries that use a connection pool or another resource pool should -# be configured to provide at least as many connections as the number of -# threads. This includes Active Record's `pool` parameter in `database.yml`. -threads_count = ENV.fetch("RAILS_MAX_THREADS", 3) -threads threads_count, threads_count - -# Specifies the `port` that Puma will listen on to receive requests; default is 3000. -port ENV.fetch("PORT", 3000) - -# Allow puma to be restarted by `bin/rails restart` command. -plugin :tmp_restart - -# Specify the PID file. Defaults to tmp/pids/server.pid in development. -# In other environments, only set the PID file if requested. -pidfile ENV["PIDFILE"] if ENV["PIDFILE"] diff --git a/modules/howtos/examples/rails-caching-example/config/routes.rb b/modules/howtos/examples/rails-caching-example/config/routes.rb deleted file mode 100644 index 1099acc..0000000 --- a/modules/howtos/examples/rails-caching-example/config/routes.rb +++ /dev/null @@ -1,14 +0,0 @@ -Rails.application.routes.draw do - # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html - - # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500. - # Can be used by load balancers and uptime monitors to verify that the app is live. - get "up" => "rails/health#show", as: :rails_health_check - - # Render dynamic PWA files from app/views/pwa/* - get "service-worker" => "rails/pwa#service_worker", as: :pwa_service_worker - get "manifest" => "rails/pwa#manifest", as: :pwa_manifest - - # Defines the root path route ("/") - root "wall_clock#now" -end diff --git a/modules/howtos/examples/rails-caching-example/db/seeds.rb b/modules/howtos/examples/rails-caching-example/db/seeds.rb deleted file mode 100644 index 4fbd6ed..0000000 --- a/modules/howtos/examples/rails-caching-example/db/seeds.rb +++ /dev/null @@ -1,9 +0,0 @@ -# This file should ensure the existence of records required to run the application in every environment (production, -# development, test). The code here should be idempotent so that it can be executed at any point in every environment. -# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup). -# -# Example: -# -# ["Action", "Comedy", "Drama", "Horror"].each do |genre_name| -# MovieGenre.find_or_create_by!(name: genre_name) -# end diff --git a/modules/howtos/examples/rails-caching-example/lib/assets/.keep b/modules/howtos/examples/rails-caching-example/lib/assets/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/lib/tasks/.keep b/modules/howtos/examples/rails-caching-example/lib/tasks/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/log/.keep b/modules/howtos/examples/rails-caching-example/log/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/public/404.html b/modules/howtos/examples/rails-caching-example/public/404.html deleted file mode 100644 index 2be3af2..0000000 --- a/modules/howtos/examples/rails-caching-example/public/404.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - The page you were looking for doesn't exist (404) - - - - - - -
-
-

The page you were looking for doesn't exist.

-

You may have mistyped the address or the page may have moved.

-
-

If you are the application owner check the logs for more information.

-
- - diff --git a/modules/howtos/examples/rails-caching-example/public/406-unsupported-browser.html b/modules/howtos/examples/rails-caching-example/public/406-unsupported-browser.html deleted file mode 100644 index 7cf1e16..0000000 --- a/modules/howtos/examples/rails-caching-example/public/406-unsupported-browser.html +++ /dev/null @@ -1,66 +0,0 @@ - - - - Your browser is not supported (406) - - - - - - -
-
-

Your browser is not supported.

-

Please upgrade your browser to continue.

-
-
- - diff --git a/modules/howtos/examples/rails-caching-example/public/422.html b/modules/howtos/examples/rails-caching-example/public/422.html deleted file mode 100644 index c08eac0..0000000 --- a/modules/howtos/examples/rails-caching-example/public/422.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - The change you wanted was rejected (422) - - - - - - -
-
-

The change you wanted was rejected.

-

Maybe you tried to change something you didn't have access to.

-
-

If you are the application owner check the logs for more information.

-
- - diff --git a/modules/howtos/examples/rails-caching-example/public/500.html b/modules/howtos/examples/rails-caching-example/public/500.html deleted file mode 100644 index 78a030a..0000000 --- a/modules/howtos/examples/rails-caching-example/public/500.html +++ /dev/null @@ -1,66 +0,0 @@ - - - - We're sorry, but something went wrong (500) - - - - - - -
-
-

We're sorry, but something went wrong.

-
-

If you are the application owner check the logs for more information.

-
- - diff --git a/modules/howtos/examples/rails-caching-example/public/icon.png b/modules/howtos/examples/rails-caching-example/public/icon.png deleted file mode 100644 index f3b5abcbde91cf6d7a6a26e514eb7e30f476f950..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5599 zcmeHL-D}fO6hCR_taXJlzs3}~RuB=Iujyo=i*=1|1FN%E=zNfMTjru|Q<6v{J{U!C zBEE}?j6I3sz>fzN!6}L_BKjcuASk~1;Dg|U_@d{g?V8mM`~#9U+>>*Ezw>c(PjYWA z4(;!cgge6k5E&d$G5`S-0}!Ik>CV(0Y#1}s-v_gAHhja2=W1?nBAte9D2HG<(+)uj z!5=W4u*{VKMw#{V@^NNs4TClr!FAA%ID-*gc{R%CFKEzG<6gm*9s_uy)oMGW*=nJf zw{(Mau|2FHfXIv6C0@Wk5k)F=3jo1srV-C{pl&k&)4_&JjYrnbJiul}d0^NCSh(#7h=F;3{|>EU>h z6U8_p;^wK6mAB(1b92>5-HxJ~V}@3?G`&Qq-TbJ2(&~-HsH6F#8mFaAG(45eT3VPO zM|(Jd<+;UZs;w>0Qw}0>D%{~r{uo_Fl5_Bo3ABWi zWo^j^_T3dxG6J6fH8X)$a^%TJ#PU!=LxF=#Fd9EvKx_x>q<(KY%+y-08?kN9dXjXK z**Q=yt-FTU*13ouhCdqq-0&;Ke{T3sQU9IdzhV9LhQIpq*P{N)+}|Mh+a-VV=x?R} c>%+pvTcMWshj-umO}|qP?%A)*_KlqT3uEqhU;qFB diff --git a/modules/howtos/examples/rails-caching-example/public/icon.svg b/modules/howtos/examples/rails-caching-example/public/icon.svg deleted file mode 100644 index 78307cc..0000000 --- a/modules/howtos/examples/rails-caching-example/public/icon.svg +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/modules/howtos/examples/rails-caching-example/public/robots.txt b/modules/howtos/examples/rails-caching-example/public/robots.txt deleted file mode 100644 index c19f78a..0000000 --- a/modules/howtos/examples/rails-caching-example/public/robots.txt +++ /dev/null @@ -1 +0,0 @@ -# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file diff --git a/modules/howtos/examples/rails-caching-example/storage/.keep b/modules/howtos/examples/rails-caching-example/storage/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/tmp/.keep b/modules/howtos/examples/rails-caching-example/tmp/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/tmp/pids/.keep b/modules/howtos/examples/rails-caching-example/tmp/pids/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/tmp/storage/.keep b/modules/howtos/examples/rails-caching-example/tmp/storage/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/examples/rails-caching-example/vendor/.keep b/modules/howtos/examples/rails-caching-example/vendor/.keep deleted file mode 100644 index e69de29..0000000 diff --git a/modules/howtos/pages/analytics-using-sdk.adoc b/modules/howtos/pages/analytics-using-sdk.adoc index 3e3da6b..9e74925 100644 --- a/modules/howtos/pages/analytics-using-sdk.adoc +++ b/modules/howtos/pages/analytics-using-sdk.adoc @@ -24,7 +24,7 @@ In these examples we will be using an `airports` dataset created on the `travel- [source,ruby] ---- -include::example$analytics.rb[tag=simple] +include::devguide:example$ruby/analytics.rb[tag=simple] ---- @@ -36,13 +36,13 @@ If parameters are used, they can either be `positional` or `named`: .Positional parameters [source,ruby] ---- -include::example$analytics.rb[tag=positional] +include::devguide:example$ruby/analytics.rb[tag=positional] ---- .Named parameters [source,ruby] ---- -include::example$analytics.rb[tag=named] +include::devguide:example$ruby/analytics.rb[tag=named] ---- NOTE: As timeouts are propagated to the server by the client, a timeout set on the client side may be used to stop the processing of a request, in order to save system resources. @@ -72,21 +72,21 @@ Here, we set a `client_context_id`: [source,ruby] ---- -include::example$analytics.rb[tag=clientcontextid] +include::devguide:example$ruby/analytics.rb[tag=clientcontextid] ---- And here we set high priority for the query: [source,ruby] ---- -include::example$analytics.rb[tag=priority] +include::devguide:example$ruby/analytics.rb[tag=priority] ---- Here we pass `readonly` to explicitly mark a query as being read only, and not mutating any documents on the server side. [source,ruby] ---- -include::example$analytics.rb[tag=readonly] +include::devguide:example$ruby/analytics.rb[tag=readonly] ---- @@ -116,7 +116,7 @@ The `metadata` object contains useful metadata, such as `Metrics` and `ClientCon [source,ruby] ---- -include::example$analytics.rb[tag=printmetrics] +include::devguide:example$ruby/analytics.rb[tag=printmetrics] ---- // For a listing of available `Metrics` in `MetaData`, see the xref:concept-docs:analytics-for-sdk-users.adoc[Understanding Analytics] SDK doc. @@ -131,7 +131,7 @@ Analytics allows `:request_plus` queries -- ensuring results contain information [source,ruby] ---- -include::example$analytics.rb[tag=scanconsistency] +include::devguide:example$ruby/analytics.rb[tag=scanconsistency] ---- @@ -149,12 +149,12 @@ You can run a query as follows: [source,ruby] ---- -include::example$analytics.rb[tag=handle-collection] +include::devguide:example$ruby/analytics.rb[tag=handle-collection] ---- In addition to running a query via the `Cluster` object, you can run one via the `Scope` object. [source,ruby] ---- -include::example$analytics.rb[tag=handle-scope] +include::devguide:example$ruby/analytics.rb[tag=handle-scope] ---- diff --git a/modules/howtos/pages/caching-example.adoc b/modules/howtos/pages/caching-example.adoc index a5c2b85..b5ac0e9 100644 --- a/modules/howtos/pages/caching-example.adoc +++ b/modules/howtos/pages/caching-example.adoc @@ -17,7 +17,7 @@ so to add it to the application you just need to update your `Gemfile`: [source,ruby] ---- -include::howtos:example$rails-caching-example/Gemfile[tag=add_dependency] +include::devguide:example$ruby/rails-caching-example/Gemfile[tag=add_dependency] ---- Do not forget to run `bundle install` to ensure that all dependencies have been satisfied. @@ -27,7 +27,7 @@ Corresponding configuration usually kept in the configuration environment file a [source,ruby] ---- -include::howtos:example$rails-caching-example/config/environments/development.rb[tag=cache_store_config] +include::devguide:example$ruby/rails-caching-example/config/environments/development.rb[tag=cache_store_config] ---- In this development example, we will try to discover cluster location and credentials in the environment variables, with a fallback to localhost and safe default. @@ -41,7 +41,7 @@ In this example, we cache the current time for the 3 seconds: [source,ruby] ---- -include::howtos:example$rails-caching-example/app/controllers/wall_clock_controller.rb[tag=cache_time_for_3_seconds] +include::devguide:example$ruby/rails-caching-example/app/controllers/wall_clock_controller.rb[tag=cache_time_for_3_seconds] ---- diff --git a/modules/howtos/pages/concurrent-document-mutations.adoc b/modules/howtos/pages/concurrent-document-mutations.adoc index c8fb125..9c6f21a 100644 --- a/modules/howtos/pages/concurrent-document-mutations.adoc +++ b/modules/howtos/pages/concurrent-document-mutations.adoc @@ -29,7 +29,7 @@ include::{version-common}@sdk:shared:partial$cas.adoc[tag=locking] [source,ruby] ---- -include::example$cas.rb[tag=locking] +include::devguide:example$ruby/cas.rb[tag=locking] ---- The handler will unlock the item either via an explicit unlock operation ([.api]`unlock`) or implicitly via modifying the item with the correct CAS. diff --git a/modules/howtos/pages/error-handling.adoc b/modules/howtos/pages/error-handling.adoc index 0348302..6238455 100644 --- a/modules/howtos/pages/error-handling.adoc +++ b/modules/howtos/pages/error-handling.adoc @@ -71,7 +71,7 @@ Transient errors -- such as those caused by resource starvation -- are best tack //// [source,ruby] ---- -include::example$error_handling.rb[tag=handle_retryable] +include::devguide:example$ruby/error_handling.rb[tag=handle_retryable] ---- //// @@ -84,14 +84,14 @@ Here we will cover some of the most common errors. [source,ruby] ---- -include::example$error_handling.rb[tag=DocumentNotFound] +include::devguide:example$ruby/error_handling.rb[tag=DocumentNotFound] ---- === Document already exists [source,ruby] ---- -include::example$error_handling.rb[tag=DocumentExists] +include::devguide:example$ruby/error_handling.rb[tag=DocumentExists] ---- === Document too large @@ -102,21 +102,21 @@ include::example$error_handling.rb[tag=DocumentExists] [source,ruby] ---- -include::example$error_handling.rb[tag=CasMismatch] +include::devguide:example$ruby/error_handling.rb[tag=CasMismatch] ---- === Durability ambiguous [source,ruby] ---- -include::example$error_handling.rb[tag=DurabilityAmbiguous] +include::devguide:example$ruby/error_handling.rb[tag=DurabilityAmbiguous] ---- === Durability invalid level [source,ruby] ---- -include::example$error_handling.rb[tag=DurabilityLevelNotAvailable] +include::devguide:example$ruby/error_handling.rb[tag=DurabilityLevelNotAvailable] ---- From b874b3f309c9d6c2d25222a289ab3c019aa101c0 Mon Sep 17 00:00:00 2001 From: Richard Smedley Date: Mon, 8 Jun 2026 14:19:58 +0100 Subject: [PATCH 2/2] DOC-14417 Ruby caching examples in devguide module --- Rakefile | 2 +- .../rails-caching-example/.dockerignore | 45 +++ .../rails-caching-example/.gitattributes | 9 + .../examples/rails-caching-example/.gitignore | 35 ++ .../rails-caching-example/.rubocop.yml | 8 + .../rails-caching-example/.ruby-version | 1 + .../examples/rails-caching-example/Dockerfile | 65 ++++ .../examples/rails-caching-example/Gemfile | 30 ++ .../rails-caching-example/Gemfile.lock | 336 ++++++++++++++++++ .../examples/rails-caching-example/README.md | 24 ++ .../examples/rails-caching-example/Rakefile | 6 + .../app/assets/config/manifest.js | 2 + .../app/assets/images/.keep | 0 .../app/assets/stylesheets/application.css | 15 + .../app/controllers/application_controller.rb | 4 + .../app/controllers/concerns/.keep | 0 .../app/controllers/wall_clock_controller.rb | 44 +++ .../app/helpers/application_helper.rb | 2 + .../app/models/application_record.rb | 3 + .../app/models/concerns/.keep | 0 .../app/views/layouts/application.html.erb | 22 ++ .../app/views/pwa/manifest.json.erb | 22 ++ .../app/views/pwa/service-worker.js | 26 ++ .../app/views/wall_clock/now.html.erb | 20 ++ .../rails-caching-example/bin/brakeman | 7 + .../examples/rails-caching-example/bin/bundle | 109 ++++++ .../bin/docker-entrypoint | 13 + .../examples/rails-caching-example/bin/rails | 4 + .../examples/rails-caching-example/bin/rake | 4 + .../rails-caching-example/bin/rubocop | 8 + .../examples/rails-caching-example/bin/setup | 37 ++ .../examples/rails-caching-example/config.ru | 6 + .../config/application.rb | 42 +++ .../rails-caching-example/config/boot.rb | 3 + .../config/credentials.yml.enc | 1 + .../rails-caching-example/config/database.yml | 32 ++ .../config/environment.rb | 5 + .../config/environments/development.rb | 73 ++++ .../config/environments/production.rb | 82 +++++ .../config/environments/test.rb | 51 +++ .../config/initializers/assets.rb | 12 + .../initializers/content_security_policy.rb | 25 ++ .../initializers/filter_parameter_logging.rb | 8 + .../config/initializers/inflections.rb | 16 + .../config/initializers/permissions_policy.rb | 13 + .../config/locales/en.yml | 31 ++ .../rails-caching-example/config/puma.rb | 34 ++ .../rails-caching-example/config/routes.rb | 14 + .../rails-caching-example/db/seeds.rb | 9 + .../rails-caching-example/lib/assets/.keep | 0 .../rails-caching-example/lib/tasks/.keep | 0 .../examples/rails-caching-example/log/.keep | 0 .../rails-caching-example/public/404.html | 67 ++++ .../public/406-unsupported-browser.html | 66 ++++ .../rails-caching-example/public/422.html | 67 ++++ .../rails-caching-example/public/500.html | 66 ++++ .../rails-caching-example/public/icon.png | Bin 0 -> 5599 bytes .../rails-caching-example/public/icon.svg | 3 + .../rails-caching-example/public/robots.txt | 1 + .../rails-caching-example/storage/.keep | 0 .../examples/rails-caching-example/tmp/.keep | 0 .../rails-caching-example/tmp/pids/.keep | 0 .../rails-caching-example/tmp/storage/.keep | 0 .../rails-caching-example/vendor/.keep | 0 modules/howtos/pages/caching-example.adoc | 8 +- 65 files changed, 1633 insertions(+), 5 deletions(-) create mode 100644 modules/devguide/examples/rails-caching-example/.dockerignore create mode 100644 modules/devguide/examples/rails-caching-example/.gitattributes create mode 100644 modules/devguide/examples/rails-caching-example/.gitignore create mode 100644 modules/devguide/examples/rails-caching-example/.rubocop.yml create mode 100644 modules/devguide/examples/rails-caching-example/.ruby-version create mode 100644 modules/devguide/examples/rails-caching-example/Dockerfile create mode 100644 modules/devguide/examples/rails-caching-example/Gemfile create mode 100644 modules/devguide/examples/rails-caching-example/Gemfile.lock create mode 100644 modules/devguide/examples/rails-caching-example/README.md create mode 100644 modules/devguide/examples/rails-caching-example/Rakefile create mode 100644 modules/devguide/examples/rails-caching-example/app/assets/config/manifest.js create mode 100644 modules/devguide/examples/rails-caching-example/app/assets/images/.keep create mode 100644 modules/devguide/examples/rails-caching-example/app/assets/stylesheets/application.css create mode 100644 modules/devguide/examples/rails-caching-example/app/controllers/application_controller.rb create mode 100644 modules/devguide/examples/rails-caching-example/app/controllers/concerns/.keep create mode 100644 modules/devguide/examples/rails-caching-example/app/controllers/wall_clock_controller.rb create mode 100644 modules/devguide/examples/rails-caching-example/app/helpers/application_helper.rb create mode 100644 modules/devguide/examples/rails-caching-example/app/models/application_record.rb create mode 100644 modules/devguide/examples/rails-caching-example/app/models/concerns/.keep create mode 100644 modules/devguide/examples/rails-caching-example/app/views/layouts/application.html.erb create mode 100644 modules/devguide/examples/rails-caching-example/app/views/pwa/manifest.json.erb create mode 100644 modules/devguide/examples/rails-caching-example/app/views/pwa/service-worker.js create mode 100644 modules/devguide/examples/rails-caching-example/app/views/wall_clock/now.html.erb create mode 100755 modules/devguide/examples/rails-caching-example/bin/brakeman create mode 100755 modules/devguide/examples/rails-caching-example/bin/bundle create mode 100755 modules/devguide/examples/rails-caching-example/bin/docker-entrypoint create mode 100755 modules/devguide/examples/rails-caching-example/bin/rails create mode 100755 modules/devguide/examples/rails-caching-example/bin/rake create mode 100755 modules/devguide/examples/rails-caching-example/bin/rubocop create mode 100755 modules/devguide/examples/rails-caching-example/bin/setup create mode 100644 modules/devguide/examples/rails-caching-example/config.ru create mode 100644 modules/devguide/examples/rails-caching-example/config/application.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/boot.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/credentials.yml.enc create mode 100644 modules/devguide/examples/rails-caching-example/config/database.yml create mode 100644 modules/devguide/examples/rails-caching-example/config/environment.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/environments/development.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/environments/production.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/environments/test.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/initializers/assets.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/initializers/content_security_policy.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/initializers/inflections.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/initializers/permissions_policy.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/locales/en.yml create mode 100644 modules/devguide/examples/rails-caching-example/config/puma.rb create mode 100644 modules/devguide/examples/rails-caching-example/config/routes.rb create mode 100644 modules/devguide/examples/rails-caching-example/db/seeds.rb create mode 100644 modules/devguide/examples/rails-caching-example/lib/assets/.keep create mode 100644 modules/devguide/examples/rails-caching-example/lib/tasks/.keep create mode 100644 modules/devguide/examples/rails-caching-example/log/.keep create mode 100644 modules/devguide/examples/rails-caching-example/public/404.html create mode 100644 modules/devguide/examples/rails-caching-example/public/406-unsupported-browser.html create mode 100644 modules/devguide/examples/rails-caching-example/public/422.html create mode 100644 modules/devguide/examples/rails-caching-example/public/500.html create mode 100644 modules/devguide/examples/rails-caching-example/public/icon.png create mode 100644 modules/devguide/examples/rails-caching-example/public/icon.svg create mode 100644 modules/devguide/examples/rails-caching-example/public/robots.txt create mode 100644 modules/devguide/examples/rails-caching-example/storage/.keep create mode 100644 modules/devguide/examples/rails-caching-example/tmp/.keep create mode 100644 modules/devguide/examples/rails-caching-example/tmp/pids/.keep create mode 100644 modules/devguide/examples/rails-caching-example/tmp/storage/.keep create mode 100644 modules/devguide/examples/rails-caching-example/vendor/.keep diff --git a/Rakefile b/Rakefile index 37177b3..6581dda 100644 --- a/Rakefile +++ b/Rakefile @@ -4,7 +4,7 @@ task :check_syntax do fail_count = 0 errors = [] - Dir.glob("modules/devguide/examples/ruby/*.rb").sort.each do |file| + Dir.glob("modules/devguide/examples/*/*.rb").sort.each do |file| source = File.read(file) RubyVM::InstructionSequence.compile(source, file) pass += 1 diff --git a/modules/devguide/examples/rails-caching-example/.dockerignore b/modules/devguide/examples/rails-caching-example/.dockerignore new file mode 100644 index 0000000..3219d20 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/.dockerignore @@ -0,0 +1,45 @@ +# See https://docs.docker.com/engine/reference/builder/#dockerignore-file for more about ignoring files. + +# Ignore git directory. +/.git/ +/.gitignore + +# Ignore bundler config. +/.bundle + +# Ignore all environment files (except templates). +/.env* +!/.env*.erb + +# Ignore all default key files. +/config/master.key +/config/credentials/*.key + +# Ignore all logfiles and tempfiles. +/log/* +/tmp/* +!/log/.keep +!/tmp/.keep + +# Ignore pidfiles, but keep the directory. +/tmp/pids/* +!/tmp/pids/.keep + +# Ignore storage (uploaded files in development and any SQLite databases). +/storage/* +!/storage/.keep +/tmp/storage/* +!/tmp/storage/.keep + +# Ignore assets. +/node_modules/ +/app/assets/builds/* +!/app/assets/builds/.keep +/public/assets + +# Ignore development files +/.devcontainer + +# Ignore Docker-related files +/.dockerignore +/Dockerfile* diff --git a/modules/devguide/examples/rails-caching-example/.gitattributes b/modules/devguide/examples/rails-caching-example/.gitattributes new file mode 100644 index 0000000..8dc4323 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/.gitattributes @@ -0,0 +1,9 @@ +# See https://git-scm.com/docs/gitattributes for more about git attribute files. + +# Mark the database schema as having been generated. +db/schema.rb linguist-generated + +# Mark any vendored files as having been vendored. +vendor/* linguist-vendored +config/credentials/*.yml.enc diff=rails_credentials +config/credentials.yml.enc diff=rails_credentials diff --git a/modules/devguide/examples/rails-caching-example/.gitignore b/modules/devguide/examples/rails-caching-example/.gitignore new file mode 100644 index 0000000..4aaf102 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/.gitignore @@ -0,0 +1,35 @@ +# See https://help.github.com/articles/ignoring-files for more about ignoring files. +# +# Temporary files generated by your text editor or operating system +# belong in git's global ignore instead: +# `$XDG_CONFIG_HOME/git/ignore` or `~/.config/git/ignore` + +# Ignore bundler config. +/.bundle + +# Ignore all environment files (except templates). +/.env* +!/.env*.erb + +# 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 storage (uploaded files in development and any SQLite databases). +/storage/* +!/storage/.keep +/tmp/storage/* +!/tmp/storage/ +!/tmp/storage/.keep + +/public/assets + +# Ignore master key for decrypting credentials and more. +/config/master.key diff --git a/modules/devguide/examples/rails-caching-example/.rubocop.yml b/modules/devguide/examples/rails-caching-example/.rubocop.yml new file mode 100644 index 0000000..f9d86d4 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/.rubocop.yml @@ -0,0 +1,8 @@ +# Omakase Ruby styling for Rails +inherit_gem: { rubocop-rails-omakase: rubocop.yml } + +# Overwrite or add rules to create your own house style +# +# # Use `[a, [b, c]]` not `[ a, [ b, c ] ]` +# Layout/SpaceInsideArrayLiteralBrackets: +# Enabled: false diff --git a/modules/devguide/examples/rails-caching-example/.ruby-version b/modules/devguide/examples/rails-caching-example/.ruby-version new file mode 100644 index 0000000..6d5369b --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/.ruby-version @@ -0,0 +1 @@ +ruby-3.3.4 diff --git a/modules/devguide/examples/rails-caching-example/Dockerfile b/modules/devguide/examples/rails-caching-example/Dockerfile new file mode 100644 index 0000000..7120e63 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/Dockerfile @@ -0,0 +1,65 @@ +# syntax = docker/dockerfile:1 + +# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand: +# docker build -t my-app . +# docker run -d -p 80:80 -p 443:443 --name my-app -e RAILS_MASTER_KEY= my-app + +# Make sure RUBY_VERSION matches the Ruby version in .ruby-version +ARG RUBY_VERSION=3.3.4 +FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base + +# Rails app lives here +WORKDIR /rails + +# Install base packages +RUN apt-get update -qq && \ + apt-get install --no-install-recommends -y curl libjemalloc2 sqlite3 && \ + rm -rf /var/lib/apt/lists /var/cache/apt/archives + +# Set production environment +ENV RAILS_ENV="production" \ + BUNDLE_DEPLOYMENT="1" \ + BUNDLE_PATH="/usr/local/bundle" \ + BUNDLE_WITHOUT="development" + +# Throw-away build stage to reduce size of final image +FROM base AS build + +# Install packages needed to build gems +RUN apt-get update -qq && \ + apt-get install --no-install-recommends -y build-essential git pkg-config && \ + rm -rf /var/lib/apt/lists /var/cache/apt/archives + +# Install application gems +COPY Gemfile Gemfile.lock ./ +RUN bundle install && \ + rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git + +# Copy application code +COPY . . + +# Precompiling assets for production without requiring secret RAILS_MASTER_KEY +RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile + + + + +# Final stage for app image +FROM base + +# Copy built artifacts: gems, application +COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}" +COPY --from=build /rails /rails + +# Run and own only the runtime files as a non-root user for security +RUN groupadd --system --gid 1000 rails && \ + useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \ + chown -R rails:rails db log storage tmp +USER 1000:1000 + +# Entrypoint prepares the database. +ENTRYPOINT ["/rails/bin/docker-entrypoint"] + +# Start the server by default, this can be overwritten at runtime +EXPOSE 3000 +CMD ["./bin/rails", "server"] diff --git a/modules/devguide/examples/rails-caching-example/Gemfile b/modules/devguide/examples/rails-caching-example/Gemfile new file mode 100644 index 0000000..232365f --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/Gemfile @@ -0,0 +1,30 @@ +source "https://rubygems.org" + +# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main" +gem "rails", "~> 7.2.1" +# The original asset pipeline for Rails [https://github.com/rails/sprockets-rails] +gem "sprockets-rails" +# Use sqlite3 as the database for Active Record +gem "sqlite3", ">= 1.4" +# Use the Puma web server [https://github.com/puma/puma] +gem "puma", ">= 5.0" + +# tag::add_dependency[] +gem "couchbase" +# end::add_dependency[] + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem "tzinfo-data", platforms: %i[ windows jruby ] + +group :development, :test do + # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem + gem "debug", platforms: %i[ mri windows ], require: "debug/prelude" + + # Static analysis for security vulnerabilities [https://brakemanscanner.org/] + gem "brakeman", require: false + + # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/] + gem "rubocop-rails-omakase", require: false + + gem "ruby-lsp" +end diff --git a/modules/devguide/examples/rails-caching-example/Gemfile.lock b/modules/devguide/examples/rails-caching-example/Gemfile.lock new file mode 100644 index 0000000..972137c --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/Gemfile.lock @@ -0,0 +1,336 @@ +GEM + remote: https://rubygems.org/ + specs: + actioncable (7.2.1) + actionpack (= 7.2.1) + activesupport (= 7.2.1) + nio4r (~> 2.0) + websocket-driver (>= 0.6.1) + zeitwerk (~> 2.6) + actionmailbox (7.2.1) + actionpack (= 7.2.1) + activejob (= 7.2.1) + activerecord (= 7.2.1) + activestorage (= 7.2.1) + activesupport (= 7.2.1) + mail (>= 2.8.0) + actionmailer (7.2.1) + actionpack (= 7.2.1) + actionview (= 7.2.1) + activejob (= 7.2.1) + activesupport (= 7.2.1) + mail (>= 2.8.0) + rails-dom-testing (~> 2.2) + actionpack (7.2.1) + actionview (= 7.2.1) + activesupport (= 7.2.1) + nokogiri (>= 1.8.5) + racc + rack (>= 2.2.4, < 3.2) + rack-session (>= 1.0.1) + rack-test (>= 0.6.3) + rails-dom-testing (~> 2.2) + rails-html-sanitizer (~> 1.6) + useragent (~> 0.16) + actiontext (7.2.1) + actionpack (= 7.2.1) + activerecord (= 7.2.1) + activestorage (= 7.2.1) + activesupport (= 7.2.1) + globalid (>= 0.6.0) + nokogiri (>= 1.8.5) + actionview (7.2.1) + activesupport (= 7.2.1) + builder (~> 3.1) + erubi (~> 1.11) + rails-dom-testing (~> 2.2) + rails-html-sanitizer (~> 1.6) + activejob (7.2.1) + activesupport (= 7.2.1) + globalid (>= 0.3.6) + activemodel (7.2.1) + activesupport (= 7.2.1) + activerecord (7.2.1) + activemodel (= 7.2.1) + activesupport (= 7.2.1) + timeout (>= 0.4.0) + activestorage (7.2.1) + actionpack (= 7.2.1) + activejob (= 7.2.1) + activerecord (= 7.2.1) + activesupport (= 7.2.1) + marcel (~> 1.0) + activesupport (7.2.1) + base64 + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb + i18n (>= 1.6, < 2) + logger (>= 1.4.2) + minitest (>= 5.1) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) + ast (2.4.2) + base64 (0.2.0) + bigdecimal (3.1.8) + brakeman (6.2.1) + racc + builder (3.3.0) + concurrent-ruby (1.3.4) + connection_pool (2.4.1) + couchbase (3.5.3) + grpc (~> 1.59) + couchbase (3.5.3-arm64-darwin) + grpc (~> 1.59) + couchbase (3.5.3-x86_64-darwin) + grpc (~> 1.59) + couchbase (3.5.3-x86_64-linux) + grpc (~> 1.59) + couchbase (3.5.3-x86_64-linux-musl) + grpc (~> 1.59) + crass (1.0.6) + date (3.3.4) + debug (1.9.2) + irb (~> 1.10) + reline (>= 0.3.8) + drb (2.2.1) + erubi (1.13.0) + globalid (1.2.1) + activesupport (>= 6.1) + google-protobuf (4.28.0) + bigdecimal + rake (>= 13) + google-protobuf (4.28.0-aarch64-linux) + bigdecimal + rake (>= 13) + google-protobuf (4.28.0-arm64-darwin) + bigdecimal + rake (>= 13) + google-protobuf (4.28.0-x86-linux) + bigdecimal + rake (>= 13) + google-protobuf (4.28.0-x86_64-darwin) + bigdecimal + rake (>= 13) + google-protobuf (4.28.0-x86_64-linux) + bigdecimal + rake (>= 13) + googleapis-common-protos-types (1.15.0) + google-protobuf (>= 3.18, < 5.a) + grpc (1.66.0) + google-protobuf (>= 3.25, < 5.0) + googleapis-common-protos-types (~> 1.0) + grpc (1.66.0-aarch64-linux) + google-protobuf (>= 3.25, < 5.0) + googleapis-common-protos-types (~> 1.0) + grpc (1.66.0-arm64-darwin) + google-protobuf (>= 3.25, < 5.0) + googleapis-common-protos-types (~> 1.0) + grpc (1.66.0-x86-linux) + google-protobuf (>= 3.25, < 5.0) + googleapis-common-protos-types (~> 1.0) + grpc (1.66.0-x86_64-darwin) + google-protobuf (>= 3.25, < 5.0) + googleapis-common-protos-types (~> 1.0) + grpc (1.66.0-x86_64-linux) + google-protobuf (>= 3.25, < 5.0) + googleapis-common-protos-types (~> 1.0) + i18n (1.14.5) + concurrent-ruby (~> 1.0) + io-console (0.7.2) + irb (1.14.0) + rdoc (>= 4.0.0) + reline (>= 0.4.2) + json (2.7.2) + language_server-protocol (3.17.0.3) + logger (1.6.0) + loofah (2.22.0) + crass (~> 1.0.2) + nokogiri (>= 1.12.0) + mail (2.8.1) + mini_mime (>= 0.1.1) + net-imap + net-pop + net-smtp + marcel (1.0.4) + mini_mime (1.1.5) + minitest (5.25.1) + net-imap (0.4.15) + date + net-protocol + net-pop (0.1.2) + net-protocol + net-protocol (0.2.2) + timeout + net-smtp (0.5.0) + net-protocol + nio4r (2.7.3) + nokogiri (1.16.7-aarch64-linux) + racc (~> 1.4) + nokogiri (1.16.7-arm-linux) + racc (~> 1.4) + nokogiri (1.16.7-arm64-darwin) + racc (~> 1.4) + nokogiri (1.16.7-x86-linux) + racc (~> 1.4) + nokogiri (1.16.7-x86_64-darwin) + racc (~> 1.4) + nokogiri (1.16.7-x86_64-linux) + racc (~> 1.4) + parallel (1.26.3) + parser (3.3.4.2) + ast (~> 2.4.1) + racc + prism (1.0.0) + psych (5.1.2) + stringio + puma (6.4.2) + nio4r (~> 2.0) + racc (1.8.1) + rack (3.1.7) + rack-session (2.0.0) + rack (>= 3.0.0) + rack-test (2.1.0) + rack (>= 1.3) + rackup (2.1.0) + rack (>= 3) + webrick (~> 1.8) + rails (7.2.1) + actioncable (= 7.2.1) + actionmailbox (= 7.2.1) + actionmailer (= 7.2.1) + actionpack (= 7.2.1) + actiontext (= 7.2.1) + actionview (= 7.2.1) + activejob (= 7.2.1) + activemodel (= 7.2.1) + activerecord (= 7.2.1) + activestorage (= 7.2.1) + activesupport (= 7.2.1) + bundler (>= 1.15.0) + railties (= 7.2.1) + rails-dom-testing (2.2.0) + activesupport (>= 5.0.0) + minitest + nokogiri (>= 1.6) + rails-html-sanitizer (1.6.0) + loofah (~> 2.21) + nokogiri (~> 1.14) + railties (7.2.1) + actionpack (= 7.2.1) + activesupport (= 7.2.1) + irb (~> 1.13) + rackup (>= 1.0.0) + rake (>= 12.2) + thor (~> 1.0, >= 1.2.2) + zeitwerk (~> 2.6) + rainbow (3.1.1) + rake (13.2.1) + rbs (3.5.3) + logger + rdoc (6.7.0) + psych (>= 4.0.0) + regexp_parser (2.9.2) + reline (0.5.9) + io-console (~> 0.5) + rexml (3.3.6) + strscan + rubocop (1.65.1) + json (~> 2.3) + language_server-protocol (>= 3.17.0) + parallel (~> 1.10) + parser (>= 3.3.0.2) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 2.4, < 3.0) + rexml (>= 3.2.5, < 4.0) + rubocop-ast (>= 1.31.1, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 2.4.0, < 3.0) + rubocop-ast (1.32.1) + parser (>= 3.3.1.0) + rubocop-minitest (0.35.1) + rubocop (>= 1.61, < 2.0) + rubocop-ast (>= 1.31.1, < 2.0) + rubocop-performance (1.21.1) + rubocop (>= 1.48.1, < 2.0) + rubocop-ast (>= 1.31.1, < 2.0) + rubocop-rails (2.26.0) + activesupport (>= 4.2.0) + rack (>= 1.1) + rubocop (>= 1.52.0, < 2.0) + rubocop-ast (>= 1.31.1, < 2.0) + rubocop-rails-omakase (1.0.0) + rubocop + rubocop-minitest + rubocop-performance + rubocop-rails + ruby-lsp (0.17.17) + language_server-protocol (~> 3.17.0) + prism (~> 1.0) + rbs (>= 3, < 4) + sorbet-runtime (>= 0.5.10782) + ruby-progressbar (1.13.0) + securerandom (0.3.1) + sorbet-runtime (0.5.11551) + sprockets (4.2.1) + concurrent-ruby (~> 1.0) + rack (>= 2.2.4, < 4) + sprockets-rails (3.5.2) + actionpack (>= 6.1) + activesupport (>= 6.1) + sprockets (>= 3.0.0) + sqlite3 (2.0.4-aarch64-linux-gnu) + sqlite3 (2.0.4-aarch64-linux-musl) + sqlite3 (2.0.4-arm-linux-gnu) + sqlite3 (2.0.4-arm-linux-musl) + sqlite3 (2.0.4-arm64-darwin) + sqlite3 (2.0.4-x86-linux-gnu) + sqlite3 (2.0.4-x86-linux-musl) + sqlite3 (2.0.4-x86_64-darwin) + sqlite3 (2.0.4-x86_64-linux-gnu) + sqlite3 (2.0.4-x86_64-linux-musl) + stringio (3.1.1) + strscan (3.1.0) + thor (1.3.2) + timeout (0.4.1) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + unicode-display_width (2.5.0) + useragent (0.16.10) + webrick (1.8.1) + websocket-driver (0.7.6) + websocket-extensions (>= 0.1.0) + websocket-extensions (0.1.5) + zeitwerk (2.6.17) + +PLATFORMS + aarch64-linux + aarch64-linux-gnu + aarch64-linux-musl + arm-linux + arm-linux-gnu + arm-linux-musl + arm64-darwin-23 + x86-linux + x86-linux-gnu + x86-linux-musl + x86_64-darwin + x86_64-linux + x86_64-linux-gnu + x86_64-linux-musl + +DEPENDENCIES + brakeman + couchbase + debug + puma (>= 5.0) + rails (~> 7.2.1) + rubocop-rails-omakase + ruby-lsp + sprockets-rails + sqlite3 (>= 1.4) + tzinfo-data + +BUNDLED WITH + 2.5.14 diff --git a/modules/devguide/examples/rails-caching-example/README.md b/modules/devguide/examples/rails-caching-example/README.md new file mode 100644 index 0000000..598127a --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/README.md @@ -0,0 +1,24 @@ +# README + +This project demonstrate usage of Couchbase as a caching provider for Rails +project. + +Install all dependencies and configure the project: + + ./bin/setup + +Enable caching for development environment (find more details at +`config/environments/development.rb`) + + bundle exec rails dev:cache + +Configure Couchbase cluster and export environment variables as it is configured +in `config/environments/development.rb`: + + export COUCHBASE_CONNECTION_STRING=couchbase://192.168.107.128 + +Start the server: + + bundle exec rails server + +Navigate to http://localhost:3000 diff --git a/modules/devguide/examples/rails-caching-example/Rakefile b/modules/devguide/examples/rails-caching-example/Rakefile new file mode 100644 index 0000000..9a5ea73 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/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 diff --git a/modules/devguide/examples/rails-caching-example/app/assets/config/manifest.js b/modules/devguide/examples/rails-caching-example/app/assets/config/manifest.js new file mode 100644 index 0000000..5918193 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/app/assets/config/manifest.js @@ -0,0 +1,2 @@ +//= link_tree ../images +//= link_directory ../stylesheets .css diff --git a/modules/devguide/examples/rails-caching-example/app/assets/images/.keep b/modules/devguide/examples/rails-caching-example/app/assets/images/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/app/assets/stylesheets/application.css b/modules/devguide/examples/rails-caching-example/app/assets/stylesheets/application.css new file mode 100644 index 0000000..288b9ab --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/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, if configured) 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 + * 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 + */ diff --git a/modules/devguide/examples/rails-caching-example/app/controllers/application_controller.rb b/modules/devguide/examples/rails-caching-example/app/controllers/application_controller.rb new file mode 100644 index 0000000..0d95db2 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/app/controllers/application_controller.rb @@ -0,0 +1,4 @@ +class ApplicationController < ActionController::Base + # Only allow modern browsers supporting webp images, web push, badges, import maps, CSS nesting, and CSS :has. + allow_browser versions: :modern +end diff --git a/modules/devguide/examples/rails-caching-example/app/controllers/concerns/.keep b/modules/devguide/examples/rails-caching-example/app/controllers/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/app/controllers/wall_clock_controller.rb b/modules/devguide/examples/rails-caching-example/app/controllers/wall_clock_controller.rb new file mode 100644 index 0000000..b3aeaa3 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/app/controllers/wall_clock_controller.rb @@ -0,0 +1,44 @@ +# tag::cache_time_for_3_seconds[] +class WallClockController < ApplicationController + def now + @current_time = Rails.cache.fetch("current_time", expires_in: 3.seconds) do + Time.now + end + end + # end::cache_time_for_3_seconds[] + + private + + before_action :fetch_cached_document + + # This method fetches the representation of the cache entry as it is stored in + # Couchbase + def fetch_cached_document + require "pp" + + @cache_entry = cache_collection.get( + "current_time", + Couchbase::Options::Get(transcoder: nil, with_expiry: true)) + rescue Couchbase::Error::DocumentNotFound + end + + def cache_collection + @collection ||= + begin + type, options = Rails.application.config.cache_store + if type != :couchbase_store + raise "Unexpected cache store configured: #{type}" + end + + cluster = Couchbase::Cluster.connect( + options[:connection_string], + options[:username], + options[:password] + ) + cluster + .bucket(options[:bucket]) + .scope(options[:scope]) + .collection(options[:collection]) + end + end +end diff --git a/modules/devguide/examples/rails-caching-example/app/helpers/application_helper.rb b/modules/devguide/examples/rails-caching-example/app/helpers/application_helper.rb new file mode 100644 index 0000000..de6be79 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/app/helpers/application_helper.rb @@ -0,0 +1,2 @@ +module ApplicationHelper +end diff --git a/modules/devguide/examples/rails-caching-example/app/models/application_record.rb b/modules/devguide/examples/rails-caching-example/app/models/application_record.rb new file mode 100644 index 0000000..b63caeb --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/app/models/application_record.rb @@ -0,0 +1,3 @@ +class ApplicationRecord < ActiveRecord::Base + primary_abstract_class +end diff --git a/modules/devguide/examples/rails-caching-example/app/models/concerns/.keep b/modules/devguide/examples/rails-caching-example/app/models/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/app/views/layouts/application.html.erb b/modules/devguide/examples/rails-caching-example/app/views/layouts/application.html.erb new file mode 100644 index 0000000..569de6b --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/app/views/layouts/application.html.erb @@ -0,0 +1,22 @@ + + + + <%= content_for(:title) || "Rails Caching Example" %> + + + <%= csrf_meta_tags %> + <%= csp_meta_tag %> + + <%= yield :head %> + + + + + + <%= stylesheet_link_tag "application" %> + + + + <%= yield %> + + diff --git a/modules/devguide/examples/rails-caching-example/app/views/pwa/manifest.json.erb b/modules/devguide/examples/rails-caching-example/app/views/pwa/manifest.json.erb new file mode 100644 index 0000000..9413c10 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/app/views/pwa/manifest.json.erb @@ -0,0 +1,22 @@ +{ + "name": "RailsCachingExample", + "icons": [ + { + "src": "/icon.png", + "type": "image/png", + "sizes": "512x512" + }, + { + "src": "/icon.png", + "type": "image/png", + "sizes": "512x512", + "purpose": "maskable" + } + ], + "start_url": "/", + "display": "standalone", + "scope": "/", + "description": "RailsCachingExample.", + "theme_color": "red", + "background_color": "red" +} diff --git a/modules/devguide/examples/rails-caching-example/app/views/pwa/service-worker.js b/modules/devguide/examples/rails-caching-example/app/views/pwa/service-worker.js new file mode 100644 index 0000000..b3a13fb --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/app/views/pwa/service-worker.js @@ -0,0 +1,26 @@ +// Add a service worker for processing Web Push notifications: +// +// self.addEventListener("push", async (event) => { +// const { title, options } = await event.data.json() +// event.waitUntil(self.registration.showNotification(title, options)) +// }) +// +// self.addEventListener("notificationclick", function(event) { +// event.notification.close() +// event.waitUntil( +// clients.matchAll({ type: "window" }).then((clientList) => { +// for (let i = 0; i < clientList.length; i++) { +// let client = clientList[i] +// let clientPath = (new URL(client.url)).pathname +// +// if (clientPath == event.notification.data.path && "focus" in client) { +// return client.focus() +// } +// } +// +// if (clients.openWindow) { +// return clients.openWindow(event.notification.data.path) +// } +// }) +// ) +// }) diff --git a/modules/devguide/examples/rails-caching-example/app/views/wall_clock/now.html.erb b/modules/devguide/examples/rails-caching-example/app/views/wall_clock/now.html.erb new file mode 100644 index 0000000..c647578 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/app/views/wall_clock/now.html.erb @@ -0,0 +1,20 @@ +

Wall Clock

+ +

+ Realtime time is <%= Time.now %> +

+ +

Cached Time

+

+ Current time is <%= @current_time %> +

+

+ <%= @current_time.to_f %> seconds since Unix Epoch +

+ +<% if @cache_entry %> +

Cache Entry

+ 
<%= @cache_entry.pretty_inspect %>
+<% else %> +

Cache Miss

+<% end %> diff --git a/modules/devguide/examples/rails-caching-example/bin/brakeman b/modules/devguide/examples/rails-caching-example/bin/brakeman new file mode 100755 index 0000000..ace1c9b --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/bin/brakeman @@ -0,0 +1,7 @@ +#!/usr/bin/env ruby +require "rubygems" +require "bundler/setup" + +ARGV.unshift("--ensure-latest") + +load Gem.bin_path("brakeman", "brakeman") diff --git a/modules/devguide/examples/rails-caching-example/bin/bundle b/modules/devguide/examples/rails-caching-example/bin/bundle new file mode 100755 index 0000000..50da5fd --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/bin/bundle @@ -0,0 +1,109 @@ +#!/usr/bin/env ruby +# frozen_string_literal: true + +# +# This file was generated by Bundler. +# +# The application 'bundle' is installed as part of a gem, and +# this file is here to facilitate running it. +# + +require "rubygems" + +m = Module.new do + module_function + + def invoked_as_script? + File.expand_path($0) == File.expand_path(__FILE__) + end + + def env_var_version + ENV["BUNDLER_VERSION"] + end + + def cli_arg_version + return unless invoked_as_script? # don't want to hijack other binstubs + return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update` + bundler_version = nil + update_index = nil + ARGV.each_with_index do |a, i| + if update_index && update_index.succ == i && a.match?(Gem::Version::ANCHORED_VERSION_PATTERN) + bundler_version = a + end + next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/ + bundler_version = $1 + update_index = i + end + bundler_version + end + + def gemfile + gemfile = ENV["BUNDLE_GEMFILE"] + return gemfile if gemfile && !gemfile.empty? + + File.expand_path("../Gemfile", __dir__) + end + + def lockfile + lockfile = + case File.basename(gemfile) + when "gems.rb" then gemfile.sub(/\.rb$/, ".locked") + else "#{gemfile}.lock" + end + File.expand_path(lockfile) + end + + def lockfile_version + return unless File.file?(lockfile) + lockfile_contents = File.read(lockfile) + return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/ + Regexp.last_match(1) + end + + def bundler_requirement + @bundler_requirement ||= + env_var_version || + cli_arg_version || + bundler_requirement_for(lockfile_version) + end + + def bundler_requirement_for(version) + return "#{Gem::Requirement.default}.a" unless version + + bundler_gem_version = Gem::Version.new(version) + + bundler_gem_version.approximate_recommendation + end + + def load_bundler! + ENV["BUNDLE_GEMFILE"] ||= gemfile + + activate_bundler + end + + def activate_bundler + gem_error = activation_error_handling do + gem "bundler", bundler_requirement + end + return if gem_error.nil? + require_error = activation_error_handling do + require "bundler/version" + end + return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION)) + warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`" + exit 42 + end + + def activation_error_handling + yield + nil + rescue StandardError, LoadError => e + e + end +end + +m.load_bundler! + +if m.invoked_as_script? + load Gem.bin_path("bundler", "bundle") +end diff --git a/modules/devguide/examples/rails-caching-example/bin/docker-entrypoint b/modules/devguide/examples/rails-caching-example/bin/docker-entrypoint new file mode 100755 index 0000000..840d093 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/bin/docker-entrypoint @@ -0,0 +1,13 @@ +#!/bin/bash -e + +# Enable jemalloc for reduced memory usage and latency. +if [ -z "${LD_PRELOAD+x}" ] && [ -f /usr/lib/*/libjemalloc.so.2 ]; then + export LD_PRELOAD="$(echo /usr/lib/*/libjemalloc.so.2)" +fi + +# If running the rails server then create or migrate existing database +if [ "${1}" == "./bin/rails" ] && [ "${2}" == "server" ]; then + ./bin/rails db:prepare +fi + +exec "${@}" diff --git a/modules/devguide/examples/rails-caching-example/bin/rails b/modules/devguide/examples/rails-caching-example/bin/rails new file mode 100755 index 0000000..efc0377 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/bin/rails @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +APP_PATH = File.expand_path("../config/application", __dir__) +require_relative "../config/boot" +require "rails/commands" diff --git a/modules/devguide/examples/rails-caching-example/bin/rake b/modules/devguide/examples/rails-caching-example/bin/rake new file mode 100755 index 0000000..4fbf10b --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/bin/rake @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +require_relative "../config/boot" +require "rake" +Rake.application.run diff --git a/modules/devguide/examples/rails-caching-example/bin/rubocop b/modules/devguide/examples/rails-caching-example/bin/rubocop new file mode 100755 index 0000000..40330c0 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/bin/rubocop @@ -0,0 +1,8 @@ +#!/usr/bin/env ruby +require "rubygems" +require "bundler/setup" + +# explicit rubocop config increases performance slightly while avoiding config confusion. +ARGV.unshift("--config", File.expand_path("../.rubocop.yml", __dir__)) + +load Gem.bin_path("rubocop", "rubocop") diff --git a/modules/devguide/examples/rails-caching-example/bin/setup b/modules/devguide/examples/rails-caching-example/bin/setup new file mode 100755 index 0000000..6e98acf --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/bin/setup @@ -0,0 +1,37 @@ +#!/usr/bin/env ruby +require "fileutils" + +APP_ROOT = File.expand_path("..", __dir__) +APP_NAME = "rails-caching-example" + +def system!(*args) + system(*args, exception: true) +end + +FileUtils.chdir APP_ROOT do + # This script is a way to set up or update your development environment automatically. + # This script is idempotent, so that you can run it at any time and get an expectable outcome. + # Add necessary setup steps to this file. + + puts "== Installing dependencies ==" + system! "gem install bundler --conservative" + system("bundle check") || system!("bundle install") + + # puts "\n== Copying sample files ==" + # unless File.exist?("config/database.yml") + # FileUtils.cp "config/database.yml.sample", "config/database.yml" + # end + + puts "\n== Preparing database ==" + system! "bin/rails db:prepare" + + puts "\n== Removing old logs and tempfiles ==" + system! "bin/rails log:clear tmp:clear" + + puts "\n== Restarting application server ==" + system! "bin/rails restart" + + # puts "\n== Configuring puma-dev ==" + # system "ln -nfs #{APP_ROOT} ~/.puma-dev/#{APP_NAME}" + # system "curl -Is https://#{APP_NAME}.test/up | head -n 1" +end diff --git a/modules/devguide/examples/rails-caching-example/config.ru b/modules/devguide/examples/rails-caching-example/config.ru new file mode 100644 index 0000000..4a3c09a --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config.ru @@ -0,0 +1,6 @@ +# This file is used by Rack-based servers to start the application. + +require_relative "config/environment" + +run Rails.application +Rails.application.load_server diff --git a/modules/devguide/examples/rails-caching-example/config/application.rb b/modules/devguide/examples/rails-caching-example/config/application.rb new file mode 100644 index 0000000..bf779b2 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/application.rb @@ -0,0 +1,42 @@ +require_relative "boot" + +require "rails" +# Pick the frameworks you want: +require "active_model/railtie" +# require "active_job/railtie" +require "active_record/railtie" +# require "active_storage/engine" +require "action_controller/railtie" +# require "action_mailer/railtie" +# require "action_mailbox/engine" +# require "action_text/engine" +require "action_view/railtie" +# require "action_cable/engine" +# require "rails/test_unit/railtie" + +# Require the gems listed in Gemfile, including any gems +# you've limited to :test, :development, or :production. +Bundler.require(*Rails.groups) + +module RailsCachingExample + class Application < Rails::Application + # Initialize configuration defaults for originally generated Rails version. + config.load_defaults 7.2 + + # Please, add to the `ignore` list any other `lib` subdirectories that do + # not contain `.rb` files, or that should not be reloaded or eager loaded. + # Common ones are `templates`, `generators`, or `middleware`, for example. + config.autoload_lib(ignore: %w[assets tasks]) + + # Configuration for the application, engines, and railties goes here. + # + # These settings can be overridden in specific environments using the files + # in config/environments, which are processed later. + # + # config.time_zone = "Central Time (US & Canada)" + # config.eager_load_paths << Rails.root.join("extras") + + # Don't generate system test files. + config.generators.system_tests = nil + end +end diff --git a/modules/devguide/examples/rails-caching-example/config/boot.rb b/modules/devguide/examples/rails-caching-example/config/boot.rb new file mode 100644 index 0000000..2820116 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/boot.rb @@ -0,0 +1,3 @@ +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +require "bundler/setup" # Set up gems listed in the Gemfile. diff --git a/modules/devguide/examples/rails-caching-example/config/credentials.yml.enc b/modules/devguide/examples/rails-caching-example/config/credentials.yml.enc new file mode 100644 index 0000000..05c626d --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/credentials.yml.enc @@ -0,0 +1 @@ +Qrzg9PAULNX+6f3b/jcI1u7WmPKSoh+rCVnRmswAE/twzFqx5E0DS2Q5PxLae+81wlcLHD0SSqiVj+FX8fNW8Z6/AboemXzPBJHF8swZvbIEWyksV5vOd4lCwQf067voMa5oowvv4ho5gjv5YqS0MQuruAyVsIfAdDJWF21+PfcJKR/X1C8ByGUg98XAvbNFeAc9NUsrDw3eG9+VzaBoNWbqtfwlNuwa59RF7rOn6myf4kAZTV9UPqoIr1jf++LR3b8PoM2o4dvK1tx+6ISTJwVzULuO9wq54RTagoxLmt9peDgke3xDqvv5Wa0IXywOc5bSgcPx1/u4N4DEC1qTrbRv0cG0biHgHoVKpcmObeGhoa6OxVDy8yU7p/gcscldzr3GM8M5nBf1VQl1+Z6lXj2w2rcR--EE54pBY7hGPg8bY4--wq86yoO4ud0VtLonsAw32g== \ No newline at end of file diff --git a/modules/devguide/examples/rails-caching-example/config/database.yml b/modules/devguide/examples/rails-caching-example/config/database.yml new file mode 100644 index 0000000..01bebb5 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/database.yml @@ -0,0 +1,32 @@ +# SQLite. Versions 3.8.0 and up are supported. +# gem install sqlite3 +# +# Ensure the SQLite 3 gem is defined in your Gemfile +# gem "sqlite3" +# +default: &default + adapter: sqlite3 + pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %> + timeout: 5000 + +development: + <<: *default + database: storage/development.sqlite3 + +# Warning: The database defined as "test" will be erased and +# re-generated from your development database when you run "rake". +# Do not set this db to the same as development or production. +test: + <<: *default + database: storage/test.sqlite3 + + +# SQLite3 write its data on the local filesystem, as such it requires +# persistent disks. If you are deploying to a managed service, you should +# make sure it provides disk persistence, as many don't. +# +# Similarly, if you deploy your application as a Docker container, you must +# ensure the database is located in a persisted volume. +production: + <<: *default + # database: path/to/persistent/storage/production.sqlite3 diff --git a/modules/devguide/examples/rails-caching-example/config/environment.rb b/modules/devguide/examples/rails-caching-example/config/environment.rb new file mode 100644 index 0000000..cac5315 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/environment.rb @@ -0,0 +1,5 @@ +# Load the Rails application. +require_relative "application" + +# Initialize the Rails application. +Rails.application.initialize! diff --git a/modules/devguide/examples/rails-caching-example/config/environments/development.rb b/modules/devguide/examples/rails-caching-example/config/environments/development.rb new file mode 100644 index 0000000..7064c43 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/environments/development.rb @@ -0,0 +1,73 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # In the development environment your application's code is reloaded any time + # it changes. This slows down response time but is perfect for development + # since you don't have to restart the web server when you make code changes. + config.enable_reloading = true + + # Do not eager load code on boot. + config.eager_load = false + + # Show full error reports. + config.consider_all_requests_local = true + + # Enable server timing. + config.server_timing = true + + # Enable/disable caching. By default caching is disabled. + # Run rails dev:cache to toggle caching. + if Rails.root.join("tmp/caching-dev.txt").exist? + config.action_controller.perform_caching = true + config.action_controller.enable_fragment_cache_logging = true + + # tag::cache_store_config[] + config.cache_store = :couchbase_store, { + connection_string: ENV.fetch("COUCHBASE_CONNECTION_STRING", "couchbase://localhost"), + username: ENV.fetch("COUCHBASE_USERNAME", "Administrator"), + password: ENV.fetch("COUCHBASE_PASSWORD", "password"), + bucket: ENV.fetch("COUCHBASE_BUCKET", "default"), + scope: ENV.fetch("COUCHBASE_SCOPE", "_default"), + collection: ENV.fetch("COUCHBASE_COLLECTION", "_default") + } + # end::cache_store_config[] + + config.public_file_server.headers = { "Cache-Control" => "public, max-age=#{2.days.to_i}" } + else + config.action_controller.perform_caching = false + + config.cache_store = :null_store + end + + # Print deprecation notices to the Rails logger. + config.active_support.deprecation = :log + + # Raise exceptions for disallowed deprecations. + config.active_support.disallowed_deprecation = :raise + + # Tell Active Support which deprecation messages to disallow. + config.active_support.disallowed_deprecation_warnings = [] + + # Raise an error on page load if there are pending migrations. + config.active_record.migration_error = :page_load + + # Highlight code that triggered database queries in logs. + config.active_record.verbose_query_logs = true + + # Suppress logger output for asset requests. + config.assets.quiet = true + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + config.action_view.annotate_rendered_view_with_filenames = true + + # Raise error when a before_action's only/except options reference missing actions. + config.action_controller.raise_on_missing_callback_actions = true + + # Apply autocorrection by RuboCop to files generated by `bin/rails generate`. + # config.generators.apply_rubocop_autocorrect_after_generate! +end diff --git a/modules/devguide/examples/rails-caching-example/config/environments/production.rb b/modules/devguide/examples/rails-caching-example/config/environments/production.rb new file mode 100644 index 0000000..8daf273 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/environments/production.rb @@ -0,0 +1,82 @@ +require "active_support/core_ext/integer/time" + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # Code is not reloaded between requests. + config.enable_reloading = false + + # Eager load code on boot. This eager loads most of Rails and + # your application in memory, allowing both threaded web servers + # and those relying on copy on write to perform better. + # Rake tasks automatically ignore this option for performance. + config.eager_load = true + + # Full error reports are disabled and caching is turned on. + config.consider_all_requests_local = false + config.action_controller.perform_caching = true + + # Ensures that a master key has been made available in ENV["RAILS_MASTER_KEY"], config/master.key, or an environment + # key such as config/credentials/production.key. This key is used to decrypt credentials (and other encrypted files). + # config.require_master_key = true + + # Disable serving static files from `public/`, relying on NGINX/Apache to do so instead. + # config.public_file_server.enabled = false + + # Compress CSS using a preprocessor. + # config.assets.css_compressor = :sass + + # Do not fall back to assets pipeline if a precompiled asset is missed. + config.assets.compile = false + + # Enable serving of images, stylesheets, and JavaScripts from an asset server. + # config.asset_host = "http://assets.example.com" + + # Specifies the header that your server uses for sending files. + # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for Apache + # config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX + + # Assume all access to the app is happening through a SSL-terminating reverse proxy. + # Can be used together with config.force_ssl for Strict-Transport-Security and secure cookies. + # config.assume_ssl = true + + # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. + config.force_ssl = true + + # Skip http-to-https redirect for the default health check endpoint. + # config.ssl_options = { redirect: { exclude: ->(request) { request.path == "/up" } } } + + # Log to STDOUT by default + config.logger = ActiveSupport::Logger.new(STDOUT) + .tap { |logger| logger.formatter = ::Logger::Formatter.new } + .then { |logger| ActiveSupport::TaggedLogging.new(logger) } + + # Prepend all log lines with the following tags. + config.log_tags = [ :request_id ] + + # "info" includes generic and useful information about system operation, but avoids logging too much + # information to avoid inadvertent exposure of personally identifiable information (PII). If you + # want to log everything, set the level to "debug". + config.log_level = ENV.fetch("RAILS_LOG_LEVEL", "info") + + # Use a different cache store in production. + # config.cache_store = :mem_cache_store + + # Enable locale fallbacks for I18n (makes lookups for any locale fall back to + # the I18n.default_locale when a translation cannot be found). + config.i18n.fallbacks = true + + # Don't log any deprecations. + config.active_support.report_deprecations = false + + # Do not dump schema after migrations. + config.active_record.dump_schema_after_migration = false + + # Enable DNS rebinding protection and other `Host` header attacks. + # config.hosts = [ + # "example.com", # Allow requests from example.com + # /.*\.example\.com/ # Allow requests from subdomains like `www.example.com` + # ] + # Skip DNS rebinding protection for the default health check endpoint. + # config.host_authorization = { exclude: ->(request) { request.path == "/up" } } +end diff --git a/modules/devguide/examples/rails-caching-example/config/environments/test.rb b/modules/devguide/examples/rails-caching-example/config/environments/test.rb new file mode 100644 index 0000000..999db70 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/environments/test.rb @@ -0,0 +1,51 @@ +require "active_support/core_ext/integer/time" + +# The test environment is used exclusively to run your application's +# test suite. You never need to work with it otherwise. Remember that +# your test database is "scratch space" for the test suite and is wiped +# and recreated between test runs. Don't rely on the data there! + +Rails.application.configure do + # Settings specified here will take precedence over those in config/application.rb. + + # While tests run files are not watched, reloading is not necessary. + config.enable_reloading = false + + # Eager loading loads your entire application. When running a single test locally, + # this is usually not necessary, and can slow down your test suite. However, it's + # recommended that you enable it in continuous integration systems to ensure eager + # loading is working properly before deploying your code. + config.eager_load = ENV["CI"].present? + + # Configure public file server for tests with Cache-Control for performance. + config.public_file_server.headers = { "Cache-Control" => "public, max-age=#{1.hour.to_i}" } + + # Show full error reports and disable caching. + config.consider_all_requests_local = true + config.action_controller.perform_caching = false + config.cache_store = :null_store + + # Render exception templates for rescuable exceptions and raise for other exceptions. + config.action_dispatch.show_exceptions = :rescuable + + # Disable request forgery protection in test environment. + config.action_controller.allow_forgery_protection = false + + # Print deprecation notices to the stderr. + config.active_support.deprecation = :stderr + + # Raise exceptions for disallowed deprecations. + config.active_support.disallowed_deprecation = :raise + + # Tell Active Support which deprecation messages to disallow. + config.active_support.disallowed_deprecation_warnings = [] + + # Raises error for missing translations. + # config.i18n.raise_on_missing_translations = true + + # Annotate rendered view with file names. + # config.action_view.annotate_rendered_view_with_filenames = true + + # Raise error when a before_action's only/except options reference missing actions. + config.action_controller.raise_on_missing_callback_actions = true +end diff --git a/modules/devguide/examples/rails-caching-example/config/initializers/assets.rb b/modules/devguide/examples/rails-caching-example/config/initializers/assets.rb new file mode 100644 index 0000000..bd5bcd2 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/initializers/assets.rb @@ -0,0 +1,12 @@ +# Be sure to restart your server when you modify this file. + +# Version of your assets, change this if you want to expire all your assets. +Rails.application.config.assets.version = "1.0" + +# Add additional assets to the asset load path. +# Rails.application.config.assets.paths << Emoji.images_path + +# Precompile additional assets. +# application.js, application.css, and all non-JS/CSS in the app/assets +# folder are already added. +# Rails.application.config.assets.precompile += %w[ admin.js admin.css ] diff --git a/modules/devguide/examples/rails-caching-example/config/initializers/content_security_policy.rb b/modules/devguide/examples/rails-caching-example/config/initializers/content_security_policy.rb new file mode 100644 index 0000000..b3076b3 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/initializers/content_security_policy.rb @@ -0,0 +1,25 @@ +# Be sure to restart your server when you modify this file. + +# Define an application-wide content security policy. +# See the Securing Rails Applications Guide for more information: +# https://guides.rubyonrails.org/security.html#content-security-policy-header + +# Rails.application.configure do +# config.content_security_policy do |policy| +# policy.default_src :self, :https +# policy.font_src :self, :https, :data +# policy.img_src :self, :https, :data +# policy.object_src :none +# policy.script_src :self, :https +# policy.style_src :self, :https +# # Specify URI for violation reports +# # policy.report_uri "/csp-violation-report-endpoint" +# end +# +# # Generate session nonces for permitted importmap, inline scripts, and inline styles. +# config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s } +# config.content_security_policy_nonce_directives = %w(script-src style-src) +# +# # Report violations without enforcing the policy. +# # config.content_security_policy_report_only = true +# end diff --git a/modules/devguide/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb b/modules/devguide/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb new file mode 100644 index 0000000..c010b83 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/initializers/filter_parameter_logging.rb @@ -0,0 +1,8 @@ +# Be sure to restart your server when you modify this file. + +# Configure parameters to be partially matched (e.g. passw matches password) and filtered from the log file. +# Use this to limit dissemination of sensitive information. +# See the ActiveSupport::ParameterFilter documentation for supported notations and behaviors. +Rails.application.config.filter_parameters += [ + :passw, :email, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn +] diff --git a/modules/devguide/examples/rails-caching-example/config/initializers/inflections.rb b/modules/devguide/examples/rails-caching-example/config/initializers/inflections.rb new file mode 100644 index 0000000..3860f65 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/initializers/inflections.rb @@ -0,0 +1,16 @@ +# Be sure to restart your server when you modify this file. + +# Add new inflection rules using the following format. Inflections +# are locale specific, and you may define rules for as many different +# locales as you wish. All of these examples are active by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.plural /^(ox)$/i, "\\1en" +# inflect.singular /^(ox)en/i, "\\1" +# inflect.irregular "person", "people" +# inflect.uncountable %w( fish sheep ) +# end + +# These inflection rules are supported but not enabled by default: +# ActiveSupport::Inflector.inflections(:en) do |inflect| +# inflect.acronym "RESTful" +# end diff --git a/modules/devguide/examples/rails-caching-example/config/initializers/permissions_policy.rb b/modules/devguide/examples/rails-caching-example/config/initializers/permissions_policy.rb new file mode 100644 index 0000000..7db3b95 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/initializers/permissions_policy.rb @@ -0,0 +1,13 @@ +# Be sure to restart your server when you modify this file. + +# Define an application-wide HTTP permissions policy. For further +# information see: https://developers.google.com/web/updates/2018/06/feature-policy + +# Rails.application.config.permissions_policy do |policy| +# policy.camera :none +# policy.gyroscope :none +# policy.microphone :none +# policy.usb :none +# policy.fullscreen :self +# policy.payment :self, "https://secure.example.com" +# end diff --git a/modules/devguide/examples/rails-caching-example/config/locales/en.yml b/modules/devguide/examples/rails-caching-example/config/locales/en.yml new file mode 100644 index 0000000..6c349ae --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/locales/en.yml @@ -0,0 +1,31 @@ +# Files in the config/locales directory are used for internationalization and +# are automatically loaded by Rails. If you want to use locales other than +# English, add the necessary files in this directory. +# +# To use the locales, use `I18n.t`: +# +# I18n.t "hello" +# +# In views, this is aliased to just `t`: +# +# <%= t("hello") %> +# +# To use a different locale, set it with `I18n.locale`: +# +# I18n.locale = :es +# +# This would use the information in config/locales/es.yml. +# +# To learn more about the API, please read the Rails Internationalization guide +# at https://guides.rubyonrails.org/i18n.html. +# +# Be aware that YAML interprets the following case-insensitive strings as +# booleans: `true`, `false`, `on`, `off`, `yes`, `no`. Therefore, these strings +# must be quoted to be interpreted as strings. For example: +# +# en: +# "yes": yup +# enabled: "ON" + +en: + hello: "Hello world" diff --git a/modules/devguide/examples/rails-caching-example/config/puma.rb b/modules/devguide/examples/rails-caching-example/config/puma.rb new file mode 100644 index 0000000..03c166f --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/puma.rb @@ -0,0 +1,34 @@ +# This configuration file will be evaluated by Puma. The top-level methods that +# are invoked here are part of Puma's configuration DSL. For more information +# about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html. + +# Puma starts a configurable number of processes (workers) and each process +# serves each request in a thread from an internal thread pool. +# +# The ideal number of threads per worker depends both on how much time the +# application spends waiting for IO operations and on how much you wish to +# to prioritize throughput over latency. +# +# As a rule of thumb, increasing the number of threads will increase how much +# traffic a given process can handle (throughput), but due to CRuby's +# Global VM Lock (GVL) it has diminishing returns and will degrade the +# response time (latency) of the application. +# +# The default is set to 3 threads as it's deemed a decent compromise between +# throughput and latency for the average Rails application. +# +# Any libraries that use a connection pool or another resource pool should +# be configured to provide at least as many connections as the number of +# threads. This includes Active Record's `pool` parameter in `database.yml`. +threads_count = ENV.fetch("RAILS_MAX_THREADS", 3) +threads threads_count, threads_count + +# Specifies the `port` that Puma will listen on to receive requests; default is 3000. +port ENV.fetch("PORT", 3000) + +# Allow puma to be restarted by `bin/rails restart` command. +plugin :tmp_restart + +# Specify the PID file. Defaults to tmp/pids/server.pid in development. +# In other environments, only set the PID file if requested. +pidfile ENV["PIDFILE"] if ENV["PIDFILE"] diff --git a/modules/devguide/examples/rails-caching-example/config/routes.rb b/modules/devguide/examples/rails-caching-example/config/routes.rb new file mode 100644 index 0000000..1099acc --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/config/routes.rb @@ -0,0 +1,14 @@ +Rails.application.routes.draw do + # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html + + # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500. + # Can be used by load balancers and uptime monitors to verify that the app is live. + get "up" => "rails/health#show", as: :rails_health_check + + # Render dynamic PWA files from app/views/pwa/* + get "service-worker" => "rails/pwa#service_worker", as: :pwa_service_worker + get "manifest" => "rails/pwa#manifest", as: :pwa_manifest + + # Defines the root path route ("/") + root "wall_clock#now" +end diff --git a/modules/devguide/examples/rails-caching-example/db/seeds.rb b/modules/devguide/examples/rails-caching-example/db/seeds.rb new file mode 100644 index 0000000..4fbd6ed --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/db/seeds.rb @@ -0,0 +1,9 @@ +# This file should ensure the existence of records required to run the application in every environment (production, +# development, test). The code here should be idempotent so that it can be executed at any point in every environment. +# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup). +# +# Example: +# +# ["Action", "Comedy", "Drama", "Horror"].each do |genre_name| +# MovieGenre.find_or_create_by!(name: genre_name) +# end diff --git a/modules/devguide/examples/rails-caching-example/lib/assets/.keep b/modules/devguide/examples/rails-caching-example/lib/assets/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/lib/tasks/.keep b/modules/devguide/examples/rails-caching-example/lib/tasks/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/log/.keep b/modules/devguide/examples/rails-caching-example/log/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/public/404.html b/modules/devguide/examples/rails-caching-example/public/404.html new file mode 100644 index 0000000..2be3af2 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/public/404.html @@ -0,0 +1,67 @@ + + + + The page you were looking for doesn't exist (404) + + + + + + +
+
+

The page you were looking for doesn't exist.

+

You may have mistyped the address or the page may have moved.

+
+

If you are the application owner check the logs for more information.

+
+ + diff --git a/modules/devguide/examples/rails-caching-example/public/406-unsupported-browser.html b/modules/devguide/examples/rails-caching-example/public/406-unsupported-browser.html new file mode 100644 index 0000000..7cf1e16 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/public/406-unsupported-browser.html @@ -0,0 +1,66 @@ + + + + Your browser is not supported (406) + + + + + + +
+
+

Your browser is not supported.

+

Please upgrade your browser to continue.

+
+
+ + diff --git a/modules/devguide/examples/rails-caching-example/public/422.html b/modules/devguide/examples/rails-caching-example/public/422.html new file mode 100644 index 0000000..c08eac0 --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/public/422.html @@ -0,0 +1,67 @@ + + + + The change you wanted was rejected (422) + + + + + + +
+
+

The change you wanted was rejected.

+

Maybe you tried to change something you didn't have access to.

+
+

If you are the application owner check the logs for more information.

+
+ + diff --git a/modules/devguide/examples/rails-caching-example/public/500.html b/modules/devguide/examples/rails-caching-example/public/500.html new file mode 100644 index 0000000..78a030a --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/public/500.html @@ -0,0 +1,66 @@ + + + + We're sorry, but something went wrong (500) + + + + + + +
+
+

We're sorry, but something went wrong.

+
+

If you are the application owner check the logs for more information.

+
+ + diff --git a/modules/devguide/examples/rails-caching-example/public/icon.png b/modules/devguide/examples/rails-caching-example/public/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..f3b5abcbde91cf6d7a6a26e514eb7e30f476f950 GIT binary patch literal 5599 zcmeHL-D}fO6hCR_taXJlzs3}~RuB=Iujyo=i*=1|1FN%E=zNfMTjru|Q<6v{J{U!C zBEE}?j6I3sz>fzN!6}L_BKjcuASk~1;Dg|U_@d{g?V8mM`~#9U+>>*Ezw>c(PjYWA z4(;!cgge6k5E&d$G5`S-0}!Ik>CV(0Y#1}s-v_gAHhja2=W1?nBAte9D2HG<(+)uj z!5=W4u*{VKMw#{V@^NNs4TClr!FAA%ID-*gc{R%CFKEzG<6gm*9s_uy)oMGW*=nJf zw{(Mau|2FHfXIv6C0@Wk5k)F=3jo1srV-C{pl&k&)4_&JjYrnbJiul}d0^NCSh(#7h=F;3{|>EU>h z6U8_p;^wK6mAB(1b92>5-HxJ~V}@3?G`&Qq-TbJ2(&~-HsH6F#8mFaAG(45eT3VPO zM|(Jd<+;UZs;w>0Qw}0>D%{~r{uo_Fl5_Bo3ABWi zWo^j^_T3dxG6J6fH8X)$a^%TJ#PU!=LxF=#Fd9EvKx_x>q<(KY%+y-08?kN9dXjXK z**Q=yt-FTU*13ouhCdqq-0&;Ke{T3sQU9IdzhV9LhQIpq*P{N)+}|Mh+a-VV=x?R} c>%+pvTcMWshj-umO}|qP?%A)*_KlqT3uEqhU;qFB literal 0 HcmV?d00001 diff --git a/modules/devguide/examples/rails-caching-example/public/icon.svg b/modules/devguide/examples/rails-caching-example/public/icon.svg new file mode 100644 index 0000000..78307cc --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/public/icon.svg @@ -0,0 +1,3 @@ + + + diff --git a/modules/devguide/examples/rails-caching-example/public/robots.txt b/modules/devguide/examples/rails-caching-example/public/robots.txt new file mode 100644 index 0000000..c19f78a --- /dev/null +++ b/modules/devguide/examples/rails-caching-example/public/robots.txt @@ -0,0 +1 @@ +# See https://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file diff --git a/modules/devguide/examples/rails-caching-example/storage/.keep b/modules/devguide/examples/rails-caching-example/storage/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/tmp/.keep b/modules/devguide/examples/rails-caching-example/tmp/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/tmp/pids/.keep b/modules/devguide/examples/rails-caching-example/tmp/pids/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/tmp/storage/.keep b/modules/devguide/examples/rails-caching-example/tmp/storage/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/devguide/examples/rails-caching-example/vendor/.keep b/modules/devguide/examples/rails-caching-example/vendor/.keep new file mode 100644 index 0000000..e69de29 diff --git a/modules/howtos/pages/caching-example.adoc b/modules/howtos/pages/caching-example.adoc index b5ac0e9..c76b6cb 100644 --- a/modules/howtos/pages/caching-example.adoc +++ b/modules/howtos/pages/caching-example.adoc @@ -7,7 +7,7 @@ This example demonstrates how to integrate Couchbase into a caching layer of the https://rubyonrails.org/[Rails] web-framework. -You can also find the https://github.com/couchbase/docs-sdk-ruby/blob/temp/3.5/modules/howtos/examples/rails-caching-example[full code for _this_ example here]. +You can also find the https://github.com/couchbase/docs-sdk-ruby/blob/temp/3.8/modules/devguide/examples/rails-caching-example[full code for _this_ example here]. == Configuration @@ -17,7 +17,7 @@ so to add it to the application you just need to update your `Gemfile`: [source,ruby] ---- -include::devguide:example$ruby/rails-caching-example/Gemfile[tag=add_dependency] +include::devguide:example$rails-caching-example/Gemfile[tag=add_dependency] ---- Do not forget to run `bundle install` to ensure that all dependencies have been satisfied. @@ -27,7 +27,7 @@ Corresponding configuration usually kept in the configuration environment file a [source,ruby] ---- -include::devguide:example$ruby/rails-caching-example/config/environments/development.rb[tag=cache_store_config] +include::devguide:example$rails-caching-example/config/environments/development.rb[tag=cache_store_config] ---- In this development example, we will try to discover cluster location and credentials in the environment variables, with a fallback to localhost and safe default. @@ -41,7 +41,7 @@ In this example, we cache the current time for the 3 seconds: [source,ruby] ---- -include::devguide:example$ruby/rails-caching-example/app/controllers/wall_clock_controller.rb[tag=cache_time_for_3_seconds] +include::devguide:example$rails-caching-example/app/controllers/wall_clock_controller.rb[tag=cache_time_for_3_seconds] ----