Merge pull request #106 from distributive/main

Flattened global penalty field to array instead of a mapping

Author: distributive

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

@@ -4,7 +4,7 @@ module Public
       class Api::V3::Public::FormatResource < JSONAPI::Resource
         immutable
 
-        attributes :name, :active_snapshot_id, :snapshot_ids, :updated_at
+        attributes :name, :active_snapshot_id, :snapshot_ids, :restriction_ids, :updated_at
         attributes :active_card_pool_id, :active_restriction_id
         key_type :string
 

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

@@ -17,7 +17,7 @@ def verdicts
           { 'banned': @model.banned_cards.pluck(:card_id),
             'restricted': @model.restricted_cards.pluck(:card_id),
             'universal_faction_cost': Hash[@model.universal_faction_cost_cards.pluck(:value, :card_id).group_by(&:first).map{ |k,a| [k,a.map(&:last)] }],
-            'global_penalty': Hash[@model.global_penalty_cards.pluck(:value, :card_id).group_by(&:first).map{ |k,a| [k,a.map(&:last)] }],
+            'global_penalty': @model.global_penalty_cards.pluck(:card_id),
             'points': Hash[@model.points_cards.pluck(:value, :card_id).group_by(&:first).map{ |k,a| [k,a.map(&:last)] }]
           }
         end

db/migrate/20220925113944_update_unified_restrictions_to_version_4.rb

@@ -0,0 +1,5 @@
+class UpdateUnifiedRestrictionsToVersion4 < ActiveRecord::Migration[7.0]
+  def change
+    update_view :unified_restrictions, materialized: true, version: 4, revert_to_version: 3
+  end
+end

db/migrate/20220925225117_remove_value_from_restrictions_cards_global_penalty.rb

@@ -0,0 +1,5 @@
+class RemoveValueFromRestrictionsCardsGlobalPenalty < ActiveRecord::Migration[7.0]
+  def change
+    remove_column :restrictions_cards_global_penalty, :value
+  end
+end

db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 2022_09_23_032558) do
+ActiveRecord::Schema[7.0].define(version: 2022_09_25_225117) do
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
 
@@ -195,7 +195,6 @@
   create_table "restrictions_cards_global_penalty", id: false, force: :cascade do |t|
     t.text "restriction_id", null: false
     t.text "card_id", null: false
-    t.integer "value", null: false
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
   end
@@ -301,7 +300,10 @@
               ELSE false
           END AS is_restricted,
       COALESCE(restrictions_cards_points.value, 0) AS eternal_points,
