card 1.91 → 1.92

data/tmpsets/set/mod005-pointer/abstract/code_pointer.rb

@@ -0,0 +1,16 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract; module CodePointer; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/abstract/code_pointer.rb ~~
+include_set Abstract::Pointer
+
+abstract_basket :item_codenames
+
+def raw_content
+  item_codenames.map do |codename|
+    Card[codename] && Card[codename].name
+  end.compact.to_pointer_content
+end
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/abstract/code_pointer.rb ~~
+end;end;end;end;

data/tmpsets/set/mod005-pointer/self/script_editors.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self; module ScriptEditors; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/self/script_editors.rb ~~
+include_set Abstract::CodePointer
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/self/script_editors.rb ~~
+end;end;end;end;

data/tmpsets/set/mod005-pointer/self/script_mods.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self; module ScriptMods; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/self/script_mods.rb ~~
+include_set Abstract::CodePointer
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/self/script_mods.rb ~~
+end;end;end;end;

data/tmpsets/set/mod005-pointer/self/script_pointer_config.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self; module ScriptPointerConfig; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/self/script_pointer_config.rb ~~
+include_set Abstract::CodeFile
+
+Self::ScriptEditors.add_to_basket :item_codenames, :script_pointer_config
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/self/script_pointer_config.rb ~~
+end;end;end;end;

data/tmpsets/set/mod005-pointer/type/pointer.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Type; module Pointer; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/type/pointer.rb ~~
+include_set Abstract::Pointer
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/pointer/set/type/pointer.rb ~~
+end;end;end;end;

data/tmpsets/set/mod006-ace_editor/abstract/ace_editor.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract; module AceEditor; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/ace_editor/set/abstract/ace_editor.rb ~~
+format :html do
+  def default_editor_args args
+    args[:ace_mode] ||= "html"
+  end
+
+  view :editor do |args|
+    text_area :content, rows: 5,
+                        class: "card-content ace-editor-textarea",
+                        "data-ace-mode" => args[:ace_mode]
+  end
+end
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/ace_editor/set/abstract/ace_editor.rb ~~
+end;end;end;end;

data/tmpsets/set/mod006-ace_editor/self/script_ace.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self; module ScriptAce; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/ace_editor/set/self/script_ace.rb ~~
+include_set Abstract::CodeFile
+
+Self::ScriptMods.add_to_basket :item_codenames, :script_ace
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/ace_editor/set/self/script_ace.rb ~~
+end;end;end;end;

data/tmpsets/set/mod006-ace_editor/self/script_ace_config.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self; module ScriptAceConfig; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/ace_editor/set/self/script_ace_config.rb ~~
+include_set Abstract::CodeFile
+
+Self::ScriptEditors.add_to_basket :item_codenames, :script_ace_config
+Self::Head::Javascript::HtmlFormat.add_to_basket :mod_js_config,
+                                                 [:ace, "setAceConfig"]
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/ace_editor/set/self/script_ace_config.rb ~~
+end;end;end;end;

data/tmpsets/set/mod007-prosemirror_editor/abstract/prosemirror_editor.rb

@@ -0,0 +1,14 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract; module ProsemirrorEditor; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/prosemirror_editor/set/abstract/prosemirror_editor.rb ~~
+format :html do
+  view :editor do |_args|
+    wrap_with(:div, id: unique_id, class: "prosemirror-editor") do
+      hidden_field(:content, class: "card-content", value: card.raw_content)
+    end
+  end
+end
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/prosemirror_editor/set/abstract/prosemirror_editor.rb ~~
+end;end;end;end;

data/tmpsets/set/mod007-prosemirror_editor/self/script_prosemirror.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self; module ScriptProsemirror; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/prosemirror_editor/set/self/script_prosemirror.rb ~~
+include_set Abstract::CodeFile
+
+Self::ScriptMods.add_to_basket :item_codenames, :script_prosemirror
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/prosemirror_editor/set/self/script_prosemirror.rb ~~
+end;end;end;end;

data/tmpsets/set/mod007-prosemirror_editor/self/script_prosemirror_config.rb

@@ -0,0 +1,13 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Self; module ScriptProsemirrorConfig; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/prosemirror_editor/set/self/script_prosemirror_config.rb ~~
+include_set Abstract::CodeFile
+
+Self::ScriptEditors.add_to_basket :item_codenames, :script_prosemirror_config
+Self::Head::Javascript::HtmlFormat.add_to_basket(
+  :mod_js_config, [:prose_mirror, "setProseMirrorConfig"]
+)
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/prosemirror_editor/set/self/script_prosemirror_config.rb ~~
+end;end;end;end;

