Merge pull request #103 from plural/card-attributes

Add first batch of advanced card attributes to API & search.

Author: plural

app/models/card.rb

@@ -15,4 +15,20 @@ class Card < ApplicationRecord
   has_many :unified_restrictions
 
   validates :name, uniqueness: true
+
+  def advancement_requirement
+    self[:advancement_requirement] == -1 ? 'X' : self[:advancement_requirement]
+  end
+   def link_provided
+    self[:link_provided] == -1 ? 'X' : self[:link_provided]
+  end
+  def mu_provided
+    self[:mu_provided] == -1 ? 'X' : self[:mu_provided]
+  end
+  def num_printed_subroutines
+    self[:num_printed_subroutines] == -1 ? 'X' : self[:num_printed_subroutines]
+  end
+  def recurring_credits_provided
+    self[:recurring_credits_provided] == -1 ? 'X' : self[:recurring_credits_provided]
+  end
 end

app/resources/api/v3/public/card_resource.rb

@@ -9,7 +9,7 @@ class Api::V3::Public::CardResource < JSONAPI::Resource
         attributes :deck_limit, :influence_cost, :influence_limit, :memory_cost
         attributes :minimum_deck_size, :strength, :stripped_text, :text, :trash_cost
         attributes :is_unique, :display_subtypes, :updated_at
-        attribute :latest_printing_id
+        attributes :card_abilities, :latest_printing_id
 
         key_type :string
 
@@ -23,6 +23,22 @@ def latest_printing_id
           @model.printings.max_by { |p| p.date_release } ['id']
         end
 
+        def card_abilities
+          {
+            additional_cost: @model.additional_cost,
+            advanceable: @model.advanceable,
+            gains_subroutines: @model.gains_subroutines,
+            interrupt: @model.interrupt,
+            link_provided: @model.link_provided,
+            mu_provided: @model.mu_provided,
+            num_printed_subroutines: @model.num_printed_subroutines,
+            on_encounter_effect: @model.on_encounter_effect,
+            performs_trace: @model.performs_trace,
+            recurring_credits_provided: @model.recurring_credits_provided,
+            trash_ability: @model.trash_ability,
+          }
+        end
+
         filters :title, :card_type_id, :side_id, :faction_id, :advancement_requirement
         filters :agenda_points, :base_link, :cost, :deck_limit, :influence_cost
         filters :influence_limit, :memory_cost, :minimum_deck_size, :strength, :trash_cost, :is_unique

app/resources/api/v3/public/printing_resource.rb

@@ -10,9 +10,9 @@ class Api::V3::Public::PrintingResource < JSONAPI::Resource
         attributes :quantity, :date_release, :updated_at
 
         # Parent Card attributes, included inline to make printings a bit more useful.
-        attributes :advancement_requirement, :agenda_points, :base_link, :card_type_id
-        attributes :cost, :deck_limit, :display_subtypes, :faction_id, :influence_cost
-        attributes :influence_limit, :is_unique, :memory_cost, :minimum_deck_size
+        attributes :advancement_requirement, :agenda_points, :base_link, :card_abilities
+        attributes :card_type_id, :cost, :deck_limit, :display_subtypes, :faction_id
+        attributes :influence_cost, :influence_limit, :is_unique, :memory_cost, :minimum_deck_size
         attributes :side_id, :strength, :stripped_text, :stripped_title, :text
         attributes :title, :trash_cost
 
@@ -122,6 +122,21 @@ def agenda_points
         def base_link
           @model.card.base_link
         end
+        def card_abilities
+          {
+            additional_cost: @model.card.additional_cost,
+            advanceable: @model.card.advanceable,
+            gains_subroutines: @model.card.gains_subroutines,
+            interrupt: @model.card.interrupt,
+            link_provided: @model.card.link_provided,
+            mu_provided: @model.card.mu_provided,
+            num_printed_subroutines: @model.card.num_printed_subroutines,
+            on_encounter_effect: @model.card.on_encounter_effect,
+            performs_trace: @model.card.performs_trace,
+            recurring_credits_provided: @model.card.recurring_credits_provided,
+            trash_ability: @model.card.trash_ability,
+          }
+        end
         def card_type_id
           @model.card.card_type_id
         end

