card 1.97.0.1 → 1.98.0

data/tmpsets/set/{mod015-carrierwave → mod019-carrierwave}/abstract/attachment.rb

@@ -1,6 +1,10 @@
 # -*- encoding : utf-8 -*-
-class Card; module Set; class Abstract; module Attachment; extend Card::Set
-# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/carrierwave/set/abstract/attachment.rb ~~
+class Card; module Set; class Abstract
+# Set: Abstract (Attachment)
+#
+module Attachment;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/carrierwave/set/abstract/attachment.rb"; end
 require "carrier_wave/cardmount"
 
 attr_writer :empty_ok
@@ -21,10 +25,9 @@ event :correct_identifier, :finalize,
   expire
 end
 
-event :save_original_filename, :prepare_to_store,
-      when: proc { |c| c.file_ready_to_save? } do
+event :save_original_filename, :prepare_to_store, on: :save, when: :file_ready_to_save? do
   return unless @current_action
-  @current_action.update_attributes! comment: original_filename
+  @current_action.update! comment: original_filename
 end
 
 event :validate_file_exist, :validate, on: :save do
@@ -36,8 +39,7 @@ event :validate_file_exist, :validate, on: :save do
   end
 end
 
-event :write_identifier, after: :save_original_filename,
-                         when: proc { |c| !c.web? } do
+event :write_identifier, after: :save_original_filename, when: proc { |c| !c.web? } do
   self.content = attachment.db_content
 end
 
@@ -45,11 +47,11 @@ def file_ready_to_save?
   attachment.file.present? &&
     !preliminary_upload? &&
     !save_preliminary_upload? &&
-    attachment_changed?
+    attachment_is_changing?
 end
 
 def item_names _args={} # needed for flexmail attachments.  hacky.
-  [cardname]
+  [name]
 end
 
 def original_filename
@@ -58,15 +60,22 @@ def original_filename
 end
 
 def unfilled?
-  !attachment.present? && !save_preliminary_upload? && !subcards.present? &&
-    !content.present?
+  !attachment.present? && !save_preliminary_upload? && !subcards? && blank_content?
 end
 
 def attachment_changed?
   send "#{attachment_name}_changed?"
 end
 
-def create_versions? new_file
+def attachment_is_changing?
+  send "#{attachment_name}_is_changing?"
+end
+
+def attachment_before_act
+  send "#{attachment_name}_before_act"
+end
+
+def create_versions? _new_file
   true
 end
 
@@ -76,9 +85,7 @@ end
 
 def assign_set_specific_attributes
   # reset content if we really have something to upload
-  if @set_specific.present? && @set_specific[attachment_name.to_s].present?
-    self.content = nil
-  end
+  self.content = nil if set_specific[attachment_name.to_s].present?
   super
 end
 
@@ -91,9 +98,10 @@ def delete_files_for_action action
   end
 end
 
-# create filesystem links to files from prior action
-def rollback_to action
-  update_attributes! revision(action).merge(empty_ok: true)
+def revision action, before_action=false
+  return unless (result = super)
+  result[:empty_ok] = true
+  result
 end
 
 def attachment_format ext
@@ -112,7 +120,5 @@ rescue => e
   Rails.logger.info "attachment_format issue: #{e.message}"
   nil
 end
-
-
-# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/carrierwave/set/abstract/attachment.rb ~~
 end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/carrierwave/set/abstract/attachment.rb ~~

data/tmpsets/set/mod019-carrierwave/abstract/attachment/paths.rb

@@ -0,0 +1,67 @@
+# -*- encoding : utf-8 -*-
+class Card; module Set; class Abstract; module Attachment;
+# Set: Abstract (Attachment, Paths)
+#
+module Paths;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/carrierwave/set/abstract/attachment/paths.rb"; end
+MOD_FILE_DIR = "file".freeze
+
+def store_dir
+  will_become_coded? ? coded_dir(@new_mod) : upload_dir
+end
+
+def retrieve_dir
+  coded? ? coded_dir : upload_dir
+end
+
+# place for files of regular file cards
+def upload_dir
+  id ? "#{files_base_dir}/#{id}" : tmp_upload_dir
+end
+
+# place for files of mod file cards
+def coded_dir new_mod=nil
+  dir = File.join mod_dir(new_mod), MOD_FILE_DIR, codename.to_s
+  FileUtils.mkdir_p(dir) unless File.directory?(dir)
+  dir
+end
+
+def mod_dir new_mod=nil
+  mod_name = new_mod || mod
+  dir = Mod.dirs.path(mod_name) || (mod_name.to_sym == :test && "test")
+
+  raise Error, "can't find mod \"#{mod_name}\"" unless dir
+  dir
+end
+
+def files_base_dir
+  dir = bucket ? bucket_config[:subdirectory] : Card.paths["files"].existent.first
+  dir || files_base_dir_configuration_error
+end
+
+def files_base_dir_configuration_error
+  raise StandardError,
+        "missing directory for file cache (default is `files` in deck root)"
+end
+
+# used in the indentifier
+def file_dir
+  if coded?
+    ":#{codename}"
+  elsif cloud?
+    "(#{bucket})/#{file_id}"
+  else
+    "~#{file_id}"
+  end
+end
+
+def public?
+  who_can(:read).include? Card::AnyoneID
+end
+
+def file_id
+  id? ? id : upload_cache_card.id
+end
+end;end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/carrierwave/set/abstract/attachment/paths.rb ~~

