diff --git a/.vscode/settings.json b/.vscode/settings.json index 29e82aa..3befe50 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -4,5 +4,6 @@ "Gemfile.lock": true, "docs": true, ".yardoc": true, + "examples": true, } } diff --git a/examples/rails/.gitattributes b/examples/rails/.gitattributes new file mode 100644 index 0000000..31eeee0 --- /dev/null +++ b/examples/rails/.gitattributes @@ -0,0 +1,7 @@ +# 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 diff --git a/examples/rails/.gitignore b/examples/rails/.gitignore new file mode 100644 index 0000000..c6186a4 --- /dev/null +++ b/examples/rails/.gitignore @@ -0,0 +1,37 @@ +# See https://help.github.com/articles/ignoring-files for more about ignoring files. +# +# If you find yourself ignoring temporary files generated by your text editor +# or operating system, you probably want to add a global ignore instead: +# git config --global core.excludesfile '~/.gitignore_global' + +# Ignore bundler config. +/.bundle + +# Ignore the default SQLite database. +/db/*.sqlite3 +/db/*.sqlite3-* + +# Ignore all logfiles and tempfiles. +/log/* +/tmp/* +!/log/.keep +!/tmp/.keep + +# Ignore pidfiles, but keep the directory. +/tmp/pids/* +!/tmp/pids/ +!/tmp/pids/.keep + +# Ignore uploaded files in development. +/storage/* +!/storage/.keep +/tmp/storage/* +!/tmp/storage/ +!/tmp/storage/.keep + +/public/assets + +# Ignore master key for decrypting credentials and more. +/config/master.key + +/config/credentials/production.key diff --git a/examples/rails/.vscode/settings.json b/examples/rails/.vscode/settings.json new file mode 100644 index 0000000..e920552 --- /dev/null +++ b/examples/rails/.vscode/settings.json @@ -0,0 +1,9 @@ +{ + "files.exclude": { + "Gemfile.lock": true, + "vendor": true, + "tmp": true, + "log": true, + "storage": true, + } +} \ No newline at end of file diff --git a/examples/rails/Gemfile b/examples/rails/Gemfile new file mode 100644 index 0000000..2673725 --- /dev/null +++ b/examples/rails/Gemfile @@ -0,0 +1,77 @@ +source "https://rubygems.org" +git_source(:github) { |repo| "https://github.com/#{repo}.git" } + +# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main" +gem "rails", "~> 7.0.3", ">= 7.0.3.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" + +# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails] +gem "importmap-rails" + +# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev] +gem "turbo-rails" + +# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev] +gem "stimulus-rails" + +# Build JSON APIs with ease [https://github.com/rails/jbuilder] +gem "jbuilder" + +# Use Redis adapter to run Action Cable in production +# gem "redis", "~> 4.0" + +# Use Kredis to get higher-level data types in Redis [https://github.com/rails/kredis] +# gem "kredis" + +# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword] +# gem "bcrypt", "~> 3.1.7" + +# Windows does not include zoneinfo files, so bundle the tzinfo-data gem +gem "tzinfo-data", platforms: %i[ mingw mswin x64_mingw jruby ] + +# Reduces boot times through caching; required in config/boot.rb +gem "bootsnap", require: false + +# Use Sass to process CSS +# gem "sassc-rails" + +# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images] +# gem "image_processing", "~> 1.2" + +group :development, :test do + # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem + gem "debug", platforms: %i[ mri mingw x64_mingw ] +end + +group :development do + # Use console on exceptions pages [https://github.com/rails/web-console] + gem "web-console" + + # Add speed badges [https://github.com/MiniProfiler/rack-mini-profiler] + # gem "rack-mini-profiler" + + # Speed up commands on slow machines / big apps [https://github.com/rails/spring] + # gem "spring" +end + +group :test do + # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing] + gem "capybara" + gem "selenium-webdriver" + gem "webdrivers" +end + +path "../.." do + gem "valued-client" + gem "valued-rails" +end +# Speed up concurrent-ruby with native extensions +gem "concurrent-ruby-ext", "~> 1.1" diff --git a/examples/rails/README.md b/examples/rails/README.md new file mode 100644 index 0000000..7db80e4 --- /dev/null +++ b/examples/rails/README.md @@ -0,0 +1,24 @@ +# README + +This README would normally document whatever steps are necessary to get the +application up and running. + +Things you may want to cover: + +* Ruby version + +* System dependencies + +* Configuration + +* Database creation + +* Database initialization + +* How to run the test suite + +* Services (job queues, cache servers, search engines, etc.) + +* Deployment instructions + +* ... diff --git a/examples/rails/Rakefile b/examples/rails/Rakefile new file mode 100644 index 0000000..9a5ea73 --- /dev/null +++ b/examples/rails/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/examples/rails/app/assets/config/manifest.js b/examples/rails/app/assets/config/manifest.js new file mode 100644 index 0000000..5918193 --- /dev/null +++ b/examples/rails/app/assets/config/manifest.js @@ -0,0 +1,2 @@ +//= link_tree ../images +//= link_directory ../stylesheets .css diff --git a/examples/rails/app/assets/images/.keep b/examples/rails/app/assets/images/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/app/assets/stylesheets/application.css b/examples/rails/app/assets/stylesheets/application.css new file mode 100644 index 0000000..288b9ab --- /dev/null +++ b/examples/rails/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/examples/rails/app/channels/application_cable/channel.rb b/examples/rails/app/channels/application_cable/channel.rb new file mode 100644 index 0000000..d672697 --- /dev/null +++ b/examples/rails/app/channels/application_cable/channel.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Channel < ActionCable::Channel::Base + end +end diff --git a/examples/rails/app/channels/application_cable/connection.rb b/examples/rails/app/channels/application_cable/connection.rb new file mode 100644 index 0000000..0ff5442 --- /dev/null +++ b/examples/rails/app/channels/application_cable/connection.rb @@ -0,0 +1,4 @@ +module ApplicationCable + class Connection < ActionCable::Connection::Base + end +end diff --git a/examples/rails/app/controllers/application_controller.rb b/examples/rails/app/controllers/application_controller.rb new file mode 100644 index 0000000..09705d1 --- /dev/null +++ b/examples/rails/app/controllers/application_controller.rb @@ -0,0 +1,2 @@ +class ApplicationController < ActionController::Base +end diff --git a/examples/rails/app/controllers/concerns/.keep b/examples/rails/app/controllers/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/app/helpers/application_helper.rb b/examples/rails/app/helpers/application_helper.rb new file mode 100644 index 0000000..de6be79 --- /dev/null +++ b/examples/rails/app/helpers/application_helper.rb @@ -0,0 +1,2 @@ +module ApplicationHelper +end diff --git a/examples/rails/app/jobs/application_job.rb b/examples/rails/app/jobs/application_job.rb new file mode 100644 index 0000000..d394c3d --- /dev/null +++ b/examples/rails/app/jobs/application_job.rb @@ -0,0 +1,7 @@ +class ApplicationJob < ActiveJob::Base + # Automatically retry jobs that encountered a deadlock + # retry_on ActiveRecord::Deadlocked + + # Most jobs are safe to ignore if the underlying records are no longer available + # discard_on ActiveJob::DeserializationError +end diff --git a/examples/rails/app/mailers/application_mailer.rb b/examples/rails/app/mailers/application_mailer.rb new file mode 100644 index 0000000..3c34c81 --- /dev/null +++ b/examples/rails/app/mailers/application_mailer.rb @@ -0,0 +1,4 @@ +class ApplicationMailer < ActionMailer::Base + default from: "from@example.com" + layout "mailer" +end diff --git a/examples/rails/app/models/application_record.rb b/examples/rails/app/models/application_record.rb new file mode 100644 index 0000000..b63caeb --- /dev/null +++ b/examples/rails/app/models/application_record.rb @@ -0,0 +1,3 @@ +class ApplicationRecord < ActiveRecord::Base + primary_abstract_class +end diff --git a/examples/rails/app/models/concerns/.keep b/examples/rails/app/models/concerns/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/app/views/layouts/application.html.erb b/examples/rails/app/views/layouts/application.html.erb new file mode 100644 index 0000000..8df9f19 --- /dev/null +++ b/examples/rails/app/views/layouts/application.html.erb @@ -0,0 +1,15 @@ + + + + MyApp + + <%= csrf_meta_tags %> + <%= csp_meta_tag %> + + <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %> + + + + <%= yield %> + + diff --git a/examples/rails/app/views/layouts/mailer.html.erb b/examples/rails/app/views/layouts/mailer.html.erb new file mode 100644 index 0000000..cbd34d2 --- /dev/null +++ b/examples/rails/app/views/layouts/mailer.html.erb @@ -0,0 +1,13 @@ + + + + + + + + + <%= yield %> + + diff --git a/examples/rails/app/views/layouts/mailer.text.erb b/examples/rails/app/views/layouts/mailer.text.erb new file mode 100644 index 0000000..37f0bdd --- /dev/null +++ b/examples/rails/app/views/layouts/mailer.text.erb @@ -0,0 +1 @@ +<%= yield %> diff --git a/examples/rails/bin/rails b/examples/rails/bin/rails new file mode 100755 index 0000000..efc0377 --- /dev/null +++ b/examples/rails/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/examples/rails/bin/rake b/examples/rails/bin/rake new file mode 100755 index 0000000..4fbf10b --- /dev/null +++ b/examples/rails/bin/rake @@ -0,0 +1,4 @@ +#!/usr/bin/env ruby +require_relative "../config/boot" +require "rake" +Rake.application.run diff --git a/examples/rails/bin/setup b/examples/rails/bin/setup new file mode 100755 index 0000000..ec47b79 --- /dev/null +++ b/examples/rails/bin/setup @@ -0,0 +1,33 @@ +#!/usr/bin/env ruby +require "fileutils" + +# path to your application root. +APP_ROOT = File.expand_path("..", __dir__) + +def system!(*args) + system(*args) || abort("\n== Command #{args} failed ==") +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" +end diff --git a/examples/rails/config.ru b/examples/rails/config.ru new file mode 100644 index 0000000..4a3c09a --- /dev/null +++ b/examples/rails/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/examples/rails/config/application.rb b/examples/rails/config/application.rb new file mode 100644 index 0000000..d2b927e --- /dev/null +++ b/examples/rails/config/application.rb @@ -0,0 +1,22 @@ +require_relative "boot" + +require "rails/all" + +# Require the gems listed in Gemfile, including any gems +# you've limited to :test, :development, or :production. +Bundler.require(*Rails.groups) + +module MyApp + class Application < Rails::Application + # Initialize configuration defaults for originally generated Rails version. + config.load_defaults 7.0 + + # 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") + end +end diff --git a/examples/rails/config/boot.rb b/examples/rails/config/boot.rb new file mode 100644 index 0000000..988a5dd --- /dev/null +++ b/examples/rails/config/boot.rb @@ -0,0 +1,4 @@ +ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__) + +require "bundler/setup" # Set up gems listed in the Gemfile. +require "bootsnap/setup" # Speed up boot time by caching expensive operations. diff --git a/examples/rails/config/cable.yml b/examples/rails/config/cable.yml new file mode 100644 index 0000000..b91d84c --- /dev/null +++ b/examples/rails/config/cable.yml @@ -0,0 +1,10 @@ +development: + adapter: async + +test: + adapter: test + +production: + adapter: redis + url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %> + channel_prefix: my_app_production diff --git a/examples/rails/config/credentials.yml.enc b/examples/rails/config/credentials.yml.enc new file mode 100644 index 0000000..566abf3 --- /dev/null +++ b/examples/rails/config/credentials.yml.enc @@ -0,0 +1 @@ +MTiBfZ2zwjrdlm4W+6kiJG9j6SySSzdXbugfoykLRMUklYzX6dwsbbW25yggsgI84rV0n5qEmADQGooM3rqlf2Gf9PcOxVeAoCkCp0vySG4z5jdLUctFzHxcqpHIco8R70Aj8O8lK0pcvCJADXHeRa51AyzSkzYr6et89ips+qL1ZNqbowp7rCQ5GQZVuo9H2bz5bgS8vSniw/X7oG39lWY5Bqqrlvu16NlA+d1Rm0ksk9YAlpC90OfzOT3tMBPzo/41jokN0bUEx8JgYjTlTiH2poHchHxOKitGgAspsRmu3ffAPL3uHTM1b9jSMxk9soU2V2Fgdocl2eqJgj75mE0y4p2WVwn/7pwt3PUGqvVs0qc1/iyHSXix7NzchvCuQAvroiB1z9SWej+DwWOC/M9twDbn9vZB5u96TQWNw4naHA==--opugrl0dov3rtiGW--SonBVZ5S3IUH7kz2tct+LA== \ No newline at end of file diff --git a/examples/rails/config/credentials/production.yml.enc b/examples/rails/config/credentials/production.yml.enc new file mode 100644 index 0000000..1d99ba8 --- /dev/null +++ b/examples/rails/config/credentials/production.yml.enc @@ -0,0 +1 @@ +URrIsGqcOOF8UqRLe/ozLXiEj3mqYrakCOMXzBSCJf2o5gJjIuigde9TXTPIOER5P0zk1qLkK4xLE3SiYGY8O827yUo=--NVp7gAATrxJC/9HR--/fVzACHVaM931YnPGjdOJg== \ No newline at end of file diff --git a/examples/rails/config/database.yml b/examples/rails/config/database.yml new file mode 100644 index 0000000..fcba57f --- /dev/null +++ b/examples/rails/config/database.yml @@ -0,0 +1,25 @@ +# 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: db/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: db/test.sqlite3 + +production: + <<: *default + database: db/production.sqlite3 diff --git a/examples/rails/config/environment.rb b/examples/rails/config/environment.rb new file mode 100644 index 0000000..cac5315 --- /dev/null +++ b/examples/rails/config/environment.rb @@ -0,0 +1,5 @@ +# Load the Rails application. +require_relative "application" + +# Initialize the Rails application. +Rails.application.initialize! diff --git a/examples/rails/config/environments/development.rb b/examples/rails/config/environments/development.rb new file mode 100644 index 0000000..8500f45 --- /dev/null +++ b/examples/rails/config/environments/development.rb @@ -0,0 +1,70 @@ +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.cache_classes = false + + # 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 + + config.cache_store = :memory_store + 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 + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Don't care if the mailer can't send. + config.action_mailer.raise_delivery_errors = false + + config.action_mailer.perform_caching = false + + # 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 + + # Uncomment if you wish to allow Action Cable access from any origin. + # config.action_cable.disable_request_forgery_protection = true +end diff --git a/examples/rails/config/environments/production.rb b/examples/rails/config/environments/production.rb new file mode 100644 index 0000000..19fa6cb --- /dev/null +++ b/examples/rails/config/environments/production.rb @@ -0,0 +1,93 @@ +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.cache_classes = true + + # 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 either ENV["RAILS_MASTER_KEY"] + # or in config/master.key. This key is used to decrypt credentials (and other encrypted files). + # config.require_master_key = true + + # Disable serving static files from the `/public` folder by default since + # Apache or NGINX already handles this. + config.public_file_server.enabled = ENV["RAILS_SERVE_STATIC_FILES"].present? + + # Compress CSS using a preprocessor. + # config.assets.css_compressor = :sass + + # Do not fallback 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 + + # Store uploaded files on the local file system (see config/storage.yml for options). + config.active_storage.service = :local + + # Mount Action Cable outside main process or domain. + # config.action_cable.mount_path = nil + # config.action_cable.url = "wss://example.com/cable" + # config.action_cable.allowed_request_origins = [ "http://example.com", /http:\/\/example.*/ ] + + # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies. + # config.force_ssl = true + + # Include generic and useful information about system operation, but avoid logging too much + # information to avoid inadvertent exposure of personally identifiable information (PII). + config.log_level = :info + + # Prepend all log lines with the following tags. + config.log_tags = [ :request_id ] + + # Use a different cache store in production. + # config.cache_store = :mem_cache_store + + # Use a real queuing backend for Active Job (and separate queues per environment). + # config.active_job.queue_adapter = :resque + # config.active_job.queue_name_prefix = "my_app_production" + + config.action_mailer.perform_caching = false + + # Ignore bad email addresses and do not raise email delivery errors. + # Set this to true and configure the email server for immediate delivery to raise delivery errors. + # config.action_mailer.raise_delivery_errors = false + + # 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 + + # Use default logging formatter so that PID and timestamp are not suppressed. + config.log_formatter = ::Logger::Formatter.new + + # Use a different logger for distributed setups. + # require "syslog/logger" + # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new "app-name") + + if ENV["RAILS_LOG_TO_STDOUT"].present? + logger = ActiveSupport::Logger.new(STDOUT) + logger.formatter = config.log_formatter + config.logger = ActiveSupport::TaggedLogging.new(logger) + end + + # Do not dump schema after migrations. + config.active_record.dump_schema_after_migration = false +end diff --git a/examples/rails/config/environments/test.rb b/examples/rails/config/environments/test.rb new file mode 100644 index 0000000..6ea4d1e --- /dev/null +++ b/examples/rails/config/environments/test.rb @@ -0,0 +1,60 @@ +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. + + # Turn false under Spring and add config.action_view.cache_template_loading = true. + config.cache_classes = true + + # Eager loading loads your whole application. When running a single test locally, + # this probably isn't necessary. It's a good idea to do in a continuous integration + # system, or in some way 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.enabled = true + 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 + + # Raise exceptions instead of rendering exception templates. + config.action_dispatch.show_exceptions = false + + # Disable request forgery protection in test environment. + config.action_controller.allow_forgery_protection = false + + # Store uploaded files on the local file system in a temporary directory. + config.active_storage.service = :test + + config.action_mailer.perform_caching = false + + # Tell Action Mailer not to deliver emails to the real world. + # The :test delivery method accumulates sent emails in the + # ActionMailer::Base.deliveries array. + config.action_mailer.delivery_method = :test + + # 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 +end diff --git a/examples/rails/config/initializers/assets.rb b/examples/rails/config/initializers/assets.rb new file mode 100644 index 0000000..2eeef96 --- /dev/null +++ b/examples/rails/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/examples/rails/config/initializers/content_security_policy.rb b/examples/rails/config/initializers/content_security_policy.rb new file mode 100644 index 0000000..54f47cf --- /dev/null +++ b/examples/rails/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 and inline scripts +# config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s } +# config.content_security_policy_nonce_directives = %w(script-src) +# +# # Report violations without enforcing the policy. +# # config.content_security_policy_report_only = true +# end diff --git a/examples/rails/config/initializers/filter_parameter_logging.rb b/examples/rails/config/initializers/filter_parameter_logging.rb new file mode 100644 index 0000000..adc6568 --- /dev/null +++ b/examples/rails/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 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, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn +] diff --git a/examples/rails/config/initializers/inflections.rb b/examples/rails/config/initializers/inflections.rb new file mode 100644 index 0000000..3860f65 --- /dev/null +++ b/examples/rails/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/examples/rails/config/initializers/permissions_policy.rb b/examples/rails/config/initializers/permissions_policy.rb new file mode 100644 index 0000000..00f64d7 --- /dev/null +++ b/examples/rails/config/initializers/permissions_policy.rb @@ -0,0 +1,11 @@ +# 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 |f| +# f.camera :none +# f.gyroscope :none +# f.microphone :none +# f.usb :none +# f.fullscreen :self +# f.payment :self, "https://secure.example.com" +# end diff --git a/examples/rails/config/initializers/valued.rb b/examples/rails/config/initializers/valued.rb new file mode 100644 index 0000000..bbebeaa --- /dev/null +++ b/examples/rails/config/initializers/valued.rb @@ -0,0 +1,46 @@ +# frozen_string_literal: true +require "valued/rails" + +Valued::Rails.setup do + # Set up the Valued connection for the prodcution environment. + # You can remove the condition if you want to use Valued in all environments. + # Note that Valued will still be disabled if you don't set at least one of #token, #client, or #backend. + connection :production do + # Tell valued-rails where to find your Valued API token. + # Accepts multiple values, which are tried in order. + # + # You can pass it as a string: + # token "my-token" + # + # You can pass a block: + # token { ENV["VALUED_TOKEN"] } + # + # Or you can pass one or more symbols: + # token :env + # + # With the following meaning: + # :env - The VALUED_TOKEN environment variable + # :config - From the environment section in the config/valued.yml file + # :credentials - From the valued section in the config/credentials.yml.enc or config/credentials/[env].yml.enc file + token :env, :credentials, :config + + # Configure the Valued API endpoint. + # + # You can pass it as a string or URI: + # endpoint "https://custom-valued.enterprise.com/events" + # + # You can pass a block: + # endpoint { ENV["VALUED_ENDPOINT"] } + # + # Or you can pass one or more symbols: + # endpoint :env + # + # With the following meaning: + # :env - The VALUED_ENDPOINT environment variable + # :config - From the environment section in the config/valued.yml file + # :credentials - From the valued section in the config/credentials.yml.enc or config/credentials/[env].yml.enc file + # :default - The default Valued endpoint + endpoint :env, :credentials, :config, :default + end + +end \ No newline at end of file diff --git a/examples/rails/config/locales/en.yml b/examples/rails/config/locales/en.yml new file mode 100644 index 0000000..8ca56fc --- /dev/null +++ b/examples/rails/config/locales/en.yml @@ -0,0 +1,33 @@ +# 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. +# +# The following keys must be escaped otherwise they will not be retrieved by +# the default I18n backend: +# +# true, false, on, off, yes, no +# +# Instead, surround them with single quotes. +# +# en: +# "true": "foo" +# +# To learn more, please read the Rails Internationalization guide +# available at https://guides.rubyonrails.org/i18n.html. + +en: + hello: "Hello world" diff --git a/examples/rails/config/puma.rb b/examples/rails/config/puma.rb new file mode 100644 index 0000000..daaf036 --- /dev/null +++ b/examples/rails/config/puma.rb @@ -0,0 +1,43 @@ +# Puma can serve each request in a thread from an internal thread pool. +# The `threads` method setting takes two numbers: a minimum and maximum. +# Any libraries that use thread pools should be configured to match +# the maximum value specified for Puma. Default is set to 5 threads for minimum +# and maximum; this matches the default thread size of Active Record. +# +max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 } +min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count } +threads min_threads_count, max_threads_count + +# Specifies the `worker_timeout` threshold that Puma will use to wait before +# terminating a worker in development environments. +# +worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development" + +# Specifies the `port` that Puma will listen on to receive requests; default is 3000. +# +port ENV.fetch("PORT") { 3000 } + +# Specifies the `environment` that Puma will run in. +# +environment ENV.fetch("RAILS_ENV") { "development" } + +# Specifies the `pidfile` that Puma will use. +pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" } + +# Specifies the number of `workers` to boot in clustered mode. +# Workers are forked web server processes. If using threads and workers together +# the concurrency of the application would be max `threads` * `workers`. +# Workers do not work on JRuby or Windows (both of which do not support +# processes). +# +# workers ENV.fetch("WEB_CONCURRENCY") { 2 } + +# Use the `preload_app!` method when specifying a `workers` number. +# This directive tells Puma to first boot the application and load code +# before forking the application. This takes advantage of Copy On Write +# process behavior so workers use less memory. +# +# preload_app! + +# Allow puma to be restarted by `bin/rails restart` command. +plugin :tmp_restart diff --git a/examples/rails/config/routes.rb b/examples/rails/config/routes.rb new file mode 100644 index 0000000..262ffd5 --- /dev/null +++ b/examples/rails/config/routes.rb @@ -0,0 +1,6 @@ +Rails.application.routes.draw do + # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html + + # Defines the root path route ("/") + # root "articles#index" +end diff --git a/examples/rails/config/storage.yml b/examples/rails/config/storage.yml new file mode 100644 index 0000000..4942ab6 --- /dev/null +++ b/examples/rails/config/storage.yml @@ -0,0 +1,34 @@ +test: + service: Disk + root: <%= Rails.root.join("tmp/storage") %> + +local: + service: Disk + root: <%= Rails.root.join("storage") %> + +# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key) +# amazon: +# service: S3 +# access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %> +# secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %> +# region: us-east-1 +# bucket: your_own_bucket-<%= Rails.env %> + +# Remember not to checkin your GCS keyfile to a repository +# google: +# service: GCS +# project: your_project +# credentials: <%= Rails.root.join("path/to/gcs.keyfile") %> +# bucket: your_own_bucket-<%= Rails.env %> + +# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key) +# microsoft: +# service: AzureStorage +# storage_account_name: your_account_name +# storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %> +# container: your_container_name-<%= Rails.env %> + +# mirror: +# service: Mirror +# primary: local +# mirrors: [ amazon, google, microsoft ] diff --git a/examples/rails/db/seeds.rb b/examples/rails/db/seeds.rb new file mode 100644 index 0000000..bc25fce --- /dev/null +++ b/examples/rails/db/seeds.rb @@ -0,0 +1,7 @@ +# This file should contain all the record creation needed to seed the database with its default values. +# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup). +# +# Examples: +# +# movies = Movie.create([{ name: "Star Wars" }, { name: "Lord of the Rings" }]) +# Character.create(name: "Luke", movie: movies.first) diff --git a/examples/rails/lib/assets/.keep b/examples/rails/lib/assets/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/lib/tasks/.keep b/examples/rails/lib/tasks/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/log/.keep b/examples/rails/log/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/public/404.html b/examples/rails/public/404.html new file mode 100644 index 0000000..2be3af2 --- /dev/null +++ b/examples/rails/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/examples/rails/public/422.html b/examples/rails/public/422.html new file mode 100644 index 0000000..c08eac0 --- /dev/null +++ b/examples/rails/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/examples/rails/public/500.html b/examples/rails/public/500.html new file mode 100644 index 0000000..78a030a --- /dev/null +++ b/examples/rails/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/examples/rails/public/apple-touch-icon-precomposed.png b/examples/rails/public/apple-touch-icon-precomposed.png new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/public/apple-touch-icon.png b/examples/rails/public/apple-touch-icon.png new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/public/favicon.ico b/examples/rails/public/favicon.ico new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/public/robots.txt b/examples/rails/public/robots.txt new file mode 100644 index 0000000..c19f78a --- /dev/null +++ b/examples/rails/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/examples/rails/storage/.keep b/examples/rails/storage/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/test/application_system_test_case.rb b/examples/rails/test/application_system_test_case.rb new file mode 100644 index 0000000..d19212a --- /dev/null +++ b/examples/rails/test/application_system_test_case.rb @@ -0,0 +1,5 @@ +require "test_helper" + +class ApplicationSystemTestCase < ActionDispatch::SystemTestCase + driven_by :selenium, using: :chrome, screen_size: [1400, 1400] +end diff --git a/examples/rails/test/channels/application_cable/connection_test.rb b/examples/rails/test/channels/application_cable/connection_test.rb new file mode 100644 index 0000000..800405f --- /dev/null +++ b/examples/rails/test/channels/application_cable/connection_test.rb @@ -0,0 +1,11 @@ +require "test_helper" + +class ApplicationCable::ConnectionTest < ActionCable::Connection::TestCase + # test "connects with cookies" do + # cookies.signed[:user_id] = 42 + # + # connect + # + # assert_equal connection.user_id, "42" + # end +end diff --git a/examples/rails/test/controllers/.keep b/examples/rails/test/controllers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/test/fixtures/files/.keep b/examples/rails/test/fixtures/files/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/test/helpers/.keep b/examples/rails/test/helpers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/test/integration/.keep b/examples/rails/test/integration/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/test/mailers/.keep b/examples/rails/test/mailers/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/test/models/.keep b/examples/rails/test/models/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/test/system/.keep b/examples/rails/test/system/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/test/test_helper.rb b/examples/rails/test/test_helper.rb new file mode 100644 index 0000000..d713e37 --- /dev/null +++ b/examples/rails/test/test_helper.rb @@ -0,0 +1,13 @@ +ENV["RAILS_ENV"] ||= "test" +require_relative "../config/environment" +require "rails/test_help" + +class ActiveSupport::TestCase + # Run tests in parallel with specified workers + parallelize(workers: :number_of_processors) + + # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order. + fixtures :all + + # Add more helper methods to be used by all tests here... +end diff --git a/examples/rails/tmp/.keep b/examples/rails/tmp/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/tmp/pids/.keep b/examples/rails/tmp/pids/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/tmp/storage/.keep b/examples/rails/tmp/storage/.keep new file mode 100644 index 0000000..e69de29 diff --git a/examples/rails/vendor/.keep b/examples/rails/vendor/.keep new file mode 100644 index 0000000..e69de29 diff --git a/valued-client/lib/valued-client.rb b/valued-client/lib/valued-client.rb new file mode 100644 index 0000000..aa8f851 --- /dev/null +++ b/valued-client/lib/valued-client.rb @@ -0,0 +1,3 @@ +# frozen_string_literal: true + +require "valued" diff --git a/valued-rails/README.md b/valued-rails/README.md new file mode 100644 index 0000000..d9a1e8e --- /dev/null +++ b/valued-rails/README.md @@ -0,0 +1,13 @@ +# Valued Rails plugin + +A Rails plugin for sending events to [Valued](https://valued.app). + +This library: +* Makes it easy to set up valued-client for your Rails project. +* Gives you tools to keep your event tracking logic separate from your business logic. +* Includes a generator to get you set up. +* Only depends on Rails itself and valued-client (which in turn only depends on concurrent-ruby, which Rails also depends on). +* Is well tested. +* Is considered thread-safe and compatible with all common concurrency models (multi-threading, forking, actors, event loops, etc). + +**Note:** This plugin isn't stricly necessary. You can use [valued-client](https://github.com/valued-app/valued.rb/tree/main/valued-client#readme) directly in your Rails application. This does leave separation of concern and setup up to you. \ No newline at end of file diff --git a/valued-rails/lib/generators/templates/initializer.rb b/valued-rails/lib/generators/templates/initializer.rb new file mode 100644 index 0000000..6700f33 --- /dev/null +++ b/valued-rails/lib/generators/templates/initializer.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true +require "valued/rails" + +Valued::Rails.setup do +<% if options["initializer"] == "long" -%> + # Set up the Valued connection for the prodcution environment. + # You can remove the condition if you want to use Valued in all environments. + # Note that Valued will still be disabled if you don't set at least one of #token, #client, or #backend. + connection :production do + # Tell valued-rails where to find your Valued API token. + # Accepts multiple values, which are tried in order. + # + # You can pass it as a string: + # token "my-token" + # + # You can pass a block: + # token { ENV["VALUED_TOKEN"] } + # + # Or you can pass one or more symbols: + # token :env + # + # With the following meaning: + # :env - The VALUED_TOKEN environment variable + # :config - From the environment section in the config/valued.yml file + # :credentials - From the valued section in the config/credentials.yml.enc or config/credentials/[env].yml.enc file + token :env, :credentials, :config + + # Configure the Valued API endpoint. + # + # You can pass it as a string or URI: + # endpoint "https://custom-valued.enterprise.com/events" + # + # You can pass a block: + # endpoint { ENV["VALUED_ENDPOINT"] } + # + # Or you can pass one or more symbols: + # endpoint :env + # + # With the following meaning: + # :env - The VALUED_ENDPOINT environment variable + # :config - From the environment section in the config/valued.yml file + # :credentials - From the valued section in the config/credentials.yml.enc or config/credentials/[env].yml.enc file + # :default - The default Valued endpoint + endpoint :env, :credentials, :config, :default + end +<% end %> +end \ No newline at end of file diff --git a/valued-rails/lib/generators/valued/install_generator.rb b/valued-rails/lib/generators/valued/install_generator.rb new file mode 100644 index 0000000..ce279f9 --- /dev/null +++ b/valued-rails/lib/generators/valued/install_generator.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +require "rails/generators/base" + +module Valued + module Generators + class InstallGenerator < ::Rails::Generators::Base + source_root File.expand_path("../templates", __dir__) + desc "Sets up Valued and creats an initializer." + + class_option :gemfile, type: :boolean, default: true, desc: "Add optional dependencies to the Gemfile" + class_option :initializer, type: :string, aliases: "-i", default: "short", desc: "Initializer type: short, long, or none" + + def install_dependencies + return unless options["gemfile"] + Bundler.gem "concurrent-ruby-ext" + rescue Gem::LoadError + return unless Gem.platforms.include? Gem::Platform::RUBY + gem "concurrent-ruby-ext", "~> 1.1", comment: "Speed up concurrent-ruby with native extensions" + end + + def create_initializer + return if options["initializer"] == "none" + template("initializer.rb", "config/initializers/valued.rb") + end + end + end +end \ No newline at end of file diff --git a/valued-rails/lib/valued-rails.rb b/valued-rails/lib/valued-rails.rb new file mode 100644 index 0000000..54a4ce3 --- /dev/null +++ b/valued-rails/lib/valued-rails.rb @@ -0,0 +1,12 @@ +# frozen_string_literal: true + +require "rails" +require "zeitwerk" + +loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false) +loader.inflector.inflect("valued-rails" => "Valued", "dsl" => "DSL") +loader.ignore("#{__dir__}/generators") +loader.setup + +require "valued" +require "valued/rails/railtie" \ No newline at end of file diff --git a/valued-rails/lib/valued/rails.rb b/valued-rails/lib/valued/rails.rb new file mode 100644 index 0000000..babf0aa --- /dev/null +++ b/valued-rails/lib/valued/rails.rb @@ -0,0 +1,6 @@ +# frozen_string_literal: true + +module Valued::Rails + def self.setup(&block) = Setup.run(&block) + def self.setup? = defined?(@setup) && !!@setup +end \ No newline at end of file diff --git a/valued-rails/lib/valued/rails/dsl.rb b/valued-rails/lib/valued/rails/dsl.rb new file mode 100644 index 0000000..43574f0 --- /dev/null +++ b/valued-rails/lib/valued/rails/dsl.rb @@ -0,0 +1,44 @@ +# frozen_string_literal: true + +module Valued::Rails + class DSL < BasicObject + def self.run(object, block) + return object unless block and object + if block.arity == 0 + instance = new + instance.instance_eval { @object = object } + instance.instance_eval(&block) + else + block.call(object) + end + object + end + + private + + def accepts_block?(name) + @accepts_block ||= {} + @accepts_block.fetch(name) do + @accepts_block[name] = + @object.respond_to?(name) && + @object.method(name).parameters.any? { _1[0] == :block } + end + end + + def method_for(method, arguments, block) + return method if method.end_with? "=" or method.end_with? "?" + return "#{method}=" if arguments.any? and @object.respond_to?("#{method}=") + method + end + + def method_missing(method, *arguments, &block) + return super if method.start_with? '_' or method == :initialize + method = method_for(method, arguments, block) + if accepts_block?(method) or !block + @object.public_send(method, *arguments, &block) + else + DSL.run(@object.public_send(method, *arguments), block) + end + end + end +end \ No newline at end of file diff --git a/valued-rails/lib/valued/rails/middleware.rb b/valued-rails/lib/valued/rails/middleware.rb new file mode 100644 index 0000000..f4d6369 --- /dev/null +++ b/valued-rails/lib/valued/rails/middleware.rb @@ -0,0 +1,17 @@ +# frozen_string_literal: true + +module Valued::Rails + class Middleware + def initialize(app) = @app = app + + def call(env) + return @app.call(env) unless client = Setup.client + Valued.connect(client) unless Valued.connected? and Valued.client == client + Valued.scope do |scope| + env["valued.client"] = client + env["valued.scope"] = scope + @app.call(env) + end + end + end +end \ No newline at end of file diff --git a/valued-rails/lib/valued/rails/process_action.rb b/valued-rails/lib/valued/rails/process_action.rb new file mode 100644 index 0000000..7231238 --- /dev/null +++ b/valued-rails/lib/valued/rails/process_action.rb @@ -0,0 +1,96 @@ +# frozen_string_literal: true + +module Valued::Rails + class ProcessAction + # Called by ActiveSupport::Notifications when a process_action.action_controller event is published. + # @api private + def self.call(name, start, finish, id, payload) + return unless name == "process_action.action_controller" + Valued::Rails.process_action(new(start: start, finish: finish, **payload)) + end + + # @return [Time] the time the controller action started + attr_reader :start + + # @return [Time] the time the controller action finished + attr_reader :finish + + # @return [String] the controller class name + attr_reader :controller + + # @return [String] the controller action name + attr_reader :action + + # @return [Hash] the controller action parameters without any filtered parameter + attr_reader :params + + # @return [ActionDispatch::Http::Headers] the request headers + attr_reader :headers + + # @return [Symbol] the response format (:html, :json, :xml, etc.) + attr_reader :format + + # @return [String] the controller action method ("GET", "POST", etc.) + attr_reader :method + + # @return [String] the controller action path + attr_reader :path + + # @return [ActionDispatch::Request] the request object + attr_reader :request + + # @return [ActionDispatch::Response] the response object + attr_reader :response + + # @return [Integer] the response status code + attr_reader :status + + # @api private + def initialize(start:, finish:, controller:, action:, params:, headers:, format:, method:, path:, request:, response:, status:) + @start = start + @finish = finish + @controller = controller + @action = action + @params = params + @headers = headers + @format = format + @method = method + @path = path + @request = request + @response = response + @status = status + end + + # @return [ActionDispatch::Session::AbstractSecureStore] the session object + def session = request.session + + # @return [Warden::Proxy, nil] the warden object if Warden/Devise is set up + def warden = request.env['warden'] + + # @return [Object, nil] the current user if Warden/Devise is set up and the user is authenticated + # @todo Needs to be overridable with custom logic. + def user = @user ||= find_user + + # @return [true, false] whether {#user} is set + def user? = !!user + + # @return [Object, nil] Currently active customer if available. + # @todo Needs to be overridable with custom logic. + def customer = @customer ||= find_customer + + private + + def find_user + return unless warden + warden.user(:user) || warden.user + end + + def find_customer + return ActsAsTenant.current_tenant if defined? ActsAsTenant and ActsAsTenant.current_tenant + return unless user + return user.customer if user.respond_to? :customer + return user.organization if user.respond_to? :organization + return user.account if user.respond_to? :account + end + end +end \ No newline at end of file diff --git a/valued-rails/lib/valued/rails/railtie.rb b/valued-rails/lib/valued/rails/railtie.rb new file mode 100644 index 0000000..4cc556e --- /dev/null +++ b/valued-rails/lib/valued/rails/railtie.rb @@ -0,0 +1,10 @@ +# frozen_string_literal: true + +module Valued::Rails + class Railtie < ::Rails::Railtie + initializer "valued.initialize" do |app| + ActiveSupport::Notifications.subscribe "process_action.action_controller", ProcessAction + app.middleware.use Middleware + end + end +end \ No newline at end of file diff --git a/valued-rails/lib/valued/rails/setup.rb b/valued-rails/lib/valued/rails/setup.rb new file mode 100644 index 0000000..2b5707e --- /dev/null +++ b/valued-rails/lib/valued/rails/setup.rb @@ -0,0 +1,28 @@ +# frozen_string_literal: true + +module Valued::Rails::Setup + # @!attribute [r] main + # @return [Main] The main setup object. + # @api private + def self.main = @main ||= Main.new + + # Executes the given block via the {DSL} wrapper. + # @see Valued::Rails.setup + # @return [Main] The main setup object. + def self.run(&block) + Valued::Rails::DSL.run(main, block) + connect + main + end + + # @return [true, false] + # @api private + def self.connect + Valued.connect(main.connection.client) if main.connection.client? + Valued.connected? + end + + # @return [Valued::Client, nil] + # @api private + def self.client = main.connection.client +end \ No newline at end of file diff --git a/valued-rails/lib/valued/rails/setup/connection.rb b/valued-rails/lib/valued/rails/setup/connection.rb new file mode 100644 index 0000000..0a73ee1 --- /dev/null +++ b/valued-rails/lib/valued/rails/setup/connection.rb @@ -0,0 +1,140 @@ +# frozen_string_literal: true + +module Valued::Rails::Setup + class Connection + DEFAULTS = { + endpoint: Valued::Connection::DEFAULT_ENDPOINT + } + + EXECUTORS = { + single_thread: Concurrent::SingleThreadExecutor, + cached_thread_pool: Concurrent::CachedThreadPool, + thread_pool: Concurrent::ThreadPoolExecutor, + immediate: Concurrent::ImmediateExecutor, + } + + DEFAULT_LOOKUP = [:env, :credentials, :config, :default] + + private_constant :DEFAULTS, :EXECUTORS, :DEFAULT_LOOKUP + + # @api private + def initialize + @client = nil + @explicit_client = false + @options = {} + end + + # @!attribute [rw] token + def token = get(:token) + def token=(*value, &block) + set(:token, [block, *value]) + end + + # @return [true, false] Whether the token is set. + def token? = !!token + + # @!attribute [rw] endpoint + def endpoint = get(:endpoint) + def endpoint=(*value, &block) + set(:endpoint, [block, *value]) + end + + # @return [true, false] Whether the endpoint is set. + def endpoint? = !!endpoint + + # @!attribute [rw] executor + def executor = Valued::Connection.executor + def executor=(*args) + executor, *args = args.flatten + was = executor + + case executor + when Symbol then executor = EXECUTORS.fetch(executor) { raise ArgumentError, "unknown executor: #{executor}" } + when Hash then executor, args = executor.delete(:mode), [args, executor] + when String then executor = executor.to_sym + when Class then executor = executor.new(*args) + end + + return self.executor = [executor, args] unless was == executor + raise ArgumentError, "Invalid executor: #{executor.inspect}" if executor and !executor.respond_to?(:post) + Valued::Connection.executor = executor + end + + # @!attribute [rw] backend + attr_reader :backend + def backend=(value = nil, &block) + if value ||= block + raise RuntimeError, "Cannot set #{key} when explicitly setting a client" if explicit_client? + raise ArgumentError, "Invalid backend: #{value.inspect}" unless value.respond_to?(:call) + @backend = value + else + @backend = nil + end + @client = nil + end + + # @return [true, false] Whether the backend is set. + def backend? = !!@backend + + # @!attribute [rw] client + # @return [Valued::Client] + def client + @client ||= if token? or backend? + case backend + when nil then Valued::Client.new(token, endpoint) + when Proc then Valued::Client.new(Valued::Connection.new(token, endpoint), &backend) + else Valued::Client.new(backend) + end + elsif Valued.connected? + Valued.client + end + end + + def client=(value) + if value + raise RuntimeError, "Cannot set client when explicitly setting a backend" if backend + raise RuntimeError, "Cannot set client when explicitly setting #{@options.compact.keys.first}" if @options.compact.any? + @explicit_client = true + @client = Valued::Client.new(value) + else + @explicit_client = false + @client = nil + end + end + + # @return [true, false] Whether a client can be created from the current options. + def client? = !!client + + # @return [true, false] Whether the client was explicitly set. + def explicit_client? = @explicit_client + + private + + def get(key) = @options.fetch(key) { @options[key] = find(key, DEFAULT_LOOKUP) } + + def set(key, value) + raise RuntimeError, "Cannot set #{key} when explicitly setting a client" if explicit_client? + @options[key] = find(key, value) + @client = nil + end + + def find(key, value) + case value + when Array then find(key, value.map { find(key, _1) }.compact.first) + when Proc then find(key, value.call) + when :env then find(key, ENV["VALUED_#{key.upcase}"]) + when :config then find(key, config[key]) + when :credentials then Rails.application.credentials.dig(:valued, key) + when :default then DEFAULTS[key] + else value.presence + end + end + + def config + @config ||= Rails.application.config_for(:valued) + rescue RuntimeError => error + raise error unless error.message.include? "Could not load configuration. No such file" + @config = {} + end + end +end \ No newline at end of file diff --git a/valued-rails/lib/valued/rails/setup/main.rb b/valued-rails/lib/valued/rails/setup/main.rb new file mode 100644 index 0000000..3ae9091 --- /dev/null +++ b/valued-rails/lib/valued/rails/setup/main.rb @@ -0,0 +1,24 @@ +# frozen_string_literal: true + +module Valued::Rails::Setup + class Main + # @return [Valued::Rails::Setup::Connection] + def connection(*conditions) + return unless check_conditions(conditions) + @connection ||= Connection.new + end + + private + + def check_conditions(condition) + case condition + when true, false then condition + when Proc then check_conditions(condition.call) + when Symbol then check_conditions(condition.name) + when String then Rails.env == condition + when Array then condition.empty? or condition.any? { check_conditions(_1) } + else raise ArgumentError, "Unknown condition: #{condition.inspect}" + end + end + end +end \ No newline at end of file diff --git a/valued-rails/valued-rails.gemspec b/valued-rails/valued-rails.gemspec index 39a37ae..31ae10d 100644 --- a/valued-rails/valued-rails.gemspec +++ b/valued-rails/valued-rails.gemspec @@ -2,4 +2,5 @@ require_relative "../lib/gemspec" Gemspec.new do |spec| spec.summary = "Rails plugin for event tracking with Valued" + spec.add_dependency "rails", "~> 7.0" end