card 1.16.15 → 1.17.0

data/lib/card.rb

@@ -8,10 +8,10 @@ Object.send :remove_const, :Card if Object.send(:const_defined?, :Card)
 # a. how ruby Card objects work, and
 # b. how to extend them.
 #
-# It assumes that you've already read the introductory text in {file:README_Developers.rdoc}.
+# It assumes that you've already read the introductory text
+# in {file:README_Developers.rdoc}.
 #
 class Card < ActiveRecord::Base
-
   # attributes that ActiveJob can handle
   def self.serializable_attr_accessor *args
     self.serializable_attributes = args
@@ -36,24 +36,29 @@ class Card < ActiveRecord::Base
   has_many :references_from, class_name: :Reference, foreign_key: :referee_id
   has_many :references_to,   class_name: :Reference, foreign_key: :referer_id
   has_many :acts, -> { order :id }
-  has_many :actions, -> { where( draft: [nil,false]).order :id }
-  has_many :drafts, -> { where( draft: true ).order :id }, class_name: :Action
+  has_many :actions, -> { where(draft: [nil, false]).order :id }
+  has_many :drafts, -> { where(draft: true).order :id }, class_name: :Action
 
-  cattr_accessor :set_patterns, :error_codes, :serializable_attributes, :set_specific_attributes
-  @@set_patterns, @@error_codes = [], {}
+  cattr_accessor :set_patterns, :serializable_attributes, :error_codes,
+                 :set_specific_attributes
+  @@set_patterns = []
+  @@error_codes = {}
 
-  serializable_attr_accessor :action, :supercard, :superleft, :current_act, :current_action,
+  serializable_attr_accessor(
+    :action, :supercard, :superleft,
+    :current_act, :current_action,
     :comment, :comment_author,    # obviated soon
     :update_referencers,          # wrong mechanism for this
     :update_all_users,            # if the above is wrong then this one too
     :silent_change,               # and this probably too
     :remove_rule_stash,
     :last_action_id_before_edit
+  )
 
   attr_accessor :follower_stash
 
-
-  define_callbacks :prepare, :approve, :store, :stored, :extend, :subsequent, :select_action, :show, :handle
+  define_callbacks :prepare, :approve, :store, :stored, :extend, :subsequent,
+                   :select_action, :show, :handle
 
   before_validation :prepare
   before_validation :approve
@@ -63,8 +68,4 @@ class Card < ActiveRecord::Base
   TRACKED_FIELDS = %w(name type_id db_content trash)
   extend CarrierWave::Mount
   ActiveSupport.run_load_hooks(:card, self)
-
-
 end
-
-

data/lib/card/auth.rb

@@ -6,6 +6,10 @@ class Card
     @@simulating_setup_need = nil
 
     SETUP_COMPLETED_KEY = 'SETUP_COMPLETED'
+    DEFAULT_RECAPTCHA_SETTINGS = {
+      recaptcha_public_key: '6LeoHfESAAAAAN1NdQeYHREq4jTSQhu1foEzv6KC',
+      recaptcha_private_key: '6LeoHfESAAAAAHLZpn7ijrO4_KGLEr2nGL4qjjis'
+    }
 
     # after_save :reset_instance_cache
 
@@ -136,12 +140,12 @@ class Card
         @@current_id = @@as_id if @@current_id.nil?
 
         return unless block_given?
-        value = yield
-
-        @@as_id   = tmp_id
-        @@as_card = tmp_card
-
-        value
+        yield
+      ensure
+        if block_given?
+          @@as_id   = tmp_id
+          @@as_card = tmp_card
+        end
       end
 
       def as_bot &block

data/lib/card/cache.rb

@@ -1,20 +1,18 @@
 # -*- encoding : utf-8 -*-
 
 class Card
-
   ActiveSupport::Cache::FileStore.class_eval do
     # escape special symbols \*"<>| additionaly to :?.
     # All of them not allowed to use in ms windows file system
-    def real_file_path(name)
-      name = name.gsub('%','%25').gsub('?','%3F').gsub(':','%3A')
-      name = name.gsub('\\','%5C').gsub('*','%2A').gsub('"','%22')
-      name = name.gsub('<','%3C').gsub('>','%3E').gsub('|','%7C')
-      '%s/%s.cache' % [@cache_path, name ]
+    def real_file_path name
+      name = name.gsub('%', '%25').gsub('?', '%3F').gsub(':', '%3A')
+      name = name.gsub('\\', '%5C').gsub('*', '%2A').gsub('"', '%22')
+      name = name.gsub('<', '%3C').gsub('>', '%3E').gsub('|', '%7C')
+      '%s/%s.cache' % [@cache_path, name]
     end
   end
 
   class Cache
