Class: Imgproxy::UrlAdapters

Inherits:
Object
  • Object
show all
Defined in:
lib/imgproxy/url_adapters.rb,
lib/imgproxy/url_adapters/shrine.rb,
lib/imgproxy/url_adapters/shrine_s3.rb,
lib/imgproxy/url_adapters/active_storage.rb,
lib/imgproxy/url_adapters/active_storage_s3.rb,
lib/imgproxy/url_adapters/active_storage_gcs.rb

Overview

URL adapters config. Allows to use this gem with ActiveStorage, Shrine, etc.

Imgproxy.configure do |config|
  config.url_adapters.add Imgproxy::UrlAdapters::ActiveStorage.new
end

Imgproxy.url_for(user.avatar)

Defined Under Namespace

Classes: ActiveStorage, ActiveStorageGCS, ActiveStorageS3, NotConfigured, NotFound, Shrine, ShrineS3

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ UrlAdapters

Returns a new instance of UrlAdapters.



23
24
25
 
# File 'lib/imgproxy/url_adapters.rb', line 23

def initialize
  @adapters = []
end

Instance Attribute Details

#adapters ⇒ Array (readonly)

Returns Currently added adapters.

Returns:

  • (Array) —

    Currently added adapters



21
22
23
 
# File 'lib/imgproxy/url_adapters.rb', line 21

def adapters
  @adapters
end

Instance Method Details

#add(adapter) ⇒ Array

Add adapter to the end of the list

Returns:

  • (Array) 


29
30
31
 
# File 'lib/imgproxy/url_adapters.rb', line 29

def add(adapter)
  adapters << adapter
end

#clear! ⇒ Array

Remove all adapters from the list

Returns:

  • (Array) 


41
42
43
 
# File 'lib/imgproxy/url_adapters.rb', line 41

def clear!
  @adapters = []
end

#prepend ⇒ Array

Add adapter to the beginning of the list

Returns:

  • (Array) 


35
36
37
 
# File 'lib/imgproxy/url_adapters.rb', line 35

def prepend
  adapters.unshift(adapter)
end

#url_of(image) ⇒ String

Get URL for the provided image

Returns:

  • (String)

Raises:



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/imgproxy/url_adapters.rb', line 47

def url_of(image)
  return image if image.is_a? String
  return image.to_s if image.is_a? URI

  adapter = adapters.find { |a| a.applicable?(image) }

  return adapter.url(image) if adapter

  raise NotFound, "Can't found URL adapter for #{image.inspect}"
end