anchormodel 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 393936de0294a0c3ee8d3096a38c365bce1843b4812e670034ac9037cdd61453
-  data.tar.gz: 130e1ae1bdf5fd50dcc1c27d9c0fd7e1b81e2923088f2bf0c81ef4d7e57ccfc6
+  metadata.gz: 0f7343b6009976e35fa3354eeabe119ad354dd4f103af1d1440251cf178de989
+  data.tar.gz: b971498fc5b0028c2f43994130abf55b6edfb9be0a327113e5cf099911c5ed78
 SHA512:
-  metadata.gz: 2a9b9e0a451d772fb0c54ae36c9f437b8aab77a74eae058f381b65ba01cc62719ec0adbd5e56b674585bc5071aa239e74e1e540591a3b70bd308c66ec8bd54da
-  data.tar.gz: f5f5326a0a77605c3a3b5b1e7139e24f5de82b4acb91d59a0624ae3965db0c2dc5dd0b0a0458b96b727bb7560a1495928ea7664b16b432427665449998eaf910
+  metadata.gz: a3a0b3e80ea3fa4fdec3fa3ade5ce8536a0e8ff00f17019a291646bc307ec6a84a8c5b12c6e247c8bfad51d6bf80df1bec3114ea9edf9b208537c5db28a1a523
+  data.tar.gz: 14af2506a7729e82c7ed664c61a0523e7dcf2e2595c83078986b6a8d590013dcb543b8e6d641f0b742dc23a9f785cd3585286e5066fb10a6a74dc463cd67ac35

data/.gitignore

@@ -1,2 +1,3 @@
 .rubocop.yml
