card 1.96.8 → 1.97.0

data/lib/card/cache/temporary.rb

@@ -20,6 +20,7 @@ class Card
       # @param key [String]
       def read key
         return unless @store.key? key
+
         @store[key]
       end
 

data/lib/card/codename.rb

@@ -1,12 +1,14 @@
 # -*- encoding : utf-8 -*-
+
 require_dependency "card/cache"
 require_dependency "card/name"
 
 class Card
-  # {Card}'s names can be changed, and therefore _names_ should not be directly mentioned in code, lest a name change break the application.
+  # {Card}'s names can be changed, and therefore _names_ should not be directly mentioned
+  # in code, lest a name change break the application.
   #
-  # Instead, a {Card} that needs specific code manipulations should be given a {Codename}, which will not change even if the card's name
-  # does.
+  # Instead, a {Card} that needs specific code manipulations should be given a {Codename},
+  # which will not change even if the card's name does.
   #
   # An administrator might add to the Company card via the RESTful web API with a url like
   #
@@ -18,7 +20,8 @@ class Card
   #
   # Generally speaking, _codenames_ are represented by Symbols.
   #
-  # The {Codename} class provides a fast cache for this slow-changing data. Every process maintains a complete cache that is not frequently reset
+  # The {Codename} class provides a fast cache for this slow-changing data.
+  # Every process maintains a complete cache that is not frequently reset
   #
   class Codename
     class << self
@@ -102,6 +105,7 @@ class Card
       # @todo remove duplicate checks here; should be caught upon creation
       def check_duplicates codehash, codename, card_id
         return unless codehash.key?(codename) || codehash.key?(card_id)
+
         Rails.logger.debug "dup codename: #{codename}, "\
                            "ID:#{card_id} (#{codehash[codename]})"
       end
@@ -125,8 +129,8 @@ class Card
 
       def unknown_codename! mark
         raise Card::Error::CodenameNotFound, I18n.t(:exception_unknown_codename,
-                                            scope: "lib.card.codename",
-                                            codename: mark)
+                                                    scope: "lib.card.codename",
+                                                    codename: mark)
       end
     end
   end
@@ -139,6 +143,7 @@ class Card
   # @raise error if codename is missing
   def self.const_missing const
     return super unless const.to_s =~ /^([A-Z]\S*)ID$/
+
     code = Regexp.last_match(1).underscore
     code_id = Card::Codename.id!(code)
     const_set const, code_id

data/lib/card/content/chunk.rb

@@ -28,6 +28,7 @@ class Card
           prefix_map_by_chunkname[klassname] = { prefix_index => klass.config }
           raw_list.each do |key, list|
             next unless list.include? klassname
+
             prefix_map_by_list[key].merge! prefix_map_by_chunkname[klassname]
           end
         end
@@ -37,12 +38,14 @@ class Card
           prefix_map_by_list[key] =
             list.each_with_object({}) do |chunkname, h|
               next unless (p_map = prefix_map_by_chunkname[chunkname])
+
               h.merge! p_map
             end
-          prefix_map_by_list[key]
         end
 
         def find_class_by_prefix prefix, chunk_list_key=:default
+          validate_chunk_list_key chunk_list_key
+
           prefix_map = prefix_map_by_list[chunk_list_key]
           config = prefix_map[prefix[0, 1]] ||
                    prefix_map[prefix[-1, 1]] ||
@@ -53,13 +56,25 @@ class Card
           config[:class]
         end
 
-        def get_prefix_regexp chunk_list_key
-          prefix_regexp_by_list[chunk_list_key] ||= begin
-            prefix_res = raw_list[chunk_list_key].map do |chunkname|
+        def prefix_regexp chunk_list_key
+          prefix_regexp_by_list[chunk_list_key] ||=
+            build_prefix_regexp chunk_list_key
+        end
+
+        def build_prefix_regexp chunk_list_key
+          validate_chunk_list_key chunk_list_key
+
+          prefix_res =
+            raw_list[chunk_list_key].map do |chunkname|
               chunk_class = const_get chunkname
               chunk_class.config[:prefix_re]
             end