data/tmpsets/set/{mod015-carrierwave → mod019-carrierwave}/abstract/attachment/storage_type.rb

@@ -1,10 +1,14 @@
 # -*- encoding : utf-8 -*-
-class Card; module Set; class Abstract; module Attachment; module StorageType; extend Card::Set
-# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/carrierwave/set/abstract/attachment/storage_type.rb ~~
+class Card; module Set; class Abstract; module Attachment;
+# Set: Abstract (Attachment, StorageType)
+#
+module StorageType;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/carrierwave/set/abstract/attachment/storage_type.rb"; end
 attr_writer :bucket, :storage_type
 
 event :storage_type_change, :store,
-      on: :update, when: proc { |c| c.storage_type_changed? } do
+      on: :update, when: :storage_type_changed? do
   # carrierwave stores file if @cache_id is not nil
   attachment.cache_stored_file!
   # attachment.retrieve_from_cache!(attachment.cache_name)
@@ -17,51 +21,52 @@ event :storage_type_change, :store,
   write_identifier
 end
 
-event :validate_storage_type, :validate,
-      on: :save do
+event :validate_storage_type, :validate, on: :save do
   if will_become_coded?
-    unless mod || @new_mod
-      errors.add :storage_type, "mod argument needed to save card as coded"
-    end
-    if codename.blank?
-      errors.add :storage_type, "codename needed for storage type coded"
-    end
+    errors.add :storage_type, tr(:mod_argument_needed_to_save) unless mod || @new_mod
+    errors.add :storage_type, tr(:codename_needed_for_storage) if codename.blank?
   end
   unless known_storage_type? will_be_stored_as
-    errors.add :storage_type, "unknown storage type: #{@new_storage_type}"
+    errors.add :storage_type, tr(
+      :unknown_storage_type,
+      new_storage_type: @new_storage_type
+    )
   end
 end
 
-event :validate_storage_type_update, :validate,
-      on: :update do
-  if cloud? && storage_type_changed?
-    errors.add :storage_type, "moving files from cloud elsewhere "\
-                              "is not supported"
+event :validate_storage_type_update, :validate, on: :update do
+  # FIXME: make it possible to retrieve the file from cloud storage
+  #   to store it somewhere else. Currently, it only works to change the
+  #   storage type if a new file is provided
+  #   i.e. `update storage_type: :local` fails but
+  #        `update storage_type: :local, file: [file handle]` is ok
+  if cloud? && storage_type_changed? && !attachment_is_changing?
+    errors.add :storage_type, tr(:moving_files_is_not_supported)
   end
 end
 
-event :loose_coded_status_on_update, :initialize,
-      on: :update, when: proc { |c| c.coded? } do
+event :lose_coded_status_on_update, :initialize, on: :update, when: :coded? do
+  # unless explicit
   return if @new_mod
   @new_storage_type ||= storage_type_from_config
 end
 
-event :update_public_link_on_create, :integrate,
-      on: :create,
-      when: proc { |c| c.local? } do
+event :change_bucket_if_read_only, :initialize,
+      on: :update, when: :change_bucket_if_read_only? do
+  @new_storage_type = storage_type_from_config
+end
+
+event :update_public_link_on_create, :integrate, on: :create, when: :local? do
   update_public_link
 end
 
-event :remove_public_link_on_delete, :integrate,
-      on: :delete,
-      when: proc { |c| c.local? } do
+event :remove_public_link_on_delete, :integrate, on: :delete, when: :local? do
   remove_public_links
 end
 
-event :update_public_link, after: :update_read_rule,
-                           when: proc { |c| c.local? } do
+event :update_public_link, after: :update_read_rule, when: :local? do
   return if content.blank?
