card 1.91 → 1.92

data/db/seed_consts.rb

@@ -0,0 +1,10 @@
+unless defined? DECKO_SEED_TABLES
+  DECKO_SEED_TABLES = %w( cards card_actions card_acts card_changes
+                         card_references ).freeze
+end
+
+unless defined? DECKO_SEED_PATH
+  DECKO_SEED_PATH = File.join(
+    ENV["DECKO_SEED_REPO_PATH"] || [Cardio.gem_root, "db", "seed"], "new"
+  )
+end

data/db/seeds.rb

@@ -1,8 +1,3 @@
-DECKO_SEED_TABLES = %w( cards card_actions card_acts card_changes
-                       card_references ).freeze
-DECKO_SEED_PATH = File.join(
-  ENV["DECKO_SEED_REPO_PATH"] || [Cardio.gem_root, "db", "seed"], "new"
-)
-
+require_relative "seed_consts"
 require "active_record/fixtures"
 ActiveRecord::FixtureSet.create_fixtures DECKO_SEED_PATH, DECKO_SEED_TABLES

data/db/version.txt

@@ -1 +1 @@
-20160122153608
+20170908114442

data/db/version_core_cards.txt

@@ -1 +1 @@
-20170608200649
+20170830210517

data/lib/active_record/connection_adapters_ext.rb

@@ -3,7 +3,7 @@ module ActiveRecord
   module ConnectionAdapters
     class AbstractAdapter
       def match _string
-        raise "match not implemented"
+        raise I18n.t(:exception_not_implemented, scope: "lib.card.active_record_ext")
       end
 
       def cast_types

data/lib/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/lib/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/lib/card.rb

@@ -2,30 +2,88 @@
 require "carrierwave"
 
 Object.const_remove_if_defined :Card
+#ActiveSupport::Dependencies.loaded.clear
 
 # Cards are wiki-inspired building blocks.
 #
 # This documentation is intended for developers who want to understand:
 #
-# a. how ruby Card objects work, and
-# b. how to extend them.
+#   1. how ruby Card objects work, and
+#   2. 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
-  def self.serializable_attr_accessor *args
-    self.serializable_attributes = args
-    attr_accessor(*args)
-  end
+# It assumes that you've already read the introductory text in {file:README.rdoc}.
+#
+# Throughout this document we will refer to @card as an instance of a Card object.
+#
+# ##Names
+#
+# There are four important card identifiers, sometimes called "marks".  Every card has a unique _name_, _key_, and _id_. Some cards also have a _codename_.
+#
+#       @card.name     # The name, a String, is the most recognizable card mark.
+#       @card.key      # The key, a String, is a simple lower-case name variant.
+#       @card.id       # The id is an Integer.
+#       @card.codename # The codename, a Symbol, is the name by which a card can be referred to in code.
+#
+# All names with the same key (including the key itself) are considered variants of each other. No two cards can have names with the same key.
+#
+# `@card.cardname` refers to the same name as ``@card.name``, but it is a {Card::Name} object and has many additional methods.
+#
+# {Card::Codename More about codenames.}
+#
+# ## Fetching
+#
+# The two main ways to retrieve cards are fetching (retrieving cards one at a time) and querying (retrieving lists of cards).
+#
+# Any of the above marks (name, key, id, codename) can be used to fetch a card, eg:
+#
+#      @card = Card.fetch "Garden" # returns the card with the name "Garden" (or, more precisely, with the key "garden")
+#      @card = Card.fetch 100      # returns the card with the id 100
+#      @card = Card.fetch :help    # returns the card with the codename help
+#
+# The fetch API will first try to find the card in the cache and will only look in the database if necessary.
+#
+# {file:mod/core/set/all/fetch.rb More about fetching}
+#
+# ## Type
+#
+# Every card has a type, and every type itself has an associated card. For example, _Paula_'s type might be _User_, so there is also a _User_ card.
+#
+# The type may be accessed in several ways:
+#
+#       @card.type_card    # returns type card [Card]
+#       @card.type_id      # returns id of type card [Integer]
+#       @card.type_name    # returns name of type card [String]
+#       @card.type_code    # returns codename of type card [Symbol]
+#
+# {file:mod/core/set/all/type.rb set module with type methods}
+#
+# ## Content
+# chunks
+#
+# ## Query
+# reference, query
+#
+# ## Accounts
+# permission
+#
+#
+# ## History
+# acts, actions, changes
+# subcards, act_manager
+#
+# ## Events
+# mailer
+#
+# ## Caching
 
+class Card < ApplicationRecord
   require_dependency "active_record/connection_adapters_ext"
   require_dependency "card/codename"
   require_dependency "card/query"
   require_dependency "card/format"
   require_dependency "card/error"
   require_dependency "card/auth"
-  require_dependency "card/mod/loader"
+  require_dependency "card/mod"
   require_dependency "card/content"
   require_dependency "card/action"
   require_dependency "card/act"