-
     TEST_ENVS         = %w{test cucumber}
     @@prepopulating   = TEST_ENVS.include? Rails.env
     @@no_rails_cache  = TEST_ENVS.include?(Rails.env) || ENV['NO_RAILS_CACHE']
@@ -24,8 +22,10 @@ class Card
 
     class << self
       def [] klass
-        raise "nil klass" if klass.nil?
-        cache_by_class[klass] ||= new class: klass, store: (@@no_rails_cache ? nil : Cardio.cache)
+        raise 'nil klass' if klass.nil?
+        cache_type = (@@no_rails_cache ? nil : Cardio.cache)
+        cache_by_class[klass] ||= new class: klass,
+                                      store: cache_type
       end
 
       def renew
@@ -36,44 +36,39 @@ class Card
             raise "renewing nil cache: #{klass}"
           end
         end
-        reset_local
-      end
-
-      def prefix_root
-        @@prefix_root ||= ( cfg = Cardio.config and cfg = cfg.database_configuration and
-                            cfg[Rails.env]['database'] )
+        reset_soft
       end
 
       def system_prefix klass
-        "#{ prefix_root }/#{ klass }"
+        "#{Rails.env}/#{klass}"
       end
 
-      def restore klass=nil
-        reset_local
+      def restore
+        reset_soft
         prepopulate
       end
 
-      def generate_cache_id
-        ((Time.now.to_f * 100).to_i).to_s +
-          ('a'..'z').to_a[rand(26)] +
-          ('a'..'z').to_a[rand(26)]
+      def reset_global # deprecated
+        reset_all
       end
 
-      def reset_global
-        cache_by_class.each do |_klass, cache|
-          cache.reset hard=true
-        end
+      def reset_all
+        reset_hard
+        reset_soft
+
         Card::Codename.reset_cache
         Cardio.delete_tmp_files
       end
 
-      def reset_local
-        cache_by_class.each do |cc, cache|
-          if Card::Cache === cache
-            cache.reset_local
-          else
-            warn "reset class #{cc}, #{cache.class} #{caller[0..8] * "\n"} ???"
-          end
+      def reset_hard
+        cache_by_class.each do |_klass, cache|
+          cache.hard.reset if cache.hard
+        end
+      end
+
+      def reset_soft
+        cache_by_class.each do |_klass, cache|
+          cache.soft.reset
         end
       end
 
@@ -82,11 +77,11 @@ class Card
         when Hash
           obj.sort.map do |key, value|
             "#{key}=>(#{obj_to_key(value)})"
-          end.join ","
+          end.join ','
         when Array
           obj.map do |value|
             obj_to_key(value)
-          end.join ","
+          end.join ','
         else
           obj.to_s
         end
@@ -96,127 +91,70 @@ class Card
 
       def prepopulate
         return unless @@prepopulating
+        soft = Card.cache.soft
         @@rule_cache ||= Card.rule_cache
         @@user_ids_cache ||= Card.user_ids_cache
         @@read_rule_cache ||= Card.read_rule_cache
         @@rule_keys_cache ||= Card.rule_keys_cache
-        Card.cache.write_local 'RULES', @@rule_cache
-        Card.cache.write_local 'READRULES', @@read_rule_cache
-        Card.cache.write_local 'USER_IDS', @@user_ids_cache
-        Card.cache.write_local 'RULE_KEYS', @@rule_keys_cache
+        soft.write 'RULES', @@rule_cache
+        soft.write 'READRULES', @@read_rule_cache
+        soft.write 'USER_IDS', @@user_ids_cache
+        soft.write 'RULE_KEYS', @@rule_keys_cache
       end
     end
 
-    attr_reader :prefix, :store, :klass
-    attr_accessor :local
+    attr_reader :hard, :soft
 
     def initialize opts={}
-      #warn "new cache #{opts.inspect}"
       @klass = opts[:class]
-      @store = opts[:store]
-      @local = Hash.new
-      self.system_prefix = opts[:prefix] || self.class.system_prefix(opts[:class])
-      cache_by_class[klass] = self
-    end
+      cache_by_class[@klass] = self
 
+      # hard cache mirrors the db
+      # only difference to db: it caches virtual cards
+      @hard = Persistent.new opts if opts[:store]
 
