card 1.97.0.1 → 1.98.0

data/tmpsets/set/{mod009-solid_cache → mod012-solid_cache}/abstract/solid_cache.rb

@@ -1,11 +1,15 @@
 # -*- 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 ~~
+class Card; module Set; class Abstract
+# Set: Abstract (SolidCache)
+#
 # -*- encoding : utf-8 -*-
 
-# A card that includes Abstract::SolidCache caches its core view
-# in a '+*solid cache' card.
+# A card that includes Abstract::SolidCache has its "core" view fully rendered
+# and stored in a '+*solid cache' card.
 # If that card exists the core view returns its content as rendered view.
+module SolidCache;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/solid_cache/set/abstract/solid_cache.rb"; end
 # 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
@@ -13,31 +17,35 @@ class Card; module Set; class Abstract; module SolidCache; extend Card::Set
 
 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]
+def self.included host_class
+  host_class.format(host_class.try(:cached_format) || :base) do
+    view :core, cache: :never do
+      return super() if voo.hide? :solid_cache
+      _render_solid_cache
+    end
 
-    subformat(card.solid_cache_card)._render_core args
+    view :solid_cache, cache: :never do
+      card.with_solid_cache do |cache_card|
+        subformat(cache_card)._render_core
+      end
+    end
   end
 end
 
 module ClassMethods
-  # If a card of the set given by 'set_of_changed_card' is updated
+  # If a card of the set given by 'set_of_changed_card' is changed
   # the given block is executed. It is supposed to return an array of
-  # cards whose solid caches are expired because of the update.
+  # cards whose solid caches are expired because of the change.
   # @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)
+  # @param args [Hash]
+  # @option args [Symbol, Array<Symbol>] :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
+  # @yield return a card or 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
@@ -54,12 +62,12 @@ module ClassMethods
 
   def define_event_to_update_expired_cached_cards set_of_changed_card, args,
                                                   method_name
