CHANGELOG.md 22.5 KB
Newer Older
1
## Rails 4.0.0 (unreleased) ##
J
José Valim 已提交
2

3 4 5 6 7 8 9 10 11 12 13
*   `ActionController::Base.page_cache_extension` option is deprecated
    in favour of `ActionController::Base.default_static_extension`.

    *Francesco Rodriguez*

*   Action and Page caching has been extracted from Action Dispatch
    as `actionpack-action_caching` and `actionpack-page_caching` gems.
    Please read the `README.md` file on both gems for the usage.

    *Francesco Rodriguez*

14 15
*   Failsafe exception returns text/plain. *Steve Klabnik*

16 17 18 19 20
*   Remove actionpack's rack-cache dependency and declare the
    dependency in the Gemfile.

    *Guillermo Iguarán*

21 22 23 24 25 26
*   Rename internal variables on ActionController::TemplateAssertions to prevent
    naming collisions. @partials, @templates and @layouts are now prefixed with an underscore.
    Fix #7459

    *Yves Senn*

27 28 29 30 31
*   `resource` and `resources` don't modify the passed options hash
    Fix #7777

    *Yves Senn*

32 33 34 35 36 37 38 39 40 41 42 43 44 45
*   Precompiled assets include aliases from foo.js to foo/index.js and vice versa.

        # Precompiles phone-<digest>.css and aliases phone/index.css to phone.css.
        config.assets.precompile = [ 'phone.css' ]

        # Precompiles phone/index-<digest>.css and aliases phone.css to phone/index.css.
        config.assets.precompile = [ 'phone/index.css' ]

        # Both of these work with either precompile thanks to their aliases.
        <%= stylesheet_link_tag 'phone', media: 'all' %>
        <%= stylesheet_link_tag 'phone/index', media: 'all' %>

    *Jeremy Kemper*

46 47
*   `assert_template` is no more passing with what ever string that matches
    with the template name.
48

49 50 51
    Before when we have a template `/layout/hello.html.erb`, `assert_template`
    was passing with any string that matches. This behavior allowed false
    positive like:
52

53 54
        assert_template "layout"
        assert_template "out/hello"
55

56
    Now it only passes with:
57

58 59 60 61
        assert_template "layout/hello"
        assert_template "hello"

    Fixes #3849.
62

63
    *Hugolnx*
64

65 66 67 68 69
*   `image_tag` will set the same width and height for image if numerical value
    passed to `size` option.

    *Nihad Abbasov*

70 71 72 73 74
*   Deprecate Mime::Type#verify_request? and Mime::Type.browser_generated_types,
    since they are no longer used inside of Rails, they will be removed in Rails 4.1

    *Michael Grosser*

75 76
*   `ActionDispatch::Http::UploadedFile` now delegates `close` to its tempfile. *Sergio Gil*

77
*   Add `ActionController::StrongParameters`, this module converts `params` hash into
78
    an instance of ActionController::Parameters that allows whitelisting of permitted
79
    parameters. Non-permitted parameters are forbidden to be used in Active Model by default
80
    For more details check the documentation of the module or the