lib/card_search_parser.rb

@@ -18,6 +18,8 @@ class CardSearchParser < Parslet::Parser
   # Note that while this list should generally be kept sorted, an entry that is a prefix of
   # a later entry will clobber the later entries and throw an error parsing text with the later entries.
   rule(:keyword) {
+    str('additional_cost') |
+    str('advanceable') |
     str('advancement_cost') |
     str('agenda_points') |
     str('base_link') |
@@ -28,19 +30,28 @@ class CardSearchParser < Parslet::Parser
     str('eternal_points') |
     str('faction') |
     str('format') |
+    str('gains_subroutines') |
     str('global_penalty') |
     str('illustrator') |
     str('in_restriction') |
     str('influence_cost') |
+    str('interrupt') |
     str('is_banned') |
     str('is_restricted') |
     str('is_unique') |
+    str('link_provided') |
     str('memory_usage') |
+    str('mu_provided') |
+    str('num_printed_subroutines') |
+    str('on_encounter_effect') |
+    str('performs_trace') |
+    str('recurring_credits_provided') |
     str('restriction_id') |
     str('side') |
     str('strength') |
     str('text') |
     str('title') |
+    str('trash_ability') |
     str('trash_cost') |
     str('universal_faction_cost') |
     # Single letter 'short codes'

lib/card_search_query_builder.rb

@@ -1,12 +1,19 @@
 class CardSearchQueryBuilder
     @@parser = CardSearchParser.new
     @@boolean_keywords = [
+        'additional_cost',
+        'advanceable',
         'b',
         'banlist',
+        'gains_subroutines',
         'in_restriction',
+        'interrupt',
         'is_banned',
         'is_restricted',
         'is_unique',
+        'on_encounter_effect',
+        'performs_trace',
+        'trash_ability',
         'u',
     ]
     @@numeric_keywords = [
@@ -20,11 +27,15 @@ class CardSearchQueryBuilder
         'h',
         'influence_cost',
         'l',
+        'link_provided',
         'm',
         'memory_usage',
+        'mu_provided',
         'n',
+        'num_printed_subroutines',
         'o',
         'p',
+        'recurring_credits_provided',
         'strength',
         'trash_cost',
         'universal_faction_cost',
@@ -62,6 +73,8 @@ class CardSearchQueryBuilder
     @@term_to_field_map = {
         # format should implicitly use the currently active card pool and restriction lists unless another is specified.
         '_' => 'cards.stripped_title',
+        'additional_cost' => 'cards.additional_cost',
+        'advanceable' => 'cards.advanceable',
         'advancement_cost' => 'cards.advancement_requirement',
         'agenda_points' => 'cards.agenda_points',
         'base_link' => 'cards.base_link',
@@ -75,26 +88,35 @@ class CardSearchQueryBuilder
         'faction' => 'cards.faction_id',
         'format' => 'unified_restrictions.format_id',
         'g' => 'cards.advancement_requirement',
+        'gains_subroutines' => 'cards.gains_subroutines',
         'global_penalty' => 'unified_restrictions.global_penalty',
         'h' => 'cards.trash_cost',
         'in_restriction' => 'unified_restrictions.in_restriction',
         'influence_cost' => 'cards.influence_cost',
+        'interrupt' => 'cards.interrupt',
         'is_banned' => 'unified_restrictions.is_banned',
         'is_restricted' => 'unified_restrictions.is_restricted',
         'is_unique' => 'cards.is_unique',
         'l' => 'cards.base_link',
+        'link_provided' => 'cards.link_provided',
         'm' => 'cards.memory_cost',
         'memory_usage' => 'cards.memory_cost',
+        'mu_provided' => 'cards.mu_provided',
         'n' => 'cards.influence_cost',
+        'num_printed_subroutines' => 'cards.num_printed_subroutines',
         'o' => 'cards.cost',
+        'on_encounter_effect' => 'cards.on_encounter_effect',
         'p' => 'cards.strength',
+        'performs_trace' => 'cards.performs_trace',
+        'recurring_credits_provided' => 'cards.recurring_credits_provided',
         'restriction_id' => 'unified_restrictions.restriction_id',
         's' => 'card_subtypes.name',
         'side' => 'cards.card_side_id',
         'strength' => 'cards.strength',
         't' => 'cards.card_type_id',
         'text' => 'cards.stripped_text',
         'title' => 'cards.stripped_title',
+        'trash_ability' => 'cards.trash_ability',
         'trash_cost' => 'cards.trash_cost',
         'u' => 'cards.is_unique',
         'universal_faction_cost' => 'unified_restrictions.universal_faction_cost',
@@ -155,19 +177,19 @@ def initialize(query)
                     constraints << '%s %s ?' % [@@term_to_field_map[keyword], operator]
                     where << value
                 elsif @@numeric_keywords.include?(keyword)
-                    if !value.match?(/\A\d+\Z/)
+                    if !value.match?(/\A(\d+|x)\Z/i)
                         @parse_error = 'Invalid value "%s" for integer field "%s"' % [value, keyword]
                         return
                     end 
                     operator = ''
-                   if @@numeric_operators.include?(match_type)
+                    if @@numeric_operators.include?(match_type)
                         operator = @@numeric_operators[match_type]
                     else
                         @parse_error = 'Invalid numeric operator "%s"' % match_type
                         return
                     end
                     constraints << '%s %s ?' % [@@term_to_field_map[keyword], operator]
-                    where << value 
+                    where << (value.downcase == 'x' ? -1 : value) 
                 else
                     # String fields only support : and !, resolving to to {,NOT} LIKE %value%.
                     # TODO(plural): consider ~ for regex matches. 
@@ -178,7 +200,7 @@ def initialize(query)
                         @parse_error = 'Invalid string operator "%s"' % match_type
                         return
                     end
-                   constraints << 'lower(%s) %s ?' % [@@term_to_field_map[keyword], operator]
+                    constraints << 'lower(%s) %s ?' % [@@term_to_field_map[keyword], operator]
                     where << '%%%s%%' % value
                 end
                 if @@term_to_left_join_map.include?(keyword)

lib/printing_search_parser.rb

@@ -18,6 +18,8 @@ class PrintingSearchParser < Parslet::Parser
   # Note that while this list should generally be kept sorted, an entry that is a prefix of
   # a later entry will clobber the later entries and throw an error parsing text with the later entries.
   rule(:keyword) {
+    str('additional_cost') |
+    str('advanceable') |
     str('advancement_cost') |
     str('agenda_points') |
     str('base_link') |
@@ -31,21 +33,30 @@ class PrintingSearchParser < Parslet::Parser
     str('faction') |
     str('flavor') |
     str('format') |
+    str('gains_subroutines') |
     str('global_penalty') |
     str('illustrator') |
     str('in_restriction') |
     str('influence_cost') |
+    str('interrupt') |
     str('is_banned') |
     str('is_restricted') |
     str('is_unique') |
+    str('link_provided') |
     str('memory_usage') |
+    str('mu_provided') |
+    str('num_printed_subroutines') |
+    str('on_encounter_effect') |
+    str('performs_trace') |
     str('quantity') |
+    str('recurring_credits_provided') |
     str('release_date') |
     str('restriction_id') |
     str('side') |
     str('strength') |
     str('text') |
     str('title') |
+    str('trash_ability') |
     str('trash_cost') |
     str('universal_faction_cost') |
     # Single letter 'short codes'