-    def system_prefix= system_prefix
-      @system_prefix = system_prefix
-      if @store.nil?
-        @prefix = system_prefix + self.class.generate_cache_id + "/"
-      else
-        @system_prefix += '/' unless @system_prefix[-1] == '/'
-        @cache_id = @store.fetch(@system_prefix + "cache_id") do
-          self.class.generate_cache_id
-        end
-        @prefix = @system_prefix + @cache_id + "/"
-      end
+      # soft cache is temporary
+      # lasts only one request/script execution/console session
+      @soft = Temporary.new
     end
 
     def read key
-      if @local.has_key? key
-        read_local key
-      elsif @store
-        write_local key, @store.read(@prefix + key)
-      end
-    end
-
-    def read_local key
-      @local[key]
-    end
-
-    def write_variable key, variable, value
-      key = @prefix + key
-      if @store && (object = @store.read key)
-        object.instance_variable_set "@#{ variable }", value
-        @store.write key, object
-      end
-      value
+      @soft.read(key) ||
+        (@hard && (ret = @hard.read(key)) && @soft.write(key, ret))
     end
 
     def write key, value
-      @store.write(@prefix + key, value) if @store
-      write_local key, value
-    end
-
-    def write_local key, value
-      @local[key] = value
+      @hard.write key, value if @hard
+      @soft.write key, value
     end
 
     def fetch key, &block
-      fetch_local key do
-        if @store
-          @store.fetch(@prefix + key, &block)
+      @soft.fetch(key) do
+        if @hard
+          @hard.fetch(key, &block)
         else
           block.call
         end
       end
     end
 
-    def fetch_local key
-      read_local(key) || write_local(key, yield)
-    end
-
     def delete key
-      @store.delete(@prefix + key) if @store
-      delete_local key
-    end
-
-    def delete_local key
-      @local.delete key
+      @hard.delete key if @hard
+      @soft.delete key
     end
 
     def dump
-      p "dumping local...."
-      @local.each do |k, v|
-        p "#{k} --> #{v.inspect[0..30]}"
-      end
+      p 'dumping temporary request cache....'
+      @soft.dump
     end
 
-    def reset hard=false
-      reset_local
-      @cache_id = self.class.generate_cache_id
-      if @store
-        if hard
-          begin
-            @store.clear
-          rescue => e
-            Rails.logger.debug "Problem clearing cache: #{e.message}"
-          end
-        else
-          @store.write @system_prefix + "cache_id", @cache_id
-        end
-      end
-      @prefix = @system_prefix + @cache_id + "/"
-    end
-
-    def reset_local
-      @local = {}
+    def reset
+      @hard.reset if @hard
+      @soft.reset
     end
 
     def exist? key
-      @local.has_key?(key) || (@store && @store.exist?(key))
+      @soft.exist?(key) || (@hard && @hard.exist?(key))
     end
   end
 end
-

data/lib/card/cache/persistent.rb

@@ -0,0 +1,50 @@
+# -*- encoding : utf-8 -*-
+
+class Card::Cache::Persistent
+  attr_reader :prefix
+
+  def initialize opts
+    @store = opts[:store]
+    self.system_prefix =
+      opts[:prefix] || Card::Cache.system_prefix(opts[:class])
+  end
+
+  def system_prefix= system_prefix
+    @system_prefix = system_prefix
+    @prefix = "#{system_prefix}/"
+  end
+
+  def read key
+    @store.read(@prefix + key)
+  end
+
+  def write_variable key, variable, value
+    if @store && (object = @store.read key)
+      object.instance_variable_set "@#{variable}", value
+      @store.write key, object
+    end
+    value
+  end
+
+  def write key, value
+    @store.write(@prefix + key, value)
+  end
+
+  def fetch key, &block
+    @store.fetch @prefix + key, &block
+  end
+
+  def delete key
+    @store.delete @prefix + key
+  end
+
+  def reset
+    @store.clear
+  rescue => e
+    Rails.logger.debug "Problem clearing cache: #{e.message}"
+  end
+
+  def exist? key
+    @store.exist? @prefix + key
+  end
+end

data/lib/card/cache/temporary.rb