81 82 83 84 85
    [strong_parameters gem](https://github.com/rails/strong_parameters)

    *DHH + Guillermo Iguaran*

*   Remove Integration between `attr_accessible`/`attr_protected` and
86
    `ActionController::ParamsWrapper`. ParamWrapper now wraps all the parameters returned
87 88 89 90
    by the class method attribute_names

    *Guillermo Iguaran*

91 92 93 94
*   Fix #7646, the log now displays the correct status code when an exception is raised.

    *Yves Senn*

95 96 97
*   Allow pass couple extensions to `ActionView::Template.register_template_handler` call.

    *Tima Maslyuchenko*
98

99 100 101 102 103 104 105
*   Fixed a bug with shorthand routes scoped with the `:module` option not
    adding the module to the controller as described in issue #6497.
    This should now work properly:

        scope :module => "engine" do
          get "api/version" # routes to engine/api#version
        end
106

107 108
    *Luiz Felipe Garcia Pereira*

109 110
*   Sprockets integration has been extracted from Action Pack to the `sprockets-rails`
    gem. `rails` gem is depending on `sprockets-rails` by default.
111 112 113

    *Guillermo Iguaran*

114 115 116 117
*   `ActionDispatch::Session::MemCacheStore` now uses `dalli` instead of the deprecated
    `memcache-client` gem. As side effect the autoloading of unloaded classes objects
    saved as values in session isn't supported anymore when mem_cache session store is
    used, this can have an impact in apps only when config.cache_classes is false.
118 119 120

    *Arun Agrawal + Guillermo Iguaran*

121 122
*   Support multiple etags in If-None-Match header. *Travis Warlick*

S
Sergey Nartimov 已提交
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
*   Allow to configure how unverified request will be handled using `:with`
    option in `protect_from_forgery` method.

    Valid unverified request handling methods are:

    - `:exception` - Raises ActionController::InvalidAuthenticityToken exception.
    - `:reset_session` - Resets the session.
    - `:null_session` - Provides an empty session during request but doesn't
      reset it completely. Used as default if `:with` option is not specified.

    New applications are generated with:

        protect_from_forgery :with => :exception

    *Sergey Nartimov*

139
*   Add .ruby template handler, this handler simply allows arbitrary Ruby code as a template. *Guillermo Iguaran*
G
Guillermo Iguaran 已提交
140

141 142 143 144 145 146
*   Add `separator` option for `ActionView::Helpers::TextHelper#excerpt`:

        excerpt('This is a very beautiful morning', 'very', :separator  => ' ', :radius => 1)
        # => ...a very beautiful...

    *Guirec Corbel*
147

148 149
*   Added controller-level etag additions that will be part of the action etag computation *Jeremy Kemper/DHH*

150 151 152 153 154 155 156 157
        class InvoicesController < ApplicationController
          etag { current_user.try :id }

          def show
            # Etag will differ even for the same invoice when it's viewed by a different current_user
            @invoice = Invoice.find(params[:id])
            fresh_when(@invoice)
          end
158 159
        end

160
*   Add automatic template digests to all `CacheHelper#cache` calls (originally spiked in the cache_digests plugin) *DHH*
161

162 163 164 165 166
*   When building a URL fails, add missing keys provided by Journey. Failed URL
    generation now returns a 500 status instead of a 404.

    *Richard Schneeman*

167
*   Deprecate availbility of `ActionView::RecordIdentifier` in controllers by default.
168
    It's view specific and can be easily included in controller manually if someone
169 170
    really needs it. RecordIdentifier will be removed from `ActionController::Base`
    in Rails 4.1. *Piotr Sarnacki*
171

172
*   Fix `ActionView::RecordIdentifier` to work as a singleton. *Piotr Sarnacki*
173

174
*   Deprecate `Template#mime_type`, it will be removed in Rails 4.1 in favor of `#type`.
175 176
    *Piotr Sarnacki*

177
*   Move vendored html-scanner from `action_controller` to `action_view` directory. If you
178
    require it directly, please use 'action_view/vendor/html-scanner', reference to
179
    'action_controller/vendor/html-scanner' will be removed in Rails 4.1. *Piot Sarnacki*
180

181 182 183 184 185
*   Fix handling of date selects when using both disabled and discard options.
    Fixes #7431.

    *Vasiliy Ermolovich*

186 187 188 189
*   `ActiveRecord::SessionStore` is extracted out of Rails into a gem `activerecord-session_store`.
    Setting `config.session_store` to `:active_record_store` will no longer work and will break
    if the `activerecord-session_store` gem isn't available. *Prem Sichanugrist*

190
*   Fix `select_tag` when `option_tags` is nil.
191 192 193 194
    Fixes #7404.

    *Sandeep Ravichandran*

195
*   Add `Request#formats=(extensions)` that lets you set multiple formats directly in a prioritized order.
196 197 198

    Example of using this for custom iphone views with an HTML fallback:

199 200 201 202 203 204 205 206
        class ApplicationController < ActionController::Base
          before_filter :adjust_format_for_iphone_with_html_fallback

          private
            def adjust_format_for_iphone_with_html_fallback
              request.formats = [ :iphone, :html ] if request.env["HTTP_USER_AGENT"][/iPhone/]
            end
        end
207

208
    *DHH*
209

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
*   Add Routing Concerns to declare common routes that can be reused inside
    others resources and routes.

    Code before:

        resources :messages do
          resources :comments
        end

        resources :posts do
          resources :comments
          resources :images, only: :index
        end

    Code after:

        concern :commentable do
          resources :comments
        end

        concern :image_attachable do
          resources :images, only: :index
        end

        resources :messages, concerns: :commentable

        resources :posts, concerns: [:commentable, :image_attachable]

238
    *DHH + Rafael Mendonça França*
239

240
*   Add `start_hour` and `end_hour` options to the `select_hour` helper. *Evan Tann*
241

242
*   Raises an `ArgumentError` when the first argument in `form_for` contain `nil`
243 244 245 246
    or is empty.

    *Richard Schneeman*

247 248 249
*   Add 'X-Frame-Options' => 'SAMEORIGIN'
    'X-XSS-Protection' => '1; mode=block' and
    'X-Content-Type-Options' => 'nosniff'
250 251 252 253
    as default headers.

    *Egor Homakov*

254 255
*   Allow data attributes to be set as a first-level option for form_for, so you can write `form_for @record, data: { behavior: 'autosave' }` instead of `form_for @record, html: { data: { behavior: 'autosave' } }` *DHH*

256 257 258 259
*   Deprecate `button_to_function` and `link_to_function` helpers.

    We recommend the use of Unobtrusive JavaScript instead. For example:

260
        link_to "Greeting", "#", :class => "nav_link"
261

262 263 264
        $(function() {
          $('.nav_link').click(function() {
            // Some complex code
265

266 267
            return false;
          });
268 269 270 271
        });

    or

272
        link_to "Greeting", '#', onclick: "alert('Hello world!'); return false", class: "nav_link"
273 274 275 276 277

    for simple cases.

    *Rafael Mendonça França*

278 279
*   `javascript_include_tag :all` will now not include `application.js` if the file does not exists. *Prem Sichanugrist*

280 281 282 283
*   Send an empty response body when call `head` with status between 100 and 199, 204, 205 or 304.

    *Armand du Plessis*

284
*   Fixed issue with where digest authentication would not work behind a proxy. *Arthur Smith*
285

286
*   Added `ActionController::Live`.  Mix it in to your controller and you can
A
Aaron Patterson 已提交
287 288
    stream data to the client live.  For example:

289 290
        class FooController < ActionController::Base
          include ActionController::Live
A
Aaron Patterson 已提交
291

292 293 294 295 296 297 298 299
          def index
            100.times {
              # Client will see this as it's written
              response.stream.write "hello world\n"
              sleep 1
            }
            response.stream.close
          end
A
Aaron Patterson 已提交
300 301
        end

302 303 304
    *Aaron Patterson*

*   Remove `ActionDispatch::Head` middleware in favor of `Rack::Head`. *Santiago Pastorino*
S
Santiago Pastorino 已提交
305

306
*   Deprecate `:confirm` in favor of `:data => { :confirm => "Text" }` option for `button_to`, `button_tag`, `image_submit_tag`, `link_to` and `submit_tag` helpers.
307

308
    *Carlos Galdino + Rafael Mendonça França*
309

310
*   Show routes in exception page while debugging a `RoutingError` in development. *Richard Schneeman and Mattt Thompson*
311

K
kennyj 已提交
312 313 314 315 316 317
*   Add `ActionController::Flash.add_flash_types` method to allow people to register their own flash types. e.g.:

        class ApplicationController
          add_flash_types :error, :warning
        end

318
    If you add the above code, you can use `<%= error %>` in an erb, and `redirect_to /foo, :error => 'message'` in a controller.
K
kennyj 已提交
319 320 321

    *kennyj*

322 323
*   Remove Active Model dependency from Action Pack. *Guillermo Iguaran*

324 325 326 327 328 329 330 331 332 333
*   Support unicode characters in routes. Route will be automatically escaped, so instead of manually escaping:

        get Rack::Utils.escape('こんにちは') => 'home#index'

    You just have to write the unicode route:

        get 'こんにちは' => 'home#index'

    *kennyj*

334 335
*   Return proper format on exceptions. *Santiago Pastorino*

336
*   Allow to use `mounted_helpers` (helpers for accessing mounted engines) in `ActionView::TestCase`. *Piotr Sarnacki*
337

338
*   Include `mounted_helpers` (helpers for accessing mounted engines) in `ActionDispatch::IntegrationTest` by default. *Piotr Sarnacki*
339

340 341 342 343
*   Extracted redirect logic from `ActionController::ForceSSL::ClassMethods.force_ssl`  into `ActionController::ForceSSL#force_ssl_redirect`

    *Jeremy Friesen*

344
*   Make possible to use a block in `button_to` if the button text is hard
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
    to fit into the name parameter, e.g.:

        <%= button_to [:make_happy, @user] do %>
          Make happy <strong><%= @user.name %></strong>
        <% end %>
        # => "<form method="post" action="/users/1/make_happy" class="button_to">
        #      <div>
        #        <button type="submit">
        #          Make happy <strong>Name</strong>
        #        </button>
        #      </div>
        #    </form>"

    *Sergey Nartimov*

360 361 362 363 364 365 366 367 368 369 370
*   change a way of ordering helpers from several directories. Previously,
    when loading helpers from multiple paths, all of the helpers files were
    gathered into one array an then they were sorted. Helpers from different
    directories should not be mixed before loading them to make loading more
    predictable. The most common use case for such behavior is loading helpers
    from engines. When you load helpers from application and engine Foo, in
    that order, first rails will load all of the helpers from application,
    sorted alphabetically and then it will do the same for Foo engine.

    *Piotr Sarnacki*

371
*   `truncate` now always returns an escaped HTML-safe string. The option `:escape` can be used as
372 373 374 375
    false to not escape the result.

    *Li Ellis Gallardo + Rafael Mendonça França*

376 377
*   `truncate` now accepts a block to show extra content when the text is truncated. *Li Ellis Gallardo*

C
Carlos Galdino 已提交
378 379 380
*   Add `week_field`, `week_field_tag`, `month_field`, `month_field_tag`, `datetime_local_field`,
    `datetime_local_field_tag`, `datetime_field` and `datetime_field_tag` helpers. *Carlos Galdino*

381 382
*   Add `color_field` and `color_field_tag` helpers. *Carlos Galdino*

383 384 385
*   `assert_generates`, `assert_recognizes`, and `assert_routing` all raise
    `Assertion` instead of `RoutingError` *David Chelimsky*

386 387
*   URL path parameters with invalid encoding now raise ActionController::BadRequest. *Andrew White*

388 389
*   Malformed query and request parameter hashes now raise ActionController::BadRequest. *Andrew White*

390 391 392 393
*   Add `divider` option to `grouped_options_for_select` to generate a separator
    `optgroup` automatically, and deprecate `prompt` as third argument, in favor
    of using an options hash. *Nicholas Greenfield*

394 395
*   Add `time_field` and `time_field_tag` helpers which render an `input[type="time"]` tag. *Alex Soulim*

396 397
*   Removed old text_helper apis for highlight, excerpt and word_wrap *Jeremy Walker*

J
José Valim 已提交
398 399 400
*   Templates without a handler extension now raises a deprecation warning but still
    defaults to ERb. In future releases, it will simply return the template contents. *Steve Klabnik*

401
*   Deprecate `:disable_with` in favor of `:data => { :disable_with => "Text" }` option from `submit_tag`, `button_tag` and `button_to` helpers.
402 403 404

    *Carlos Galdino + Rafael Mendonça França*

405 406 407
*   Remove `:mouseover` option from `image_tag` helper. *Rafael Mendonça França*

*   The `select` method (select tag) forces :include_blank  if `required` is true and
408 409
    `display size` is one and `multiple` is not true. *Angelo Capilleri*

410 411 412 413 414
*   Copy literal route constraints to defaults so that url generation know about them.
    The copied constraints are `:protocol`, `:subdomain`, `:domain`, `:host` and `:port`.

    *Andrew White*

J
José Valim 已提交
415 416 417 418
*   `respond_to` and `respond_with` now raise ActionController::UnknownFormat instead
    of directly returning head 406. The exception is rescued and converted to 406
    in the exception handling middleware. *Steven Soroka*

419 420
*   Allows `assert_redirected_to` to match against a regular expression. *Andy Lindeman*

S
Santiago Pastorino 已提交
421 422
*   Add backtrace to development routing error page. *Richard Schneeman*

423 424 425
*   Replace `include_seconds` boolean argument with `:include_seconds => true` option
    in `distance_of_time_in_words` and `time_ago_in_words` signature. *Dmitriy Kiriyenko*

426 427 428
*   Make current object and counter (when it applies) variables accessible when
    rendering templates with :object / :collection. *Carlos Antonio da Silva*

J
Jo Liss 已提交
429
*   JSONP now uses mimetype text/javascript instead of application/json. *omjokine*
430

431 432
*   Allow to lazy load `default_form_builder` by passing a `String` instead of a constant. *Piotr Sarnacki*

433 434 435 436 437 438 439
*   Session arguments passed to `process` calls in functional tests are now merged into
    the existing session, whereas previously they would replace the existing session.
    This change may break some existing tests if they are asserting the exact contents of
    the session but should not break existing tests that only assert individual keys.

    *Andrew White*

440 441
*   Add `index` method to FormBuilder class. *Jorge Bejar*

442 443
*   Remove the leading \n added by textarea on assert_select. *Santiago Pastorino*

444 445 446 447 448
*   Changed default value for `config.action_view.embed_authenticity_token_in_remote_forms`
    to `false`. This change breaks remote forms that need to work also without javascript,
    so if you need such behavior, you can either set it to `true` or explicitly pass
    `:authenticity_token => true` in form options

449 450
*   Added ActionDispatch::SSL middleware that when included force all the requests to be under HTTPS protocol. *Rafael Mendonça França*

451
*   Add `include_hidden` option to select tag. With `:include_hidden => false` select with `multiple` attribute doesn't generate hidden input with blank value. *Vasiliy Ermolovich*
452

453 454 455 456
*   Removed default `size` option from the `text_field`, `search_field`, `telephone_field`, `url_field`, `email_field` helpers. *Philip Arndt*

*   Removed default `cols` and `rows` options from the `text_area` helper. *Philip Arndt*

457
*   Adds support for layouts when rendering a partial with a given collection. *serabe*
458

459
*   Allows the route helper `root` to take a string argument. For example, `root 'pages#main'`. *bcardarella*
460

461
*   Forms of persisted records use always PATCH (via the `_method` hack). *fxn*
462

463
*   For resources, both PATCH and PUT are routed to the `update` action. *fxn*
464

465 466 467 468 469 470 471 472 473 474 475 476
*   Don't ignore `force_ssl` in development. This is a change of behavior - use a `:if` condition to recreate the old behavior.

        class AccountsController < ApplicationController
          force_ssl :if => :ssl_configured?

          def ssl_configured?
            !Rails.env.development?
          end
        end

    *Pat Allan*

477 478 479 480 481 482 483 484 485 486 487
*   Adds support for the PATCH verb:
      * Request objects respond to `patch?`.
      * Routes have a new `patch` method, and understand `:patch` in the
        existing places where a verb is configured, like `:via`.
      * New method `patch` available in functional tests.
      * If `:patch` is the default verb for updates, edits are
        tunneled as PATCH rather than as PUT, and routing acts accordingly.
      * New method `patch_via_redirect` available in integration tests.

    *dlee*

488 489
*   Integration tests support the `OPTIONS` method. *Jeremy Kemper*

490 491 492
*   `expires_in` accepts a `must_revalidate` flag. If true, "must-revalidate"
    is added to the Cache-Control header. *fxn*

493 494
*   Add `date_field` and `date_field_tag` helpers which render an `input[type="date"]` tag *Olek Janiszewski*

495 496 497 498
*   Adds `image_url`, `javascript_url`, `stylesheet_url`, `audio_url`, `video_url`, and `font_url`
    to assets tag helper. These URL helpers will return the full path to your assets. This is useful
    when you are going to reference this asset from external host. *Prem Sichanugrist*

499 500
*   Default responder will now always use your overridden block in `respond_with` to render your response. *Prem Sichanugrist*

501 502 503 504 505 506 507 508 509 510
*   Allow `value_method` and `text_method` arguments from `collection_select` and
    `options_from_collection_for_select` to receive an object that responds to `:call`,
    such as a `proc`, to evaluate the option in the current element context. This works
    the same way with `collection_radio_buttons` and `collection_check_boxes`.

    *Carlos Antonio da Silva + Rafael Mendonça França*

*   Add `collection_check_boxes` form helper, similar to `collection_select`:
    Example:

511 512 513 514 515 516 517
        collection_check_boxes :post, :author_ids, Author.all, :id, :name
        # Outputs something like:
        <input id="post_author_ids_1" name="post[author_ids][]" type="checkbox" value="1" />
        <label for="post_author_ids_1">D. Heinemeier Hansson</label>
        <input id="post_author_ids_2" name="post[author_ids][]" type="checkbox" value="2" />
        <label for="post_author_ids_2">D. Thomas</label>
        <input name="post[author_ids][]" type="hidden" value="" />
518 519 520 521 522 523 524 525

    The label/check_box pairs can be customized with a block.

    *Carlos Antonio da Silva + Rafael Mendonça França*

*   Add `collection_radio_buttons` form helper, similar to `collection_select`:
    Example:

526 527 528 529 530 531
        collection_radio_buttons :post, :author_id, Author.all, :id, :name
        # Outputs something like:
        <input id="post_author_id_1" name="post[author_id]" type="radio" value="1" />
        <label for="post_author_id_1">D. Heinemeier Hansson</label>
        <input id="post_author_id_2" name="post[author_id]" type="radio" value="2" />
        <label for="post_author_id_2">D. Thomas</label>
532 533 534 535 536

    The label/radio_button pairs can be customized with a block.

    *Carlos Antonio da Silva + Rafael Mendonça França*

537 538 539
*   check_box with `:form` html5 attribute will now replicate the `:form`
    attribute to the hidden field as well. *Carlos Antonio da Silva*

540 541 542
*   Turn off verbose mode of rack-cache, we still have X-Rack-Cache to
    check that info. Closes #5245. *Santiago Pastorino*

543 544
*   `label` form helper accepts :for => nil to not generate the attribute. *Carlos Antonio da Silva*

545 546
*   Add `:format` option to number_to_percentage *Rodrigo Flores*

547
*   Add `config.action_view.logger` to configure logger for Action View. *Rafael Mendonça França*
548

549
*   Deprecated `ActionController::Integration` in favour of `ActionDispatch::Integration`.
550

551
*   Deprecated `ActionController::IntegrationTest` in favour of `ActionDispatch::IntegrationTest`.
552

553
*   Deprecated `ActionController::PerformanceTest` in favour of `ActionDispatch::PerformanceTest`.
554

555
*   Deprecated `ActionController::AbstractRequest` in favour of `ActionDispatch::Request`.
556

557
*   Deprecated `ActionController::Request` in favour of `ActionDispatch::Request`.
558

559
*   Deprecated `ActionController::AbstractResponse` in favour of `ActionDispatch::Response`.
560

561
*   Deprecated `ActionController::Response` in favour of `ActionDispatch::Response`.
562

563
*   Deprecated `ActionController::Routing` in favour of `ActionDispatch::Routing`.
564

565 566 567 568
*   `check_box helper` with `:disabled => true` will generate a disabled
    hidden field to conform with the HTML convention where disabled fields are
    not submitted with the form. This is a behavior change, previously the hidden
    tag had a value of the disabled checkbox. *Tadas Tamosauskas*
569

570 571
*   `favicon_link_tag` helper will now use the favicon in app/assets by default. *Lucas Caton*

572 573
*   `ActionView::Helpers::TextHelper#highlight` now defaults to the
    HTML5 `mark` element. *Brian Cardarella*
574

X
Xavier Noria 已提交
575
Please check [3-2-stable](https://github.com/rails/rails/blob/3-2-stable/actionpack/CHANGELOG.md) for previous changes.