Bubblegumdrop
/
cl-deck-builder2
1
1
Fork 0
Koodi Ongelmat 0 Pull-pyynnöt 0 Julkaisut 0 Wiki Activity
Yu-Gi-Oh! Deck Building and Card Inventory Management web interface written in Common Lisp, utilizing HTMX.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 Commit
1 Haara
5.3MB
Puu: fc475a9eec
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from 'fc475a9eec'
${ noResults }
cl-deck-builder2/src/models/ygoprodeck-classes.lisp

473 lines
18KB
Raaka Blame Historia 

  1. #|

  2. 

  3. src/models/ygoprodeck-classes.lisp

  4. 

  5. Yu-Gi-Oh! Pro Deck Database Interface v2

  6. 

  7. TODO Documentation; The diagram from schemacrawler would be nice.

  8. 

  9. |#

  10. 

  11. (in-package #:cl-deck-builder2.models.ygoprodeck.classes)

  12. 

  13. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  14. ;; This is part of cardsv3 now.

  15. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  16. 

  17. (defclass ygo-name-mixin ()

  18.   ((name :accessor name-of

  19.          :col-type :text

  20.          :initarg :name))

  21.   (:unique-keys name)

  22.   (:documentation "A table for the names of all Yu-Gi-Oh! card properties.")

  23.   (:metaclass registered-table-class))

  24. 

  25. (defclass ygo-card-name (ygo-name-mixin)

  26.   ()

  27.   (:documentation "A table for the names of all Yu-Gi-Oh! card names. Dark Magician, Red-Eyes Black Dragon, and so on.")

  28.   (:metaclass registered-table-class))

  29. 

  30. (defclass ygo-card-type (ygo-name-mixin)

  31.   ()

  32.   (:documentation "A table for the types of Yu-Gi-Oh! cards. Spell, Flip Effect Monster, and so on.")

  33.   (:metaclass registered-table-class))

  34. 

  35. (defclass ygo-card-frame-type (ygo-name-mixin)

  36.   ()

  37.   (:documentation "A table for the frame types of Yu-Gi-Oh! cards. spell, effect_pendulum, and so on.")

  38.   (:metaclass registered-table-class))

  39. 

  40. (defclass ygo-card-race (ygo-name-mixin)

  41.   ()

  42.   (:documentation "A table for the races of Yu-Gi-Oh! cards. Insect, Beast, and so on.

  43. 

  44. YGOProDeck stores the kind of spell card here too, like Equip or Continuous.")

  45.   (:metaclass registered-table-class))

  46. 

  47. (defclass ygo-card-archetype (ygo-name-mixin)

  48.   ()

  49.   (:documentation "A table for the archetypes of Yu-Gi-Oh! cards. Archfiend, Elemental HERO, A.I, and so on.")

  50.   (:metaclass registered-table-class))

  51. 

  52. (defclass ygo-card-attribute (ygo-name-mixin)

  53.   ()

  54.   (:documentation "A table for the attributes of Yu-Gi-Oh! cards. FIRE, WIND, EARTH, DARK, and so on.")

  55.   (:metaclass registered-table-class))

  56. 

  57. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  58. ;; YGO-CARD uses the PASSCODE as its UNIQUE ID, so you don't see it in

  59. ;; here, because it's added implicitly by MITO as ID slot.

  60. (defclass ygo-card ()

  61.   ((id :accessor ygo-passcode-of

  62.        :col-type :integer

  63.        :primary-key t

  64.        :initarg :id)

  65.    (;; Cards *always* have a UNIQUE Name, and a description. Description isn't necessarily unique.

  66.     name :accessor name-of

  67.          :col-type :text

  68.          :initarg :name)

  69.    (desc :accessor ygo-desc-of

  70.          :col-type :text

  71.          :initarg :desc)

  72. 

  73.    ;; Some cards pre-date Archetype (e.g. Normal Monsters)

  74.    (archetype :accessor ygo-archetype-of

  75.               :col-type (or ygo-card-archetype :null)

  76.               :initarg :archetype)

  77.    ;; Some cards don't have Attribute/ATK/DEF/Level/Scale:

  78.    ;; - Skill

  79.    ;; - Spell

  80.    ;; - Trap

  81.    (attribute :accessor ygo-attribute-of

  82.               :col-type (or ygo-card-attribute :null)

  83.               :initarg :attribute)

  84.    (atk :accessor ygo-atk-of

  85.         :col-type (or :integer :null)

  86.         :initarg :atk)

  87.    (def :accessor ygo-def-of

  88.         :col-type (or :integer :null)

  89.         :initarg :def)

  90.    (scale :accessor ygo-scale-of

  91.           :col-type (or :integer :null)

  92.           :initarg :scale)

  93.    (level :accessor ygo-level-of

  94.           :col-type (or :integer :null)

  95.           :initarg :level)

  96. 

  97.    ;; Every card has a Frame-Type and a Race; Even Spell and Trap cards have a Race.

  98.    ;; YGOProDeck uses this field to keep "Continuous", or "Field" ... yuck.

  99.    (frame-type :accessor ygo-frame-type-of

  100.                :col-type ygo-card-frame-type

  101.                :initarg :frame-type)

  102.    (race :accessor ygo-race-of

  103.          :col-type ygo-card-race

  104.          :initarg :race)

  105. 

  106.    ;; There's a conflict with the existing lisp builtin TYPE-OF. Call

  107.    ;; it CARD-TYPE and access with CARD-TYPE-OF.

  108.    (card-type :accessor ygo-card-type-of

  109.               :col-type ygo-card-type

  110.               :initarg :type))

  111.   (:primary-key id)

  112.   (:auto-pk nil)

  113.   (:documentation "A table for most info of Yu-Gi-Oh! cards.

  114. 

  115. This corresponds to the top level data for each card in the YGOProDeck API export.")

  116.   (:metaclass registered-table-class))

  117. 

  118. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  119. ;; From here onward, the code depends on YGO-CARD.

  120. (defclass ygo-card-misc-info ()

  121.   ((passcode :accessor ygo-passcode-of

  122.              :col-type ygo-card

  123.              :initarg :passcode)

  124.    (views :accessor ygo-views-of

  125.           :col-type :integer

  126.           :initform 0

  127.           :initarg :views)

  128.    (viewsweek :accessor ygo-viewsweek-of

  129.               :col-type :integer

  130.               :initform 0

  131.               :initarg :viewsweek)

  132.    (upvotes :accessor ygo-upvotes-of

  133.             :col-type :integer

  134.             :initform 0

  135.             :initarg :upvotes)

  136.    (downvotes :accessor ygo-downvotes-of

  137.               :col-type :integer

  138.               :initform 0

  139.               :initarg :downvotes)

  140.    (beta-id :accessor ygo-beta-id-of

  141.             :col-type (or :integer :null)

  142.             :initarg :beta--id)

  143.    (beta-name :accessor ygo-beta-name-of

  144.               :col-type (or ygo-name-mixin :null)

  145.               :initarg :beta--name)

  146.    (staple :accessor ygo-is-staple

  147.            :col-type (or :integer :null)

  148.            :initarg :staple)

  149.    (konami-id :accessor ygo-konami-id-of

  150.               :col-type :integer

  151.               :initarg :konami--id)

  152.    ;; This :INTEGER is just an index into this table, YGO-CARDS.

  153.    (treated-as :accessor ygo-treated-as

  154.                :col-type (or :null ygo-name-mixin)

  155.                :initarg :treated--as)

  156.    (has-effect :accessor ygo-has-effect

  157.                :col-type (or :integer :null)

  158.                :initarg :has--effect)

  159.    (question-atk :accessor ygo-question-atk

  160.                  :col-type (or :integer :null)

  161.                  :initarg :question--atk)

  162.    (question-def :accessor ygo-question-def

  163.                  :col-type (or :integer :null)

  164.                  :initarg :question--def)

  165. 

  166.    ;; When the TCG-DATE or OCG-DATE is NULL, that means it hasn't been released in TCG/OCG...

  167.    (tcg-date :accessor ygo-tcg-date-of

  168.              :col-type (or :timestamp :null)

  169.              :initarg :tcg--date)

  170.    (ocg-date :accessor ygo-ocg-date-of

  171.              :col-type (or :timestamp :null)

  172.              :initarg :ocg--date))

  173.   (:metaclass registered-table-class)

  174.   (:documentation "This corresponds to the \"misc_info\" data for each card in the YGOProDeck API export."))

  175. 

  176. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  177. ;; Now Card Set Stuff

  178. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  179. (defclass ygo-set-name (ygo-name-mixin)

  180.   ()

  181.   (:documentation "A table for the sets of Yu-Gi-Oh! cards. Lightning Overdrive, 2021 Tin of Ancient Battles, and so on.")

  182.   (:metaclass registered-table-class))

  183. 

  184. (defclass ygo-set-code (ygo-name-mixin)

  185.   ()

  186.   (:documentation "A table for the set codes of Yu-Gi-Oh! cards. LOB-001, LOB-002, and so on.

  187. 

  188. SET-CODE is the full code, e.g. \"LOB-001\".

  189. 

  190. CODE is just \"001\" part, SET is just \"LOB\" part, both of which can be accessed by SPLIT-CODE.")

  191.   (:metaclass registered-table-class))

  192. 

  193. ;; Rarity => "Common", "Ghost Rare", "Ultra Rare", "Secret Rare"

  194. (defclass ygo-set-rarity (ygo-name-mixin)

  195.   ()

  196.   (:documentation "A table for the rarities of Yu-Gi-Oh! cards. Common, Secret Rare, Ghost Rare, and so on.")

  197.   (:metaclass registered-table-class))

  198. 

  199. ;; jq '.[]?.card_sets[]?.set_rarity_code' < /tmp/cardinfo.json  | sort -h | uniq

  200. (defclass ygo-set-rarity-code (ygo-name-mixin)

  201.   ()

  202.   (:documentation "A table for the rarity codes of Yu-Gi-Oh! cards. (C), (SR), (GUR), etc.")

  203.   (:metaclass registered-table-class))

  204. 

  205. (defclass ygo-set-edition (ygo-name-mixin)

  206.   ()

  207.   (:documentation "A table for the editions of Yu-Gi-Oh! cards. 1st Edition, Unlimited, and so on.")

  208.   (:metaclass registered-table-class))

  209. 

  210. (defclass ygo-set ()

  211.   ((passcode :accessor ygo-passcode-of

  212.              :col-type ygo-card

  213.              :initarg :passcode)

  214.    (name :accessor name-of

  215.          :col-type ygo-set-name

  216.          :initarg :name)

  217.    (code :accessor ygo-code-of

  218.          :col-type ygo-set-code

  219.          :initarg :code)

  220.    (rarity :accessor ygo-rarity-of

  221.            :col-type ygo-set-rarity

  222.            :initarg :rarity)

  223.    (rarity-code :accessor ygo-rarity-code--of

  224.            :col-type ygo-set-rarity-code

  225.            :initarg :rarity-code)

  226.    (edition :accessor ygo-edition-of

  227.             :col-type ygo-set-edition

  228.             :initarg :edition)

  229. 

  230.    (url :accessor ygo-url-of

  231.         :col-type :text

  232.         :initarg :url)

  233. 

  234.    ;; PRICE is $X,XX * 100 => XXX,00 That way we don't have to store floats at all.

  235.    ;;

  236.    ;; Default set price is Half a Doll Hair (0.50$) if none supplied

  237.    (price    :accessor ygo-price-of

  238.              :col-type :integer

  239.              :initarg :price

  240.              :initform 0.50

  241.              :inflate #'currency-inflate

  242.              :deflate #'currency-deflate))

  243.   (:documentation "A table for the sets of Yu-Gi-Oh! cards.

  244. 

  245. This corresponds to the \"card_sets\" field in the YGOProDeck API export.")

  246.   (:metaclass registered-table-class))

  247. 

  248. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  249. (defclass ygo-linkmarker ()

  250.   ((passcode :accessor ygo-passcode-of

  251.              :col-type ygo-card

  252.              :initarg :passcode)

  253.    (bottom :accessor ygo-linkmarker-bottom

  254.            :col-type (or :null ygo-linkmarker-name)

  255.            :initarg :bottom)

  256.    (bottom-left :accessor ygo-linkmarker-bottom-left

  257.                 :col-type (or :null ygo-linkmarker-name)

  258.                 :initarg :bottom-left)

  259.    (bottom-right :accessor ygo-linkmarker-bottom-right

  260.                  :col-type (or :null ygo-linkmarker-name)

  261.                  :initarg :bottom-right)

  262.    (left :accessor ygo-linkmarker-left

  263.          :col-type (or :null ygo-linkmarker-name)

  264.          :initarg :left)

  265.    (right :accessor ygo-linkmarker-right

  266.           :col-type (or :null ygo-linkmarker-name)

  267.           :initarg :right)

  268.    (top :accessor ygo-linkmarker-top

  269.         :col-type (or :null ygo-linkmarker-name)

  270.         :initarg :top)

  271.    (top-left :accessor ygo-linkmarker-top-left

  272.              :col-type (or :null ygo-linkmarker-name)

  273.              :initarg :top-left)

  274.    (top-right :accessor ygo-linkmarker-top-right

  275.               :col-type (or :null ygo-linkmarker-name)

  276.               :initarg :top-right))

  277.   (:metaclass registered-table-class)

  278.   (:documentation "A table for Yu-Gi-Oh! Link Monster Link markers.

  279. 

  280. This corresponds to the \"linkmarkers\" field in each card."))

  281. 

  282. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  283. (defclass ygo-format ()

  284.   ((passcode :accessor ygo-passcode-of

  285.              :col-type (or :null ygo-format-name)

  286.              :initarg :passcode)

  287.    (common-charity :accessor ygo-common-charity-format

  288.                    :col-type (or :null ygo-format-name)

  289.                    :initarg :common-charity)

  290.    (duel-links :accessor ygo-duel-links-format

  291.                :col-type (or :null ygo-format-name)

  292.                :initarg :duel-links)

  293.    (edison :accessor ygo-edison-format

  294.            :col-type (or :null ygo-format-name)

  295.            :initarg :edison)

  296.    (goat :accessor ygo-goat-format

  297.          :col-type (or :null ygo-format-name)

  298.          :initarg :goat)

  299.    (ocg :accessor ygo-ocg-format

  300.         :col-type (or :null ygo-format-name)

  301.         :initarg :ocg)

  302.    (ocg-goat :accessor ygo-ocg-goat-format

  303.              :col-type (or :null ygo-format-name)

  304.              :initarg :ocg-goat)

  305.    (speed-duel :accessor ygo-speed-duel-format

  306.                :col-type (or :null ygo-format-name)

  307.                :initarg :speed-duel)

  308.    (tcg :accessor ygo-tcg-format

  309.         :col-type (or :null ygo-format-name)

  310.         :initarg :tcg))

  311.   (:metaclass registered-table-class)

  312.   (:documentation "A table for Yu-Gi-Oh! rule formats.

  313. 

  314. This corresponds to the \"formats\" field in the \"misc_info\" for each card.

  315. 

  316. If the card is available in this format, e.g. listed under misc_info.formats \"TCG\", that means the card is allowed in TCG games. The YGO-TCG-FORMAT slot for this object would have a non-NIL YGO-FORMAT-NAME value."))

  317. 

  318. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  319. (defclass ygo-banlist ()

  320.   ((passcode :accessor ygo-passcode-of

  321.              :col-type ygo-card

  322.              :initarg :passcode)

  323.    (ban-goat :accessor ygo-ban-goat

  324.              :col-type (or :null ygo-banlist-name)

  325.              :initarg :ban--goat)

  326.    (ban-ocg  :accessor ygo-ban-ocg

  327.              :col-type (or :null ygo-banlist-name)

  328.              :initarg :ban--ocg)

  329.    (ban-tcg  :accessor ygo-ban-tcg

  330.              :col-type (or :null ygo-banlist-name)

  331.              :initarg :ban--tcg))

  332.   (:unique-keys passcode)

  333.   (:metaclass registered-table-class)

  334.   (:documentation "A table for Yu-Gi-Oh! rule banlist.

  335. 

  336. This corresponds to the \"banlist_info\" field  for each card."))

  337. 

  338. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  339. (defclass ygo-alternative-artwork ()

  340.   ((passcode :accessor ygo-passcode-of

  341.              :col-type ygo-card

  342.              :initarg :passcode)

  343.    (alternate :accessor ygo-alternate-id-of

  344.               :col-type ygo-card

  345.               :initarg :alternate))

  346.   (:metaclass registered-table-class)

  347.   (:documentation "A table for Yu-Gi-Oh! alternative artwork.

  348. 

  349. This corresponds to the \"card_images\" array for each card."))

  350. 

  351. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

  352. (defclass ygo-price ()

  353.   ((passcode :accessor ygo-passcode-of

  354.              :col-type ygo-card

  355.              :initarg :passcode

  356.              :deflate #'currency-deflate

  357.              :inflate #'currency-inflate)

  358.    (cardmarket-price :accessor ygo-cardmarket-price-of

  359.                      :col-type :integer

  360.                      :initarg :cardmarket--price

  361.                      :deflate #'currency-deflate

  362.                      :inflate #'currency-inflate)

  363.    (tcgplayer-price :accessor ygo-tcgplayer-price-of

  364.                     :col-type :integer

  365.                     :initarg :tcgplayer--price

  366.                     :deflate #'currency-deflate

  367.                     :inflate #'currency-inflate)

  368.    (ebay-price :accessor ygo-ebay-price-of

  369.                :col-type :integer

  370.                :initarg :ebay--price

  371.                :deflate #'currency-deflate

  372.                :inflate #'currency-inflate)

  373.    (amazon-price :accessor ygo-amazon-price-of

  374.                  :col-type :integer

  375.                  :initarg :amazon--price

  376.                  :deflate #'currency-deflate

  377.                  :inflate #'currency-inflate)

  378.    (coolstuffinc-price :accessor ygo-coolstuffinc-price-of

  379.                        :col-type :integer

  380.                        :initarg :coolstuffinc--price

  381.                        :deflate #'currency-deflate

  382.                        :inflate #'currency-inflate))

  383.   (:metaclass registered-table-class)

  384.   (:documentation "A table for Yu-Gi-Oh! pricing information. Represents the API information about Card Pricing. Encapsulates the following fields:

  385. - Passcode

  386. - CardMarket

  387. - TCGPlayer

  388. - eBay

  389. - Amazon

  390. - CoolStuffInc

  391. 

  392. This corresponds to the \"card_prices\" array for each card."))

  393. 

  394. ;; YGO-FORMAT-NAME, YGO-LINKMARKER-NAME, YGO-BANLIST-NAME,

  395. ;; YGO-SET-RARITY-CODE, and the like have moved to YGOPRODECK.FIELDS.

  396. 

  397. (defclass ygo-set-item ()

  398.   ((item :accessor item-of

  399.          :initarg :item

  400.          :col-type ygo-set)

  401.    (variant :accessor variant-of

  402.             :initarg :variant

  403.             :col-type variant-condition)

  404.    (qty :accessor qty-of

  405.         :col-type :integer

  406.         :initform 0

  407.         :initarg :qty)

  408.    (opt-qty :accessor opt-qty-of

  409.             :col-type :integer

  410.             :initform 0

  411.             :initarg :opt-qty)

  412.    (;; 10 cent buy price

  413.     buy-price :accessor buy-price-of

  414.               :col-type :integer

  415.               :initform 0.10

  416.               :initarg :buy-price

  417.               :inflate #'currency-inflate

  418.               :deflate #'currency-deflate)

  419.    (;; 50 cent sell price

  420.     sell-price :accessor sell-price-of

  421.                :col-type :integer

  422.                :initform 0.50

  423.                :initarg :sell-price

  424.                :inflate #'currency-inflate

  425.                :deflate #'currency-deflate))

  426.   (:metaclass registered-table-class)

  427.   (:documentation "YGO-SET + VARIANT-CONDITION relationship table."))

  428. 

  429. 

  430. #|

  431. ;;;; models/ygoprodeck.lisp

  432.   (defstruct ygoprodeck-item

  433.     (:documentation "Represents the top level API information queried from YGOProDeck. Encapsulates the following fields: ~Passcode~,~Name~,~Type~, ~Frame Type~, ~Documentation~,~Race~,~ATK~, ~DEF~,~Level~,~Attribute~, and ~Archetype~."))

  434.   (defstruct ygoprodeck-card-set

  435.     (:documentation "Represents the API information about Card Sets. Encapsulates the following fields: ~Passcode~,~Name~,~Code~, ~Rarity~, ~Rarity-code~, and ~Price~."))

  436.   (defstruct ygoprodeck-card-image

  437.     (:documentation "Card images. We don't use this much."))

  438.   (defstruct ygoprodeck-card-price

  439.   (defun drop-table-ygoprodeck-data

  440.       (:documentation "Destroy the table for this data."))

  441.   (defun create-table-ygoprodeck-data

  442.       (:documentation "Create the corresponding database structure for the YGOProDeck API data import."))

  443.   (defun json-import-ygoprodeck-data

  444.       (:arguments

  445.        ((data "The data to be imported."))

  446.        :documentation "Import the base API data (ATK, DEF,Level, ...) information from the Card Info API data."))

  447.   (defun json-import-ygoprodeck-card-images

  448.       (:arguments

  449.        ((data "The data to be imported."))

  450.        :documentation "Import the images information from the Card Info API data."))

  451.   (defun json-import-ygoprodeck-card-prices

  452.       (:arguments

  453.        ((data "The data to be imported."))

  454.        :documentation "Import the pricing information from the Card Info API data."))

  455.   (defun json-import-ygoprodeck-card-sets

  456.       (:arguments

  457.        ((data "The data to be imported."))

  458.        :documentation "Import the card set information from the Card Info API data."))

  459.   (defun json-import-ygoprodeck-banlist-info

  460.       (:arguments

  461.        ((data "The data to be imported."))

  462.        :documentation "Import the banlist information from the Card Info API data."))

  463.   (defun json-import-ygoprodeck

  464.       (:arguments

  465.        ((json "The JSON query to iterate over. Response from YGOProDeck API."))

  466.        :documentation "Import YGOProDeck data. Wraps the ~JSON-IMPORT-*~ functions."))

  467.   (defun card-rarity-list

  468.       (:documentation "List all card rarities."))

  469.   (defun card-code-list

  470.       (:documentation "List all card set codes."))

  471. 

  472. |#