@@ -0,0 +1,38 @@
+class Card::Cache::Temporary
+  attr_reader :store
+
+  def initialize
+    @store = Hash.new
+  end
+
+  def read key
+    return unless @store.has_key? key
+    @store[key]
+  end
+
+  def write key, value
+    @store[key] = value
+  end
+
+  def fetch key, &block
+    read(key) || write(key, block.call)
+  end
+
+  def delete key
+    @store.delete key
+  end
+
+  def dump
+    @store.each do |k, v|
+      p "#{k} --> #{v.inspect[0..30]}"
+    end
+  end
+
+  def reset
+    @store = {}
+  end
+
+  def exist? key
+    @store.has_key? key
+  end
+end

data/lib/card/chunk.rb

@@ -7,9 +7,7 @@ require 'uri/common'
 # +pattern+ that states what sort of text it matches.
 # Chunks are initalized by passing in the result of a
 
-
 class Card
-
   # A chunk is a pattern of text that can be protected
   # and interrogated by a format. Each Chunk class has a
   # +pattern+ that states what sort of text it matches.
@@ -17,12 +15,15 @@ class Card
   # match by its pattern.
   module Chunk
     mattr_accessor :raw_list, :prefix_regexp_by_list, :prefix_map
-    @@raw_list, @@prefix_regexp_by_list, @@prefix_map = {}, {}, {}
+    @@raw_list = {}
+    @@prefix_regexp_by_list = {}
+    @@prefix_map = {}
 
     class << self
       def register_class klass, hash
         klass.config = hash.merge class: klass
-        prefix_index = hash[:idx_char] || :default  # this is gross and needs to be moved out.
+        prefix_index = hash[:idx_char] || :default
+        # ^ this is gross and needs to be moved out.
         prefix_map[prefix_index] = klass.config
       end
 
@@ -31,51 +32,57 @@ class Card
       end
 
       def find_class_by_prefix prefix
-        config = prefix_map[ prefix[0,1] ] || prefix_map[ prefix[-1,1] ] || prefix_map[:default]
-        #prefix identified by first character, last character, or default.  a little ugly...
+        config = prefix_map[prefix[0, 1]] ||
+                 prefix_map[prefix[-1, 1]] ||
+                 prefix_map[:default]
+        # prefix identified by first character, last character, or default.
+        # a little ugly...
         config[:class]
       end
 
       def get_prefix_regexp chunk_list_key
         prefix_regexp_by_list[chunk_list_key] ||= begin
-          chunk_types = raw_list[chunk_list_key].map { |chunkname| const_get chunkname }
-          prefix_res = chunk_types.map do |chunk_class|
+          prefix_res = raw_list[chunk_list_key].map do |chunkname|
+            chunk_class = const_get chunkname
             chunk_class.config[:prefix_re]
           end
           /(?:#{ prefix_res * '|' })/m
         end
       end
-
     end
 
-
-    #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, :Include, :Link ]
-    register_list :references,                         [ :EscapedLiteral, :Include, :Link ]
-    register_list :inclusion_only,                     [ :Include ]
-    register_list :query,                              [ :QueryReference ]
+    # 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, :Include, :Link
+    ]
+    register_list :references,  [:EscapedLiteral, :Include, :Link]
+    register_list :inclusion_only, [:Include]
+    register_list :query, [:QueryReference]
 
     class Abstract
       class_attribute :config
       attr_reader :text, :process_chunk
 
       class << self
-
         # if the prefix regex matched check that chunk against the full regex
         def full_match content, prefix=nil
-  #        warn "attempting full match on #{content}.  class = #{self}"
-          content.match full_re( prefix )
+          content.match full_re(prefix)
         end
 
-        def full_re prefix
+        def full_re _prefix
           config[:full_re]
         end
 
-        def context_ok? content, chunk_start
+        def context_ok? _content, _chunk_start
           true
         end
       end
 
+      def reference_code
+        'I'
+      end
+
       def initialize match, content
         @text = match[0]
         @processed = nil
@@ -84,8 +91,9 @@ class Card
         self
       end
 
-      def interpret match_string, content, params
-        Rails.logger.info "no #interpret method found for chunk class: #{self.class}"
+      def interpret _match_string, _content, _params
+        Rails.logger.info 'no #interpret method found for chunk class: ' \
+                          "#{self.class}"
       end
 
       def format
@@ -101,11 +109,12 @@ class Card
       end
 
       def inspect
-        "<##{self.class}##{to_s}>"
+        "<##{self.class}##{self}>"
       end
 
-      def as_json(options={})
-        @process_chunk || @processed|| "not rendered #{self.class}, #{card and card.name}"
+      def as_json _options={}
+        @process_chunk || @processed ||
+          "not rendered #{self.class}, #{card && card.name}"
       end
     end
   end