Class: AssetSync::Storage

Inherits:
Object
  • Object
show all
Defined in:
lib/asset_sync/storage.rb

Defined Under Namespace

Classes: BucketNotFound

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cfg) ⇒ Storage

Returns a new instance of Storage.



8
9
10
 
# File 'lib/asset_sync/storage.rb', line 8

def initialize(cfg)
  @config = cfg
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



6
7
8
 
# File 'lib/asset_sync/storage.rb', line 6

def config
  @config
end

Instance Method Details

#always_upload_files ⇒ Object 



56
57
58
 
# File 'lib/asset_sync/storage.rb', line 56

def always_upload_files
  self.config.always_upload.map { |f| File.join(self.config.assets_prefix, f) }
end

#bucket ⇒ Object 



16
17
18
19
 
# File 'lib/asset_sync/storage.rb', line 16

def bucket
  # fixes: https://github.com/rumblelabs/asset_sync/issues/18
  @bucket ||= connection.directories.get(self.config.fog_directory, :prefix => self.config.assets_prefix)
end

#connection ⇒ Object 



12
13
14
 
# File 'lib/asset_sync/storage.rb', line 12

def connection
  @connection ||= Fog::Storage.new(self.config.fog_options)
end

#delete_extra_remote_files ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/asset_sync/storage.rb', line 92

def delete_extra_remote_files
  log "Fetching files to flag for delete"
  remote_files = get_remote_files
  # fixes: https://github.com/rumblelabs/asset_sync/issues/19
  from_remote_files_to_delete = remote_files - local_files - ignored_files

  log "Flagging #{from_remote_files_to_delete.size} file(s) for deletion"
  # Delete unneeded remote files
  bucket.files.each do |f|
    delete_file(f, from_remote_files_to_delete)
  end
end

#delete_file(f, remote_files_to_delete) ⇒ Object 



85
86
87
88
89
90
 
# File 'lib/asset_sync/storage.rb', line 85

def delete_file(f, remote_files_to_delete)
  if remote_files_to_delete.include?(f.key)
    log "Deleting: #{f.key}"
    f.destroy
  end
end

#get_local_files ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/asset_sync/storage.rb', line 60

def get_local_files
  if self.config.manifest
    if File.exists?(self.config.manifest_path)
      yml = YAML.load(IO.read(self.config.manifest_path))
      log "Using: Manifest #{self.config.manifest_path}"
      return yml.values.map { |f| File.join(self.config.assets_prefix, f) }
    else
      log "Warning: manifest.yml not found at #{self.config.manifest_path}"
    end
  end
  log "Using: Directory Search of #{path}/#{self.config.assets_prefix}"
  Dir.chdir(path) do
    Dir["#{self.config.assets_prefix}/**/**"]
  end
end

#get_remote_files ⇒ Object

Raises:



76
77
78
79
80
81
82
83
 
# File 'lib/asset_sync/storage.rb', line 76

def get_remote_files
  raise BucketNotFound.new("#{self.config.fog_provider} Bucket: #{self.config.fog_directory} not found.") unless bucket
  # fixes: https://github.com/rumblelabs/asset_sync/issues/16
  #        (work-around for https://github.com/fog/fog/issues/596)
  files = []
  bucket.files.each { |f| files << f.key }
  return files
end

#ignored_files ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/asset_sync/storage.rb', line 33

def ignored_files
  files = []
  Array(self.config.ignored_files).each do |ignore|
    case ignore
    when Regexp
      files += self.local_files.select do |file|
        file =~ ignore
      end
    when String
      files += self.local_files.select do |file|
        file.split('/').last == ignore
      end
    else
      log "Error: please define ignored_files as string or regular expression. #{ignore} (#{ignore.class}) ignored."
    end
  end
  files.uniq
end

#keep_existing_remote_files? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/asset_sync/storage.rb', line 25

def keep_existing_remote_files?
  self.config.existing_remote_files?
end

#local_files ⇒ Object 



52
53
54
 
# File 'lib/asset_sync/storage.rb', line 52

def local_files
  @local_files ||= get_local_files
end

#log(msg) ⇒ Object 



21
22
23
 
# File 'lib/asset_sync/storage.rb', line 21

def log(msg)
  AssetSync.log(msg)
end

#path ⇒ Object 



29
30
31
 
# File 'lib/asset_sync/storage.rb', line 29

def path
  self.config.public_path
end

#sync ⇒ Object 



174
175
176
177
178
179
180
 
# File 'lib/asset_sync/storage.rb', line 174

def sync
  # fixes: https://github.com/rumblelabs/asset_sync/issues/19
  log "AssetSync: Syncing."
  upload_files
  delete_extra_remote_files unless keep_existing_remote_files?
  log "AssetSync: Done."
end

#upload_file(f) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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
 
# File 'lib/asset_sync/storage.rb', line 105

def upload_file(f)
  # TODO output files in debug logs as asset filename only.
  one_year = 31557600
  ext = File.extname(f)[1..-1]
  mime = MultiMime.lookup(ext)
  file = {
    :key => f,
    :body => File.open("#{path}/#{f}"),
    :public => true,
    :cache_control => "public, max-age=#{one_year}",
    :expires => CGI.rfc1123_date(Time.now + one_year),
    :content_type => mime
  }

  gzipped = "#{path}/#{f}.gz"
  ignore = false

  if config.gzip? && File.extname(f) == ".gz"
    # Don't bother uploading gzipped assets if we are in gzip_compression mode
    # as we will overwrite file.css with file.css.gz if it exists.
    log "Ignoring: #{f}"
    ignore = true
  elsif config.gzip? && File.exists?(gzipped)
    original_size = File.size("#{path}/#{f}")
    gzipped_size  = File.size(gzipped)

    if gzipped_size < original_size
      percentage = ((gzipped_size.to_f/original_size.to_f)*100).round(2)
      file.merge!({
        :key => f,
        :body => File.open(gzipped),
        :content_encoding => 'gzip'
      })
      log "Uploading: #{gzipped} in place of #{f} saving #{percentage}%"
    else
      percentage = ((original_size.to_f/gzipped_size.to_f)*100).round(2)
      log "Uploading: #{f} instead of #{gzipped} (compression increases this file by #{percentage}%)"
    end
  else
    if !config.gzip? && File.extname(f) == ".gz"
      # set content encoding for gzipped files this allows cloudfront to properly handle requests with Accept-Encoding
      # http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html
      uncompressed_filename = f[0..-4]
      ext = File.extname(uncompressed_filename)[1..-1]
      mime = MultiMime.lookup(ext)
      file.merge!({
        :content_type     => mime,
        :content_encoding => 'gzip'
      })
    end
    log "Uploading: #{f}"
  end

  file = bucket.files.create( file ) unless ignore
end

#upload_files ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/asset_sync/storage.rb', line 161

def upload_files
  # get a fresh list of remote files
  remote_files = ignore_existing_remote_files? ? [] : get_remote_files
  # fixes: https://github.com/rumblelabs/asset_sync/issues/19
  local_files_to_upload = local_files - ignored_files - remote_files + always_upload_files

  # Upload new files
  local_files_to_upload.each do |f|
    next unless File.file? "#{path}/#{f}" # Only files.
    upload_file f
  end
end