@@ -34,7 +92,6 @@ class Card < ActiveRecord::Base
   require_dependency "card/subcards"
   require_dependency "card/view"
   require_dependency "card/act_manager"
-  require_dependency "card/act_manager/stage_director"
 
   has_many :references_in,  class_name: :Reference, foreign_key: :referee_id
   has_many :references_out, class_name: :Reference, foreign_key: :referer_id
@@ -47,6 +104,12 @@ class Card < ActiveRecord::Base
   self.set_patterns = []
   self.error_codes = {}
 
+  # attributes that ActiveJob can handle
+  def self.serializable_attr_accessor *args
+    self.serializable_attributes = args
+    attr_accessor(*args)
+  end
+
   serializable_attr_accessor(
     :action, :supercard, :superleft,
     :current_act, :current_action,
@@ -56,7 +119,8 @@ class Card < ActiveRecord::Base
     :silent_change,               # and this probably too
     :remove_rule_stash,
     :last_action_id_before_edit,
-    :only_storage_phase           # used to save subcards
+    :only_storage_phase,           # used to save subcards
+    :changed_attributes
   )
 
   def serializable_attributes

data/lib/card/act_manager.rb

@@ -1,3 +1,6 @@
+require_dependency "card/act_manager/stage_director"
+
+
 class Card
   # Manages the whole process of creating an {act Card::Act} ie. changing
   # a card and attached subcards.

data/lib/card/act_manager/stage_director.rb

@@ -1,11 +1,8 @@
 
 class Card
   def restore_changes_information
-    return unless @previously_changed
-    @changed_attributes = ActiveSupport::HashWithIndifferentAccess.new
-    @previously_changed.each do |k, (old, _new)|
-      @changed_attributes[k] = old
-    end
+    return unless saved_changes.present?
+    @changed_attributes = previous_mutation_tracker.changed_values
   end
 
   def clean_after_stage_fail
@@ -47,6 +44,7 @@ class Card
     # stage
     class StageDirector
       include Stage
+      include Phases
 
       attr_accessor :prior_store, :act, :card, :stage, :parent, :main,
                     :subdirectors, :transact_in_stage
@@ -94,39 +92,6 @@ class Card
         @subdirectors.each(&:prepare_for_phases)
       end
 
-      def validation_phase
-        run_single_stage :initialize
-        run_single_stage :prepare_to_validate
-        run_single_stage :validate
-        @card.expire_pieces if @card.errors.any?
-        @card.errors.empty?
-      end
-
-      def storage_phase &block
-        catch_up_to_stage :prepare_to_store
-        run_single_stage :store, &block
-        run_single_stage :finalize
-      ensure
-        @from_trash = nil
-      end
-
-      def integration_phase
-        return if @abort
-        @card.restore_changes_information
-        run_single_stage :integrate
-        run_single_stage :after_integrate
-        run_single_stage :integrate_with_delay
-      rescue => e  # don't rollback
-        Card::Error.current = e
-        warn "exception in integrate stage: #{e.message}"
-        # binding.pry
-        @card.notable_exception_raised
-        return false
-      ensure
-        @card.changes_applied unless @abort
-        ActManager.clear if main? && !@card.only_storage_phase
-      end
-
       def catch_up_to_stage next_stage
         if @transact_in_stage
           return if @transact_in_stage != next_stage

data/lib/card/act_manager/stage_director/phases.rb

@@ -0,0 +1,39 @@
+class Card
+  class ActManager
+    class StageDirector
+      module Phases
+        def validation_phase
+          run_single_stage :initialize
+          run_single_stage :prepare_to_validate
+          run_single_stage :validate
+          @card.expire_pieces if @card.errors.any?
+          @card.errors.empty?
+        end
+
+        def storage_phase &block
+          catch_up_to_stage :prepare_to_store
+          run_single_stage :store, &block
+          run_single_stage :finalize
+        ensure
+          @from_trash = nil
+        end
+
+        def integration_phase
+          return if @abort
+          @card.restore_changes_information
+          run_single_stage :integrate
+          run_single_stage :after_integrate
+          run_single_stage :integrate_with_delay
+        rescue => e # don't rollback
+          Card::Error.current = e
+          warn "exception in integrate stage: #{e.message}"
+          @card.notable_exception_raised
+          return false
+        ensure
+          @card.clear_changes_information unless @abort
+          ActManager.clear if main? && !@card.only_storage_phase
+        end
+      end
+    end
+  end
+end

data/lib/card/codename.rb

@@ -3,17 +3,22 @@ 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. Instead, a
-  # {Card} that needs specific code manipulations should be given a {Codename},
-  # a unique string identifier that will not change even if the card's name
+  # {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.
   #
-  # The {Codename} class provides a fast cache for this slow-changing data.
-  # Every process maintains a complete cache that is not frequently reset
+  # An administrator might add to the Company card via the RESTful web API with a url like
+  #
+  #     /update/CARDNAME?card[codename]=CODENAME
+  #
+  # ...or via the api like
+  #
+  #     Card[CARDNAME].update_attributes! codename: CODENAME
+  #
+  # Generally speaking, _codenames_ are represented by Symbols.
   #