data/tmpsets/set/mod009-solid_cache/abstract/solid_cache.rb

@@ -0,0 +1,106 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract; module SolidCache; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/solid_cache/set/abstract/solid_cache.rb ~~
+# -*- encoding : utf-8 -*-
+
+# A card that includes Abstract::SolidCache caches its core view
+# in a '+*solid cache' card.
+# If that card exists the core view returns its content as rendered view.
+# If it doesn't exist the usual core view is rendered and saved in that card.
+#
+# The cache expiration can be controlled with the cache_update_trigger and
+# cache_expire_trigger methods.
+
+card_accessor :solid_cache, type: :html
+
+format :html do
+  def default_core_args args
+    args[:solid_cache] = true unless args.key?(:solid_cache)
+  end
+
+  view :core do |args|
+    return super(args) unless args[:solid_cache]
+
+    subformat(card.solid_cache_card)._render_core args
+  end
+end
+
+module ClassMethods
+  # If a card of the set given by 'set_of_changed_card' is updated
+  # the given block is executed. It is supposed to return an array of
+  # cards whose solid caches are expired because of the update.
+  # @param set_of_changed_card [set constant] a set of cards that triggers
+  #   a cache update
+  # @params args [Hash]
+  # @option args [Symbol, Array of symbols] :on the action(s)
+  #   (:create, :update, or :delete) on which the cache update
+  #   should be triggered. Default is all actions.
+  # @option args [Stage] :in_stage the stage when the update is executed.
+  #   Default is :integrate
+  # @yield return an array of cards with solid cache that need to be updated
+  def cache_update_trigger set_of_changed_card, args={}, &block
+    define_event_to_update_expired_cached_cards(
+      set_of_changed_card, args, :update_solid_cache, &block
+    )
+  end
+
+  # Same as 'cache_update_trigger' but expires instead of updates the
+  # outdated solid caches
+  def cache_expire_trigger set_of_changed_card, args={}, &block
+    define_event_to_update_expired_cached_cards(
+      set_of_changed_card, args, :expire_solid_cache, &block
+    )
+  end
+
+  def define_event_to_update_expired_cached_cards set_of_changed_card, args,
+                                                  method_name
+    args[:on] ||= [:create, :update, :delete]
+    name = event_name set_of_changed_card, args
+    stage = args[:in_stage] || :integrate
+    Card::Set.register_set set_of_changed_card
+    set_of_changed_card.event name, stage, args do
+      Array(yield(self)).compact.each do |expired_cache_card|
+        next unless expired_cache_card.solid_cache?
+        expired_cache_card.send method_name
+      end
+    end
+  end
+
+  def event_name set, args
+    changed_card_set = set.to_s.tr(":", "_").underscore
+    solid_cache_set = to_s.tr(":", "_").underscore
+    actions = Array.wrap(args[:on]).join("_")
+    "update_#{solid_cache_set}_solid_cache_changed_by_" \
+    "#{changed_card_set}_on_#{actions}".to_sym
+  end
+end
+
+def expire_solid_cache
+  return unless solid_cache?
+  Auth.as_bot do
+    solid_cache_card.delete!
+  end
+end
+
+def update_solid_cache
+  return unless solid_cache?
+  new_content = format(:html)._render_core(solid_cache: false)
+  return unless new_content
+  write_to_solid_cache new_content
+  new_content
+end
+
+def write_to_solid_cache new_content
+  Auth.as_bot do
+    if solid_cache_card.new_card?
+      solid_cache_card.update_attributes! content: new_content
+    elsif new_content != solid_cache_card.content
+      solid_cache_card.update_column :db_content, new_content
+      solid_cache_card.expire
+    end
+  end
+end
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/solid_cache/set/abstract/solid_cache.rb ~~
+end;end;end;end;

data/tmpsets/set/mod009-solid_cache/all/solid_cache.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class All; module SolidCache; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/solid_cache/set/all/solid_cache.rb ~~
+def solid_cache?
+  respond_to?(:solid_cache_card)
+end
+
+module ClassMethods
+  def clear_solid_cache
+    Auth.as_bot do
+      Card.search(right: { codename: "solid_cache" }).each do |card|
+        card.update_columns trash: true
+        card.expire
+      end
+    end
+  end
+end
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/solid_cache/set/all/solid_cache.rb ~~
+end;end;end;end;

data/tmpsets/set/mod009-solid_cache/right/solid_cache.rb

