card 1.93.5 → 1.93.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22a6880a14a1b28876da170d7ac7c6c766d66a3c
-  data.tar.gz: 435e1b6b1746051ebca11c4532ab93887817ef1c
+  metadata.gz: b0adcfab0f64530119b1670a194d67fde9845ad6
+  data.tar.gz: 3febe6d143c9de76acff582cbddd9ec8fded0104
 SHA512:
-  metadata.gz: f05ee5687c4f1f67823576af89880a5b18becf2fef033815c7a5eb4024796a53807f5020cbf40e4b0175bdfabe44cbb55601f4acce566caa0e92635af6663b76
-  data.tar.gz: 6e12874f9150fb3adede3f6f9ed12e41bff2c1bc8ee13ef51e37b876644d1f9c11d173860c6760ea51f30c85703f976afe691e985702d973761cc2d62d79c38e
+  metadata.gz: a9f35f827cce3f73f984671c7a09f0d6adeff29523503f6b46b64bcfdee09c71449dcae5ab2356084f81788a9122a24821dc07a02b0036c9ee79f28ee2f699ae
+  data.tar.gz: f843c07e3dd51ae50d2cae972cdfd307706b7e8ae1b0057cd83dd2d0256b9336de707b5b9e9e49353881aaf526331559d1dcf3f4bd05da2e1a1fb73c61d1ca8d

data/VERSION

@@ -1 +1 @@
-0.3.5
+0.3.6

data/db/migrate_core_cards/data/1.12_stylesheets/classic_cards.scss

