card-mod-alias 0.11.5 → 0.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce2d278a69467daefce5f76122241a2a89b895e0f4f2a4a4acd367565acbee9
-  data.tar.gz: 369d73e1686df3eff09121550aa912406696b9f9e1dc6e9b28e3289c249e7ecf
+  metadata.gz: c574df8634230364ee03616fece0e9223ce632e03cf9c0c8e9a70a73d8fb065e
+  data.tar.gz: 7a44bba4a8219a005dd3febc4b432505809651a319dc5757f9de3161259672fd
 SHA512:
-  metadata.gz: 1f52be3ccc55d922524113e0f46d58bba871ff1152a2fb045b6f2aea16047ee6d5dba558f9906762f77146ea4093c01691a54cf6a9ac34d831348cfaae1fd300
-  data.tar.gz: 02fcd442c379612bb78123ab6254bf31f104addd1cc1fc6158c1fcfa7d7b807e762c486e7f9366738f65f68c558465a95fa9ddefc2d07755a5d8866820d0f2b3
+  metadata.gz: 99c50131bd1fc3268a23d165f34af82cae12d3ac192c8b2ea1ec467ad8904b09663c7f0ed047f0ac1b2f5ce157e36d4b68857ca8b85756df689f2c51ed5b01db
+  data.tar.gz: af0cb63ee5deb619dcdd9df09b6bfed4cb78d189d66708bbbed812620536a15a8cb1761513344066f3357ca34f89d20f08ff5395b963cd4906ff90c7ed9d5f6b

data/README.md

@@ -0,0 +1,68 @@
+<!--
+# @title README - mod: alias
+-->
+
+# Alias Mod
+Enable Alias cards, which alias one simple card name to another.
+
+The primary use case for alias cards is for handling redirects, for example after a card 
+has been renamed. Suppose, for example, a card's name is changed from *Former* to
+*Current*. One can create an Alias card named "Former" with the content "Current". This
+not only insures that links to /Former will be redirected to /Current, but it also 
+handles all descendants, redirecting /Former+field to /Current+field and /My+Former+Life
+to /My+Current+Life.
+
+Alias cards themselves must be simple cards and are not allowed to have children.
+
+If a request to an alias specifies a view, eg `/Former?view=edit`, then the request
+will not be redirected and will instead return the view of the Alias card itself. 
+Similarly, transactional requests (create, update, and delete) to the alias card
+will take effect on the alias, not the target.
+
+## Cards with codenames
+
+| codename | default name | purpose |
+|:--------:|:------------:|:-------:|
+| :alias | Alias | Cardtype of aliases |
+
+## Sets with code rules
+
+### {Card::Set::Type::Alias type: Alias}
+An alias card's name is the alias's *source*, and its content is its target. So, in the 
+example above, the Alias card would be named *Former* and its content would be *Current*.
+
+Content is stored as a card id.
+
+#### Events
+
+| event name | when | purpose |
+|:---------:|:------:|:-------:|
+| validate_alias_source | on save | ensures name is simple and card has no children |
+| validate_alias_target | on save | ensures target is existing simple card |
+
+### {Card::Set::All::Alias All}
+
+#### Events
+
+| event name | when | purpose |
+|:---------:|:------:|:-------:|
+| create_alias_upon_rename | triggered | creates an alias from old name to new one |
+
+
+#### HtmlFormat
+Extends `#edit_name_buttons` so that when renaming, user is presented with a checkbox 
+to trigger the creation of an alias
+
+### {Card::Set::AllPlus::Alias All Plus}
+Handle aliasing of compound names when at least one name part is an alias.
+
+#### Events
+
+| event name | when | purpose |
+|:---------:|:------:|:-------:|
+| validate_not_alias | on save | prevents creation of deescendents of aliases |
+
+## {CardController::Aliasing}
+Module that enables card controller to handle alias-driven redirects and ensure that 
+transaction requests act upon the correct card (the alias when simple, the target when
+compound).

data/lib/card_controller/aliasing.rb

@@ -7,6 +7,8 @@ class CardController
       hard_redirect target_url
     end
 
+    # create, read, and update requests take effect on the target card
+    # when aliases are compound (but on the alias card itself when simple).
     %i[create update delete].each do |action|
       define_method action do
         @card = card.target_card if card&.compound? && card&.alias?
@@ -16,12 +18,14 @@ class CardController
 
     private
 
+    # url to which aliased requests should be redirected
     def target_url
       target_params = params.clone.merge(mark: card.target_name).to_unsafe_h
       target_params.delete :controller
       card.target_card.format(:base).path target_params
     end
 
+    # aliased names are not redirected when a view is specified for a simple alias card
     def redirect_to_aliased?
       return false unless card&.alias?
 

data/set/all/alias.rb

@@ -1,13 +1,16 @@
+# triggerable event to auto-add an alias upon renaming a card
 event :create_alias_upon_rename, :finalize,
       on: :update, changed: :name, trigger: :required do
   add_subcard name_before_act, type_code: :alias, content: name
 end
 
+# actual aliases override this in narrower sets.
 def alias?
   false
 end
 
 format :html do
+  # adds checkbox to rename form
   def edit_name_buttons
     output [auto_alias_checkbox, super].compact
   end

data/set/all_plus/alias.rb

@@ -2,10 +2,12 @@ event :validate_not_alias, :validate, on: :save do
   errors.add t(:alias_cards_no_children) if alias? && type_code != :alias
 end
 
+# a compound name is an alias if any part is an alias
 def alias?
   name.parts.any? { |p| Card[p]&.alias? }
 end
 
+# reconstructs the name to which a compound name is aliased
 def target_name
   Card::Name[
     name.parts.map do |p|

data/set/type/alias.rb

@@ -16,10 +16,12 @@ def alias?
   true
 end
 
+# @return [Card::Name] name to which card's name is aliased
 def target_name
   first_name
 end
 
+# @return [Card] card to which card is aliased
 def target_card
   first_card
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: card-mod-alias
 version: !ruby/object:Gem::Version
-  version: 0.11.5
+  version: 0.11.6
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: card
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.101.5
+        version: 1.101.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.101.5
+        version: 1.101.6
 description: ''
 email:
 - info@decko.org
@@ -33,6 +33,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - config/initializers/init_aliasing.rb
 - db/migrate_cards/20210504195646_add_alias_type.rb
 - lib/card_controller/aliasing.rb