-  # Generally speaking, _codenames_ are represented by Symbols, _names_ are
-  # Strings, and _ids_ are Integers.
+  # 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
@@ -86,7 +91,8 @@ class Card
       if (card_id = Codename[code])
         const_set const, card_id
       else
-        raise "Missing codename #{code} (#{const})"
+        raise I18n.t(:exception_missing_codename, scope: "lib.card.codename",
+                                                  code: code, const: const)
       end
     else
       super

data/lib/card/content.rb

@@ -50,6 +50,10 @@ class Card
       each_chunk { |chunk| chunk.process_chunk(&block) }
     end
 
+    def pieces
+      Array.wrap(__getobj__)
+    end
+
     def each_chunk
       return enum_for(:each_chunk) unless block_given?
 

data/lib/card/content/chunk.rb

@@ -120,6 +120,10 @@ class Card
         end
 
         def to_s
+          result
+        end
+
+        def result
           @process_chunk || @processed || @text
         end
 

data/lib/card/env.rb

@@ -41,8 +41,12 @@ class Card
       end
 
       def slot_opts
-        return {} unless params[:slot].is_a? Hash
-        params[:slot].deep_symbolize_keys
+        # FIXME:  upgrade to safe parameters
+        self[:slot_opts] ||= begin
+          opts = params[:slot] || {}
+          opts = opts.to_unsafe_h if opts.is_a? ActionController::Parameters
+          opts.deep_symbolize_keys
+        end
       end
 
       def session

data/lib/card/env/location_history.rb

@@ -18,7 +18,7 @@ class Card
       end
 
       def save_location? card
-        !Env.ajax? && Env.html? && card.known? && (card.codename != "signin")
+        !Env.ajax? && Env.html? && card.known? && (card.codename != :signin)
       end
 
       def previous_location

data/lib/card/env/success.rb

@@ -12,6 +12,8 @@ class Card
         case success_params
         when Hash
           apply(success_params)
+        when ActionController::Parameters
+          apply(success_params.to_unsafe_h)
         when nil then  self.name = "_self"
         else;  self.target = success_params
         end
@@ -38,7 +40,8 @@ class Card
         when Integer then @id = value
         when String then @name = value
         when Card then @card = value
-        else; self.target = value
+        else
+          self.target = value
         end
       end
 
@@ -86,7 +89,7 @@ class Card
         elsif @id
           Card.find @id
         elsif @name
-          Card.fetch @name.to_name.to_absolute(name_context), new: @new_args
+          Card.fetch @name.to_name.absolute(name_context), new: @new_args
         end
       end
 

data/lib/card/error.rb

@@ -6,7 +6,7 @@ class Card
   class Error < StandardError
     cattr_accessor :current
 
-    class Oops < Error # wagneer problem (rename!)
+    class Oops < Error # carditect problem (rename!)
     end
 
     class BadQuery < Error
@@ -26,7 +26,8 @@ class Card
 
       def build_message
         if (msg = @card.errors[:permission_denied])
-          "for card #{@card.name}: #{msg}"
+          I18n.t :exception_for_card, scope: [:lib, :card, :error],
+                                      cardname: @card.name, message: msg
         else
           super
         end

data/lib/card/format.rb

@@ -28,36 +28,27 @@ class Card
     include Nest
     include Permission
     include Render
-    include Names
+    include ContextNames
     include Content
     include Error
 
     extend Registration
 
-    # FIXME: should be set in views
-
-    cattr_accessor :ajax_call, :registered
+    cattr_accessor :registered
     self.registered = []
-    [:perms, :denial, :closed, :error_code,
-     :view_tags, :aliases].each do |accessor_name|
+    VIEW_VARS = [ :perms, :denial, :closed, :error_code ]
+    (VIEW_VARS + [ :view_tags, :aliases ]).each do |accessor_name|
       cattr_accessor accessor_name
       send "#{accessor_name}=", {}
     end
 
-    attr_reader :card, :root, :parent, :main_opts, :mode
+    attr_reader :card, :parent, :main_opts
     attr_accessor :form, :error_status
 
     def initialize card, opts={}
       @card = card
       require_card_to_initialize!
-
       opts.each { |key, value| instance_variable_set "@#{key}", value }
-
-      @mode ||= :normal
-      @root ||= self
-      @depth ||= 0
-
-      @context_names = initial_context_names
       include_set_format_modules
       self
     end
@@ -94,13 +85,6 @@ class Card
       Env.session
     end
 
-    def main?
-      @depth.zero?
-    end
-
-    def focal? # meaning the current card is the requested card
-      @depth.zero?
-    end
 
     def template
       @template ||= begin
@@ -133,5 +117,13 @@ class Card
     def tagged view, tag
       self.class.tagged view, tag
     end
+
+    def mime_type
+      "text/text"
+    end
+
+    def to_sym
+      Card::Format.format_sym self
+    end
   end
 end