-  if who_can(:read).include? Card[:anyone].id
+  if who_can(:read).include? Card::AnyoneID
     create_public_links
   else
     remove_public_links
@@ -93,6 +98,14 @@ def will_be_stored_as
   @new_storage_type || storage_type
 end
 
+def change_bucket_if_read_only?
+  cloud? && bucket_config[:read_only] && attachment_is_changing?
+end
+
+def read_only?
+  web? || (cloud? && bucket_config[:read_only])
+end
+
 def cloud?
   storage_type == :cloud
 end
@@ -146,8 +159,17 @@ end
 
 def bucket
   @bucket ||= cloud? &&
-              ((new_card? && bucket_from_config) || bucket_from_content ||
-                bucket_from_config)
+              (new_card_bucket || bucket_from_content || bucket_from_config)
+end
+
+def new_card_bucket
+  return unless new_card?
+  # If the file is assigned before the bucket option we have to
+  # check if there is a bucket options in set_specific.
+  # That happens for exmaple when the file appears before the bucket in the
+  # options hash:
+  #   Card.create file: file_handle, bucket: "my_bucket"
+  set_specific[:bucket] || set_specific["bucket"] || bucket_from_config
 end
 
 def bucket_config
@@ -173,13 +195,16 @@ def ensure_bucket_config
   unless config.present?
     raise Card::Error, "couldn't find configuration for bucket #{bucket}"
   end
+  unless config[:credentials]
+    raise Card::Error, "couldn't find credentials for bucket #{bucket}"
+  end
   config
 end
 
 def load_bucket_config_from_env config
   config ||= {}
   CarrierWave::FileCardUploader::CONFIG_OPTIONS.each do |key|
-    next if key.in? [:attributes, :credentials]
+    next if key.in? %i[attributes credentials]
     replace_with_env_variable config, key
   end
   config[:credentials] ||= {}
@@ -212,7 +237,7 @@ end
 
 def bucket_from_config
   Cardio.config.file_default_bucket ||
-    (Cardio.config.file_buckets && Cardio.config.file_buckets.keys.first)
+    (Cardio.config.file_buckets&.keys&.first)
 end
 
 def storage_type
@@ -255,7 +280,7 @@ def update_storage_attributes
 end
 
 def storage_type_changed?
-  @new_bucket || @new_storage_type || @new_mod
+  @new_bucket || (@new_storage_type && @new_storage_type != storage_type) || @new_mod
 end
 
 def bucket= value
@@ -268,7 +293,7 @@ end
 
 def storage_type= value
   known_storage_type? value
-  if @action == :update
+  if @action == :update #&& storage_type != value
     # we cant update the storage type directly here
     # if we do then the uploader doesn't find the file we want to update
     @new_storage_type = value
@@ -278,7 +303,7 @@ def storage_type= value
 end
 
 def mod= value
-  if @action == :update
+  if @action == :update && mod != value
     @new_mod = value.to_s
   else
     @mod = value.to_s
@@ -288,7 +313,7 @@ end
 def with_storage_options opts={}
   old_values = {}
   validate_temporary_storage_type_change opts[:storage_type]
-  [:storage_type, :mod, :bucket].each do |opt_name|
+  %i[storage_type mod bucket].each do |opt_name|
     next unless opts[opt_name]
     old_values[opt_name] = instance_variable_get "@#{opt_name}"
     instance_variable_set "@#{opt_name}", opts[opt_name]
@@ -310,8 +335,9 @@ def validate_temporary_storage_type_change new_storage_type=nil
   new_storage_type ||= @new_storage_type
   return unless new_storage_type
   unless known_storage_type? new_storage_type
-    raise Error, "unknown storage type: #{new_storage_type}"
+    raise Error, tr(:unknown_storage_type, new_storage_type: new_storage_type)
   end
+
   if new_storage_type == :coded && codename.blank?
     raise Error, "codename needed for storage type :coded"
   end
@@ -320,7 +346,5 @@ end
 def known_storage_type? type=storage_type
   type.in? CarrierWave::FileCardUploader::STORAGE_TYPES
 end
-
-
-# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/carrierwave/set/abstract/attachment/storage_type.rb ~~
 end;end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/carrierwave/set/abstract/attachment/storage_type.rb ~~

data/tmpsets/set/{mod015-carrierwave → mod019-carrierwave}/abstract/attachment/upload_cache.rb

@@ -1,19 +1,27 @@
 # -*- encoding : utf-8 -*-
