card 1.16.1 → 1.16.2

data/db/version.txt

@@ -1 +1 @@
-20141216053032
+20150724210803

data/db/version_core_cards.txt

@@ -1 +1 @@
-20150702130543
+20150724123438

data/lib/card.rb

@@ -1,7 +1,15 @@
 # -*- encoding : utf-8 -*-
+require 'carrierwave'
 
 Object.send :remove_const, :Card if Object.send(:const_defined?, :Card)
 
+# This documentation is intended for developers who want to understand:
+#
+# 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}.
+#
 class Card < ActiveRecord::Base
 
   # attributes that ActiveJob can handle
@@ -11,6 +19,7 @@ class Card < ActiveRecord::Base
   end
 
 
+
   require_dependency 'card/active_record_ext'
   require_dependency 'card/codename'
   require_dependency 'card/query'
@@ -31,7 +40,7 @@ class Card < ActiveRecord::Base
   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
+  cattr_accessor :set_patterns, :error_codes, :serializable_attributes, :set_specific_attributes
   @@set_patterns, @@error_codes = [], {}
 
   serializable_attr_accessor :action, :supercard, :current_act, :current_action,
@@ -43,16 +52,17 @@ class Card < ActiveRecord::Base
 
   attr_accessor :follower_stash
 
+
   define_callbacks :approve, :store, :stored, :extend, :subsequent
 
   before_validation :approve
   around_save :store
   after_save :extend
 
-
   TRACKED_FIELDS = %w(name type_id db_content trash)
-
+  extend CarrierWave::Mount
   ActiveSupport.run_load_hooks(:card, self)
+
 end
 
 

data/lib/card/chunk.rb

@@ -6,30 +6,36 @@ require 'uri/common'
 # and interrogated by a format. Each Chunk class has a
 # +pattern+ that states what sort of text it matches.
 # Chunks are initalized by passing in the result of a
-# match by its pattern.
+
 
 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.
+  # Chunks are initalized by passing in the result of a
+  # match by its pattern.
   module Chunk
     mattr_accessor :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
-    
+
       def register_list key, list
         raw_list[key] = list
       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[: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 }
@@ -41,17 +47,18 @@ class Card
       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 :inclusion_only,                     [ :Include ]
+    register_list :query,                              [ :QueryReference ]
+
     class Abstract
       class_attribute :config
       attr_reader :text, :process_chunk
-    
+
       class << self
         def full_match content, prefix=nil
   #        warn "attempting full match on #{content}.  class = #{self}"
@@ -61,7 +68,7 @@ class Card
         def full_re prefix
           config[:full_re]
         end
-      
+
         def context_ok? content, chunk_start
           true
         end
@@ -74,15 +81,15 @@ class Card
         interpret match, content
         self
       end
-    
+
       def interpret match_string, content, params
         Rails.logger.info "no #interpret method found for chunk class: #{self.class}"
       end
-    
+
       def format
         @content.format
       end
-    
+
       def card
         @content.card
       end

data/lib/card/content.rb

@@ -8,15 +8,16 @@ class Card
     attr_reader :revision, :format, :chunks, :opts
 
     def initialize content, format_or_card, opts={}
-      @format = if Card===format_or_card
-        Format.new format_or_card, :format=>nil
-      else
-        format_or_card
-      end
+      @format =
+        if Card===format_or_card
+          Format.new format_or_card, :format=>nil
+        else
+          format_or_card
+        end
       @opts = opts || {}
-      
+
       unless Array === content
-        content = parse_content content  
+        content = parse_content content
       end
       super content
     end
@@ -24,7 +25,7 @@ class Card
     def card
       format.card
     end
-    
+
     def chunk_list
       @opts[:chunk_list] || @format.chunk_list
     end

data/lib/card/diff.rb

@@ -1,23 +1,23 @@
 # -*- encoding : utf-8 -*-
 
 module Card::Diff
-  
+
   def self.complete a, b, opts={}
     DiffBuilder.new(a, b, opts).complete
   end
-  
+
   def self.summary a, b, opts={}
     DiffBuilder.new(a, b, opts).summary
   end
-  
+
   def self.render_added_chunk text
     "<ins class='diffins diff-green'>#{text}</ins>"
   end
-  
+
   def self.render_deleted_chunk text, count=true
     "<del class='diffdel diff-red'>#{text}</del>"
   end
-  
+
   def self.render_chunk action, text
     case action
     when '+'      then render_added_chunk text
@@ -30,16 +30,16 @@ module Card::Diff
 
   class DiffBuilder
     attr_reader :summary, :complete
