Module: ActiveStorage
Overview
Welcome to ::Rails
What's Rails?
::Rails is a web-application framework that includes everything needed to
create database-backed web applications according to the
Model-View-Controller (MVC)
pattern.
Understanding the MVC pattern is key to understanding ::Rails. MVC divides your
application into three layers: Model, View, and Controller, each with a specific responsibility.
Model layer
The Model layer represents the domain model (such as Account, Product,
Person, Post, etc.) and encapsulates the business logic specific to
your application. In Rails, database-backed model classes are derived from
::ActiveRecord::Base. Active Record allows you to present the data from
database rows as objects and embellish these data objects with business logic
methods.
Although most ::Rails models are backed by a database, models can also be ordinary
Ruby classes, or Ruby classes that implement a set of interfaces as provided by
the Active Model module.
View layer
The View layer is composed of "templates" that are responsible for providing appropriate representations of your application's resources. Templates can come in a variety of formats, but most view templates are HTML with embedded Ruby code (ERB files). Views are typically rendered to generate a controller response or to generate the body of an email. In Rails, View generation is handled by Action View.
Controller layer
The Controller layer is responsible for handling incoming HTTP requests and
providing a suitable response. Usually, this means returning HTML, but ::Rails controllers
can also generate XML, JSON, PDFs, mobile-specific views, and more. Controllers load and
manipulate models, and render view templates in order to generate the appropriate HTTP response.
In Rails, incoming requests are routed by Action Dispatch to an appropriate controller, and
controller classes are derived from ::ActionController::Base. Action Dispatch and Action Controller
are bundled together in Action Pack.
Frameworks and libraries
Active Record, Active Model, Action Pack, and Action View can each be used independently outside ::Rails.
In addition to that, ::Rails also comes with:
- Action Mailer, a library to generate and send emails
- Action Mailbox, a library to receive emails within a
::Railsapplication - Active Job, a framework for declaring jobs and making them run on a variety of queuing backends
- Action Cable, a framework to integrate WebSockets with a
::Railsapplication - Active Storage, a library to attach cloud and local files to
::Railsapplications - Action Text, a library to handle rich text content
- Active Support, a collection of utility classes and standard library extensions that are useful for
::Rails, and may also be used independently outside::Rails
Getting Started
Install Rails at the command prompt if you haven't yet:
$ gem install railsAt the command prompt, create a new
::Railsapplication:$ rails new myapp
where "myapp" is the application name.
Change directory to
myappand start the web server:$ cd myapp $ bin/rails serverRun with
--helpor-hfor options.Go to
http://localhost:3000and you'll see the::Railsbootscreen with your::Railsand Ruby versions.Follow the guidelines to start developing your application. You may find the following resources handy:
Contributing
We encourage you to contribute to Ruby on Rails! Please check out the
Contributing to Ruby on ::Rails guide for guidelines about how to proceed. Join us!
Trying to report a possible security vulnerability in Rails? Please check out our security policy for guidelines about how to proceed.
Everyone interacting in ::Rails and its sub-projects' codebases, issue trackers, chat rooms, and mailing lists is expected to follow the ::Rails code of conduct.
License
Ruby on ::Rails is released under the MIT License.
Class Attribute Summary
- .analyzers (also: #analyzers) rw
- .binary_content_type (also: #binary_content_type) rw
- .content_types_allowed_inline (also: #content_types_allowed_inline) rw
- .content_types_to_serve_as_binary (also: #content_types_to_serve_as_binary) rw
- .draw_routes (also: #draw_routes) rw
- .logger (also: #logger) rw
- .paths (also: #paths) rw
- .previewers (also: #previewers) rw
- .queues (also: #queues) rw
- .resolve_model_to_route (also: #resolve_model_to_route) rw
- .routes_prefix (also: #routes_prefix) rw
- .service_urls_expire_in (also: #service_urls_expire_in) rw
- .supported_image_processing_methods (also: #supported_image_processing_methods) rw
- .touch_attachment_records (also: #touch_attachment_records) rw
- .track_variants (also: #track_variants) rw
- .unsupported_image_processing_arguments (also: #unsupported_image_processing_arguments) rw
- .urls_expire_in (also: #urls_expire_in) rw
- .variable_content_types (also: #variable_content_types) rw
- .variant_processor (also: #variant_processor) rw
- .variant_transformer (also: #variant_transformer) rw
- .verifier (also: #verifier) rw
- .video_preview_arguments (also: #video_preview_arguments) rw
- .web_image_content_types (also: #web_image_content_types) rw
Class Method Summary
-
.gem_version
Returns the currently loaded version of Active Storage as a
Gem::Version. -
.version
Returns the currently loaded version of Active Storage as a
Gem::Version. - .deprecator Internal use only
::ActiveSupport::Autoload - Extended
Instance Attribute Summary
- #analyzers rw
- #binary_content_type rw
- #content_types_allowed_inline rw
- #content_types_to_serve_as_binary rw
- #draw_routes rw
- #logger rw
- #paths rw
- #previewers rw
- #queues rw
- #resolve_model_to_route rw
- #routes_prefix rw
- #service_urls_expire_in rw
- #supported_image_processing_methods rw
- #touch_attachment_records rw
- #track_variants rw
- #unsupported_image_processing_arguments rw
- #urls_expire_in rw
- #variable_content_types rw
- #variant_processor rw
- #variant_transformer rw
- #verifier rw
- #video_preview_arguments rw
- #web_image_content_types rw
Class Attribute Details
.analyzers (rw) Also known as: #analyzers
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 57
mattr_accessor :analyzers, default: []
.binary_content_type (rw) Also known as: #binary_content_type
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 63
mattr_accessor :binary_content_type, default: "application/octet-stream"
.content_types_allowed_inline (rw) Also known as: #content_types_allowed_inline
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 65
mattr_accessor :content_types_allowed_inline, default: []
.content_types_to_serve_as_binary (rw) Also known as: #content_types_to_serve_as_binary
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 64
mattr_accessor :content_types_to_serve_as_binary, default: []
.draw_routes (rw) Also known as: #draw_routes
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 360
mattr_accessor :draw_routes, default: true
.logger (rw) Also known as: #logger
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 48
mattr_accessor :logger
.paths (rw) Also known as: #paths
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 59
mattr_accessor :paths, default: {}
.previewers (rw) Also known as: #previewers
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 56
mattr_accessor :previewers, default: []
.queues (rw) Also known as: #queues
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 54
mattr_accessor :queues, default: {}
.resolve_model_to_route (rw) Also known as: #resolve_model_to_route
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 361
mattr_accessor :resolve_model_to_route, default: :rails_storage_redirect
.routes_prefix (rw) Also known as: #routes_prefix
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 359
mattr_accessor :routes_prefix, default: "/rails/active_storage"
.service_urls_expire_in (rw) Also known as: #service_urls_expire_in
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 355
mattr_accessor :service_urls_expire_in, default: 5.minutes
.supported_image_processing_methods (rw) Also known as: #supported_image_processing_methods
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 67
mattr_accessor :supported_image_processing_methods, default: [ "adaptive_blur", "adaptive_resize", "adaptive_sharpen", "adjoin", "affine", "alpha", "annotate", "antialias", "append", "attenuate", "authenticate", "auto_gamma", "auto_level", "auto_orient", "auto_threshold", "backdrop", "background", "bench", "bias", "bilateral_blur", "black_point_compensation", "black_threshold", "blend", "blue_primary", "blue_shift", "blur", "border", "bordercolor", "borderwidth", "brightness_contrast", "cache", "canny", "caption", "channel", "channel_fx", "charcoal", "chop", "clahe", "clamp", "clip", "clip_path", "clone", "clut", "coalesce", "colorize", "colormap", "color_matrix", "colors", "colorspace", "colourspace", "color_threshold", "combine", "combine_options", "comment", "compare", "complex", "compose", "composite", "compress", "connected_components", "contrast", "contrast_stretch", "convert", "convolve", "copy", "crop", "cycle", "deconstruct", "define", "delay", "delete", "density", "depth", "descend", "deskew", "despeckle", "direction", "displace", "dispose", "dissimilarity_threshold", "dissolve", "distort", "dither", "draw", "duplicate", "edge", "emboss", "encoding", "endian", "enhance", "equalize", "evaluate", "evaluate_sequence", "extent", "extract", "family", "features", "fft", "fill", "filter", "flatten", "flip", "floodfill", "flop", "font", "foreground", "format", "frame", "function", "fuzz", "fx", "gamma", "gaussian_blur", "geometry", "gravity", "grayscale", "green_primary", "hald_clut", "highlight_color", "hough_lines", "iconGeometry", "iconic", "identify", "ift", "illuminant", "immutable", "implode", "insert", "intensity", "intent", "interlace", "interline_spacing", "interpolate", "interpolative_resize", "interword_spacing", "kerning", "kmeans", "kuwahara", "label", "lat", "layers", "level", "level_colors", "limit", "limits", "linear_stretch", "linewidth", "liquid_rescale", "list", "log", "loop", "lowlight_color", "magnify", "map", "mattecolor", "median", "mean_shift", "metric", "mode", "modulate", "moments", "monitor", "monochrome", "morph", "morphology", "mosaic", "motion_blur", "name", "negate", "noise", "normalize", "opaque", "ordered_dither", "orient", "page", "paint", "pause", "perceptible", "ping", "pointsize", "polaroid", "poly", "posterize", "precision", "preview", "process", "quality", "quantize", "quiet", "radial_blur", "raise", "random_threshold", "range_threshold", "red_primary", "regard_warnings", "region", "remote", "render", "repage", "resample", "resize", "resize_to_fill", "resize_to_fit", "resize_to_limit", "resize_and_pad", "respect_parentheses", "reverse", "roll", "rotate", "sample", "sampling_factor", "scale", "scene", "screen", "seed", "segment", "selective_blur", "separate", "sepia_tone", "shade", "shadow", "shared_memory", "sharpen", "shave", "shear", "sigmoidal_contrast", "silent", "similarity_threshold", "size", "sketch", "smush", "snaps", "solarize", "sort_pixels", "sparse_color", "splice", "spread", "statistic", "stegano", "stereo", "storage_type", "stretch", "strip", "stroke", "strokewidth", "style", "subimage_search", "swap", "swirl", "synchronize", "taint", "text_font", "threshold", "thumbnail", "tile_offset", "tint", "title", "transform", "transparent", "transparent_color", "transpose", "transverse", "treedepth", "trim", "type", "undercolor", "unique_colors", "units", "unsharp", "update", "valid_image", "view", "vignette", "virtual_pixel", "visual", "watermark", "wave", "wavelet_denoise", "weight", "white_balance", "white_point", "white_threshold", "window", "window_group" ]
.touch_attachment_records (rw) Also known as: #touch_attachment_records
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 356
mattr_accessor :, default: true
.track_variants (rw) Also known as: #track_variants
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 363
mattr_accessor :track_variants, default: false
.unsupported_image_processing_arguments (rw) Also known as: #unsupported_image_processing_arguments
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 353
mattr_accessor :unsupported_image_processing_arguments
.urls_expire_in (rw) Also known as: #urls_expire_in
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 357
mattr_accessor :urls_expire_in
.variable_content_types (rw) Also known as: #variable_content_types
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 61
mattr_accessor :variable_content_types, default: []
.variant_processor (rw) Also known as: #variant_processor
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 50
mattr_accessor :variant_processor, default: :mini_magick
.variant_transformer (rw) Also known as: #variant_transformer
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 52
mattr_accessor :variant_transformer
.verifier (rw) Also known as: #verifier
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 49
mattr_accessor :verifier
.video_preview_arguments (rw) Also known as: #video_preview_arguments
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 365
mattr_accessor :video_preview_arguments, default: "-y -vframes 1 -f image2"
.web_image_content_types (rw) Also known as: #web_image_content_types
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 62
mattr_accessor :web_image_content_types, default: []
Class Method Details
.deprecator
# File 'activestorage/lib/active_storage/deprecator.rb', line 4
def self.deprecator # :nodoc: @deprecator ||= ActiveSupport::Deprecation.new end
.gem_version
Returns the currently loaded version of Active Storage as a Gem::Version.
.version
Returns the currently loaded version of Active Storage as a Gem::Version.
# File 'activestorage/lib/active_storage/version.rb', line 7
def self.version gem_version end
Instance Attribute Details
#analyzers (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 57
mattr_accessor :analyzers, default: []
#binary_content_type (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 63
mattr_accessor :binary_content_type, default: "application/octet-stream"
#content_types_allowed_inline (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 65
mattr_accessor :content_types_allowed_inline, default: []
#content_types_to_serve_as_binary (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 64
mattr_accessor :content_types_to_serve_as_binary, default: []
#draw_routes (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 360
mattr_accessor :draw_routes, default: true
#logger (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 48
mattr_accessor :logger
#paths (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 59
mattr_accessor :paths, default: {}
#previewers (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 56
mattr_accessor :previewers, default: []
#queues (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 54
mattr_accessor :queues, default: {}
#resolve_model_to_route (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 361
mattr_accessor :resolve_model_to_route, default: :rails_storage_redirect
#routes_prefix (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 359
mattr_accessor :routes_prefix, default: "/rails/active_storage"
#service_urls_expire_in (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 355
mattr_accessor :service_urls_expire_in, default: 5.minutes
#supported_image_processing_methods (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 67
mattr_accessor :supported_image_processing_methods, default: [ "adaptive_blur", "adaptive_resize", "adaptive_sharpen", "adjoin", "affine", "alpha", "annotate", "antialias", "append", "attenuate", "authenticate", "auto_gamma", "auto_level", "auto_orient", "auto_threshold", "backdrop", "background", "bench", "bias", "bilateral_blur", "black_point_compensation", "black_threshold", "blend", "blue_primary", "blue_shift", "blur", "border", "bordercolor", "borderwidth", "brightness_contrast", "cache", "canny", "caption", "channel", "channel_fx", "charcoal", "chop", "clahe", "clamp", "clip", "clip_path", "clone", "clut", "coalesce", "colorize", "colormap", "color_matrix", "colors", "colorspace", "colourspace", "color_threshold", "combine", "combine_options", "comment", "compare", "complex", "compose", "composite", "compress", "connected_components", "contrast", "contrast_stretch", "convert", "convolve", "copy", "crop", "cycle", "deconstruct", "define", "delay", "delete", "density", "depth", "descend", "deskew", "despeckle", "direction", "displace", "dispose", "dissimilarity_threshold", "dissolve", "distort", "dither", "draw", "duplicate", "edge", "emboss", "encoding", "endian", "enhance", "equalize", "evaluate", "evaluate_sequence", "extent", "extract", "family", "features", "fft", "fill", "filter", "flatten", "flip", "floodfill", "flop", "font", "foreground", "format", "frame", "function", "fuzz", "fx", "gamma", "gaussian_blur", "geometry", "gravity", "grayscale", "green_primary", "hald_clut", "highlight_color", "hough_lines", "iconGeometry", "iconic", "identify", "ift", "illuminant", "immutable", "implode", "insert", "intensity", "intent", "interlace", "interline_spacing", "interpolate", "interpolative_resize", "interword_spacing", "kerning", "kmeans", "kuwahara", "label", "lat", "layers", "level", "level_colors", "limit", "limits", "linear_stretch", "linewidth", "liquid_rescale", "list", "log", "loop", "lowlight_color", "magnify", "map", "mattecolor", "median", "mean_shift", "metric", "mode", "modulate", "moments", "monitor", "monochrome", "morph", "morphology", "mosaic", "motion_blur", "name", "negate", "noise", "normalize", "opaque", "ordered_dither", "orient", "page", "paint", "pause", "perceptible", "ping", "pointsize", "polaroid", "poly", "posterize", "precision", "preview", "process", "quality", "quantize", "quiet", "radial_blur", "raise", "random_threshold", "range_threshold", "red_primary", "regard_warnings", "region", "remote", "render", "repage", "resample", "resize", "resize_to_fill", "resize_to_fit", "resize_to_limit", "resize_and_pad", "respect_parentheses", "reverse", "roll", "rotate", "sample", "sampling_factor", "scale", "scene", "screen", "seed", "segment", "selective_blur", "separate", "sepia_tone", "shade", "shadow", "shared_memory", "sharpen", "shave", "shear", "sigmoidal_contrast", "silent", "similarity_threshold", "size", "sketch", "smush", "snaps", "solarize", "sort_pixels", "sparse_color", "splice", "spread", "statistic", "stegano", "stereo", "storage_type", "stretch", "strip", "stroke", "strokewidth", "style", "subimage_search", "swap", "swirl", "synchronize", "taint", "text_font", "threshold", "thumbnail", "tile_offset", "tint", "title", "transform", "transparent", "transparent_color", "transpose", "transverse", "treedepth", "trim", "type", "undercolor", "unique_colors", "units", "unsharp", "update", "valid_image", "view", "vignette", "virtual_pixel", "visual", "watermark", "wave", "wavelet_denoise", "weight", "white_balance", "white_point", "white_threshold", "window", "window_group" ]
#touch_attachment_records (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 356
mattr_accessor :, default: true
#track_variants (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 363
mattr_accessor :track_variants, default: false
#unsupported_image_processing_arguments (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 353
mattr_accessor :unsupported_image_processing_arguments
#urls_expire_in (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 357
mattr_accessor :urls_expire_in
#variable_content_types (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 61
mattr_accessor :variable_content_types, default: []
#variant_processor (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 50
mattr_accessor :variant_processor, default: :mini_magick
#variant_transformer (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 52
mattr_accessor :variant_transformer
#verifier (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 49
mattr_accessor :verifier
#video_preview_arguments (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 365
mattr_accessor :video_preview_arguments, default: "-y -vframes 1 -f image2"
#web_image_content_types (rw)
[ GitHub ]# File 'activestorage/lib/active_storage.rb', line 62
mattr_accessor :web_image_content_types, default: []