RubyGems - anchormodel - Versions diffs - 0.0.1 - Mend

anchormodel 0.0.1

Files changed (33) hide show

checksums.yaml +7 -0
data/.gitignore +2 -0
data/.ruby-version +1 -0
data/.yardopts +1 -0
data/LICENSE +165 -0
data/README.md +96 -0
data/Rakefile +27 -0
data/anchormodel.gemspec +33 -0
data/doc/Anchormodel/ActiveModelTypeValue.html +513 -0
data/doc/Anchormodel/Attribute.html +502 -0
data/doc/Anchormodel/ModelMixin.html +307 -0
data/doc/Anchormodel/Version.html +195 -0
data/doc/Anchormodel.html +846 -0
data/doc/_index.html +151 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +497 -0
data/doc/file.README.html +167 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +167 -0
data/doc/js/app.js +314 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +203 -0
data/doc/top-level-namespace.html +110 -0
data/lib/anchormodel/active_model_type_value.rb +37 -0
data/lib/anchormodel/attribute.rb +24 -0
data/lib/anchormodel/model_mixin.rb +46 -0
data/lib/anchormodel/version.rb +11 -0
data/lib/anchormodel.rb +65 -0
metadata +114 -0

data/doc/method_list.html ADDED Viewed

@@ -0,0 +1,203 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
+      <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    <title>Method List</title>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <div id="content">
+      <div class="fixed_header">
+        <h1 id="full_list_header">Method List</h1>
+        <div id="full_list_nav">
+            <span><a target="_self" href="class_list.html">
+              Classes
+            </a></span>
+            <span><a target="_self" href="method_list.html">
+              Methods
+            </a></span>
+            <span><a target="_self" href="file_list.html">
+              Files
+            </a></span>
+        </div>
+        <div id="search">Search: <input type="text" /></div>
+      </div>
+      <ul id="full_list" class="method">
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel.html#==-instance_method" title="Anchormodel#== (method)">#==</a></span>
+      <small>Anchormodel</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel.html#all-class_method" title="Anchormodel.all (method)">all</a></span>
+      <small>Anchormodel</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/Attribute.html#anchor_class-instance_method" title="Anchormodel::Attribute#anchor_class (method)">#anchor_class</a></span>
+      <small>Anchormodel::Attribute</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/Attribute.html#attribute_name-instance_method" title="Anchormodel::Attribute#attribute_name (method)">#attribute_name</a></span>
+      <small>Anchormodel::Attribute</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/ModelMixin.html#belongs_to_anchormodel-class_method" title="Anchormodel::ModelMixin.belongs_to_anchormodel (method)">belongs_to_anchormodel</a></span>
+      <small>Anchormodel::ModelMixin</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/ActiveModelTypeValue.html#cast-instance_method" title="Anchormodel::ActiveModelTypeValue#cast (method)">#cast</a></span>
+      <small>Anchormodel::ActiveModelTypeValue</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/ActiveModelTypeValue.html#changed%3F-instance_method" title="Anchormodel::ActiveModelTypeValue#changed? (method)">#changed?</a></span>
+      <small>Anchormodel::ActiveModelTypeValue</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/ActiveModelTypeValue.html#deserialize-instance_method" title="Anchormodel::ActiveModelTypeValue#deserialize (method)">#deserialize</a></span>
+      <small>Anchormodel::ActiveModelTypeValue</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel.html#find-class_method" title="Anchormodel.find (method)">find</a></span>
+      <small>Anchormodel</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel.html#index-instance_method" title="Anchormodel#index (method)">#index</a></span>
+      <small>Anchormodel</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel.html#initialize-instance_method" title="Anchormodel#initialize (method)">#initialize</a></span>
+      <small>Anchormodel</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/Attribute.html#initialize-instance_method" title="Anchormodel::Attribute#initialize (method)">#initialize</a></span>
+      <small>Anchormodel::Attribute</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/ActiveModelTypeValue.html#initialize-instance_method" title="Anchormodel::ActiveModelTypeValue#initialize (method)">#initialize</a></span>
+      <small>Anchormodel::ActiveModelTypeValue</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel.html#inspect-instance_method" title="Anchormodel#inspect (method)">#inspect</a></span>
+      <small>Anchormodel</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel.html#key-instance_method" title="Anchormodel#key (method)">#key</a></span>
+      <small>Anchormodel</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel.html#label-instance_method" title="Anchormodel#label (method)">#label</a></span>
+      <small>Anchormodel</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/Attribute.html#optional-instance_method" title="Anchormodel::Attribute#optional (method)">#optional</a></span>
+      <small>Anchormodel::Attribute</small>
+    </div>
+  </li>
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel/ActiveModelTypeValue.html#serialize-instance_method" title="Anchormodel::ActiveModelTypeValue#serialize (method)">#serialize</a></span>
+      <small>Anchormodel::ActiveModelTypeValue</small>
+    </div>
+  </li>
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Anchormodel.html#to_s-instance_method" title="Anchormodel#to_s (method)">#to_s</a></span>
+      <small>Anchormodel</small>
+    </div>
+  </li>
+      </ul>
+    </div>
+  </body>
+</html>

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.28
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Anchormodel.html" title="Anchormodel (class)">Anchormodel</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Sat Dec 17 12:56:00 2022 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.28 (ruby-3.0.4).
+</div>
+    </div>
+  </body>
+</html>

