Class: Saviour::File

Inherits:
Object
  • Object
show all
Defined in:
lib/saviour/file.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uploader_klass, model, attached_as, persisted_path = nil) ⇒ File

Returns a new instance of File.



7
8
9
10
11
12
13
14
15
16
 
# File 'lib/saviour/file.rb', line 7

def initialize(uploader_klass, model, attached_as, persisted_path = nil)
  @uploader_klass, @model, @attached_as = uploader_klass, model, attached_as
  @source_was = @source = nil
  @persisted_path = persisted_path
  @storage = @uploader_klass.storage

  if persisted_path
    @model.instance_variable_set("@__uploader_#{@attached_as}_was", ReadOnlyFile.new(persisted_path, @uploader_klass.storage))
  end
end

Instance Attribute Details

#persisted_path ⇒ Object (readonly)

Returns the value of attribute persisted_path.



5
6
7
 
# File 'lib/saviour/file.rb', line 5

def persisted_path
  @persisted_path
end

#source ⇒ Object (readonly)

Returns the value of attribute source.



5
6
7
 
# File 'lib/saviour/file.rb', line 5

def source
  @source
end

#storage ⇒ Object (readonly)

Returns the value of attribute storage.



5
6
7
 
# File 'lib/saviour/file.rb', line 5

def storage
  @storage
end

Instance Method Details

#==(another_file) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/saviour/file.rb', line 38

def ==(another_file)
  return false unless another_file.is_a?(Saviour::File)
  return false unless another_file.persisted? == persisted?

  if persisted?
    another_file.persisted_path == persisted_path
  else
    another_file.source == @source
  end
end

#__maybe_with_tmpfile(source_type, file) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/saviour/file.rb', line 126

def __maybe_with_tmpfile(source_type, file)
  return yield if source_type == :stream

  tmpfile = Tempfile.new([::File.basename(file.path, ".*"), ::File.extname(file.path)])
  tmpfile.binmode
  FileUtils.cp(file.path, tmpfile.path)

  begin
    yield(tmpfile)
  ensure
    tmpfile.close!
  end
end

#assign(object) ⇒ Object

Raises:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/saviour/file.rb', line 73

def assign(object)
  raise(SourceError, "given object to #assign or #<attach_as>= must respond to `read`") if object && !object.respond_to?(:read)

  followers = @model.class.followers_per_leader_config[@attached_as]

  (followers || []).each do |x|
    attachment = @model.send(x[:attachment])
    attachment.assign(object) unless attachment.changed?
  end

  @source_data = nil
  @source = object

  if changed? && @model.instance_variable_get("@__uploader_#{@attached_as}_was").nil?
    @model.instance_variable_set("@__uploader_#{@attached_as}_was", clone)
  end

  @persisted_path = nil if object

  object
end

#blank? ⇒ Boolean

Returns:

  • (Boolean) 


184
185
186
 
# File 'lib/saviour/file.rb', line 184

def blank?
  !@source && !persisted?
end

#changed? ⇒ Boolean

Returns:

  • (Boolean) 


99
100
101
 
# File 'lib/saviour/file.rb', line 99

def changed?
  @source_was != @source
end

#clone ⇒ Object 



49
50
51
52
 
# File 'lib/saviour/file.rb', line 49

def clone
  return nil unless persisted?
  Saviour::File.new(@uploader_klass, @model, @attached_as, @persisted_path)
end

#delete ⇒ Object 



27
28
29
30
31
 
# File 'lib/saviour/file.rb', line 27

def delete
  @persisted_path = nil
  @source_was = nil
  @source = nil
end

#dup(new_model) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/saviour/file.rb', line 54

def dup(new_model)
  new_file = Saviour::File.new(@uploader_klass, new_model, @attached_as)

  if persisted?
    new_file.assign(Saviour::StringSource.new(read, filename))
  elsif @source
    new_file.assign(Saviour::StringSource.new(source_data, filename_to_be_assigned))
  end

  new_file
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/saviour/file.rb', line 18

def exists?
  persisted? && @storage.exists?(@persisted_path)
end

#filename ⇒ Object 



103
104
105
 
# File 'lib/saviour/file.rb', line 103

def filename
  ::File.basename(@persisted_path) if persisted?
end

#filename_to_be_assigned ⇒ Object 



122
123
124
 
# File 'lib/saviour/file.rb', line 122

def filename_to_be_assigned
  changed? ? (SourceFilenameExtractor.new(@source).detected_filename || SecureRandom.hex) : nil
end

#persisted? ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/saviour/file.rb', line 95

def persisted?
  !!@persisted_path
end

#public_url ⇒ Object Also known as: url 



33
34
35
36
 
# File 'lib/saviour/file.rb', line 33

def public_url
  return nil unless persisted?
  @storage.public_url(@persisted_path)
end

#read ⇒ Object 



22
23
24
25
 
# File 'lib/saviour/file.rb', line 22

def read
  return nil unless persisted?
  @storage.read(@persisted_path)
end

#reload ⇒ Object 



66
67
68
69
 
# File 'lib/saviour/file.rb', line 66

def reload
  @model.instance_variable_set("@__uploader_#{@attached_as}", nil)
  @model.instance_variable_set("@__uploader_#{@attached_as}_was", nil)
end

#source_data ⇒ Object 



177
178
179
180
181
182
 
# File 'lib/saviour/file.rb', line 177

def source_data
  @source_data ||= begin
    @source.rewind if @source.respond_to?(:rewind)
    @source.read
  end
end

#source_type ⇒ Object 



169
170
171
172
173
174
175
 
# File 'lib/saviour/file.rb', line 169

def source_type
  if @source.respond_to?(:path)
    :file
  else
    :stream
  end
end

#uploader ⇒ Object 



188
189
190
 
# File 'lib/saviour/file.rb', line 188

def uploader
  @uploader ||= @uploader_klass.new(data: { model: @model, attached_as: @attached_as })
end

#with_copy ⇒ Object

Raises:



107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/saviour/file.rb', line 107

def with_copy
  raise CannotCopy, "must be persisted" unless persisted?

  temp_file = Tempfile.new([::File.basename(filename, ".*"), ::File.extname(filename)])
  temp_file.binmode

  begin
    @storage.read_to_file(@persisted_path, temp_file)

    yield(temp_file)
  ensure
    temp_file.close!
  end
end

#write(before_write: nil) ⇒ Object

Raises:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/saviour/file.rb', line 140

def write(before_write: nil)
  raise(MissingSource, "You must provide a source to read from before trying to write") unless @source

  __maybe_with_tmpfile(source_type, @source) do |tmpfile|
    contents, path = case source_type
                       when :stream
                         uploader._process_as_contents(source_data, filename_to_be_assigned)
                       when :file
                         uploader._process_as_file(tmpfile, filename_to_be_assigned)
                     end
    @source_was = @source

    if path
      before_write.call(path) if before_write

      case source_type
        when :stream
          @storage.write(contents, path)
        when :file
          @storage.write_from_file(contents, path)
      end

      @persisted_path = path
      @model.instance_variable_set("@__uploader_#{@attached_as}_was", ReadOnlyFile.new(persisted_path, @storage))
      path
    end
  end
end