-.yardoc
+.yardoc
+/pkg/*

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.2.0 (27.04.2024)
+
+- Add support for multiple anchormodels (`belongs_to_anchormodels`)
+- Implement YourAnchormodelclass.form_collection
+
+# 0.1.5 (24.04.2024)
+
+- Enhance documentation
+- Add support for simple_form
+
 # 0.1.4 (23.04.2024)
 
 - Stick closer to the Rails API of Value

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    anchormodel (0.1.4.edge)
+    anchormodel (0.1.6.edge)
       rails (~> 7.0)
 
 GEM

data/README.md

@@ -35,7 +35,7 @@ are regular classes and can easily be extended.
 
 ### ActiveEnum
 
-The gem (ActiveEnum)[https://github.com/adzap/active_enum] allows to create
+The gem [ActiveEnum](https://github.com/adzap/active_enum) allows to create
 Enum-like classes that can be extended. However it only supports Integer keys. I
 find this unsatisfactory, as debugging with tools like `psql` or `mysql` is made
 unnecessarily hard when you only see numbers. Keys for enums should be
@@ -116,6 +116,41 @@ puts("User #{@user.name} has role #{@user.role.label}")
 @user.role.admin? # true if and only if the role is admin (false otherwise)
 ```
 
+Your form could look something like this:
+
+```erb
+<%= form_with(model: user) do |form| %>
+  <%# ... %>
+  <%= form.collection_select :role, Role.all, :key, :label %>
+  <%# ... %>
+<% end %>
+```
+
+## Using Anchormodel with Simpleform
+
+Anchormodel has built-in support for the [simple_form](https://github.com/heartcombo/simple_form) gem by providing an input for the type `:anchormodel` which displays anchormodel attributes as a collection select.
+
+After SimpleForm is installed, you can write your form as:
+
+```erb
+<%= simple_form_for user do |f| %>
+  <%# ... %>
+  <%= f.input :role %>
+  <%# ... %>
+<% end %>
+```
+
+Or, if you prefer radio buttons instead:
+
+
+```erb
+<%= simple_form_for user do |f| %>
+  <%# ... %>
+  <%= f.input :role, as: :anchormodel_radio_buttons %>
+  <%# ... %>
+<% end %>
+```
+
 # Rails Enum style model methods
 
 By default, Anchormodel adds three kinds of methods for each key to the model:
@@ -188,6 +223,82 @@ If you want to have multiple attributes in the same model pointing to the same A
 
 ```ruby
 # app/models/user.rb
-  belongs_to_anchormodel :role
-  belongs_to_anchormodel :secondary_role, Role, model_methods: false
+belongs_to_anchormodel :role
+belongs_to_anchormodel :secondary_role, Role, model_methods: false
+```
+
+# Attaching multiple Anchormodels to an attribute (similar to a has_many collection)
+
+Collections of Anchormodels are supported. Assuming that your `User` can have multiple `Role` anchormodels, your code can look as follows:
+
+```ruby
+# app/models/user.rb
+belongs_to_anchormodels :roles
+```
+
+The method is deliberately called `belongs_to...` and not `has_many...` in order to indicate that the key is stored in a column of the model in which you are calling it. The rule of thumb for using a collection of Anchormodels is:
+
+- Your column should be of type `string`, just like with the singular `belongs_to_anchormodel`.
+- Anchormodels will be stored in string form, separated by the `,` character
+- When reading the attribute, you will get a `Set`, thus duplicates are avoided.
+
+Example usage for a User model with multiple roles as shown above:
+
+```ruby
+u = User.first
+u.roles = %i[moderator admin] # this will replace the user's roles by the two specified
+u.roles # this will return a set of two Role Anchormodel instances, moderator and role
+u.guest! # this will add the role `guest` to the user's roles
+u.guest? # this will query whether the role `guest` is part of the user's roles
+User.moderator # This will return all users that have the moderator role as part of their roles
+```
+
+For modifying a collection of Anchormodels, the following methods are implemented, the first three accepting a String, Symbol or Anchormodel:
+
+```ruby
+u.roles.add(:moderator) # same as u.moderator!
+u.roles << :moderator # alias of add
+u.roles.delete(:moderator)
+u.roles.clear
+```
+
+Note that no other methods of Set are overwritten at this point - if you use any other methods mutating the underlying Set, your changes will not be applied.
+
+## Basic rails form for a collection of Anchormodels
+
+```erb
+<%= form_with(model: user) do |form| %>
+  <%# ... %>
+  <%= form.collection_select :role, Role.all, :key, :label, multiple: true %>
+  <%# ... %>
+<% end %>
+```
+
+If you get an error due to unpermitted params, make sure, you are allowing array-style parameters: `params.require(:user).permit(roles: [])`
+
+## SimpleForm for a collection of Anchormodels
+
+Anchormodel's [simple_form](https://github.com/heartcombo/simple_form) support also includes collections of Anchormodels.
+
+Just like in the single Anchormodel implementation, a select input can be provided with:
+
+```erb
+<%= simple_form_for user do |f| %>
+  <%# ... %>
+  <%= f.input :role %>
+  <%# ... %>
+<% end %>
+```
+
+The input figures out automatically that it is operating on a collection, so the form code is the same as for a single Anchormodel.
+
+However, radio buttons are unsuitable for collections, so use check boxes instead:
+
+
+```erb
+<%= simple_form_for user do |f| %>
+  <%# ... %>
+  <%= f.input :role, as: :anchormodel_check_boxes %>
+  <%# ... %>
+<% end %>
 ```

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/anchormodel.gemspec

@@ -2,21 +2,21 @@
 # This file is auto-generated via: 'rake gemspec'.
 
 # -*- encoding: utf-8 -*-
-# stub: anchormodel 0.1.4 ruby lib
+# stub: anchormodel 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "anchormodel".freeze
-  s.version = "0.1.4".freeze
+  s.version = "0.2.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sandro Kalbermatter".freeze]
-  s.date = "2024-04-23"
-  s.files = [".gitignore".freeze, ".ruby-version".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "Gemfile.lock".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "anchormodel.gemspec".freeze, "bin/rails".freeze, "doc/Anchormodel.html".freeze, "doc/Anchormodel/ActiveModelTypeValue.html".freeze, "doc/Anchormodel/Attribute.html".freeze, "doc/Anchormodel/ModelMixin.html".freeze, "doc/Anchormodel/Version.html".freeze, "doc/_index.html".freeze, "doc/class_list.html".freeze, "doc/css/common.css".freeze, "doc/css/full_list.css".freeze, "doc/css/style.css".freeze, "doc/file.README.html".freeze, "doc/file_list.html".freeze, "doc/frames.html".freeze, "doc/index.html".freeze, "doc/js/app.js".freeze, "doc/js/full_list.js".freeze, "doc/js/jquery.js".freeze, "doc/method_list.html".freeze, "doc/top-level-namespace.html".freeze, "lib/anchormodel.rb".freeze, "lib/anchormodel/active_model_type_value_single.rb".freeze, "lib/anchormodel/attribute.rb".freeze, "lib/anchormodel/model_mixin.rb".freeze, "lib/anchormodel/util.rb".freeze, "lib/anchormodel/version.rb".freeze, "lib/generators/anchormodel/USAGE".freeze, "lib/generators/anchormodel/anchormodel_generator.rb".freeze, "lib/generators/anchormodel/templates/anchormodel.rb.erb".freeze, "logo.svg".freeze, "pkg/anchormodel-0.1.3.gem".freeze, "test/active_record_model/user_test.rb".freeze, "test/dummy/.gitignore".freeze, "test/dummy/Rakefile".freeze, "test/dummy/app/anchormodels/locale.rb".freeze, "test/dummy/app/anchormodels/role.rb".freeze, "test/dummy/app/helpers/application_helper.rb".freeze, "test/dummy/app/models/application_record.rb".freeze, "test/dummy/app/models/concerns/.keep".freeze, "test/dummy/app/models/user.rb".freeze, "test/dummy/bin/rails".freeze, "test/dummy/bin/rake".freeze, "test/dummy/bin/setup".freeze, "test/dummy/config.ru".freeze, "test/dummy/config/application.rb".freeze, "test/dummy/config/boot.rb".freeze, "test/dummy/config/credentials.yml.enc".freeze, "test/dummy/config/database.yml".freeze, "test/dummy/config/environment.rb".freeze, "test/dummy/config/environments/test.rb".freeze, "test/dummy/config/initializers/content_security_policy.rb".freeze, "test/dummy/config/initializers/filter_parameter_logging.rb".freeze, "test/dummy/config/initializers/inflections.rb".freeze, "test/dummy/config/initializers/permissions_policy.rb".freeze, "test/dummy/config/locales/en.yml".freeze, "test/dummy/config/puma.rb".freeze, "test/dummy/config/routes.rb".freeze, "test/dummy/db/migrate/20230107173151_create_users.rb".freeze, "test/dummy/db/schema.rb".freeze, "test/dummy/db/seeds.rb".freeze, "test/dummy/lib/tasks/.keep".freeze, "test/dummy/log/.keep".freeze, "test/dummy/tmp/.keep".freeze, "test/dummy/tmp/pids/.keep".freeze, "test/test_helper.rb".freeze]
+  s.date = "2024-04-27"
+  s.files = [".gitignore".freeze, ".ruby-version".freeze, ".yardopts".freeze, "CHANGELOG.md".freeze, "Gemfile".freeze, "Gemfile.lock".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "anchormodel.gemspec".freeze, "bin/rails".freeze, "doc/Anchormodel.html".freeze, "doc/Anchormodel/ActiveModelTypeValue.html".freeze, "doc/Anchormodel/ActiveModelTypeValueSingle.html".freeze, "doc/Anchormodel/Attribute.html".freeze, "doc/Anchormodel/ModelMixin.html".freeze, "doc/Anchormodel/SimpleFormInputs.html".freeze, "doc/Anchormodel/SimpleFormInputs/Helpers.html".freeze, "doc/Anchormodel/SimpleFormInputs/Helpers/AnchormodelInputsCommon.html".freeze, "doc/Anchormodel/Util.html".freeze, "doc/Anchormodel/Version.html".freeze, "doc/AnchormodelGenerator.html".freeze, "doc/AnchormodelInput.html".freeze, "doc/AnchormodelRadioButtonsInput.html".freeze, "doc/_index.html".freeze, "doc/class_list.html".freeze, "doc/css/common.css".freeze, "doc/css/full_list.css".freeze, "doc/css/style.css".freeze, "doc/file.README.html".freeze, "doc/file_list.html".freeze, "doc/frames.html".freeze, "doc/index.html".freeze, "doc/js/app.js".freeze, "doc/js/full_list.js".freeze, "doc/js/jquery.js".freeze, "doc/method_list.html".freeze, "doc/top-level-namespace.html".freeze, "lib/anchormodel.rb".freeze, "lib/anchormodel/active_model_type_value_multi.rb".freeze, "lib/anchormodel/active_model_type_value_single.rb".freeze, "lib/anchormodel/attribute.rb".freeze, "lib/anchormodel/model_mixin.rb".freeze, "lib/anchormodel/simple_form_inputs/anchormodel_check_boxes_input.rb".freeze, "lib/anchormodel/simple_form_inputs/anchormodel_input.rb".freeze, "lib/anchormodel/simple_form_inputs/anchormodel_radio_buttons_input.rb".freeze, "lib/anchormodel/simple_form_inputs/helpers/anchormodel_inputs_common.rb".freeze, "lib/anchormodel/util.rb".freeze, "lib/anchormodel/version.rb".freeze, "lib/generators/anchormodel/USAGE".freeze, "lib/generators/anchormodel/anchormodel_generator.rb".freeze, "lib/generators/anchormodel/templates/anchormodel.rb.erb".freeze, "logo.svg".freeze, "test/active_record_model/user_test.rb".freeze, "test/dummy/.gitignore".freeze, "test/dummy/Rakefile".freeze, "test/dummy/app/anchormodels/animal.rb".freeze, "test/dummy/app/anchormodels/locale.rb".freeze, "test/dummy/app/anchormodels/role.rb".freeze, "test/dummy/app/helpers/application_helper.rb".freeze, "test/dummy/app/models/application_record.rb".freeze, "test/dummy/app/models/concerns/.keep".freeze, "test/dummy/app/models/user.rb".freeze, "test/dummy/bin/rails".freeze, "test/dummy/bin/rake".freeze, "test/dummy/bin/setup".freeze, "test/dummy/config.ru".freeze, "test/dummy/config/application.rb".freeze, "test/dummy/config/boot.rb".freeze, "test/dummy/config/credentials.yml.enc".freeze, "test/dummy/config/database.yml".freeze, "test/dummy/config/environment.rb".freeze, "test/dummy/config/environments/test.rb".freeze, "test/dummy/config/initializers/content_security_policy.rb".freeze, "test/dummy/config/initializers/filter_parameter_logging.rb".freeze, "test/dummy/config/initializers/inflections.rb".freeze, "test/dummy/config/initializers/permissions_policy.rb".freeze, "test/dummy/config/locales/en.yml".freeze, "test/dummy/config/puma.rb".freeze, "test/dummy/config/routes.rb".freeze, "test/dummy/db/migrate/20230107173151_create_users.rb".freeze, "test/dummy/db/migrate/20240425182000_add_animals_to_users.rb".freeze, "test/dummy/db/schema.rb".freeze, "test/dummy/db/seeds.rb".freeze, "test/dummy/lib/tasks/.keep".freeze, "test/dummy/log/.keep".freeze, "test/dummy/tmp/.keep".freeze, "test/dummy/tmp/pids/.keep".freeze, "test/test_helper.rb".freeze]
   s.homepage = "https://github.com/kalsan/anchormodel".freeze
   s.licenses = ["LGPL-3.0-or-later".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
-  s.rubygems_version = "3.5.6".freeze
+  s.rubygems_version = "3.5.9".freeze
   s.summary = "Bringing object-oriented programming to Rails enums".freeze
 
   s.specification_version = 4