-    
-    # diff options 
-    # :format  => :html|:text|:pointer|:raw 
+
+    # diff options
+    # :format  => :html|:text|:pointer|:raw
     #   :html    = maintain html structure, but compare only content
     #   :text    = remove all html tags; compare plain text
     #   :pointer = remove all double square brackets
     #   :raw     = escape html tags and compare everything
     #
     # :summary => {:length=><number> , :joint=><string> }
-    
+
     def initialize(old_version, new_version, opts={})
       @new_version = new_version
       @old_version = old_version
@@ -47,7 +47,7 @@ module Card::Diff
       @lcs_opts[:summary] = opts[:summary]
       @dels_cnt = 0
       @adds_cnt = 0
-      
+
       if not @new_version
         @complete = ''
         @summary  = ''
@@ -57,13 +57,13 @@ module Card::Diff
     end
 
     def red?
-      @dels_cnt > 0 
+      @dels_cnt > 0
     end
-    
+
     def green?
-      @adds_cnt > 0 
+      @adds_cnt > 0
     end
-    
+
     def lcs_opts_for_format format
       opts = {}
       case format
@@ -85,7 +85,7 @@ module Card::Diff
       end
       opts
     end
-    
+
     def lcs_diff
       @lcs = LCS.new(@old_version, @new_version, @lcs_opts)
       @summary  = @lcs.summary
@@ -94,7 +94,7 @@ module Card::Diff
       @adds_cnt = @lcs.adds_cnt
     end
 
-    
+
     class LCS
       attr_reader :adds_cnt, :dels_cnt
       def initialize old_text, new_text, opts, summary=nil
@@ -102,12 +102,12 @@ module Card::Diff
         @exclude_pattern = opts[:exclude]       # regex; put back to the result after diff
         @preprocess      = opts[:preprocess]    # block; called with every word
         @postprocess     = opts[:postprocess]   # block; called with complete diff
-        
+
         @adds_cnt = 0
         @dels_cnt = 0
-        
+
         @splitters = %w( <[^>]+>  \[\[[^\]]+\]\]  \{\{[^}]+\}\}  \s+ )
-        @disjunction_pattern = /^\s/ 
+        @disjunction_pattern = /^\s/
         @summary ||= Summary.new opts[:summary]
         if not old_text
           list = split_and_preprocess(new_text)
@@ -122,24 +122,24 @@ module Card::Diff
           run_diff
         end
       end
-      
-      def summary 
+
+      def summary
         @summary.result
       end
-      
+
       def complete
         @result
       end
-      
-      private 
-      
+
+      private
+
       def init_diff old_text, new_text
         @adds = []
         @dels = []
         @result = ''
         old_words, old_ex = separate_comparables_from_excludees old_text
         new_words, new_ex = separate_comparables_from_excludees new_text
-        
+
         @words = {
           :old => old_words,
           :new => new_words
@@ -149,22 +149,22 @@ module Card::Diff
           :new => ExcludeeIterator.new(new_ex)
         }
       end
-        
-      def run_diff 
-        prev_action = nil        
+
+      def run_diff
+        prev_action = nil
         ::Diff::LCS.traverse_balanced(@words[:old], @words[:new]) do |word|
 
-          if prev_action 
+          if prev_action
             if prev_action != word.action and
-              !(prev_action == '-' and word.action == '!') and 
+              !(prev_action == '-' and word.action == '!') and
               !(prev_action == '!' and word.action == '+')
 
               # delete and/or add section stops here; write changes to result
               write_dels
               write_adds
-                  
+
               write_excludees # new neutral section starts, we can just write excludees to result
-              
+
             else # current word belongs to edit of previous word
               case word.action
               when '-'
@@ -176,39 +176,39 @@ module Card::Diff
                 add_new_excludees
               else
                 write_excludees
-              end             
+              end
             end
           else
             write_excludees
           end
-          
+
           process_word word
-          prev_action = word.action      
+          prev_action = word.action
         end
         write_dels
         write_adds
         write_excludees
-      
+
         @result = postprocess @result
       end
 
-      
+
       def added_chunk text, count=true
         @adds_cnt += 1 if count
         Card::Diff.render_added_chunk text
       end
-  
+
       def deleted_chunk text, count=true
         @dels_cnt += 1 if count
         Card::Diff.render_deleted_chunk text
       end
 
-      
+
       def write_unchanged text
         @result << text
         @summary.omit
       end
-      
+
       def write_dels
         if !@dels.empty?
           @result << deleted_chunk(@dels.join)
@@ -216,7 +216,7 @@ module Card::Diff
           @dels = []
         end
       end
-      
+
       def write_adds
         if !@adds.empty?
           @result << added_chunk(@adds.join)
@@ -224,13 +224,13 @@ module Card::Diff
           @adds = []
         end
       end
-      
+
       def write_excludees
         while ex = @excludees[:new].next
           @result << ex[:element]
         end
       end