-      COALESCE(restrictions_cards_global_penalty.value, 0) AS global_penalty,
+          CASE
+              WHEN (restrictions_cards_global_penalty.restriction_id IS NOT NULL) THEN true
+              ELSE false
+          END AS has_global_penalty,
       COALESCE(restrictions_cards_universal_faction_cost.value, 0) AS universal_faction_cost
      FROM ((((((cards_cross_restrictions_and_snapshots
        JOIN card_pools_cards ON (((card_pools_cards.card_pool_id = cards_cross_restrictions_and_snapshots.card_pool_id) AND (card_pools_cards.card_id = (cards_cross_restrictions_and_snapshots.card_id)::text))))

db/views/unified_restrictions_v04.sql

@@ -0,0 +1,49 @@
+WITH cards_cross_restrictions_and_snapshots AS (
+    SELECT
+        cards.id as card_id,
+        restrictions.id as restriction_id,
+        snapshots.id as snapshot_id,
+        snapshots.format_id as format_id,
+        snapshots.card_pool_id as card_pool_id,
+        snapshots.date_start as snapshot_date_start
+    FROM
+        cards, restrictions JOIN snapshots ON restrictions.id = snapshots.restriction_id
+)
+SELECT
+    cards_cross_restrictions_and_snapshots.format_id,
+    cards_cross_restrictions_and_snapshots.card_pool_id,
+    cards_cross_restrictions_and_snapshots.snapshot_id,
+    cards_cross_restrictions_and_snapshots.snapshot_date_start,
+    cards_cross_restrictions_and_snapshots.restriction_id,
+    cards_cross_restrictions_and_snapshots.card_id,
+    restrictions_cards_banned.restriction_id IS NOT NULL
+        OR restrictions_cards_restricted.restriction_id IS NOT NULL
+        OR restrictions_cards_points.restriction_id IS NOT NULL
+        OR restrictions_cards_global_penalty.restriction_id IS NOT NULL
+        OR restrictions_cards_universal_faction_cost.restriction_id IS NOT NULL
+        as in_restriction,
+    CASE WHEN restrictions_cards_banned.restriction_id IS NOT NULL THEN true ELSE false END AS is_banned,
+    CASE WHEN restrictions_cards_restricted.restriction_id IS NOT NULL THEN true ELSE false END AS is_restricted,
+    COALESCE(restrictions_cards_points.value, 0) AS eternal_points,
+    CASE WHEN restrictions_cards_global_penalty.restriction_id IS NOT NULL THEN true ELSE false END AS has_global_penalty,
+    COALESCE(restrictions_cards_universal_faction_cost.value, 0) AS universal_faction_cost
+FROM
+    cards_cross_restrictions_and_snapshots
+    JOIN card_pools_cards ON card_pools_cards.card_pool_id = cards_cross_restrictions_and_snapshots.card_pool_id
+        AND card_pools_cards.card_id = cards_cross_restrictions_and_snapshots.card_id
+    LEFT OUTER JOIN restrictions_cards_banned ON
+        restrictions_cards_banned.restriction_id = cards_cross_restrictions_and_snapshots.restriction_id
+        AND restrictions_cards_banned.card_id = cards_cross_restrictions_and_snapshots.card_id
+    LEFT OUTER JOIN restrictions_cards_points ON
+        restrictions_cards_points.restriction_id = cards_cross_restrictions_and_snapshots.restriction_id
+        AND restrictions_cards_points.card_id = cards_cross_restrictions_and_snapshots.card_id
+    LEFT OUTER JOIN restrictions_cards_global_penalty ON
+        restrictions_cards_global_penalty.restriction_id = cards_cross_restrictions_and_snapshots.restriction_id
+        AND restrictions_cards_global_penalty.card_id = cards_cross_restrictions_and_snapshots.card_id
+    LEFT OUTER JOIN restrictions_cards_restricted ON
+        restrictions_cards_restricted.restriction_id = cards_cross_restrictions_and_snapshots.restriction_id
+        AND restrictions_cards_restricted.card_id = cards_cross_restrictions_and_snapshots.card_id
+    LEFT OUTER JOIN restrictions_cards_universal_faction_cost ON
+        restrictions_cards_universal_faction_cost.restriction_id = cards_cross_restrictions_and_snapshots.restriction_id
+        AND restrictions_cards_universal_faction_cost.card_id = cards_cross_restrictions_and_snapshots.card_id
+;

lib/card_search_parser.rb

@@ -31,7 +31,7 @@ class CardSearchParser < Parslet::Parser
     str('faction') |
     str('format') |
     str('gains_subroutines') |
-    str('global_penalty') |
+    str('has_global_penalty') |
     str('illustrator') |
     str('in_restriction') |
     str('influence_cost') |

lib/card_search_query_builder.rb

@@ -6,6 +6,7 @@ class CardSearchQueryBuilder
         'b',
         'banlist',
         'gains_subroutines',
+        'has_global_penalty',
         'in_restriction',
         'interrupt',
         'is_banned',
@@ -23,7 +24,6 @@ class CardSearchQueryBuilder
         'cost',
         'eternal_points',
         'g',
-        'global_penalty',
         'h',
         'influence_cost',
         'l',
@@ -89,8 +89,8 @@ class CardSearchQueryBuilder
         'format' => 'unified_restrictions.format_id',
         'g' => 'cards.advancement_requirement',
         'gains_subroutines' => 'cards.gains_subroutines',
-        'global_penalty' => 'unified_restrictions.global_penalty',
         'h' => 'cards.trash_cost',
+        'has_global_penalty' => 'unified_restrictions.has_global_penalty',
         'in_restriction' => 'unified_restrictions.in_restriction',
         'influence_cost' => 'cards.influence_cost',
         'interrupt' => 'cards.interrupt',
@@ -128,7 +128,7 @@ class CardSearchQueryBuilder
         'card_pool' => :card_pool_cards,
         'card_subtype' => :card_subtypes,
         'eternal_points' => :unified_restrictions,
-        'global_penalty' => :unified_restrictions,
+        'has_global_penalty' => :unified_restrictions,
         'in_restriction' => :unified_restrictions,
         'is_banned' => :unified_restrictions,
         'is_restricted' => :unified_restrictions,
@@ -141,7 +141,7 @@ def initialize(query)
         @query = query
         @parse_error = nil
         @parse_tree = nil
-        @left_joins = Set.new 
+        @left_joins = Set.new
         @where = ''
         @where_values = []
         begin
@@ -155,8 +155,8 @@ def initialize(query)
         constraints = []
         where = []
         # TODO(plural): build in explicit support for requirements
-        #   {is_banned,is_restricted,eternal_points,global_penalty,universal_faction_cost} all require restriction_id, would be good to have card_pool_id as well.
-        # TODO(plural): build in explicit support for smart defaults, like restriction_id should imply is_banned = false.  card_pool_id should imply the latest restriction list. 
+        #   {is_banned,is_restricted,eternal_points,has_global_penalty,universal_faction_cost} all require restriction_id, would be good to have card_pool_id as well.
+        # TODO(plural): build in explicit support for smart defaults, like restriction_id should imply is_banned = false.  card_pool_id should imply the latest restriction list.
         @parse_tree[:fragments].each {|f|
             if f.include?(:search_term)
                 keyword = f[:search_term][:keyword].to_s
@@ -180,7 +180,7 @@ def initialize(query)
                     if !value.match?(/\A(\d+|x)\Z/i)
                         @parse_error = 'Invalid value "%s" for integer field "%s"' % [value, keyword]
                         return
-                    end 
+                    end
                     operator = ''
                     if @@numeric_operators.include?(match_type)
                         operator = @@numeric_operators[match_type]
@@ -192,7 +192,7 @@ def initialize(query)
                     where << (value.downcase == 'x' ? -1 : value) 
                 else
                     # String fields only support : and !, resolving to to {,NOT} LIKE %value%.
-                    # TODO(plural): consider ~ for regex matches. 
+                    # TODO(plural): consider ~ for regex matches.
                     operator = ''
                     if @@string_operators.include?(match_type)
                         operator = @@string_operators[match_type]
@@ -205,7 +205,7 @@ def initialize(query)
                 end
                 if @@term_to_left_join_map.include?(keyword)
                     @left_joins << @@term_to_left_join_map[keyword]
-                end 
+                end
              end
 
             # bare/quoted words in the query are automatically mapped to stripped_title
@@ -214,7 +214,7 @@ def initialize(query)
                     operator = value.start_with?('!') ? 'NOT LIKE' : 'LIKE'
                     value    = value.start_with?('!') ? value[1..] : value
                     constraints << 'lower(cards.stripped_title) %s ?' % operator
-                    where << '%%%s%%' % value 
+                    where << '%%%s%%' % value
             end
         }
         @where = constraints.join(' AND ')

lib/printing_search_parser.rb

@@ -34,7 +34,7 @@ class PrintingSearchParser < Parslet::Parser
     str('flavor') |
     str('format') |
     str('gains_subroutines') |
-    str('global_penalty') |
+    str('has_global_penalty') |
     str('illustrator') |
     str('in_restriction') |
     str('influence_cost') |

lib/printing_search_query_builder.rb

@@ -6,6 +6,7 @@ class PrintingSearchQueryBuilder
         'b',
         'banlist',
         'gains_subroutines',
+        'has_global_penalty',
         'in_restriction',
         'interrupt',
         'is_banned',
@@ -27,7 +28,6 @@ class PrintingSearchQueryBuilder
         'cost',
         'eternal_points',
         'g',
-        'global_penalty',
         'h',
         'influence_cost',
         'l',
@@ -113,7 +113,7 @@ class PrintingSearchQueryBuilder
         'format' => 'unified_restrictions.format_id',
         'g' => 'cards.advancement_requirement',
         'gains_subroutines' => 'cards.gains_subroutines',
-        'global_penalty' => 'unified_restrictions.global_penalty',
+        'has_global_penalty' => 'unified_restrictions.has_global_penalty',
         'h' => 'cards.trash_cost',
         'i' => 'illustrators.name',
         'illustrator' => 'illustrators.name',
@@ -175,7 +175,7 @@ class PrintingSearchQueryBuilder
         'format' => :unified_restrictions,
         'g' => :card,
         'gains_subroutines' => :card,
-        'global_penalty' => :unified_restrictions,
+        'has_global_penalty' => :unified_restrictions,
         'h' => :card,
         'i' => :illustrators,
         'illustrator' => :illustrators,
@@ -216,7 +216,7 @@ def initialize(query)
         @query = query
         @parse_error = nil
         @parse_tree = nil
-        @left_joins = Set.new 
+        @left_joins = Set.new
         @where = ''
         @where_values = []
         begin
@@ -230,8 +230,8 @@ def initialize(query)
         constraints = []
         where = []
         # TODO(plural): build in explicit support for requirements
-        #   {is_banned,is_restricted,eternal_points,global_penalty,universal_faction_cost} all require restriction_id, would be good to have card_pool_id as well.
-        # TODO(plural): build in explicit support for smart defaults, like restriction_id should imply is_banned = false.  card_pool_id should imply the latest restriction list. 
+        #   {is_banned,is_restricted,eternal_points,has_global_penalty,universal_faction_cost} all require restriction_id, would be good to have card_pool_id as well.
+        # TODO(plural): build in explicit support for smart defaults, like restriction_id should imply is_banned = false.  card_pool_id should imply the latest restriction list.
         @parse_tree[:fragments].each {|f|
             if f.include?(:search_term)
                 keyword = f[:search_term][:keyword].to_s
@@ -255,7 +255,7 @@ def initialize(query)
                     if !value.match?(/\A(\d{4}-\d{2}-\d{2}|\d{8})\Z/)
                         @parse_error = 'Invalid value "%s" for date field "%s" - only YYYY-MM-DD or YYYYMMDD are supported.' % [value, keyword]
                         return
-                    end 
+                    end
                     operator = ''
                     if @@date_operators.include?(match_type)
                         operator = @@date_operators[match_type]
@@ -264,12 +264,12 @@ def initialize(query)
                         return
                     end
                     constraints << '%s %s ?' % [@@term_to_field_map[keyword], operator]
-                    where << value 
+                    where << value
                 elsif @@numeric_keywords.include?(keyword)
                     if !value.match?(/\A(\d+|x)\Z/i)
                         @parse_error = 'Invalid value "%s" for integer field "%s"' % [value, keyword]
                         return
-                    end 
+                    end
                     operator = ''
                     if @@numeric_operators.include?(match_type)
                         operator = @@numeric_operators[match_type]
@@ -281,7 +281,7 @@ def initialize(query)
                     where << (value.downcase == 'x' ? -1 : value)
                 else
                     # String fields only support : and !, resolving to to {,NOT} LIKE %value%.
-                    # TODO(plural): consider ~ for regex matches. 
+                    # TODO(plural): consider ~ for regex matches.
                     operator = ''
                     if @@string_operators.include?(match_type)
                         operator = @@string_operators[match_type]
@@ -294,7 +294,7 @@ def initialize(query)
                 end
                 if @@term_to_left_join_map.include?(keyword)
                     @left_joins << @@term_to_left_join_map[keyword]
-                end 
+                end
             end
 
             # bare/quoted words in the query are automatically mapped to stripped_title
@@ -303,7 +303,7 @@ def initialize(query)
                     operator = value.start_with?('!') ? 'NOT LIKE' : 'LIKE'
                     value    = value.start_with?('!') ? value[1..] : value
                     constraints << 'lower(cards.stripped_title) %s ?' % operator
-                    where << '%%%s%%' % value 
+                    where << '%%%s%%' % value
             end
         }
         @where = constraints.join(' AND ')

lib/tasks/cards.rake

@@ -570,8 +570,7 @@ namespace :cards do
           cards.each do |card|
             global_penalty << RestrictionCardGlobalPenalty.new(
               restriction_id: r['id'],
-              card_id: card,
-              value: cost
+              card_id: card
             )
           end
         end