anchormodel 0.0.2 → 0.1.1

data/test/active_record_model/user_test.rb

@@ -0,0 +1,115 @@
+class UserTest < Minitest::Test
+  def setup; end
+
+  def teardown
+    User.destroy_all
+  end
+
+  def test_retrieval
+    assert_equal Role.find(:guest), Role.find('guest')
+  end
+
+  def test_collections
+    # Order must fit as well
+    assert_equal(
+      %i[guest moderator admin the_chosen_one].map { |key| Role.find(key) },
+      Role.all
+    )
+    assert_equal(
+      %i[en de fr it].map { |key| Locale.find(key) },
+      Locale.all
+    )
+  end
+
+  def test_missing_key
+    assert_raises { Role.find(:does_not_exist) }
+  end
+
+  def test_basic_setters_and_getters
+    u = User.create!(role: 'guest', locale: 'de') # String assignment
+    assert_equal Role.find(:guest), u.role
+    assert_equal Locale.find(:de), u.locale
+    u.update!(role: :admin, locale: Locale.find(:en)) # Symbol and Anchormodel assignemnt
+    assert_equal Role.find(:admin), u.role
+    assert_equal Locale.find(:en), u.locale
+  end
+
+  def test_comparison
+    bob = User.create(locale: :en)
+    alice = User.create(locale: :fr)
+    celine = User.create(locale: :fr)
+    assert_equal(alice.locale, celine.locale)
+    assert bob.locale != alice.locale
+  end
+
+  def test_attributes
+    # Standalone
+    assert_equal 0, Role.find(:guest).privilege_level
+    # With a model
+    u = User.create(role: :the_chosen_one)
+    assert_equal 42, u.role.privilege_level
+  end
+
+  def test_custom_comparison
+    assert_equal(-1, Role.find(:moderator) <=> Role.find(:admin))
+    assert_equal(1, Role.find(:moderator) <=> Role.find(:guest))
+    assert_equal(0, Role.find(:moderator) <=> Role.find(:moderator))
+    assert Role.find(:moderator) < Role.find(:admin)
+  end
+
+  def test_presence_validation
+    valentine = User.new
+    assert_raises(ActiveRecord::RecordInvalid) { valentine.save! }
+  end
+
+  def test_alternative_column_name
+    ben = User.create!(
+      role: Role.find(:moderator),
+      secondary_role: Role.find(:admin),
+      locale: Locale.find(:de)
+    )
+    assert_equal(Role.find(:moderator), ben.role)
+    assert_equal(Role.find(:admin), ben.secondary_role)
+    assert_equal(Locale.find(:de), ben.locale)
+  end
+
+  def test_optional_attribute
+    jenny = User.create!(role: :admin, locale: :en)
+    assert_nil jenny.secondary_role
+  end
+
+  def test_model_readers_and_writers
+    pia = User.new
+    pia.admin!
+    assert_equal true, pia.admin?
+    assert_equal false, pia.guest?
+    assert_equal Role.find(:admin), pia.role
+  end
+
+  def test_model_scopes
+    User.create!(role: :admin, locale: :en)
+    User.create!(role: :admin, locale: :en)
+    User.create!(role: :moderator, locale: :en)
+    assert_equal 2, User.admin.count
+    assert_equal 1, User.moderator.count
+    assert_equal 0, User.guest.count
+  end
+
+  def test_model_readers_writers_with_different_class_name
+    pia = User.new(locale: :en)
+    pia.de!
+    assert_equal true, pia.de?
+    assert_equal false, pia.fr?
+    assert_equal Locale.find(:de), pia.preferred_locale
+    assert_equal Locale.find(:en), pia.locale
+  end
+
+  def test_model_scopes_with_different_class_name
+    User.create!(role: :admin, locale: :en, preferred_locale: :de)
+    User.create!(role: :admin, locale: :en, preferred_locale: :de)
+    User.create!(role: :admin, locale: :en, preferred_locale: :fr)
+    assert_equal 2, User.de.count
+    assert_equal 1, User.fr.count
+    assert_equal 0, User.en.count
+  end
+end

data/test/dummy/.gitignore

@@ -0,0 +1,29 @@
+# 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
+
+
+/public/assets
+
+# Ignore master key for decrypting credentials and more.
+/config/master.key

data/test/dummy/Rakefile

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

data/test/dummy/app/anchormodels/locale.rb