-      
+
       def del_old_excludees
         while ex = @excludees[:old].next
           if ex[:type] == :disjunction
@@ -241,7 +241,7 @@ module Card::Diff
           end
         end
       end
-      
+
       def add_new_excludees
         while ex = @excludees[:new].next
           if ex[:type] == :disjunction
@@ -252,11 +252,11 @@ module Card::Diff
           end
         end
       end
-      
+
       def process_word word
         process_element word.old_element, word.new_element, word.action
       end
-      
+
       def process_element old_element, new_element, action
         case action
         when '-'
@@ -275,13 +275,13 @@ module Card::Diff
           @excludees[:new].word_step
         end
       end
-      
+
       def separate_comparables_from_excludees text
         # return two arrays, one with all words, one with pairs (index in word list, html_tag)
         list = split_and_preprocess text
         if @exclude_pattern
           list.each_with_index.inject([[],[]]) do |res, pair|
-            element, index = pair  
+            element, index = pair
             if element.match @disjunction_pattern
               res[1] << {:chunk_index=>index, :element=>element, :type=>:disjunction}
             elsif element.match @exclude_pattern
@@ -295,19 +295,19 @@ module Card::Diff
           [list, []]
         end
       end
-    
+
       def split_and_preprocess text
         splitted = split_to_list_of_words(text).select do |s|
           s.size > 0 and (!@reject_pattern or !s.match @reject_pattern)
         end
         @preprocess ? splitted.map {|s| @preprocess.call(s) } : splitted
       end
-    
+
       def split_to_list_of_words text
         split_regex = /(#{@splitters.join '|'})/
         text.split(split_regex)
       end
-          
+
       def preprocess text
         if @preprocess
           @preprocess.call(text)
@@ -315,7 +315,7 @@ module Card::Diff
           text
         end
       end
-      
+
       def postprocess text
         if @postprocess
           @postprocess.call(text)
@@ -323,64 +323,64 @@ module Card::Diff
           text
         end
       end
-      
-  
-      class Summary 
+
+
+      class Summary
         def initialize opts
           opts ||= {}
-          @remaining_chars = opts[:length] || 50 
+          @remaining_chars = opts[:length] || 50
           @joint = opts[:joint] || '...'
-          
+
           @summary = nil
           @chunks = []
         end
-        
+
         def result
           @summary ||= render_chunks
         end
-        
+
         def add text
           add_chunk text, :added
         end
-        
+
         def delete text
           add_chunk text, :deleted
         end
-        
-        def omit 
+
+        def omit
            if @chunks.empty? or @chunks.last[:action] != :ellipsis
             add_chunk @joint, :ellipsis
           end
-        end  
-        
+        end
+
         private
-        
+
         def add_chunk text, action
           if @remaining_chars > 0
             @chunks << {:action => action, :text=>text}
             @remaining_chars -= text.size
           end
         end
-        
+
         def render_chunks
           truncate_overlap
           @chunks.map do |chunk|
               Card::Diff.render_chunk chunk[:action], chunk[:text]
-          end.join 
+          end.join
         end
-   
+
         def truncate_overlap
           if @remaining_chars < 0
             if @chunks.last[:action] == :ellipsis
               @chunks.pop
               @remaining_chars += @joint.size
             end
-            
+
             index = @chunks.size - 1
             while @remaining_chars < @joint.size and index >= 0
               if @remaining_chars + @chunks[index][:text].size == @joint.size   # d
                 @chunks.pop
-                if index-1 >= 0 
+                if index-1 >= 0
                   if @chunks[index-1][:action] == :added
                     @chunks << {:action => :ellipsis, :text=>@joint}
                   elsif @chunks[index-1][:action] == :deleted
@@ -389,7 +389,7 @@ module Card::Diff
                 end
                 break
               elsif @remaining_chars + @chunks[index][:text].size > @joint.size
-                @chunks[index][:text] =  @chunks[index][:text][0..(@remaining_chars-@joint.size-1)] 
+                @chunks[index][:text] =  @chunks[index][:text][0..(@remaining_chars-@joint.size-1)]
                 @chunks[index][:text] += @joint
                 break
               else
@@ -399,21 +399,21 @@ module Card::Diff
               index -= 1
             end
           end
-        end 
-        
+        end
+
       end
-     
-      class ExcludeeIterator     
+
+      class ExcludeeIterator
         def initialize list
           @list = list
           @index = 0
           @chunk_index = 0
         end
-        
+
         def word_step
           @chunk_index += 1
         end
-        
+
         def next
           if @index < @list.size and @list[@index][:chunk_index] == @chunk_index
             res = @list[@index]
@@ -423,7 +423,7 @@ module Card::Diff
           end
         end
       end
-      
+
     end
   end
 end