anchormodel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc6cfead46a797c2039091347636575edf3b46be9172aa0b5e859d64c8dec816
+  data.tar.gz: c195d9fbb46ea16961977818d30628c8223926708bde1385aa7ca50307820f43
+SHA512:
+  metadata.gz: 91f34a409344033c7e04ac4eef8a5af81b0997c4c092c2a0baba3df1fcd3c00980a9e11aadee18ef410609bd2aff77476d0524384cad4a3e5d797e0e0e1fb7c2
+  data.tar.gz: e689dd2d03bc6932b6c7ebf444e3fd8db72136f430b2863c05c9d9f7d3b65dae91f320cadb94b0eb119326244263d34540ac59cccc19310dd2d33ff3bbea3f36

data/.gitignore

@@ -0,0 +1,2 @@
+.rubocop.yml
+.yardoc

data/.ruby-version

@@ -0,0 +1 @@
+3.0.4

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown --plugin activesupport-concern

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,96 @@
+# Introducing Anchormodel
+
+This gem provides a simple but powerful alternative to [Rails
+Enums](https://api.rubyonrails.org/v7.0/classes/ActiveRecord/Enum.html). In
+contrast to regular Enums, Anchormodels can hold application logic, making them
+ideal for tying code to database objects.
+
+# Use case
+
+Typically, a Rails application consists of three kinds of state:
+
+- The code, which we can consider static within a given version. Code can
+  reference to other code, e.g. `node.parent = other_node`.
+- The database contents, which can fluctuate within the bounds of the DB schema.
+  Data can reference to other data, ideally via foreign keys.
+- A mix of the two, where code needs to be specifically tailored for some kind
+  of data. A prominent example of such a mix would for instance be user roles:
+  roles must be hardcoded in the code because security logic is tied to them.
+  However, as users are assigned to roles in the database, roles also need to be
+  persisted in the database. This is where Anchormodel comes into play.
+
+## Alternatives coviering the same use case
+
+### Enum
+
+In Rails and other frameworks, the third point in the listing above is typically
+achieved via Enums. Enums map either Integers or Strings to constants and
+therefore provide a link between the DB and the application code.
+
+However, at least in Rails, Enums provide very limited customization options.
+They are basic values that can be used in if-statements. Anchormodels however
+are regular classes and can easily be extended.
+
+### ActiveEnum
+
+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
+meaningful, making you immediately understand what they stand for.
+
+This is why Anchormodel is strictly relying on String keys corresponding to the
+entries of an Anchormodel.
+
+# Example
+
+`app/anchormodels/role.rb`:
+
+```ruby
+class Anchormodels::Role < Anchormodel
+  # Expose the attribute privilege_level
+  attr_reader :privilege_level
+
+  # Overload <=> to make user roles comparable based on the privilege level
+  def <=>(other)
+    other.privilege_level <=> @privilege_level
+  end
+
+  # Declare all available roles
+  new :guest, privilege_level: 0
+  new :manager, privilege_level: 1
+  new :admin, privilege_level: 2
+end
+```
+
+`app/models/user.rb`
+
+```ruby
+# The DB table `users` must have a String column `users.role`
+class User < ApplicationRecord
+  belongs_to_anchormodel :role
+end
+```
+
+You may now use the following methods:
+
+```ruby
+# Retrieve all user roles:
+Anchormodels::Role.all
+
+# Retrieve a specific role from the String and find its privilege level
+Anchormodels::Role.find(:guest).privilege_level
+
+# Implement a Rails helper that makes sure users can only edit other users that have a lower privilege level than themselves
+def user_can_edit?(this_user, other_user)
+  this_user.role.privilege_level > other_user.role.privilege_level
+end
+
+# Pretty print a user's role, e.g. using the Rails FastGettext gem:
+puts("User #{@user.name} has role #{@user.role.label}")
+```
+
+# Installation
+
+1. Add gem to Gemfile: `gem 'anchormodel'`
+2. In `application_record.rb`, add in the class body: `include Anchormodel::ModelMixin`

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require_relative 'lib/anchormodel/version'
+
+task :gemspec do
+  specification = Gem::Specification.new do |s|
+    s.name = 'anchormodel'
+    s.version = Anchormodel::Version::LABEL
+    s.author = ['Sandro Kalbermatter']
+    s.summary = 'Bringing object-oriented programming to Rails enums'
+    s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+    s.executables   = []
+    s.require_paths = ['lib']
+    s.required_ruby_version = '>= 3.0.0'
+
+    # Dependencies
+    s.add_runtime_dependency 'rails', '>= 7.0'
+
+    s.add_development_dependency 'yard', '>= 0.9.28'
+    s.add_development_dependency 'yard-activesupport-concern'
+  end
+
+  File.open('anchormodel.gemspec', 'w') do |f|
+    f.puts('# DO NOT EDIT')
+    f.puts("# This file is auto-generated via: 'rake gemspec'.\n\n")
+    f.write(specification.to_ruby.strip)
+  end
+end

data/anchormodel.gemspec

@@ -0,0 +1,33 @@
+# DO NOT EDIT
+# This file is auto-generated via: 'rake gemspec'.
+
+# -*- encoding: utf-8 -*-
+# stub: anchormodel 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "anchormodel".freeze
+  s.version = "0.0.1"
+
+  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 = "2022-12-17"
+  s.files = [".gitignore".freeze, ".ruby-version".freeze, ".yardopts".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "anchormodel.gemspec".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.rb".freeze, "lib/anchormodel/attribute.rb".freeze, "lib/anchormodel/model_mixin.rb".freeze, "lib/anchormodel/version.rb".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
+  s.rubygems_version = "3.2.33".freeze
+  s.summary = "Bringing object-oriented programming to Rails enums".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<rails>.freeze, [">= 7.0"])
+    s.add_development_dependency(%q<yard>.freeze, [">= 0.9.28"])
+    s.add_development_dependency(%q<yard-activesupport-concern>.freeze, [">= 0"])
+  else
+    s.add_dependency(%q<rails>.freeze, [">= 7.0"])
+    s.add_dependency(%q<yard>.freeze, [">= 0.9.28"])
+    s.add_dependency(%q<yard-activesupport-concern>.freeze, [">= 0"])
+  end
+end