base on Work with JSON-backed attributes as ActiveRecord-ish models # StoreModel [](https://rubygems.org/gems/store_model)  **StoreModel** gem allows you to wrap JSON-backed DB columns with ActiveModel-like classes. - 💪 **Powered with [Attributes API](https://api.rubyonrails.org/classes/ActiveRecord/Attributes/ClassMethods.html)**. You can use a number of familiar types or write your own - 🔧 **Works like ActiveModel**. Validations, enums and nested attributes work very similar to APIs provided by Rails - 1️⃣ **Follows single responsibility principle**. Keep the logic around the data stored in a JSON column separated from the model - 👷‍♂️ **Born in production**. ```ruby class Configuration include StoreModel::Model attribute :model, :string enum :status, %i[active archived], default: :active validates :model, :status, presence: true end class Product < ApplicationRecord attribute :configuration, Configuration.to_type end ``` You can support my open–source work [here](https://boosty.to/dmitry_tsepelev). ## Why should I wrap my JSON columns? Imagine that you have a model `Product` with a `jsonb` column called `configuration`. This is how you likely gonna work with this column: ```ruby product = Product.find(params[:id]) if product.configuration["model"] == "spaceship" product.configuration["color"] = "red" end product.save ``` This approach works fine when you don't have a lot of keys with logic around them and just read the data. However, when you start working with that data more intensively–you may find the code a bit verbose and error-prone. For instance, try to find a way to validate `:model` value to be required. Despite of the fact, that you'll have to write this validation by hand, it violates the single-responsibility principle: why parent model (`Product`) should know about the logic related to a child (`Configuration`)? > 📖 Read more about the motivation in the [Wrapping JSON-based ActiveRecord attributes with classes](https://evilmartians.com/chronicles/wrapping-json-based-active-record-attributes-with-classes) post ## Getting started Start with creating a class for representing the hash as an object: ```ruby class Configuration include StoreModel::Model attribute :model, :string attribute :color, :string end ``` Attributes should be defined using [Rails Attributes API](https://api.rubyonrails.org/classes/ActiveRecord/Attributes/ClassMethods.html). There is a number of types available out of the box, and you can always extend the type system. Register the field in the ActiveRecord model class: ```ruby class Product < ApplicationRecord attribute :configuration, Configuration.to_type end ``` When you're done, the initial snippet could be rewritten in the following way: ```ruby product = Product.find(params[:id]) if product.configuration.model == "spaceship" product.configuration.color = "red" end product.save ``` _Usage note: Rails and assigning Arrays/Hashes to records_ - Assigned attributes must be a String, Hash, Array of Hashes, or StoreModel. For example, if the attributes are coming from a controller, be sure to convert any ActionController::Parameters as needed. - Any changes made to a StoreModel instance requires the attribute be flagged as dirty, either by reassignment (`self.my_stored_models = my_stored_models.map(&:as_json)`) or by `will_change!` (`self.my_stored_models_will_change!`) - Mixing `StoreModel::NestedAttributes` into your model will allow you to use `accepts_nested_attributes_for` in the same way as ActiveRecord. ```ruby class Supplier < ActiveRecord::Base include StoreModel::NestedAttributes has_many :bicycles, dependent: :destroy attribute :products, Product.to_array_type accepts_nested_attributes_for :bicycles, :products, allow_destroy: true end ``` This will allow the form builders to work their magic: ```erb <%= form_with model: @supplier do |form| %> <%= form.fields_for :products do |product_fields| %> <%= product_fields.text_field :name %> <% end %> <% end %> ``` Resulting in: ```html <input type="text" name="supplier[products_attributes][0][name]" id="supplier_products_attributes_0_name"> ``` In the controller: ```ruby def create @supplier = Supplier.from_value(supplier_params) @supplier.save end private def supplier_params params.require(:supplier).permit(products_attributes: [:name]) end ``` ### ActiveAdmin Integration If you're using [ActiveAdmin](https://activeadmin.info/), enable compatibility mode to make the `has_many` form helper work with StoreModel attributes: ```ruby # config/initializers/store_model.rb StoreModel.config.active_admin_compatibility = true ``` Example usage: ```ruby # app/models/supplier.rb class Supplier include StoreModel::Model attribute :title, :string attribute :address, :string end # app/models/product.rb class Product < ApplicationRecord include StoreModel::NestedAttributes attribute :suppliers, Supplier.to_array_type accepts_nested_attributes_for :suppliers, allow_destroy: true end # app/admin/products.rb ActiveAdmin.register Product do permit_params suppliers_attributes: [:title, :address, :_destroy] form do |f| f.has_many :suppliers, allow_destroy: true do |s| s.input :title s.input :address end f.actions end end ``` ## Documentation 1. [Installation](./docs/installation.md) 2. `StoreModel::Model` API: * [Instantiation](./docs/instantiation.md) * [Validations](./docs/validations.md) * [Enums](./docs/enums.md) * [Nested models](./docs/nested_models.md) * [Unknown attributes](./docs/unknown_attributes.md) * [Empty attributes](./docs/empty_attributes.md) 3. [Array of stored models](./docs/array_of_stored_models.md) 4. [Hash of stored models](./docs/hash_of_stored_models.md) 5. [One of](./docs/one_of.md) 6. [Alternatives](./docs/alternatives.md) 7. [Defining custom types](./docs/defining_custom_types.md) 8. [Disabling Parent Tracking](./docs/enable_parent_assignment.md) ## Credits Initially sponsored by [Evil Martians](http://evilmartians.com). ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). ", Assign "at most 3 tags" to the expected json: {"id":"10815","tags":[]} "only from the tags list I provide: [{"id":39,"name":"3d-generation","display_name":"3D generation","slug":"3d-generation"},{"id":3,"name":"ai-agent","display_name":"AI agent","slug":"ai-agent"},{"id":8,"name":"ai-coding","display_name":"AI coding assistant","slug":"ai-coding"},{"id":5,"name":"ai-image","display_name":"AI image generation","slug":"ai-image"},{"id":9,"name":"ai-infrastructure","display_name":"AI infrastructure","slug":"ai-infrastructure"},{"id":10,"name":"ai-memory","display_name":"AI memory","slug":"ai-memory"},{"id":11,"name":"ai-skills","display_name":"AI skills","slug":"ai-skills"},{"id":12,"name":"ai-translation","display_name":"AI translation","slug":"ai-translation"},{"id":6,"name":"ai-video","display_name":"AI video generation","slug":"ai-video"},{"id":4,"name":"ai-voice","display_name":"AI voice","slug":"ai-voice"},{"id":7,"name":"ai-workflow","display_name":"AI workflow","slug":"ai-workflow"},{"id":22,"name":"audio-processing","display_name":"Audio processing","slug":"audio-processing"},{"id":29,"name":"authentication","display_name":"Authentication","slug":"authentication"},{"id":51,"name":"bundler","display_name":"Bundler","slug":"bundler"},{"id":41,"name":"chatbot","display_name":"Chatbot","slug":"chatbot"},{"id":27,"name":"cloud-native","display_name":"Cloud native","slug":"cloud-native"},{"id":1,"name":"computer-vision","display_name":"Computer vision","slug":"computer-vision"},{"id":37,"name":"crypto-trading","display_name":"Crypto trading","slug":"crypto-trading"},{"id":57,"name":"curated-list","display_name":"Curated list","slug":"curated-list"},{"id":54,"name":"data-streaming","display_name":"Data streaming","slug":"data-streaming"},{"id":35,"name":"data-visualization","display_name":"Data visualization","slug":"data-visualization"},{"id":16,"name":"database-backup","display_name":"Database backup","slug":"database-backup"},{"id":49,"name":"design-system","display_name":"Design system","slug":"design-system"},{"id":38,"name":"digital-human","display_name":"Digital human","slug":"digital-human"},{"id":34,"name":"document-processing","display_name":"Document processing","slug":"document-processing"},{"id":44,"name":"ecommerce","display_name":"E-commerce","slug":"ecommerce"},{"id":45,"name":"emulator","display_name":"Emulator","slug":"emulator"},{"id":46,"name":"file-management","display_name":"File management","slug":"file-management"},{"id":32,"name":"fintech","display_name":"Fintech","slug":"fintech"},{"id":31,"name":"game-development","display_name":"Game development","slug":"game-development"},{"id":24,"name":"headless-browser","display_name":"Headless browser","slug":"headless-browser"},{"id":52,"name":"headless-cms","display_name":"Headless CMS","slug":"headless-cms"},{"id":36,"name":"home-automation","display_name":"Home automation","slug":"home-automation"},{"id":20,"name":"image-editing","display_name":"Image editing","slug":"image-editing"},{"id":28,"name":"iot","display_name":"IoT","slug":"iot"},{"id":13,"name":"local-llm","display_name":"Local LLM","slug":"local-llm"},{"id":17,"name":"mcp","display_name":"MCP","slug":"mcp"},{"id":47,"name":"monitoring","display_name":"Monitoring","slug":"monitoring"},{"id":2,"name":"nlp","display_name":"NLP","slug":"nlp"},{"id":26,"name":"observability","display_name":"Observability","slug":"observability"},{"id":40,"name":"pentesting","display_name":"Pentesting","slug":"pentesting"},{"id":48,"name":"programming-examples","display_name":"Programming examples","slug":"programming-examples"},{"id":42,"name":"proxy","display_name":"Proxy","slug":"proxy"},{"id":14,"name":"rag","display_name":"RAG","slug":"rag"},{"id":56,"name":"resume-building","display_name":"Resume building","slug":"resume-building"},{"id":33,"name":"robotics","display_name":"Robotics","slug":"robotics"},{"id":30,"name":"search","display_name":"Search","slug":"search"},{"id":43,"name":"self-hosted","display_name":"Self-hosted","slug":"self-hosted"},{"id":50,"name":"static-analysis","display_name":"Static analysis","slug":"static-analysis"},{"id":18,"name":"synthetic-data","display_name":"Synthetic data","slug":"synthetic-data"},{"id":19,"name":"text-to-speech","display_name":"Text to speech","slug":"text-to-speech"},{"id":53,"name":"ui-components","display_name":"UI components","slug":"ui-components"},{"id":15,"name":"vector-database","display_name":"Vector database","slug":"vector-database"},{"id":21,"name":"video-editing","display_name":"Video editing","slug":"video-editing"},{"id":25,"name":"web-scraping","display_name":"Web scraping","slug":"web-scraping"},{"id":55,"name":"webassembly","display_name":"WebAssembly","slug":"webassembly"},{"id":23,"name":"workflow-automation","display_name":"Workflow automation","slug":"workflow-automation"}]" returns me the "expected json"