-    args[:on] ||= [:create, :update, :delete]
+    args[:on] ||= %i[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|
+      Array.wrap(yield(self)).compact.each do |expired_cache_card|
         next unless expired_cache_card.solid_cache?
         expired_cache_card.send method_name
       end
@@ -67,16 +75,22 @@ module ClassMethods
   end
 
   def event_name set, args
-    changed_card_set = set.to_s.tr(":", "_").underscore
-    solid_cache_set = to_s.tr(":", "_").underscore
+    changed_card_set = set.underscore
+    solid_cache_set = underscore + "__solid_cache"
     actions = Array.wrap(args[:on]).join("_")
-    "update_#{solid_cache_set}_solid_cache_changed_by_" \
-    "#{changed_card_set}_on_#{actions}".to_sym
+    ["update", solid_cache_set,
+     "changed_by", changed_card_set,
+     "on", actions].join("___").to_sym
   end
 end
 
-def expire_solid_cache
-  return unless solid_cache?
+def with_solid_cache
+  update_solid_cache if solid_cache_card.new?
+  yield solid_cache_card
+end
+
+def expire_solid_cache _changed_card=nil
+  return unless solid_cache? && solid_cache_card.real?
   Auth.as_bot do
     solid_cache_card.delete!
   end
@@ -84,23 +98,18 @@ end
 
 def update_solid_cache
   return unless solid_cache?
-  new_content = format(:html)._render_core(solid_cache: false)
-  return unless new_content
+  new_content = generate_content_for_cache
   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
+def generate_content_for_cache
+  format_type = try(:cached_format) || :base
+  format(format_type)._render_core hide: :solid_cache
 end
 
-
-# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/solid_cache/set/abstract/solid_cache.rb ~~
+def write_to_solid_cache new_content
+  solid_cache_card.write! new_content
+end
 end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/solid_cache/set/abstract/solid_cache.rb ~~

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

@@ -0,0 +1,23 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class All
+# Set: All cards (SolidCache)
+#
+module SolidCache;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/solid_cache/set/all/solid_cache.rb"; end
+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
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/solid_cache/set/all/solid_cache.rb ~~

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

@@ -0,0 +1,57 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Right
+# Set: All "+SolidCache" cards
+#
+module SolidCache;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/solid_cache/set/right/solid_cache.rb"; end
+include_set Abstract::Lock
+
+def ok_to_read
+  left.ok_to_read
+end
+
+def followable?
+  false
+end
+
+def history?
+  false
+end
+
+def clean_html?
+  false
+end
+
+def write! new_content
+  lock do
+    if new_card?
+      update! content: new_content
+    elsif new_content != solid_cache_card.content
+      update_column :db_content, new_content
+      expire
+    end
+  end
+end
+
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  view :core, cache: :never do
+    return super() unless card.new_card?
+    @denied_view = :core
+    _render_missing
+  end
+
+  view :missing, cache: :never do
+    if @card.new_card? && (l = @card.left) && l.solid_cache?
+      l.update_solid_cache
+      @card = Card.fetch card.name
+      render! @denied_view
+    else
+      super()
+    end
+  end
+
+  view :new, :missing
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/solid_cache/set/right/solid_cache.rb ~~

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

@@ -0,0 +1,32 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Type
+# Set: All "Html" cards
+#
+module Html;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/basic_types/set/type/html.rb"; end
+def clean_html?
+  false
+end
+
+def diff_args
+  { diff_format: :raw }
+end
+
+module Format; parent.send :register_set_format, Card::Format, self; extend Card::Set::AbstractFormat
+  view :closed_content do
+    ""
+  end
+
+  def chunk_list
+    :references
+  end
+end
+
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  def editor
+    :ace_editor
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/basic_types/set/type/html.rb ~~

data/tmpsets/set/mod013-basic_types/type/json.rb

@@ -0,0 +1,40 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Type
+# Set: All "Json" cards
+#
+module Json;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/basic_types/set/type/json.rb"; end
+event :validate_json, :validate, on: :save, changed: :content do
+  check_json_syntax if content.present?
+end
+
+def check_json_syntax
+  parse_content
+rescue JSON::ParserError => e
+  errors.add tr(:invalid_json), e.message.sub(/^\d+: /, "").to_s
+end
+
+def parse_content
+  JSON.parse content
+end
+
+def item_names _args={}
+  parse_content.keys
+end
+
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  view :core do
+    process_content ::CodeRay.scan(_render_raw, :json).div
+  end
+
+  def editor
+    :ace_editor
+  end
+
+  def ace_mode
+    :json
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/basic_types/set/type/json.rb ~~

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

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Type
+# Set: All "PlainText" cards
+#
+module PlainText;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/basic_types/set/type/plain_text.rb"; end
+module HtmlFormat; parent.send :register_set_format, Card::Format::HtmlFormat, self; extend Card::Set::AbstractFormat
+  def editor
+    :text_area
+  end
+
+  view :core do
+    process_content CGI.escapeHTML(_render_raw)
+  end
+end
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/basic_types/set/type/plain_text.rb ~~

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

@@ -0,0 +1,202 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract
+# Set: Abstract (Machine)
+#
+# ## 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:
+module Machine;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/machines/set/abstract/machine.rb"; end
+#
+#  -  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
+
+card_accessor :machine_output, type: :file
+card_accessor :machine_input, type: :pointer
+
+def before_engine
+end
+
+def engine_input
+  # TODO: replace with call of extended_item_cards
+  # 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
+
+def engine input
+  input
+end
+
+def after_engine output
+  filetype = 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
+
+view :machine_output_url do
+  machine_output_url
+end
+
+class << self
+  def included host_class
+    host_class.extend(MachineClassMethods)
+    host_class.mattr_accessor :output_config
+    host_class.output_config = { filetype: "txt" }
+
+    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, changed: :content, on: :save do
+      reset_machine_output
+    end
+  end
+end
+
+include_set Abstract::Lock
+
+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 direct_machine_input? input_card
+  !input_card.is_a?(Card::Set::Type::Pointer) ||
+    input_card.respond_to?(:machine_input)
+end
+
+def run_engine input_card
+  return unless direct_machine_input? input_card
+  if (cached = fetch_cache_card(input_card)) && cached.content?
+    return cached.content
+  end
+
+  engine(input_from_card(input_card)).tap do |output|
+    cache_output_part input_card, output
+  end
+end
+
+def input_from_card input_card
+  if input_card.respond_to? :machine_input
+    input_card.machine_input
+  else
+    input_card.format._render_raw
+  end
+end
+
+def make_machine_output_coded mod=:machines
+  update_machine_output
+  Card::Auth.as_bot do
+    ENV["STORE_CODED_FILES"] = "true"
+    machine_output_card.update! storage_type: :coded, mod: mod,
+                                           codename: machine_output_codename
+    ENV["STORE_CODED_FILES"] = nil
+  end
+end
+
+def machine_output_codename
+  machine_output_card.name.parts.map do |part|
+    Card[part].codename&.to_s || Card[part].name.safe_key
+  end.join "_"
+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
+end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/machines/set/abstract/machine.rb ~~