1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Ruby on Rails
Find a file
Jacob Smith 0210ac0b43 Disable variant options when false or nil present
In response to https://github.com/rails/rails/issues/32917

In the current implementation, ActiveStorage passes all options to the underlying processor,
including when a key has a value of false.

For example, passing:

```
avatar.variant(resize: "100x100", monochrome: false, flip: "-90")
```

will return a monochrome image (or an error, pending on ImageMagick configuration) because
it passes `-monochrome false` to the command (but the command line does not allow disabling
flags this way, as usually a user would omit the flag entirely to disable that feature).

This fix only passes those keys forward to the underlying processor if the value responds to
`present?`. In practice, this means that `false` or `nil` will be filtered out before going
to the processor.

One possible use case would be for a user to be able to apply different filters to an avatar.
The code might look something like:

```
  variant_options = {
    monochrome: params[:monochrome],
    resize:     params[:resize]
  }

  avatar.variant(*variant_options)
```

Obviously some sanitization may be beneficial in a real-world scenario, but this type of
configuration object could be used in many other places as well.

- Add removing falsy values from varaints to changelog

- The entirety of #image_processing_transformation inject block was wrapped in `list.tap`
 to guard against the default `nil` being returned if no conditional was called.

- add test for explicitly true variant options
2018-05-21 10:38:15 -04:00
.github Navigate edgeguide from .github template [ci skip] 2018-04-20 00:40:04 +09:00
actioncable assert_called_with 2018-04-26 08:02:08 +02:00
actionmailer Strip duplicated suffixes more strictly 2018-04-22 14:30:07 +09:00
actionpack Fix documentation for ActionController::Params#fetch 2018-05-18 10:03:42 +02:00
actionview Fix CustomCops/AssertNot to allow it to have failure message 2018-05-13 11:32:47 +09:00
activejob Pass the error instance as the second parameter of block executed by discard_on 2018-05-12 13:55:25 +09:00
activemodel Fix user_input_in_time_zone to coerce non valid string into nil 2018-05-16 17:01:07 -04:00
activerecord Rollback correctly restore initial record id after double save 2018-05-19 10:40:27 +09:00
activestorage Disable variant options when false or nil present 2018-05-21 10:38:15 -04:00
activesupport Raise a better exception when a invalid depreation behavior is set 2018-05-18 13:35:09 -04:00
ci Fix CustomCops/AssertNot to allow it to have failure message 2018-05-13 11:32:47 +09:00
guides Fix markdown [ci skip] 2018-05-17 18:19:18 -04:00
railties Add test case that configure config.action_view.finalize_compiled_template_methods 2018-05-20 10:19:12 +09:00
tasks prefer File.write for bulk writes 2018-05-05 19:38:38 +02:00
tools Use frozen string literal in tools/ 2017-08-13 22:04:59 +09:00
.codeclimate.yml Rubocop 0.54 2018-04-21 13:18:50 -04:00
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore Clean up and consolidate .gitignores 2018-02-17 14:26:19 -08:00
.rubocop.yml Rubocop 0.54 2018-04-21 13:18:50 -04:00
.travis.yml Bump tested versions of Ruby on CI 2018-03-31 12:25:09 +01:00
.yardopts Let YARD document the railties gem 2010-09-09 18:24:34 -07:00
Brewfile Use frozen string literal 2018-04-11 17:10:15 +09:00
CODE_OF_CONDUCT.md Update CoC to change a history of updates URL [ci skip] 2018-04-19 23:33:53 +09:00
CONTRIBUTING.md Remove html tag making markdown misrender [ci skip] 2017-06-05 22:11:57 -05:00
Gemfile Support streaming downloads from Google Cloud Storage 2018-05-01 23:20:56 -04:00
Gemfile.lock Support streaming downloads from Google Cloud Storage 2018-05-01 23:20:56 -04:00
MIT-LICENSE Bump license years for 2018 2017-12-31 22:36:55 +09:00
rails.gemspec Rails 6 requires Ruby 2.4.1+ 2018-02-17 15:34:57 -08:00
RAILS_VERSION Start Rails 6.0 development!!! 2018-01-30 18:51:17 -05:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09:00
README.md [ci skip] Remove style of the word Rails at the top 2018-04-19 11:53:44 -05:00
RELEASING_RAILS.md Use https with weblog URI 2018-05-02 21:06:03 +09:00
version.rb Start Rails 6.0 development!!! 2018-01-30 18:51:17 -05:00

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.

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.

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.

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; Active Job, a framework for declaring jobs and making them run on a variety of queueing backends; Action Cable, a framework to integrate WebSockets with a Rails application; Active Storage, a library to attach cloud and local files to Rails applications; and 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

  1. Install Rails at the command prompt if you haven't yet:

     $ gem install rails
    
  2. At the command prompt, create a new Rails application:

     $ rails new myapp
    

    where "myapp" is the application name.

  3. Change directory to myapp and start the web server:

     $ cd myapp
     $ rails server
    

    Run with --help or -h for options.

  4. Go to http://localhost:3000 and you'll see: "Yay! Youre on Rails!"

  5. Follow the guidelines to start developing your application. You may find the following resources handy:

Contributing

Code Triage Badge

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.

Code Status

Build Status

License

Ruby on Rails is released under the MIT License.