Class: Alchemy::Attachment

Inherits:
BaseRecord
  • Object
show all
Includes:
Filetypes, NameConversions, Taggable, TouchElements
Defined in:
app/models/alchemy/attachment.rb,
app/models/alchemy/attachment/url.rb

Defined Under Namespace

Classes: Url

Constant Summary

Constants included from Filetypes

Filetypes::ARCHIVE_FILE_TYPES, Filetypes::AUDIO_FILE_TYPES, Filetypes::EXCEL_FILE_TYPES, Filetypes::IMAGE_FILE_TYPES, Filetypes::POWERPOINT_FILE_TYPES, Filetypes::TEXT_FILE_TYPES, Filetypes::VCARD_FILE_TYPES, Filetypes::VIDEO_FILE_TYPES, Filetypes::WORD_FILE_TYPES

Class Method Summary collapse

Instance Method Summary collapse

Methods included from TouchElements

included

Methods included from Taggable

included, #tag_list=

Methods included from NameConversions

#convert_to_humanized_name, #convert_to_urlname

Class Method Details

.alchemy_resource_filtersObject


58
59
60
61
62
63
64
65
66
67
68
69
# File 'app/models/alchemy/attachment.rb', line 58

def alchemy_resource_filters
  [
    {
      name: :by_file_type,
      values: distinct.pluck(:file_mime_type).map { |type| [Alchemy.t(type, scope: "mime_types"), type] }.sort_by(&:first),
    },
    {
      name: :misc,
      values: %w(recent last_upload without_tag),
    },
  ]
end

.allowed_filetypesObject


82
83
84
# File 'app/models/alchemy/attachment.rb', line 82

def allowed_filetypes
  Config.get(:uploader).fetch("allowed_filetypes", {}).fetch("alchemy/attachments", [])
end

.last_uploadObject


71
72
73
74
75
76
# File 'app/models/alchemy/attachment.rb', line 71

def last_upload
  last_id = Attachment.maximum(:id)
  return Attachment.all unless last_id

  where(id: last_id)
end

.searchable_alchemy_resource_attributesObject


78
79
80
# File 'app/models/alchemy/attachment.rb', line 78

def searchable_alchemy_resource_attributes
  %w(name file_name)
end

.url_classObject

The class used to generate URLs for attachments

See Also:


47
48
49
# File 'app/models/alchemy/attachment.rb', line 47

def url_class
  @_url_class ||= Alchemy::Attachment::Url
end

.url_class=(klass) ⇒ Object

Set a different attachment url class

See Also:


54
55
56
# File 'app/models/alchemy/attachment.rb', line 54

def url_class=(klass)
  @_url_class = klass
end

Instance Method Details

#extensionObject Also known as: suffix

File format suffix


127
128
129
# File 'app/models/alchemy/attachment.rb', line 127

def extension
  file_name.split(".").last
end

#icon_css_classObject

Returns a css class name for kind of file


135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'app/models/alchemy/attachment.rb', line 135

def icon_css_class
  case file_mime_type
  when "application/pdf"
    "file-pdf"
  when "application/msword"
    "file-word"
  when *TEXT_FILE_TYPES
    "file-alt"
  when *EXCEL_FILE_TYPES
    "file-excel"
  when *POWERPOINT_FILE_TYPES
    "file-powerpoint"
  when *WORD_FILE_TYPES
    "file-word"
  when *VCARD_FILE_TYPES
    "address-card"
  when *ARCHIVE_FILE_TYPES
    "file-archive"
  when *AUDIO_FILE_TYPES
    "file-audio"
  when *IMAGE_FILE_TYPES
    "file-image"
  when *VIDEO_FILE_TYPES
    "file-video"
  else
    "file"
  end
end

#restricted?Boolean

Checks if the attachment is restricted, because it is attached on restricted pages only

Returns:

  • (Boolean)

122
123
124
# File 'app/models/alchemy/attachment.rb', line 122

def restricted?
  pages.any? && pages.not_restricted.blank?
end

#slugObject

An url save filename without format suffix


117
118
119
# File 'app/models/alchemy/attachment.rb', line 117

def slug
  CGI.escape(file_name.gsub(/\.#{extension}$/, "").tr(".", " "))
end

#to_jq_uploadObject

Instance methods


102
103
104
105
106
107
108
# File 'app/models/alchemy/attachment.rb', line 102

def to_jq_upload
  {
    "name" => read_attribute(:file_name),
    "size" => read_attribute(:file_size),
    "error" => errors[:file].join,
  }
end

#url(options = {}) ⇒ Object


110
111
112
113
114
# File 'app/models/alchemy/attachment.rb', line 110

def url(options = {})
  if file
    self.class.url_class.new(self).call(options)
  end
end