data/lib/anchormodel/active_model_type_value.rb ADDED Viewed

@@ -0,0 +1,37 @@
+# @see https://www.rubydoc.info/docs/rails/ActiveModel/Type/Value
+class Anchormodel::ActiveModelTypeValue < ActiveModel::Type::Value
+  def initialize(attribute)
+    super()
+    @attribute = attribute
+  end
+  def cast(value)
+    serialize value
+  end
+  # Implementing this instead of cast to force key validation in any case
+  def serialize(value)
+    return case value
+           when Symbol, String
+             unless @attribute.anchor_class.valid_keys.include?(value.to_sym)
+               fail("Attempt to set #{@attribute.attribute_name} to unsupported key #{value.inspect}.")
+             end
+             value.to_s
+           when @attribute.anchor_class
+             value.key.to_s
+           when nil
+             nil
+           else
+             fail "Attempt to set #{@attribute.attribute_name} to unsupported type #{value.class}"
+           end
+  end
+  def deserialize(value)
+    return value if value.is_a?(@attribute.anchor_class)
+    return @attribute.anchor_class.find(value)
+  end
+  def changed?(old_value, new_value, _new_value_before_type_cast)
+    return deserialize(old_value) != deserialize(new_value)
+  end
+end

data/lib/anchormodel/attribute.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# @api description
+# This class holds all information related to a Rails model pointing to an Anchormodel.
+# It is instanciated when {Anchormodel::ModelMixin#belongs_to_anchormodel} is used.
+class Anchormodel::Attribute
+  attr_reader :attribute_name
+  attr_reader :optional
+  # @param model_class [ActiveRecord::Base] The Rails model where {Anchormodel::ModelMixin#belongs_to_anchormodel} is used
+  # @param attribute_name [String,Symbol] The name and database column of the attribute
+  # @param anchor_class_name [String] Name of the Anchormodel class (omit if attribute `:foo_bar` holds an `Anchormodels::FooBar`)
+  # @param optional [Boolean] If true, a presence validation is added to the model.
+  def initialize(model_class, attribute_name, anchor_class_name = nil, optional = false)
+    @model_class = model_class
+    @attribute_name = attribute_name.to_sym
+    @anchor_class_name = anchor_class_name || "Anchormodels::#{attribute_name.to_s.classify}"
+    @optional = optional
+  end
+  # Getter for the Anchormodel class based on the name passed to the initializer.
+  # We are loading the anchor class lazily, because the model mixin instanciates this statically -> avoid premature anchor class loading
+  def anchor_class
+    @anchor_class ||= @anchor_class_name.constantize
+  end
+end

data/lib/anchormodel/model_mixin.rb ADDED Viewed