@@ -0,0 +1,39 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Right; module SolidCache; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/solid_cache/set/right/solid_cache.rb ~~
+def followable?
+  false
+end
+
+def history?
+  false
+end
+
+def clean_html?
+  false
+end
+
+format :html do
+  view :core do |args|
+    return super(args) unless card.new_card?
+    _render_missing args.merge(denied_view: :core)
+  end
+
+  view :missing do |args|
+    if @card.new_card? &&
+       (l = @card.left) &&
+       l.solid_cache?
+      l.update_solid_cache
+      @card = Card.fetch(card.name)
+      render(args[:denied_view], args)
+    else
+      super(args)
+    end
+  end
+
+  view :new, :missing
+end
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/solid_cache/set/right/solid_cache.rb ~~
+end;end;end;end;

data/tmpsets/set/mod010-basic_types/type/html.rb

@@ -0,0 +1,26 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Type; module Html; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/basic_types/set/type/html.rb ~~
+include_set Abstract::AceEditor
+
+def clean_html?
+  false
+end
+
+def diff_args
+  { format: :raw }
+end
+
+format do
+  view :closed_content do |_args|
+    ""
+  end
+
+  def chunk_list
+    :references
+  end
+end
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/basic_types/set/type/html.rb ~~
+end;end;end;end;

data/tmpsets/set/mod010-basic_types/type/plain_text.rb

@@ -0,0 +1,19 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Type; module PlainText; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/basic_types/set/type/plain_text.rb ~~
+format :html do
+  view :editor do |_args|
+    text_area :content,
+              rows: 5,
+              class: "card-content",
+              "data-card-type-code" => card.type_code
+  end
+
+  view :core do |_args|
+    process_content CGI.escapeHTML(_render_raw)
+  end
+end
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/basic_types/set/type/plain_text.rb ~~
+end;end;end;end;

data/tmpsets/set/mod011-machines/abstract/machine.rb