-class Card; module Set; class Abstract; module Attachment; module UploadCache; extend Card::Set
-# ~~ above autogenerated; below pulled from /Users/ethan/dev/wagn/gem/card/mod/carrierwave/set/abstract/attachment/upload_cache.rb ~~
+class Card; module Set; class Abstract; module Attachment;
+# Set: Abstract (Attachment, UploadCache)
+#
 # action id of the cached upload
+module UploadCache;
+extend Card::Set
+def self.source_location; "/Users/ethan/dev/decko/gem/card/mod/carrierwave/set/abstract/attachment/upload_cache.rb"; end
 attr_accessor :action_id_of_cached_upload
 
-event :upload_attachment, :prepare_to_validate,
-      on: :save, when: proc { |c| c.preliminary_upload? } do
+def actionable?
+  super || preliminary_upload?
+end
+
+event :prepare_attachment, :prepare_to_validate, on: :save, when: :preliminary_upload? do
   save_original_filename  # save original filename as comment in action
   write_identifier        # set db_content
   # (needs original filename to determine extension)
   store_attachment!
-  finalize_action         # create Card::Change entry for db_content
+  store_card_changes
+  # finalize_action         # create Card::Change entry for db_content
 
   card_id = new_card? ? upload_cache_card.id : id
-  @current_action.update_attributes! draft: true, card_id: card_id
+  @current_action.update! draft: true, card_id: card_id
   success << {
     target: (new_card? ? upload_cache_card : self),
     type: type_name,
@@ -24,8 +32,7 @@ event :upload_attachment, :prepare_to_validate,
 end
 
 event :assign_attachment_on_create, :initialize,
-      after: :assign_action, on: :create,
-      when: proc { |c| c.save_preliminary_upload? } do
+      after: :assign_action, on: :create, when: :save_preliminary_upload? do
   return unless  (action = Card::Action.fetch(@action_id_of_cached_upload))
   upload_cache_card.selected_action_id = action.id
   upload_cache_card.select_file_revision
@@ -33,8 +40,7 @@ event :assign_attachment_on_create, :initialize,
 end
 
 event :assign_attachment_on_update, :initialize,
-      after: :assign_action, on: :update,
-      when:  proc { |c| c.save_preliminary_upload? } do
+      after: :assign_action, on: :update, when: :save_preliminary_upload? do
   return unless (action = Card::Action.fetch(@action_id_of_cached_upload))
   uploaded_file = with_selected_action_id(action.id) { attachment.file }
   assign_attachment uploaded_file, action.comment
@@ -43,19 +49,25 @@ end
 def assign_attachment file, original_filename
   send "#{attachment_name}=", file
   write_identifier
-  @current_action.update_attributes! comment: original_filename
+  @current_action&.update! comment: original_filename
 end
 
 event :delete_cached_upload_file_on_create, :integrate,
-      on: :create, when: proc { |c| c.save_preliminary_upload? } do
+      on: :create, when: :save_preliminary_upload? do
   return unless (action = Card::Action.fetch(@action_id_of_cached_upload))
   upload_cache_card.delete_files_for_action action
   action.delete
+end
+
+# at some point uploaded files of canceled file card creation
+# should be deleted. We do this when ever an new file is created.
+event :clear_draft_files, :integrate_with_delay,
+      on: :create do
   Card.delete_tmp_files_of_cached_uploads
 end
 
 event :delete_cached_upload_file_on_update, :integrate,
-      on: :update, when: proc { |c| c.save_preliminary_upload? } do
+      on: :update, when: :save_preliminary_upload? do
   return unless  (action = Card::Action.fetch(@action_id_of_cached_upload))
   delete_files_for_action action
   action.delete
@@ -63,7 +75,8 @@ end
 
 # used for uploads for new cards until the new card is created
 def upload_cache_card
-  @upload_cache_card ||= Card["new_#{attachment_name}".to_sym]
+  cache_card_codename = "new_#{attachment_name}"
+  @upload_cache_card ||= Card::Codename.card(cache_card_codename) { Card[:new_file] }
 end
 
 def preliminary_upload?
@@ -78,7 +91,5 @@ end
 def tmp_upload_dir _action_id=nil
   "#{files_base_dir}/#{upload_cache_card.id}"
 end
-
-
-# ~~ below autogenerated; above pulled from /Users/ethan/dev/wagn/gem/card/mod/carrierwave/set/abstract/attachment/upload_cache.rb ~~
 end;end;end;end;end;
+# ~~ generated from /Users/ethan/dev/decko/gem/card/mod/carrierwave/set/abstract/attachment/upload_cache.rb ~~