Go to file
Jean Boussier 8e0f88d558 Optimize humanize inflector
There a mixed bag of small optimizations here:

  - Since underscores are converted to spaces and that we remove all leading underscores. By changing the order of operations we can leverage the faster `.lstrip!`.
  - Corrected the gsub regexp to no longer match empty strings (`+` vs `*`).
  - Modify the matched strings in place to save on allocations

```ruby
require 'benchmark/ips'
require 'active_support/all'

module ActiveSupport
  module Inflector
    def humanize2(lower_case_and_underscored_word, capitalize: true, keep_id_suffix: false)
      result = lower_case_and_underscored_word.to_s.dup

      inflections.humans.each { |(rule, replacement)| break if result.sub!(rule, replacement) }

      result.tr!("_", " ")
      result.lstrip!
      unless keep_id_suffix
        result.delete_suffix!(" id")
      end

      result.gsub!(/([a-z\d]+)/i) do |match|
        match.downcase!
        inflections.acronyms[match] || match
      end

      if capitalize
        result.sub!(/\A\w/) do |match|
          match.upcase!
          match
        end
      end

      result
    end
  end
end

%w(foo foo_bar_id ____foo_bar).each do |str|
  puts "== Comparing with #{str.inspect} (#{RUBY_VERSION}) =="
  unless ActiveSupport::Inflector.humanize(str) == ActiveSupport::Inflector.humanize2(str)
    raise "#{ActiveSupport::Inflector.humanize2(str)} != #{ActiveSupport::Inflector.humanize(str)}"
  end

  Benchmark.ips do |x|
    x.report('humanize') { ActiveSupport::Inflector.humanize(str) }
    x.report('humanize2') { ActiveSupport::Inflector.humanize2(str) }
    x.compare!
  end
  puts
end
```

```
== Comparing with "foo" (2.7.2) ==
Warming up --------------------------------------
            humanize    25.593k i/100ms
           humanize2    29.256k i/100ms
Calculating -------------------------------------
            humanize    263.989k (± 1.9%) i/s -      1.331M in   5.043110s
           humanize2    299.883k (± 2.2%) i/s -      1.521M in   5.075478s

Comparison:
           humanize2:   299882.5 i/s
            humanize:   263989.1 i/s - 1.14x  (± 0.00) slower

== Comparing with "foo_bar_id" (2.7.2) ==
Warming up --------------------------------------
            humanize    18.187k i/100ms
           humanize2    25.678k i/100ms
Calculating -------------------------------------
            humanize    183.702k (± 1.5%) i/s -    927.537k in   5.050326s
           humanize2    250.470k (± 2.5%) i/s -      1.258M in   5.026682s

Comparison:
           humanize2:   250469.6 i/s
            humanize:   183702.3 i/s - 1.36x  (± 0.00) slower

== Comparing with "____foo_bar" (2.7.2) ==
Warming up --------------------------------------
            humanize    18.577k i/100ms
           humanize2    24.686k i/100ms
Calculating -------------------------------------
            humanize    188.868k (± 1.5%) i/s -    947.427k in   5.017524s
           humanize2    255.650k (± 1.8%) i/s -      1.284M in   5.022833s

Comparison:
           humanize2:   255649.8 i/s
```
2021-02-02 12:16:16 +01:00
.github Rename master to main in all code references 2021-01-19 20:46:33 +00:00
actioncable Update ActionCable docs [ci skip] 2021-01-08 19:08:55 +09:00
actionmailbox Upload raw email before creating pending ActionMailbox::InboundEmail 2021-01-04 09:28:09 -05:00
actionmailer Rename master to main in all code references 2021-01-19 20:46:33 +00:00
actionpack Fix exception in raw_params method 2021-02-01 16:22:42 +09:00
actiontext Improve ActionText::FixtureSet documentation (#41062) 2021-01-24 11:16:27 +01:00
actionview Fix CI failure due to app.config.action_view.delete(:apply_apply_stylesheet_media_default) 2021-01-27 10:40:54 +09:00
activejob Merge remote-tracking branch 'origin/main' into skip-logging-rescuable-exceptions 2021-02-02 01:09:06 +00:00
activemodel Merge pull request #41166 from kamipo/raise_unknown_type_error_on_definition_time 2021-01-20 18:24:40 +09:00
activerecord attribute should not require a connection is established 2021-02-02 15:04:23 +09:00
activestorage Merge branch 'main' into active_storage-named-variants 2021-01-29 03:25:37 +01:00
activesupport Optimize humanize inflector 2021-02-02 12:16:16 +01:00
ci Remove .travis.yml and ci/travis.rb 2020-01-02 09:27:53 +09:00
guides Merge branch 'main' into active_storage-named-variants 2021-01-29 03:25:37 +01:00
railties Stop setting RAILS_ENV when test_unit railtie is loaded 2021-02-01 16:00:05 -05:00
tasks Fix release task 2019-11-27 12:24:31 -03:00
tools Fix bin/test 2020-10-30 21:33:19 +00:00
.gitattributes adds .gitattributes to enable Ruby-awareness 2016-03-16 11:15:22 +01:00
.gitignore Gitignore Brewfile.lock.json 2020-12-07 14:58:17 +01:00
.rubocop.yml Disable rubocop suggestions 2021-01-27 00:28:55 +00:00
.yardopts Updating .yardopts to document .rb files in [GEM]/app 2019-08-20 13:25:36 -04:00
.yarnrc Make Webpacker the default JavaScript compiler for Rails 6 (#33079) 2018-09-30 22:31:21 -07:00
Brewfile Address Error: caskroom/cask was moved. Tap homebrew/cask-cask instead. 2019-12-18 18:50:57 +09:00
CODE_OF_CONDUCT.md Updated links from http to https in guides, docs, etc 2019-03-09 16:43:47 +05:30
CONTRIBUTING.md Adding badges and logo to README and CONTRIBUTING page 2021-01-20 10:53:47 +01:00
Gemfile Avoid nokogiri v1.11.0 to make our CI green 2021-01-05 21:59:37 +09:00
Gemfile.lock Upgrade all the gems to make sure we are testing with the latest versions locally 2021-01-21 21:22:41 +00:00
MIT-LICENSE Bump license years to 2021 [ci skip] 2021-01-01 12:21:20 +09:00
package.json Install JavaScript packages before run test 2019-02-11 09:58:08 +09:00
RAILS_VERSION Start Rails 6.2 development 🎉 2020-12-03 01:35:29 +00:00
rails.gemspec Update outdated bundler in gemspec 2020-08-18 00:39:54 +08:00
Rakefile Use frozen string literal in root files 2017-08-13 22:14:24 +09:00
README.md Adding badges and logo to README and CONTRIBUTING page 2021-01-20 10:53:47 +01:00
RELEASING_RAILS.md Rename master to main in all code references 2021-01-19 20:46:33 +00:00
version.rb Start Rails 6.2 development 🎉 2020-12-03 01:35:29 +00:00
yarn.lock Upgrade kind-of 2020-04-19 23:59:27 -03: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; Action Mailbox, a library to receive emails within a Rails application; 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 Rails application; Active Storage, a library to attach cloud and local files to Rails applications; Action Text, a library to handle rich text content; 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
     $ bin/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

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.