@@ -0,0 +1,277 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract; module Machine; extend Card::Set
+# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/machines/set/abstract/machine.rb ~~
+# ## What are Machines?
+# {Machine} and {MachineInput} together implement a kind of observer pattern.
+# {Machine} processes a collection of input cards to generate an output card
+# (a {Set::Type::File} card by default). If one of the input cards is changed
+# the output card will be updated.
+#
+# The classic example: A style card observes a collection of css and sccs card
+# to generate a file card with a css file that contains the assembled
+# compressed  css.
+#
+# ## Using Machines
+# Include the Machine module in the card set that is supposed to produce the
+# output card. If the output card should be automatically updated when a input
+# card is changed the input card has to be in a set that includes the
+# MachineInput module.
+#
+# The default machine:
+#
+#  -  uses its item cards as input cards or the card itself if there are no
+# item cards;
+#  -  can be changed by passing a block to collect_input_cards
+#  -  takes the raw view of the input cards to generate the output;
+#  -  can be changed by passing a block to machine_input (in the input card
+# set)
+#  -  stores the output as a .txt file in the '+machine output' card;
+#  -  can be changed by passing a filetype and/or a block to
+#     store_machine_output
+#
+#
+# ## How does it work?
+# Machine cards have a '+machine input' and a '+machine output' card. The
+# '+machine input' card is a pointer to all input cards. Including the
+# MachineInput module creates an 'on: save' event that runs the machines of
+# all cards that are linked to that card via the +machine input pointer.
+module MachineClassMethods
+  attr_accessor :output_config
+
+  def collect_input_cards &block
+    define_method :engine_input, &block
+  end
+
+  def prepare_machine_input &block
+    define_method :before_engine, &block
+  end
+
+  def machine_engine &block
+    define_method :engine, &block
+  end
+
+  def store_machine_output args={}, &block
+    output_config.merge!(args)
+    return unless block_given?
+    define_method :after_engine, &block
+  end
+end
+
+class << self
+  def included host_class
+    host_class.extend(MachineClassMethods)
+    host_class.output_config = { filetype: "txt" }
+
+    # for compatibility with old migrations
+    return unless  Codename[:machine_output]
+
+    host_class.card_accessor :machine_output, type: :file
+    host_class.card_accessor :machine_input, type: :pointer
+
+    set_default_machine_behaviour host_class
+    define_machine_views host_class
+    define_machine_events host_class
+  end
+
+  def define_machine_events host_class
+    event_suffix = host_class.name.tr ":", "_"
+    event_name = "reset_machine_output_#{event_suffix}".to_sym
+    host_class.event event_name, after: :expire_related, on: :save do
+      reset_machine_output
+    end
+  end
+
+  def define_machine_views host_class
+    host_class.format do
+      view :machine_output_url do |_args|
+        machine_output_url
+      end
+    end
+  end
+
+  def set_default_machine_behaviour host_class
+    set_default_input_collection_method host_class
+    set_default_input_preparation_method host_class
+    set_default_output_storage_method host_class
+    host_class.machine_engine { |input| input }
+  end
+
+  def set_default_input_preparation_method host_class
+    host_class.prepare_machine_input {}
+  end
+
+  def set_default_output_storage_method host_class
+    host_class.store_machine_output do |output|
+      filetype = host_class.output_config[:filetype]
+      file = Tempfile.new [id.to_s, ".#{filetype}"]
+      file.write output
+      file.rewind
+      Card::Auth.as_bot do
+        p = machine_output_card
+        p.file = file
+        p.save!
+      end
+      file.close
+      file.unlink
+    end
+  end
+
+  def set_default_input_collection_method host_class
+    host_class.collect_input_cards do
+      # traverse through all levels of pointers and
+      # collect all item cards as input
+      items = [self]
+      new_input = []
+      already_extended = {} # avoid loops
+      loop_limit = 5
+      until items.empty?
+        item = items.shift
+        next if item.trash || already_extended[item.id].to_i > loop_limit
+        if item.item_cards == [item] # no pointer card
+          new_input << item
+        else
+          # item_cards instantiates non-existing cards
+          # we don't want those
+          items.insert(0, item.item_cards.reject(&:unknown?))
+          items.flatten!
+
+          new_input << item if item != self && item.known?
+          already_extended[item] = already_extended[item].to_i + 1
+        end
+      end
+      new_input
+    end
+  end
+end
+
+def run_machine joint="\n"
+  before_engine
+  output =
+    input_item_cards.map do |input_card|
+      run_engine input_card
+    end.select(&:present?).join(joint)
+  after_engine output
+end
+
+def run_engine input_card
+  return if input_card.is_a? Card::Set::Type::Pointer
+  if (cached = fetch_cache_card(input_card))
+    return cached.content
+  end
+
+  input = if input_card.respond_to? :machine_input
+            input_card.machine_input
+          else
+            input_card.format._render_raw
+          end
+  output = engine(input)
+  cache_output_part input_card, output
+  output
+end
+
+def fetch_cache_card input_card, new=nil
+  new &&= { type_id: PlainTextID }
+  Card.fetch input_card.name, name, :machine_cache, new: new
+end
+
+def cache_output_part input_card, output
+  Auth.as_bot do
+    cache_card = fetch_cache_card(input_card, true)
+    cache_card.update_attributes! content: output
+  end
+end
+
+def reset_machine_output
+  Auth.as_bot do
+    (moc = machine_output_card) && moc.real? && moc.delete!
+    update_input_card
+  end
+end
+
+def update_machine_output
+  lock do
+    update_input_card
+    run_machine
+  end
+end
+
+def make_machine_output_coded mod=:machines
+  update_machine_output
+  Auth.as_bot do
+    output_codename =
+      machine_output_card.cardname.parts.map do |part|
+        Card[part].codename || Card[part].cardname.safe_key
+      end.join '_'
+    machine_output_card.update_attributes! codename: output_codename,
+                                           storage_type: :coded,
+                                           mod: mod
+  end
+end
+
+def regenerate_machine_output
+  lock do
+    run_machine
+  end
+end
+
+def lock
+  if ok?(:read) && !(was_already_locked = locked?)
+    Auth.as_bot do
+      lock!
+      yield
+    end
+  end
+ensure
+  unlock! unless was_already_locked
+end
+
+def lock_cache_key
+  "UPDATE-LOCK:#{key}"
+end
+
+def locked?
+  Card.cache.read lock_cache_key
+end
+
+def lock!
+  Card.cache.write lock_cache_key, true
+end
+
+def unlock!
+  Card.cache.write lock_cache_key, false
+end
+
+def update_input_card
+  if DirectorRegister.running_act?
+    input_card = attach_subcard! machine_input_card
+    input_card.content = ""
+    engine_input.each { |input| input_card << input }
+  else
+    machine_input_card.items = engine_input
+  end
+end
+
+def input_item_cards
+  machine_input_card.item_cards
+end
+
+def machine_output_url
+  ensure_machine_output
+  machine_output_card.file.url # (:default, timestamp: false)
+  # to get rid of additional number in url
+end
+
+def machine_output_path
+  ensure_machine_output
+  machine_output_card.file.path
+end
+
+def ensure_machine_output
+  output = fetch trait: :machine_output
+  return if output && output.selected_content_action_id
+  update_machine_output
+end
+
+
+# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/machines/set/abstract/machine.rb ~~
+end;end;end;end;