@@ -0,0 +1,6 @@
+class Locale < Anchormodel
+  new :en
+  new :de
+  new :fr
+  new :it
+end

data/test/dummy/app/anchormodels/role.rb

@@ -0,0 +1,14 @@
+class Role < Anchormodel
+  include Comparable
+
+  attr_reader :privilege_level
+
+  new :guest, privilege_level: 0
+  new :moderator, privilege_level: 1
+  new :admin, privilege_level: 2
+  new :the_chosen_one, privilege_level: 42
+
+  def <=>(other)
+    @privilege_level <=> other.privilege_level
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

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

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,5 @@
+class ApplicationRecord < ActiveRecord::Base
+  include Anchormodel::ModelMixin
+
+  primary_abstract_class
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,6 @@
+class User < ApplicationRecord
+  belongs_to_anchormodel :role
+  belongs_to_anchormodel :secondary_role, Role, optional: true, model_readers: false, model_writers: false, model_scopes: false
+  belongs_to_anchormodel :locale, model_methods: false
+  belongs_to_anchormodel :preferred_locale, Locale
+end

data/test/dummy/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'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/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

data/test/dummy/config/application.rb

@@ -0,0 +1,37 @@
+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 Dummy
+  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")
+
+    # Don't generate system test files.
+    config.generators.system_tests = nil
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,3 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/test/dummy/config/credentials.yml.enc

@@ -0,0 +1 @@
+P7kFGwr6/RaXmQCebyeCrAyHgw+3lIjhK1w0ibCxdg5tKNHKbOq3EAC67l+QqSiww4eAKZ2ShT/dPBFXVNlYlwinxeap/Uu3ZulCjQdZT1GGnv8umlUsvznAe4FXJtBhEyKB60HRcTt/wwqDaz0uUeE1qQNpGbN4h7yQPlIPMMn+6XsBnY+32KYHhsZVwN92oQdR6hjwuethgN31HZtP+F97N3+HKbN9P/Nh778kOyZqZHdQygMWUuLM9ZoNOr8BsmUEonLGZB8stJThhu9sZQHGVafTXPMSw0P3cpPx/PfiU6rjQtOZGsc58e/i/VL6poF0Bd526VGaaHBCXj9rzb8HlgUWzCiJdBi52wVozf8ax9Fg/Rjx0NfVtryScyNvCQQaK/iRrPi3CWjOD0ldgjs7PkMTwvbO18i/--+VAjSXw8o2l4pFRL--EQZXxxTinNbA8IUp8M3i3w==

data/test/dummy/config/database.yml

@@ -0,0 +1,8 @@
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+test:
+  <<: *default
+  database: db/development.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,50 @@
+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
+
+  # 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

data/test/dummy/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

data/test/dummy/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 += %i[
+  passw secret token _key crypt salt certificate otp ssn
+]

data/test/dummy/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

data/test/dummy/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

data/test/dummy/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"

data/test/dummy/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

data/test/dummy/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

data/test/dummy/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

data/test/dummy/db/migrate/20230107173151_create_users.rb

@@ -0,0 +1,12 @@
+class CreateUsers < ActiveRecord::Migration[7.0]
+  def change
+    create_table :users do |t|
+      t.string :role
+      t.string :secondary_role
+      t.string :locale
+      t.string :preferred_locale, null: false, default: :en
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,23 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[7.0].define(version: 2023_01_24_084241) do
+  create_table "users", force: :cascade do |t|
+    t.string "role"
+    t.string "locale"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.string "secondary_role"
+    t.string "preferred_locale", default: "en", null: false
+  end
+
+end

data/test/dummy/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)

data/test/test_helper.rb

@@ -0,0 +1,21 @@
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= "#{File.dirname(__FILE__)}../../../test/dummy"
+
+require_relative '../test/dummy/config/environment'
+ActiveRecord::Migrator.migrations_paths = [File.expand_path('../test/dummy/db/migrate', __dir__)]
+require 'rails/test_help'
+
+# Filter out the backtrace from minitest while preserving the one from other libraries.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+require 'rails/test_unit/reporter'
+Rails::TestUnitReporter.executable = 'bin/test'
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path('fixtures', __dir__)
+  ActionDispatch::IntegrationTest.fixture_path = ActiveSupport::TestCase.fixture_path
+  ActiveSupport::TestCase.file_fixture_path = "#{ActiveSupport::TestCase.fixture_path}/files"
+  ActiveSupport::TestCase.fixtures :all
+end