rails_vault 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16b77af3600aeafb69c0dd23616eaf08db0c397a9347593808a18ac8b08ed2ba
+  data.tar.gz: 96d839e3f8a44e8c492d095ae6f63a8ea7e7610c37558f3d73a833ffebda0f7d
+SHA512:
+  metadata.gz: fb0b5fb21469672cf72ac6b53d4a9fe542890b1a2a1c7334031c84c6159d0c45fdf91ef1a715d84ff6e3b4f5f49128524d67630212330dfe3eb35a1a24d1fe4e
+  data.tar.gz: e77570745a3feb5e56c2c6f79435177e7210742679fe48c4ad672ca1cd7cc46e4cb9640d9b0e1bd8d7272e2fbc82392be5bbc7bd86888fe101814e3038c5a94d

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_vault.gemspec
+gemspec
+
+group :development do
+  gem "standard"
+end
+
+group :development, :test do
+  gem "minitest"
+  gem "debug", "~> 1.9", ">= 1.9.2"
+end

data/Gemfile.lock

@@ -0,0 +1,246 @@
+PATH
+  remote: .
+  specs:
+    rails_vault (0.1.0)
+      rails (>= 7.2.2)
+      store_attribute (>= 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activejob (= 7.2.2.1)
+      activerecord (= 7.2.2.1)
+      activestorage (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      mail (>= 2.8.0)
+    actionmailer (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      actionview (= 7.2.2.1)
+      activejob (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      mail (>= 2.8.0)
+      rails-dom-testing (~> 2.2)
+    actionpack (7.2.2.1)
+      actionview (= 7.2.2.1)
+      activesupport (= 7.2.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.2.1)
+      actionpack (= 7.2.2.1)
+      activerecord (= 7.2.2.1)
+      activestorage (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.2.2.1)
+      activesupport (= 7.2.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.2.2.1)
+      activesupport (= 7.2.2.1)
+      globalid (>= 0.3.6)
+    activemodel (7.2.2.1)
+      activesupport (= 7.2.2.1)
+    activerecord (7.2.2.1)
+      activemodel (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      timeout (>= 0.4.0)
+    activestorage (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activejob (= 7.2.2.1)
+      activerecord (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      marcel (~> 1.0)
+    activesupport (7.2.2.1)
+      base64
+      benchmark (>= 0.3)
+      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)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    builder (3.3.0)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
+    crass (1.0.6)
+    date (3.4.1)
+    debug (1.10.0)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.1)
+    erubi (1.13.1)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    logger (1.6.6)
+    loofah (2.24.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)
+    mini_portile2 (2.8.8)
+    minitest (5.25.4)
+    net-imap (0.5.6)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.5.1)
+      net-protocol
+    nio4r (2.7.4)
+    nokogiri (1.18.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
+    psych (5.2.3)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.10)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rack-test (2.2.0)
+      rack (>= 1.3)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails (7.2.2.1)
+      actioncable (= 7.2.2.1)
+      actionmailbox (= 7.2.2.1)
+      actionmailer (= 7.2.2.1)
+      actionpack (= 7.2.2.1)
+      actiontext (= 7.2.2.1)
+      actionview (= 7.2.2.1)
+      activejob (= 7.2.2.1)
+      activemodel (= 7.2.2.1)
+      activerecord (= 7.2.2.1)
+      activestorage (= 7.2.2.1)
+      activesupport (= 7.2.2.1)
+      bundler (>= 1.15.0)
+      railties (= 7.2.2.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (7.2.2.1)
+      actionpack (= 7.2.2.1)
+      activesupport (= 7.2.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)
+    rdoc (6.12.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.10.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
+    rubocop (1.71.2)
+      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.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
+    standard (1.45.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.71.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.6)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.6.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.23.0)
+    store_attribute (2.0.0)
+      activerecord (>= 6.1)
+    stringio (3.1.3)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    useragent (0.16.11)
+    websocket-driver (0.7.7)
+      base64
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.18)
+
+PLATFORMS
+  arm64-darwin-23
+  x86_64-linux
+
+DEPENDENCIES
+  debug (~> 1.9, >= 1.9.2)
+  minitest
+  rails_vault!
+  standard
+
+BUNDLED WITH
+   2.3.3

data/README.md

@@ -0,0 +1,80 @@
+# rails_vault
+
+Simple and easy to add settings, preferences and so on to any model. See [an example](#usage).
+
+
+**Sponsored By [Rails Designer](https://railsdesigner.com/)**
+
+<a href="https://railsdesigner.com/" target="_blank">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/Rails-Designer/rails_vault/HEAD/.github/logo-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/Rails-Designer/rails_vault/HEAD/.github/logo-light.svg">
+    <img alt="Rails Designer" src="https://raw.githubusercontent.com/Rails-Designer/rails_vault/HEAD/.github/logo-light.svg" width="240" style="max-width: 100%;">
+  </picture>
+</a>
+
+
+## Installation
+
+```bash
+bundle add rails_vault
+rails generate rails_vault:install
+rails db:migrate
+```
+
+
+## Usage
+
+Generate a vault:
+```bash
+rails generate rails_vault:add MODEL::VAULT [field:type field:type]
+```
+
+Example:
+
+```bash
+rails generate rails_vault:add User::Preferences \
+  time_zone:string \
+  datetime_format:string \
+  hotkeys_disabled:boolean
+```
+
+This will:
+1. Create a vault class at **app/models/users/preferences.rb**
+2. Add `vault :preferences` to your User model
+
+### Define vault attributes
+
+```ruby
+class User::Preferences < RailsVault::Base
+  vault_attribute :time_zone, :string, default: "UTC"
+  vault_attribute :datetime_format, :string, default: "dd-mm-yyyy"
+  vault_attribute :hotkeys_disabled, :boolean, default: false
+end
+```
+
+### Read and write values
+
+```ruby
+user = User.first
+user.create_preferences # => User::Preferences Create (6.3ms)  INSERT INTO "rails_vaults" …
+user.preferences.time_zone # => "UTC"
+user.preferences.hotkeys_disabled? # => false
+
+user.preferences.update time_zone: "Amsterdam", hotkeys_disabled: true
+
+user.preferences.time_zone # => "Amsterdam"
+user.preferences.hotkeys_disabled? # => true
+```
+
+> **Note**: currently **rails_vault** is only tested against PostgreSQL, but PRs for improvements to other databases are appreciated.
+
+
+## Contributing
+
+This project uses [Standard](https://github.com/testdouble/standard) for formatting Ruby code. Please make sure to run `be standardrb` before submitting pull requests. Run tests via `rails test`.
+
+
+## License
+
+rails_vault is released under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails_vault"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/release

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+VERSION=$1
+
+if [ -z "$VERSION" ]; then
+  echo "Error: The version number is required."
+  echo "Usage: $0 <version-number>"
+  exit 1
+fi
+
+printf "module RailsVault\n  VERSION = \"$VERSION\"\nend\n" > ./lib/rails_vault/version.rb
+bundle
+git add Gemfile.lock lib/rails_vault/version.rb
+git commit -m "Bump version for $VERSION"
+git push
+git tag v$VERSION
+git push --tags
+gem build rails_vault.gemspec
+gem push "rails_vault-$VERSION.gem"

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/db/migrate/20241128150951_create_rails_vaults.rb

@@ -0,0 +1,23 @@
+class CreateRailsVaults < ActiveRecord::Migration[7.0]
+  def change
+    create_table :rails_vaults do |t|
+      t.belongs_to :resource, polymorphic: true, null: false
+      t.string :scope, null: false
+
+      if t.respond_to?(:jsonb)
+        t.jsonb :payload, null: false, default: {}
+      else
+        t.json :payload, null: false, default: {}
+      end
+
+      t.timestamps
+    end
+
+    add_index :rails_vaults, :scope
+    if connection.adapter_name.downcase == "postgresql"
+      add_index :rails_vaults, :payload, using: :gin
+    else
+      add_index :rails_vaults, :payload
+    end
+  end
+end

data/lib/generators/rails_vault/add_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails/generators/named_base"
+
+module RailsVault
+  module Generators
+    class AddGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      def create_vault_file
+        template "vault.rb", File.join("app/models", class_path, "#{file_name}.rb")
+      end
+
+      def inject_vault_into_model
+        parent_class = class_name.split("::").first
+
+        inject_into_class "app/models/#{class_path.join("/")}.rb", parent_class do
+          "  vault :#{plural_name}\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails_vault/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module RailsVault
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_migrations
+        rails_command "railties:install:migrations FROM=rails_vault", inline: true
+      end
+    end
+  end
+end

data/lib/generators/rails_vault/templates/vault.rb.tt

@@ -0,0 +1,5 @@
+class <%= class_name %> < RailsVault::Base
+<%- attributes.each do |attribute| -%>
+  vault_attribute :<%= attribute.name %>, :<%= attribute.type %>
+<%- end -%>
+end

data/lib/rails_vault/base.rb

@@ -0,0 +1,24 @@
+module RailsVault
+  class Base < ActiveRecord::Base
+    self.table_name = "rails_vaults"
+
+    belongs_to :resource, polymorphic: true
+
+    def self.inherited(subclass)
+      super
+      scope_name = subclass.name.demodulize.underscore
+
+      subclass.vault_scope(scope_name)
+    end
+
+    def self.vault_scope(scope_name)
+      default_scope { where(scope: scope_name) }
+    end
+
+    def self.vault_attribute(key, *attributes)
+      options = attributes.extract_options!
+
+      store_attribute :payload, key, *attributes, **options
+    end
+  end
+end

data/lib/rails_vault/engine.rb

@@ -0,0 +1,11 @@
+module RailsVault
+  class Engine < ::Rails::Engine
+    isolate_namespace RailsVault
+
+    initializer "rails_vault.active_record" do
+      ActiveSupport.on_load(:active_record) do
+        include RailsVault::Vaults
+      end
+    end
+  end
+end

data/lib/rails_vault/vaults.rb

@@ -0,0 +1,17 @@
+module RailsVault
+  module Vaults
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def vault(association_name, class_name: nil)
+        has_one association_name, as: :resource, class_name: class_name.presence || "#{self}::#{association_name.to_s.camelize}", dependent: :destroy
+      end
+
+      def vaults(*association_names)
+        association_names.each do |association_name|
+          has_one association_name, as: :resource, dependent: :destroy
+        end
+      end
+    end
+  end
+end

data/lib/rails_vault/version.rb

@@ -0,0 +1,3 @@
+module RailsVault
+  VERSION = "0.1.0"
+end

data/lib/rails_vault.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "store_attribute"
+require "rails_vault/version"
+require "rails_vault/engine"
+require "rails_vault/base"
+require "rails_vault/vaults"
+
+module RailsVault
+  class Error < StandardError; end
+end

data/rails_vault.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "lib/rails_vault/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rails_vault"
+  spec.version = RailsVault::VERSION
+  spec.authors = ["Rails Designer Developers"]
+  spec.email = ["devs@railsdesigner.com"]
+  spec.summary = "Simple and easy to add settings, preferences and so on to any model."
+  spec.description = "Rails Vault is a simple to use gem to add settings and preferences to ActiveRecord models. The settings are stored as JSON in a separate table."
+  spec.homepage = "https://railsdesigner.com/rails-vault/"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Rails-Designer/rails_vault/"
+
+  spec.files = Dir["{bin,app,config,db,lib,public}/**/*", "Rakefile", "README.md", "rails_vault.gemspec", "Gemfile", "Gemfile.lock"]
+
+  spec.required_ruby_version = ">= 3.1.0"
+  spec.add_dependency "rails", ">= 7.2.2"
+  spec.add_dependency "store_attribute", ">= 1.3"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rails_vault
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rails Designer Developers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.2
+- !ruby/object:Gem::Dependency
+  name: store_attribute
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Rails Vault is a simple to use gem to add settings and preferences to
+  ActiveRecord models. The settings are stored as JSON in a separate table.
+email:
+- devs@railsdesigner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/release
+- bin/setup
+- db/migrate/20241128150951_create_rails_vaults.rb
+- lib/generators/rails_vault/add_generator.rb
+- lib/generators/rails_vault/install_generator.rb
+- lib/generators/rails_vault/templates/vault.rb.tt
+- lib/rails_vault.rb
+- lib/rails_vault/base.rb
+- lib/rails_vault/engine.rb
+- lib/rails_vault/vaults.rb
+- lib/rails_vault/version.rb
+- rails_vault.gemspec
+homepage: https://railsdesigner.com/rails-vault/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://railsdesigner.com/rails-vault/
+  source_code_uri: https://github.com/Rails-Designer/rails_vault/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Simple and easy to add settings, preferences and so on to any model.
+test_files: []