-            /(?:#{ prefix_res * '|' })/m
+          /(?:#{ prefix_res * '|' })/m
+        end
+
+        def validate_chunk_list_key chunk_list_key
+          unless raw_list.key? chunk_list_key
+            raise ArgumentError, "invalid chunk list key: #{chunk_list_key}"
           end
         end
       end
@@ -67,10 +82,10 @@ class Card
       # not sure whether this is best place.
       # Could really happen almost anywhere
       # (even before chunk classes are loaded).
-      register_list :default, [
-        :URI, :HostURI, :EmailURI, :EscapedLiteral, :Nest, :Link
+      register_list :default, %i[
+        URI HostURI EmailURI EscapedLiteral Nest Link
       ]
-      register_list :references,  [:EscapedLiteral, :Nest, :Link]
+      register_list :references,  %i[EscapedLiteral Nest Link]
       register_list :nest_only, [:Nest]
       register_list :query, [:QueryReference]
       register_list :stub, [:ViewStub]
@@ -133,7 +148,7 @@ class Card
 
         def as_json _options={}
           @process_chunk || @processed ||
-            "not rendered #{self.class}, #{card && card.name}"
+            "not rendered #{self.class}, #{card&.name}"
         end
       end
     end

data/lib/card/content/clean.rb

@@ -3,10 +3,10 @@ class Card
     # tools for cleaning content, especially for restricing unwanted HTML
     module Clean
       allowed_tags = {}
-      %w(
+      %w[
         br i b pre cite caption strong em ins sup sub del ol hr ul li p
         div h1 h2 h3 h4 h5 h6 span table tr td th tbody thead tfoot
-      ).each { |tag| allowed_tags[tag] = [] }
+      ].each { |tag| allowed_tags[tag] = [] }
 
       # allowed attributes
       allowed_tags.merge!(
@@ -61,6 +61,7 @@ class Card
 
       def process_attribute attrib, all_attributes
         return ['"', nil] unless all_attributes =~ /\b#{attrib}\s*=\s*(?=(.))/i
+
         q = '"'
         rest_value = $'
         if (idx = %w[' "].index Regexp.last_match(1))
@@ -74,6 +75,7 @@ class Card
       # NOTE allows classes beginning with "w-" (deprecated)
       def process_attribute_match rest_value, reg_exp, attrib
         return rest_value unless (match = rest_value.match reg_exp)
+
         rest_value = match[0]
         if attrib == "class"
           rest_value.split(/\s+/).select { |s| s =~ /^w-/i }.join(" ")

data/lib/card/content/diff.rb

@@ -34,10 +34,10 @@ class Card
       # summary: {length: <number> , joint: <string> }
       def initialize old_version, new_version, opts={}
         @result = Result.new opts[:summary]
-        if new_version
-          lcs_opts = lcs_opts_for_format opts[:diff_format]
-          LCS.new(lcs_opts).run(old_version, new_version, @result)
-        end
+        return unless new_version
+
+        lcs_opts = lcs_opts_for_format opts[:diff_format]
+        LCS.new(lcs_opts).run(old_version, new_version, @result)
       end
 
       def red?

data/lib/card/content/diff/lcs.rb

@@ -34,9 +34,7 @@ class Card
             processor.run @result
           else
             list = split_and_preprocess(new_text)
-            if @exclude_pattern
-              list = list.reject { |word| word.match @exclude_pattern }
-            end
+            list = list.reject { |word| word.match @exclude_pattern } if @exclude_pattern
             # CAUTION: postproces and added_chunk changed order
             # and no longer postprocess for summary
             @result.write_added_chunk list.join

data/lib/card/content/diff/processor.rb

@@ -62,12 +62,14 @@ class Card
 
           def write_dels
             return if @dels.empty?
+
             @result.write_deleted_chunk @dels.join
             @dels = []
           end
 
           def write_adds
             return if @adds.empty?
+
             @result.write_added_chunk @adds.join
             @adds = []
           end

data/lib/card/content/diff/result.rb

@@ -102,18 +102,21 @@ class Card
 
           def truncate_overlap
             return unless @remaining_chars < 0
+
             process_ellipsis
 
             index = @chunks.size - 1
             while @remaining_chars < @joint.size && index >= 0
               overlap_size = @remaining_chars + @chunks[index][:text].size
               break if process_overlap overlap_size, index
+
               index -= 1
             end
           end
 
           def process_ellipsis
             return unless @chunks.last[:action] == :ellipsis
+
             @chunks.pop
             @content_omitted = true
             @remaining_chars += @joint.size

data/lib/card/content/parser.rb

@@ -21,6 +21,7 @@ class Card
         @content = content
         @chunks = []
         return @chunks unless content.is_a? String
+
         @position = @last_position = 0
         @interval_string = ""
         parse_chunks
@@ -30,7 +31,7 @@ class Card
       private
 
       def parse_chunks
-        prefix_regexp = Chunk.get_prefix_regexp @chunk_list
+        prefix_regexp = Chunk.prefix_regexp @chunk_list
         match_prefices prefix_regexp
         handle_remainder
       end

data/lib/card/content/truncate.rb

@@ -6,6 +6,7 @@ class Card
 
       def smart_truncate input, words=25
         return if input.nil?
+
         truncated, wordstring = truncate input, words
         # nuke partial tags at end of snippet
         wordstring.gsub!(/(<[^\>]+)$/, "")
@@ -18,7 +19,7 @@ class Card
       def truncate input, words
         wordlist = input.to_s.split
         l = words.to_i - 1
-        l = 0 if l < 0
+        l = 0 if l.negative?
         truncating = wordlist.length > l
         wordstring = truncating ? wordlist[0..l].join(" ") : input.to_s
         [truncating, wordstring]
@@ -48,11 +49,13 @@ class Card
         # match tags with self closing and mark them as closed
         wordstring.scan(%r{\<([^\>\s/]+)[^\>]*?/\>}).each do |t|
           next unless (x = tags.index(t[0]))
+
           tags.slice!(x)
         end
         # match close tags
         wordstring.scan(%r{\</([^\>\s/]+)[^\>]*?\>}).each do |t|
           next unless (x = tags.rindex(t[0]))
+
           tags.slice!(x)
         end
         tags

data/lib/card/dirty.rb

@@ -9,7 +9,7 @@ class Card
     end
   end
 
-  [:name, :db_content, :trash, :type_id].each do |field|
+  %i[name db_content trash type_id].each do |field|
     define_dirty_methods field
   end
 
@@ -25,7 +25,8 @@ class Card
     end
   end
 
-  def not_in_callback? # or in integrate_with_delay stage
+  def not_in_callback?
+    # or in integrate_with_delay stage
     mutations_before_last_save.equal?(mutations_from_database)
   end
 

data/lib/card/env.rb

@@ -9,14 +9,15 @@ class Card
   module Env
     extend LocationHistory
 
-    SERIALIZABLE_ATTRIBUTES = ::Set.new [
-      :main_name, :params, :ip, :ajax, :html, :host, :protocol, :salt
+    SERIALIZABLE_ATTRIBUTES = ::Set.new %i[
+      main_name params ip ajax html host protocol salt
     ]
 
     class << self
       def reset args={}
         @env = { main_name: nil }
         return self unless (c = args[:controller])
+
         self[:controller] = c
         self[:session]    = c.request.session
         self[:params]     = c.params
@@ -44,11 +45,19 @@ class Card
         # FIXME:  upgrade to safe parameters
         self[:slot_opts] ||= begin
           opts = params[:slot] || {}
+          opts.merge shortcut_slot_opts
           opts = opts.to_unsafe_h if opts.is_a? ActionController::Parameters
           opts.deep_symbolize_keys
         end
       end
 
+      def shortcut_slot_opts
+        opts = {}
+        opts[:size] = params[:size].to_sym if params[:size]
+        opts[:items] = { view: params[:item].to_sym } if params[:item].present?
+        opts
+      end
+
       def session
         self[:session] ||= {}
       end

data/lib/card/env/location_history.rb

@@ -11,6 +11,7 @@ class Card
 
       def save_location card
         return unless save_location?(card)
+
         discard_locations_for card
         session[:previous_location] =
           Env::Location.card_path card.name.url_key
@@ -23,6 +24,7 @@ class Card
 
       def previous_location
         return unless location_history
+
         session[:previous_location] ||= location_history.last
       end
 
@@ -45,7 +47,7 @@ class Card
       end
 
       def url_key_for_location location
-        (%r{/([^/]*$)} =~ location) ? Regexp.last_match[1] : nil
+        %r{/([^/]*$)} =~ location ? Regexp.last_match[1] : nil
       end
     end
   end

data/lib/card/env/success.rb

@@ -4,7 +4,9 @@ class Card
     class Success
       include Card::Env::Location
 
-      attr_accessor :params, :redirect, :id, :name, :card, :name_context
+      attr_accessor :redirect, :name, :name_context
+      attr_writer :params, :card
+      attr_reader :id
 
       def initialize name_context=nil, success_args=nil
         @name_context = name_context

data/lib/card/error.rb

@@ -6,6 +6,7 @@ class Card
   class Error < StandardError
     cattr_accessor :current
     class_attribute :status_code, :view
+    attr_writer :backtrace
 
     self.view = :errors
     self.status_code = 422
@@ -25,6 +26,10 @@ class Card
              scope: %i[lib card error], cardname: card.name, message: card_message_text
     end
 
+    def backtrace
+      @backtrace || super
+    end
+
     def report
       Rails.logger.info "exception = #{self.class}: #{message}"
     end
@@ -35,8 +40,15 @@ class Card
 
     # error attributable to code (as opposed to card configuration)
     class ServerError < Error
-      self.view = :server_error
-      self.status_code = 500
+      def self.view
+        Card[:debugger]&.content =~ /on/ ? :debug_server_error : :server_error
+      end
+
+      def self.status_code
+        # Errors with status code 900 are displayed as modal instead of inside
+        # the "card-notice" div``
+        Card[:debugger]&.content =~ /on/ ? 900 : 500
+      end
 
       def report
         super
@@ -52,6 +64,11 @@ class Card
     class BadQuery < UserError
     end
 
+    class BadAddress < UserError
+      self.status_code = 404
+      self.view = :bad_address
+    end
+
     # card not found
     class NotFound < UserError
       self.status_code = 404
@@ -81,6 +98,10 @@ class Card
     class Abort < StandardError
       attr_reader :status
 
+      def report
+        Rails.logger.debug "aborting: #{message}"
+      end
+
       def initialize status, msg=""
         @status = status
         super msg
@@ -92,13 +113,24 @@ class Card
       KEY_MAP = { permission_denied: PermissionDenied,
                   conflict: EditConflict }.freeze
 
+      def report exception, card
+        e = cardify_exception exception, card
+        self.current = e
+        e.report
+        e
+      end
+
       def cardify_exception exception, card
-        unless exception.is_a? Card::Error
-          exception = card_error_class(exception, card).new exception.message
-        end
-        exception.card ||= card
-        add_card_errors card, exception if exception.card.errors.empty?
-        exception
+        card_exception =
+          if exception.is_a? Card::Error
+            exception
+          else
+            card_error_class(exception, card).new exception.message
+          end
+        card_exception.card ||= card
+        card_exception.backtrace ||= exception.backtrace
+        add_card_errors card, card_exception if card.errors.empty?
+        card_exception
       end
 
       def add_card_errors card, exception
@@ -107,6 +139,8 @@ class Card
       end
 
       def card_error_class exception, card
+        # "simple" error messages are visible to end users and are generally not
+        # treated as software bugs (though they may be "shark" bugs)
         case exception
         when ActiveRecord::RecordInvalid
           invalid_card_error_class card