@@ -0,0 +1,46 @@
+# @api description
+# All Rails models making use of #belongs_to_anchormodel must include this mixin. Typically, it is included in `application_record.rb`.
+module Anchormodel::ModelMixin
+  extend ActiveSupport::Concern
+  included do
+    class_attribute :anchormodel_attributes, default: {}.freeze
+  end
+  class_methods do
+    # Creates an attribute linking to an Anchormodel. The attribute should be
+    # present in the DB and the column should be named the same as `attribute_name.`
+    # @param attribute_name [String,Symbol] The name and database column of the attribute
+    # @param anchor_class_name [String] Name of the Anchormodel class (omit if attribute `:foo_bar` holds an `Anchormodels::FooBar`)
+    # @param optional [Boolean] If true, a presence validation is added to the model.
+    def belongs_to_anchormodel(attribute_name, anchor_class_name = nil, optional: false)
+      attribute_name = attribute_name.to_sym
+      attribute = Anchormodel::Attribute.new(self, attribute_name, anchor_class_name, optional)
+      # Register attribute
+      self.anchormodel_attributes = anchormodel_attributes.merge({ attribute_name => attribute }).freeze
+      # Add presence validation if required
+      unless optional
+        validates attribute_name, presence: true
+      end
+      # Make casting work
+      # Define serializer/deserializer
+      active_model_type_value = Anchormodel::ActiveModelTypeValue.new(attribute)
+      # Overwrite reader to force building anchors at every retrieval
+      define_method(attribute_name.to_s) do
+        active_model_type_value.deserialize(read_attribute(attribute_name))
+      end
+      # Override writer to fail early when an invalid target value is specified
+      define_method("#{attribute_name}=") do |new_value|
+        write_attribute(attribute_name, active_model_type_value.serialize(new_value))
+      end
+      # Supply serializer and deserializer
+      attribute attribute_name, active_model_type_value
+    end
+  end
+end

data/lib/anchormodel/version.rb ADDED Viewed

@@ -0,0 +1,11 @@
+class Anchormodel
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+    EDGE = false
+    LABEL = [MAJOR, MINOR, PATCH, EDGE ? 'edge' : nil].compact.join('.')
+  end
+end

data/lib/anchormodel.rb ADDED Viewed

@@ -0,0 +1,65 @@
+# @api description
+# Inherit from this class and place your Anchormodel under `app/anchormodels/your_anchor_model.rb`. Use it like `Anchormodels::YourAnchorModel`.
+# Refer to the README for usage.
+class Anchormodel
+  attr_reader :key
+  attr_reader :index
+  class_attribute :entries_list, default: [] # For ordering
+  class_attribute :entries_hash, default: {} # For quick access
+  class_attribute :valid_keys, default: Set.new
+  # Returns all possible values this Anchormodel can take.
+  def self.all
+    entries_list
+  end
+  # Retrieves a particular value given the key. Fails if not found.
+  # @param key [String,Symbol] The key of the value that should be retrieved.
+  def self.find(key)
+    return nil if key.nil?
+    return entries_hash[key.to_sym] || fail("Retreived undefined anchor model key #{key.inspect} for #{inspect}.")
+  end
+  # Call this initializer directly in your Anchormodel class. To set `@foo=:bar` for anchor `:ter`, use `new(:ter, foo: :bar)`
+  # @param key [String,Symbol] The key under which the entry should be stored.
+  # @param attributes All named arguments to Anchormodel are made available as instance attributes.
+  def initialize(key, **attributes)
+    @key = key.to_sym
+    @index = entries_list.count
+    # Save attributes as instance variables
+    attributes.each do |k, v|
+      instance_variable_set(:"@#{k}", v)
+    end
+    # Register self
+    entries_list << self
+    entries_hash[key] = self
+    # Register valid keys
+    valid_keys << key
+  end
+  def ==(other)
+    self.class == other.class && key == other.key
+  end
+  # Returns a Rails label that is compatible with the [Rails FastGettext](https://github.com/grosser/gettext_i18n_rails/) gem.
+  def label
+    I18n.t("#{self.class.name.demodulize}|#{key.to_s.humanize}")
+  end
+  def inspect
+    "#<#{self.class.name}<#{key}>:#{hash}>"
+  end
+  def to_s
+    inspect
+  end
+end
+require 'anchormodel/active_model_type_value'
+require 'anchormodel/attribute'
+require 'anchormodel/model_mixin'
+require 'anchormodel/version'

metadata ADDED Viewed

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: anchormodel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sandro Kalbermatter
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.28
+- !ruby/object:Gem::Dependency
+  name: yard-activesupport-concern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".yardopts"
+- LICENSE
+- README.md
+- Rakefile
+- anchormodel.gemspec
+- doc/Anchormodel.html
+- doc/Anchormodel/ActiveModelTypeValue.html
+- doc/Anchormodel/Attribute.html
+- doc/Anchormodel/ModelMixin.html
+- doc/Anchormodel/Version.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/anchormodel.rb
+- lib/anchormodel/active_model_type_value.rb
+- lib/anchormodel/attribute.rb
+- lib/anchormodel/model_mixin.rb
+- lib/anchormodel/version.rb
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Bringing object-oriented programming to Rails enums
+test_files: []