@@ -1,5 +1,5 @@
 /*
-This stylesheet defines the core rules of the "classic" Wagn look.
+This stylesheet defines the core rules of the "classic" Decko look.
 */
 
 body {

data/db/migrate_core_cards/data/1.12_stylesheets/traditional.scss

@@ -1,5 +1,6 @@
 /*
-This "traditional" styling is for backwards compatibility.  It is not intended for use in Wagns created after version 1.12.
+This "traditional" styling is for backwards compatibility.
+It is not intended for use in decks created after Wagnversion 1.12.
 
 There are three types of rules here:
   1. rules applying to selectors no longer included in standard layouts (#menu, #logo, #credit)

data/lib/card/format/nest.rb

@@ -17,7 +17,10 @@ class Card
         return "" if nest_invisible?
         nested_card = fetch_nested_card cardish, options
         view, options = interpret_nest_options nested_card, options
-        nest_render nested_card, view, options, override, &block
+
+        with_nest_mode options.delete(:mode) do
+          nest_render nested_card, view, options, override, &block
+        end
       end
 
       # nested by another card's content

data/lib/card/format/nest/mode.rb

@@ -18,12 +18,20 @@ class Card
         # run block with new_mode as nest_mode, then return to prior mode
         # @param new_mode [Symbol] :normal, :closed, :edit, or :template
         # @return block result
-        def with_nest_mode new_mode
+        def with_nest_mode new_mode, &block
+          if new_mode
+            with_altered_nest_mode new_mode, &block
+          else
+            yield
+          end
+        end
+
+        def with_altered_nest_mode new_mode
           old_mode = nest_mode
           @nest_mode = new_mode
-          result = yield
+          yield
+        ensure
           @nest_mode = old_mode
-          result
         end
 
         # view to be rendered in current mode

data/lib/card/query.rb

@@ -78,7 +78,7 @@ class Card
     OPERATORS =
       %w(!= = =~ < > in ~).each_with_object({}) { |v, h| h[v] = v }.merge(
         {
-          eq: "=", gt: ">", lt: "<", match: "~", ne: "!=", "not in" => nil
+          eq: "=", gt: ">", lt: "<", match: "~", ne: "!=", "not in": "not in"
         }.stringify_keys
       )
 
@@ -152,7 +152,11 @@ class Card
     end
 
     def limit
-      @mods[:limit].to_i
+      mods[:limit].to_i
+    end
+
+    def full?
+      !superquery && mods[:return] != "count"
     end
   end
 end

data/lib/card/query/sorting.rb

@@ -1,34 +1,43 @@
 class Card
   class Query
     module Sorting
-      SORT_JOIN_TO_ITEM_MAP = { left: "left_id", right: "right_id" }.freeze
+      SORT_BY_ITEM_JOIN_MAP = { left: "left_id", right: "right_id" }.freeze
 
       def sort val
-        return nil if @superquery
+        return nil unless full?
         sort_field = val[:return] || "db_content"
+        val = val.clone
         item = val.delete(:item) || "left"
-
         if sort_field == "count"
           sort_by_count val, item
-        elsif (join_field = SORT_JOIN_TO_ITEM_MAP[item.to_sym])
-          sq = join_cards(val, to_field: join_field,
-                               side: "LEFT",
-                               conditions_on_join: true)
-          @mods[:sort] ||= "#{sq.table_alias}.#{sort_field}"
         else
-          raise Card::Error::BadQuery, "sort item: #{item} not yet implemented"
+          sort_by_item_join val, item, sort_field
         end
       end
 
+      def sort_by_item_join val, item, sort_field
+        join_field = sort_by_item_join_field item
+        join = join_cards val, to_field: join_field,
+                               side: "LEFT",
+                               conditions_on_join: true
+        @mods[:sort] ||= "#{join.table_alias}.#{sort_field}"
+      end
+
+      def sort_by_item_join_field item
+        SORT_BY_ITEM_JOIN_MAP[item.to_sym] || sort_method_not_implemented(:join, item)
+      end
+
       # EXPERIMENTAL!
       def sort_by_count val, item
         method_name = "sort_by_count_#{item}"
-        unless respond_to?(method_name)
-          raise Card::Error::BadQuery, "count with item: #{item} not yet implemented"
-        end
+        sort_by_count_not_implemented :count, item unless respond_to? method_name
         send method_name, val
       end
 
+      def sort_method_not_implemented method, item
+        raise Card::Error::BadQuery, "sorting by ##{method}/#{item} not yet implemented"
+      end
+
       def sort_by_count_referred_to val
         @mods[:sort] = "coalesce(count,0)" # needed for postgres
         cs = Query.new(

data/lib/card/query/sql_statement.rb

@@ -179,8 +179,7 @@ class Card
       end
 
       def full_syntax
-        return if @query.superquery || @mods[:return] == "count"
-        yield
+        @query.full? ? yield : return
       end
 
       def order

data/lib/card/view/options.rb

@@ -16,17 +16,18 @@ class Card
 
       @keymap = {
         carditect: [
-          :view,          # view to render
-          :nest_name,     # name as used in nest
-          :nest_syntax,   # full nest syntax
-          :show,          # render these views when optional
-          :hide           # do not render these views when optional
-        ],                # note: show/hide can be single view (Symbol), list of views (Array),
-                          # or comma separated views (String)
+          :view,           # view to render
+          :nest_name,      # name as used in nest
+          :nest_syntax,    # full nest syntax
+          :show,           # render these views when optional
+          :hide            # do not render these views when optional
+        ],                 #   show/hide can be view (Symbol), list of views (Array),
+                           #   or comma separated views (String)
         heir: [
           :main,           # format object is page's "main" object (Boolean)
           :home_view,      # view for slot to return to when no view specified
-          :edit_structure  # use a different structure for editing (Array)
+          :edit_structure, # use a different structure for editing (Array)
+          :wql             # contextual wql alterations for search cards (Hash)
         ],
         both: [
           :help,           # cue text when editing
@@ -36,10 +37,10 @@ class Card
           :editor,         # inline_nests makes a form within standard content (Symbol)
           :type,           # set the default type of new cards
           :size,           # set an image size
-          :params,         # parameters for add button.  deprecate?
+          :params,         # parameters for add button.  deprecate!
           :items,          # options for items (Hash)
           :cache           # change view cache behaviour
-        ],                 # (Symbol<:always, :standard, :never>)
+        ],                 #   (Symbol<:always, :standard, :never>)
         none: [
           :skip_perms,     # do not check permissions for this view (Boolean)
           :main_view       # this is main view of page (Boolean)
@@ -136,9 +137,14 @@ class Card
 
       # options to be used in data attributes of card slots (normalized options
       # with standard keys)
+      # FIXME: what we really want is options as they were when render was called.
+      # normalized is wrong because it can get changed before render. live is wrong
+      # because they can get changed after.  current solution is a compromise.
       # @return [Hash]
       def slot_options
-        normalized_options.select { |k, _v| Options.all_keys.include? k }
+        normalized_options.merge(view: requested_view).select do |k, _v|
+          Options.all_keys.include? k
+        end
       end
 
       def closest_live_option key
@@ -175,7 +181,6 @@ class Card
         opts
       end
 
-
       # typically options are already a hash.  this also handles an array of
       # hashes and nil.
       def options_to_hash opts

data/mod/Modfile

@@ -1,3 +1,4 @@
+mod 'utility'
 mod 'admin'
 mod 'core'
 mod 'history'

data/mod/core/layout/simple_modal.html

@@ -0,0 +1,3 @@
+<div class="modal-body ">
+  {{_main}}
+</div>

data/mod/core/set/all/fetch_helper.rb

@@ -1,38 +1,45 @@
-
 module ClassMethods
-
   # a fetch method to support the needs of the card controller.
   # should be in Decko?
   def controller_fetch args
-    opts = controller_fetch_opts args
+    card_opts = controller_fetch_opts args
     if args[:action] == "create"
       # FIXME: we currently need a "new" card to catch duplicates
       # (otherwise save will just act like a normal update)
       # We may need a "#create" instance method to handle this checking?
-      Card.new opts
+      Card.new card_opts
     else
-      mark = args[:id] || opts[:name]
-      Card.fetch mark, look_in_trash: args[:look_in_trash], new: opts
+      standard_controller_fetch args, card_opts
     end
   end
 
   private
 
+  def standard_controller_fetch args, card_opts
+    mark = args[:id] || card_opts[:name]
+    card = Card.fetch mark, look_in_trash: args[:look_in_trash], new: card_opts
+    card.assign_attributes card_opts if args[:assign] && card&.real?
+    card
+  end
+
   def controller_fetch_opts args
-    opts =
-        # clone doesn't work for Parameters
-        if args[:card].respond_to?(:to_unsafe_h)
-          args[:card].to_unsafe_h
-        else
-          (args[:card] || {}).clone
-        end
-    # clone so that original params remain unaltered.  need deeper clone?
+    opts = safe_card_opts args[:card]
     opts[:type] ||= args[:type] if args[:type]
     # for /new/:type shortcut.  we should handle in routing and deprecate this
     opts[:name] ||= Card::Name.url_key_to_standard(args[:id])
     opts
   end
 
+  def safe_card_opts card_opts
+    if card_opts.respond_to? :to_unsafe_h
+      # clone doesn't work for Parameters
+      card_opts.to_unsafe_h
+    else
+      # clone so that original params remain unaltered.  need deeper clone?
+      (card_opts || {}).clone
+    end
+  end
+
   def validate_fetch_opts! opts
     return unless opts[:new] && opts[:skip_virtual]
     raise Card::Error, "fetch called with new args and skip_virtual"
@@ -46,23 +53,30 @@ module ClassMethods
     opts[:skip_virtual] || opts[:new].present? || opts[:skip_type_lookup]
   end
 
+  # look in cache.  if that doesn't work, look in database
+  # @return [{Card}, {True/False}] Card object and "needs_caching" ruling
   def retrieve_existing mark, opts
     return [nil, false] unless mark.present?
     mark_type, mark_key = retrievable_mark_type_and_value mark
-    needs_caching = false # until proven true :)
-
-    # look in cache
-    card = send "retrieve_from_cache_by_#{mark_type}", mark_key, opts[:local_only]
-
-    if retrieve_from_db? card, mark_type, mark_key, opts[:look_in_trash]
-      # look in db if needed
+    if (card = retrieve_from_cache_by_mark mark_type, mark_key, opts)
+      # we have an acceptable card in the cache
+      # (and don't need to cache it again!)
+      [card, false]
+    else
+      # try to find the card in the database
       card = retrieve_from_db mark_type, mark_key, opts[:look_in_trash]
-      needs_caching = !card.nil? && !card.trash
+      [card, !(card.nil? || card.trash)]
     end
+  end
 
-    [card, needs_caching]
+  def retrieve_from_cache_by_mark mark_type, mark_key, opts
+    card = send "retrieve_from_cache_by_#{mark_type}", mark_key, opts[:local_only]
+    return_cached_card?(card, opts[:look_in_trash]) ? card : nil
   end
 
+  # In both the cache and the db, ids and keys are used to retrieve card data.
+  # This method identifies the kind of mark to use and its value
+  # @return [Array] first item is :id or :key, second is corresponding value
   def retrievable_mark_type_and_value mark
     # return mark_type and mark_value
     if mark.is_a? Integer
@@ -72,17 +86,16 @@ module ClassMethods
     end
   end
 
-  def retrieve_from_db? card, mark_type, mark_key, look_in_trash
-    return false if card&.real?                                      # real card found in cache
-#    return false if mark_type == :key && mark_key.to_name.relative?  # no relative names in db
-    card.nil? || (look_in_trash && !card.trash)                      # card not found in cache (or trash lookup)
+  def return_cached_card? card, look_in_trash
+    return false unless card
+    card.real? || !look_in_trash
   end
 
+  # @return [Card, nil] Card object
   def retrieve_from_db mark_type, mark_key, look_in_trash=false
     query = { mark_type => mark_key }
     query[:trash] = false unless look_in_trash
-    card = Card.where(query).take
-    card
+    Card.where(query).take
   end
 
   def standard_fetch_results card, mark, opts
@@ -120,7 +133,6 @@ module ClassMethods
     return mark unless mark.name? && supercard
     mark.to_name.absolute_name supercard.name
   end
-
 end
 
 public

data/mod/core/spec/format/html_format_spec.rb

@@ -107,16 +107,12 @@ RSpec.describe Card::Format::HtmlFormat do
       it "does not recurse" do
         @layout_card.content = "Mainly {{_main|core}}"
         Card::Auth.as_bot { @layout_card.save }
-
-        expect(@layout_card.format.render!(:layout)).to eq(
-          "Mainly <div id=\"main\"><div class=\"CodeRay\">\n  " \
-          "<div class=\"code\"><pre>Mainly {{_main|core}}</pre></div>\n" \
-          "</div>\n</div>\n" \
-          '<div class="modal fade" role="dialog" id="modal-main-slot">' \
-          '<div class="modal-dialog"><div class="modal-content">' \
-          "</div></div></div>"
-        )
-        # probably better to check that it matches "Mainly" exactly twice.
+        rendered = @layout_card.format.render! :layout
+        expect(rendered).to have_tag "div#main" do
+          have_tag "div.code" do
+            have_tag("pre") { with_text "Mainly {{_main|core}}" }
+          end
+        end
       end
 
       it "handles nested _main references" do
@@ -125,13 +121,10 @@ RSpec.describe Card::Format::HtmlFormat do
           @layout_card.save!
           Card.create name: "outer space", content: "{{_main|name}}"
         end
-
-        expect(@main_card.format.render!(:layout)).to eq(
-          '<div id="main">Joe User</div>' + "\n" \
-          '<div class="modal fade" role="dialog" id="modal-main-slot">' \
-          '<div class="modal-dialog"><div class="modal-content">' \
-          "</div></div></div>"
-        )
+        rendered = @main_card.format.render! :layout
+        expect(rendered).to have_tag "div#main" do
+          with_text "Joe User"
+        end
       end
     end
   end

data/mod/core/spec/set/all/fetch_helper_spec.rb

@@ -0,0 +1,48 @@
+# -*- encoding : utf-8 -*-
+
+RSpec.describe Card::Set::All::FetchHelper do
+  let(:retrieve) { test_retrieve_existing }
+  let(:retrieve_from_trash) { test_retrieve_existing look_in_trash: true }
+
+  def test_retrieve_existing opts={}
+    Card.send :retrieve_existing, "A".to_name, opts
+  end
+
+  describe "retrieve_existing" do
+    it "looks for non-cached card in database" do
+      expect_db_retrieval_with(:key, "a", nil) { retrieve }
+    end
+
+    it "doesn't look in db for cached cards(real)" do
+      Card.cache.write "a", Card["B"]
+      expect_no_db_retrieval { retrieve }
+    end
+
+    it "doesn't look in db for cached cards (new)" do
+      Card.cache.write "a", Card.new
+      expect_no_db_retrieval { retrieve }
+    end
+
+    it "doesn't look in db for cached cards (real) if 'look_in_trash' option used" do
+      Card.cache.write "a", Card["B"]
+      expect_no_db_retrieval { retrieve_from_trash }
+    end
+
+    it "looks in db for cached cards (new) if 'look_in_trash' option used" do
+      Card.cache.write "a", Card.new
+      expect_db_retrieval_with(:key, "a", true) { retrieve_from_trash }
+    end
+
+    def expect_no_db_retrieval
+      allow(Card).to receive(:retrieve_from_db)
+      yield
+      expect(Card).not_to have_received(:retrieve_from_db)
+    end
+
+    def expect_db_retrieval_with *args
+      allow(Card).to receive(:retrieve_from_db)
+      yield
+      expect(Card).to have_received(:retrieve_from_db).with(*args)
+    end
+  end
+end