Module: Neofiles

Defined in:
lib/neofiles.rb,
lib/neofiles/engine.rb,
lib/neofiles/version.rb

Defined Under Namespace

Modules: DataStore, NeofilesHelper, NotFound Classes: AdminController, AdminTestController, Engine, File, FileChunk, FilesController, Image, ImagesController, Swf

Constant Summary collapse

VERSION = 
'2.0.0'
@@routes_proc = 
proc do
  scope 'neofiles', module: :neofiles do
    # admin routes
    get  '/admin/file_compact/', to: 'admin#file_compact', as: :neofiles_file_compact
    post '/admin/file_save/', to: 'admin#file_save', as: :neofiles_file_save
    post '/admin/file_remove/', to: 'admin#file_remove', as: :neofiles_file_remove
    post '/admin/file_update/', to: 'admin#file_update', as: :neofiles_file_update
     # admin routes for WYSIWYG editor Redactor.js
    post '/admin/redactor-upload/', to: 'admin#redactor_upload', as: :neofiles_redactor_upload
    get  '/admin/redactor-list/:owner_type/:owner_id/:type', to: 'admin#redactor_list', as: :neofiles_redactor_list
     # web frontend for serving images and other files
    get  '/serve/:id', to: 'files#show', as: :neofiles_file
    get  '/serve-image/:id(/:format(/c:crop)(/q:quality))', to: 'images#show', as: :neofiles_image, format: false, constraints: {format: /[1-9]\d*x[1-9]\d*/, crop: /[10]/, quality: /[1-9]\d*/}
     # serve images w/o watermark - path has prefix nowm_ to let Nginx ot other web server not cache these queries,
    # unlike usual /serve-image/:id
    get  '/nowm-serve-image/:id', to: 'images#show', as: :neofiles_image_nowm, defaults: {nowm: true}
  end
end

Class Method Summary collapse

Class Method Details

.crop_requested?(params) ⇒ Boolean

Is request params hash contains crop request?

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/neofiles.rb', line 78

def crop_requested?(params)
  params[:crop].present? and params[:crop] != '0'
end

.is_admin?(context) ⇒ Boolean

Is current user considered “admin”? “Admin” means the user can fetch images w/o watermarks.

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/neofiles.rb', line 93

def is_admin?(context)
  Rails.application.config.neofiles.try(:current_admin).try(:call, context)
end

.quality_requested(params) ⇒ Object

The quality value requested, from request params hash.



88
89
90
 
# File 'lib/neofiles.rb', line 88

def quality_requested(params)
  params[:quality].to_i if params[:quality].present? and params[:quality] != '0'
end

.quality_requested?(params) ⇒ Boolean

Is request params hash contains quality request?

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/neofiles.rb', line 83

def quality_requested?(params)
  !!quality_requested(params)
end

.resized_image_dimensions(image_file, width, height, resize_options) ⇒ Object

Calculate image dimensions after resize. Returns [w, h] or nil if some info is lacking (e.g. image passed as ID so no width & height available).

image_file      - Neofiles::Image, ID or Hash
width, height   - max width and height after resize
resize_options  - {crop: '1'/'0'}, @see Neofiles::ImagesController#show

Can call ImageMagick.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/neofiles.rb', line 39

def resized_image_dimensions(image_file, width, height, resize_options)
  # dimensions are equal to requested ones if cropping
  return width, height if crop_requested? resize_options

  # otherwise ask ImageMagick - prepare input vars...
  image_file = Neofiles::Image.find image_file if image_file.is_a?(String)
  return nil if image_file.nil?

  if image_file.is_a? Neofiles::Image
    image_file_width = image_file.width
    image_file_height = image_file.height
  elsif image_file.is_a? Hash
    image_file_width = image_file[:width]
    image_file_height = image_file[:height]
  end

  # no input, terminate
  return if image_file_width.blank? || image_file_height.blank?

  # image fits into requested dimensions, no resizing will occur
  return image_file_width, image_file_height if image_file_width <= width && image_file_height <= height

  # ... construct request ...
  command = MiniMagick::CommandBuilder.new(:convert)            # convert input file...
  command.size([image_file_width, image_file_height].join 'x')  # with the given dimensions...
  command.xc('white')                                           # and filled with whites...
  command.resize([width, height].join 'x')                      # to fit in the given rectangle...
  command.push('info:-')                                        # return info about the resulting file

  # ... and send it to ImageMagick
  # the result will be: xc:white XC 54x100 54x100+0+0 16-bit DirectClass 0.070u 0:00.119
  # extract dimensions and return them as array of integers
  MiniMagick::Image.new(nil, nil).run(command).match(/ (\d+)x(\d+) /).values_at(1, 2).map(&:to_i)

rescue
  nil
end