If you are the application owner check the logs for more information.
64 |Maybe you tried to change something you didn't have access to.
63 |If you are the application owner check the logs for more information.
65 |You may have mistyped the address or the page may have moved.
63 |If you are the application owner check the logs for more information.
65 |
58 |
59 | Next, I will explain how to solve each step:
60 |
61 | #### Step 1: pick the file.
62 |
63 | Suppose you want to go to the import form from the `AdminUser`'s index page. To do that, you can add an `action_item` with a `collection_action`:
64 |
65 | */your_app/app/admin/admin_users.rb*
66 |
67 | ```ruby
68 | ActiveAdmin.register AdminUser do
69 | # more code...
70 | action_item :import_users, only: :index do
71 | link_to "Import Users", import_form_admin_admin_users_path
72 | end
73 |
74 | collection_action :import_form, title: "Import Users" do
75 | # Nothing here. We just want to render the form.
76 | end
77 | end
78 | ```
79 |
80 | With the related wiew:
81 |
82 | *your_app/app/views/admin/admin_users/import_form.html.erb*
83 |
84 | ```erb
85 | <%= semantic_form_for :data, url: { action: :import }, method: :post do |f| %>
86 | <%= f.inputs "Form" do %>
87 | <%= f.input :source, as: :file, label: "File", :hint => "Excel file with thousands rows that need to be processed in background..." %>
88 | <% end %>
89 | <%= f.actions do %>
90 | <%= f.action :submit, as: :button, label: "Import" %>
91 | <% end %>
92 | <% end %>
93 | ```
94 |
95 | 
96 |
97 | You need to add the endpoint pointed in the form action too.
98 |
99 | */your_app/app/admin/admin_users.rb*
100 |
101 | ```ruby
102 | ActiveAdmin.register AdminUser do
103 | # more code...
104 | collection_action :import, title: "Import Users", method: :post do
105 | # We fill this in the next step.
106 | end
107 | end
108 | ```
109 |
110 | #### Step 2: create a job.
111 |
112 | Inside the import action definition, you need to call the job in charge of parsing the .xls file. To do this:
113 |
114 | First, we need to create the job. We need to do it using `perform_with_feedback` method provided by [Job Notifier](https://github.com/platanus/job_notifier) gem. You can see how it works reading the **Third and Fourth Steps** of the [usage section](https://github.com/platanus/job_notifier#usage).
115 |
116 | */your_app/app/jobs/user_upload_job.rb*
117 |
118 | ```ruby
119 | class UserUploadJob < ActiveJob::Base
120 | def perform_with_feedback(xls_path)
121 | # Here you need to process the file an return a success or error result.
122 | #
123 | # Lets say I'm going to return this message:
124 | #
125 | # "Users successfully loaded"
126 | #
127 | # with a successful result and something like this:
128 | #
129 | # errors = [
130 | # { row: 4, errors: ["Invalid First Name", "Invalid Category"] },
131 | # { row: 6, errors: ["Invalid Last Name"] },
132 | # { row: 84, errors: ["Invalid ID"] }
133 | # ]
134 | #
135 | # raise JobNotifier::Error::Validation.new(errors)
136 | #
137 | # with unsuccessful result.
138 | end
139 | end
140 |
141 | ```
142 |
143 | Then, we call the job in the import action:
144 |
145 | */your_app/app/admin/admin_users.rb*
146 |
147 | ```ruby
148 | ActiveAdmin.register AdminUser do
149 | # more code...
150 | collection_action :import, title: "Import Users", method: :post do
151 | file_path = get_file_path(params[:data][:source]) # I'm not going to implement this. It's just an example.
152 | UserUploadJob.perform_later(current_admin_user.job_identifier, file_path)
153 | end
154 | end
155 | ```
156 |
157 | #### Step 3: notify process completion.
158 |
159 | You don't need to do nothing here, the gem will do it for you using [jQuery Growl](http://ksylvest.github.io/jquery-growl/).
160 |
161 | On success...
162 |
163 | 
164 |
165 | On error...
166 |
167 | 
168 |
169 | #### Step 4: show success and error feedback.
170 |
171 | The gem includes an index view for jobs. There, you can see a jobs list with the current state of each job.
172 |
173 | 
174 |
175 | To show feedback, you need to add one partial by possible job state prefixed by the job's class name in snake_case. For example:
176 | If you have the `UserUploadJob` job, following the convention: `_[job_class_name].[job_state].html.erb`, you will need two partials:
177 |
178 | One for success...
179 |
180 | */your_app/app/views/admin/jobs/_user_upload_job.finished.html.erb*
181 |
182 | ```erb
183 | <%= result %>
184 | ```
185 |
186 | > Remember: we get this: "Users successfully loaded" as `result` on success.
187 |
188 | 
189 |
190 | One for error...
191 |
192 | */your_app/app/views/admin/jobs/_user_upload_job.failed.html.erb*
193 |
194 | ```erb
195 | 
218 |
219 | Those partials will be rendered in the job's show view depending on its state.
220 |
221 | ## I18n
222 |
223 | If you want to translate your notifications, you can do it following this convention:
224 |
225 | **/your_app/config/locales/en.yml**
226 |
227 | ```yml
228 | en:
229 | activeadmin_jobs:
230 | [job_class_name]:
231 | description: "XXX"
232 | finished:
233 | title: "XXX"
234 | one: "XXX"
235 | other: "XXX"
236 | failed:
237 | title: "XXX"
238 | one: "XXX"
239 | other: "XXX"
240 | ```
241 |
242 | For example:
243 |
244 | ```yml
245 | en:
246 | activeadmin_jobs:
247 | user_upload_job:
248 | description: "Users upload through .xls file"
249 | finished:
250 | title: "Users have been uploaded! :)"
251 | one: "One .xls file was completed with no errors. Click here to see the result"
252 | other: ".xls files were completed with no errors. Click here to see the result"
253 | failed:
254 | title: "Error trying to upload users :("
255 | one: "One .xls file could not be uploaded. Click here to see errors"
256 | other: ".xls files could not be uploaded. Click here to see errors"
257 | ```
258 |
259 |
260 | ## Contributing
261 |
262 | 1. Fork it
263 | 2. Create your feature branch (`git checkout -b my-new-feature`)
264 | 3. Commit your changes (`git commit -am 'Add some feature'`)
265 | 4. Push to the branch (`git push origin my-new-feature`)
266 | 5. Create new Pull Request
267 |
268 | ## Credits
269 |
270 | Thank you [contributors](https://github.com/platanus/activeadmin_jobs/graphs/contributors)!
271 |
272 | 
273 |
274 | Active Admin Jobs is maintained by [platanus](http://platan.us).
275 |
276 | ## License
277 |
278 | Active Admin Jobs is © 2016 platanus, spa. It is free software and may be redistributed under the terms specified in the LICENSE file.
279 |
--------------------------------------------------------------------------------
/spec/dummy/config/initializers/active_admin.rb:
--------------------------------------------------------------------------------
1 | ActiveAdmin.setup do |config|
2 | # == Site Title
3 | #
4 | # Set the title that is displayed on the main layout
5 | # for each of the active admin pages.
6 | #
7 | config.site_title = "Dummy"
8 |
9 | # Set the link url for the title. For example, to take
10 | # users to your main site. Defaults to no link.
11 | #
12 | # config.site_title_link = "/"
13 |
14 | # Set an optional image to be displayed for the header
15 | # instead of a string (overrides :site_title)
16 | #
17 | # Note: Aim for an image that's 21px high so it fits in the header.
18 | #
19 | # config.site_title_image = "logo.png"
20 |
21 | # == Default Namespace
22 | #
23 | # Set the default namespace each administration resource
24 | # will be added to.
25 | #
26 | # eg:
27 | # config.default_namespace = :hello_world
28 | #
29 | # This will create resources in the HelloWorld module and
30 | # will namespace routes to /hello_world/*
31 | #
32 | # To set no namespace by default, use:
33 | # config.default_namespace = false
34 | #
35 | # Default:
36 | # config.default_namespace = :admin
37 | #
38 | # You can customize the settings for each namespace by using
39 | # a namespace block. For example, to change the site title
40 | # within a namespace:
41 | #
42 | # config.namespace :admin do |admin|
43 | # admin.site_title = "Custom Admin Title"
44 | # end
45 | #
46 | # This will ONLY change the title for the admin section. Other
47 | # namespaces will continue to use the main "site_title" configuration.
48 |
49 | # == User Authentication
50 | #
51 | # Active Admin will automatically call an authentication
52 | # method in a before filter of all controller actions to
53 | # ensure that there is a currently logged in admin user.
54 | #
55 | # This setting changes the method which Active Admin calls
56 | # within the application controller.
57 | config.authentication_method = :authenticate_admin_user!
58 |
59 | # == User Authorization
60 | #
61 | # Active Admin will automatically call an authorization
62 | # method in a before filter of all controller actions to
63 | # ensure that there is a user with proper rights. You can use
64 | # CanCanAdapter or make your own. Please refer to documentation.
65 | # config.authorization_adapter = ActiveAdmin::CanCanAdapter
66 |
67 | # In case you prefer Pundit over other solutions you can here pass
68 | # the name of default policy class. This policy will be used in every
69 | # case when Pundit is unable to find suitable policy.
70 | # config.pundit_default_policy = "MyDefaultPunditPolicy"
71 |
72 | # You can customize your CanCan Ability class name here.
73 | # config.cancan_ability_class = "Ability"
74 |
75 | # You can specify a method to be called on unauthorized access.
76 | # This is necessary in order to prevent a redirect loop which happens
77 | # because, by default, user gets redirected to Dashboard. If user
78 | # doesn't have access to Dashboard, he'll end up in a redirect loop.
79 | # Method provided here should be defined in application_controller.rb.
80 | # config.on_unauthorized_access = :access_denied
81 |
82 | # == Current User
83 | #
84 | # Active Admin will associate actions with the current
85 | # user performing them.
86 | #
87 | # This setting changes the method which Active Admin calls
88 | # (within the application controller) to return the currently logged in user.
89 | config.current_user_method = :current_admin_user
90 |
91 | # == Logging Out
92 | #
93 | # Active Admin displays a logout link on each screen. These
94 | # settings configure the location and method used for the link.
95 | #
96 | # This setting changes the path where the link points to. If it's
97 | # a string, the strings is used as the path. If it's a Symbol, we
98 | # will call the method to return the path.
99 | #
100 | # Default:
101 | config.logout_link_path = :destroy_admin_user_session_path
102 |
103 | # This setting changes the http method used when rendering the
104 | # link. For example :get, :delete, :put, etc..
105 | #
106 | # Default:
107 | # config.logout_link_method = :get
108 |
109 | # == Root
110 | #
111 | # Set the action to call for the root path. You can set different
112 | # roots for each namespace.
113 | #
114 | # Default:
115 | # config.root_to = 'dashboard#index'
116 |
117 | # == Admin Comments
118 | #
119 | # This allows your users to comment on any resource registered with Active Admin.
120 | #
121 | # You can completely disable comments:
122 | config.comments = false
123 | #
124 | # You can disable the menu item for the comments index page:
125 | # config.show_comments_in_menu = false
126 | #
127 | # You can change the name under which comments are registered:
128 | # config.comments_registration_name = 'AdminComment'
129 | #
130 | # You can change the order for the comments and you can change the column
131 | # to be used for ordering
132 | # config.comments_order = 'created_at ASC'
133 |
134 | # == Batch Actions
135 | #
136 | # Enable and disable Batch Actions
137 | #
138 | config.batch_actions = true
139 |
140 | # == Controller Filters
141 | #
142 | # You can add before, after and around filters to all of your
143 | # Active Admin resources and pages from here.
144 | #
145 | # config.before_filter :do_something_awesome
146 |
147 | # == Localize Date/Time Format
148 | #
149 | # Set the localize format to display dates and times.
150 | # To understand how to localize your app with I18n, read more at
151 | # https://github.com/svenfuchs/i18n/blob/master/lib%2Fi18n%2Fbackend%2Fbase.rb#L52
152 | #
153 | config.localize_format = :long
154 |
155 | # == Setting a Favicon
156 | #
157 | # config.favicon = 'favicon.ico'
158 |
159 | # == Meta Tags
160 | #
161 | # Add additional meta tags to the head element of active admin pages.
162 | #
163 | # Add tags to all pages logged in users see:
164 | # config.meta_tags = { author: 'My Company' }
165 |
166 | # By default, sign up/sign in/recover password pages are excluded
167 | # from showing up in search engine results by adding a robots meta
168 | # tag. You can reset the hash of meta tags included in logged out
169 | # pages:
170 | # config.meta_tags_for_logged_out_pages = {}
171 |
172 | # == Removing Breadcrumbs
173 | #
174 | # Breadcrumbs are enabled by default. You can customize them for individual
175 | # resources or you can disable them globally from here.
176 | #
177 | # config.breadcrumb = false
178 |
179 | # == Register Stylesheets & Javascripts
180 | #
181 | # We recommend using the built in Active Admin layout and loading
182 | # up your own stylesheets / javascripts to customize the look
183 | # and feel.
184 | #
185 | # To load a stylesheet:
186 | # config.register_stylesheet 'my_stylesheet.css'
187 | #
188 | # You can provide an options hash for more control, which is passed along to stylesheet_link_tag():
189 | # config.register_stylesheet 'my_print_stylesheet.css', media: :print
190 | #
191 | # To load a javascript file:
192 | # config.register_javascript 'my_javascript.js'
193 |
194 | # == CSV options
195 | #
196 | # Set the CSV builder separator
197 | # config.csv_options = { col_sep: ';' }
198 | #
199 | # Force the use of quotes
200 | # config.csv_options = { force_quotes: true }
201 |
202 | # == Menu System
203 | #
204 | # You can add a navigation menu to be used in your application, or configure a provided menu
205 | #
206 | # To change the default utility navigation to show a link to your website & a logout btn
207 | #
208 | # config.namespace :admin do |admin|
209 | # admin.build_menu :utility_navigation do |menu|
210 | # menu.add label: "My Great Website", url: "http://www.mygreatwebsite.com", html_options: { target: :blank }
211 | # admin.add_logout_button_to_menu menu
212 | # end
213 | # end
214 | #
215 | # If you wanted to add a static menu item to the default menu provided:
216 | #
217 | # config.namespace :admin do |admin|
218 | # admin.build_menu :default do |menu|
219 | # menu.add label: "My Great Website", url: "http://www.mygreatwebsite.com", html_options: { target: :blank }
220 | # end
221 | # end
222 |
223 | # == Download Links
224 | #
225 | # You can disable download links on resource listing pages,
226 | # or customize the formats shown per namespace/globally
227 | #
228 | # To disable/customize for the :admin namespace:
229 | #
230 | # config.namespace :admin do |admin|
231 | #
232 | # # Disable the links entirely
233 | # admin.download_links = false
234 | #
235 | # # Only show XML & PDF options
236 | # admin.download_links = [:xml, :pdf]
237 | #
238 | # # Enable/disable the links based on block
239 | # # (for example, with cancan)
240 | # admin.download_links = proc { can?(:view_download_links) }
241 | #
242 | # end
243 |
244 | # == Pagination
245 | #
246 | # Pagination is enabled by default for all resources.
247 | # You can control the default per page count for all resources here.
248 | #
249 | # config.default_per_page = 30
250 | #
251 | # You can control the max per page count too.
252 | #
253 | # config.max_per_page = 10_000
254 |
255 | # == Filters
256 | #
257 | # By default the index screen includes a "Filters" sidebar on the right
258 | # hand side with a filter for each attribute of the registered model.
259 | # You can enable or disable them for all resources here.
260 | #
261 | # config.filters = true
262 | end
263 |
--------------------------------------------------------------------------------
/spec/dummy/config/initializers/devise.rb:
--------------------------------------------------------------------------------
1 | # Use this hook to configure devise mailer, warden hooks and so forth.
2 | # Many of these configuration options can be set straight in your model.
3 | Devise.setup do |config|
4 | # The secret key used by Devise. Devise uses this key to generate
5 | # random tokens. Changing this key will render invalid all existing
6 | # confirmation, reset password and unlock tokens in the database.
7 | # Devise will use the `secret_key_base` on Rails 4+ applications as its `secret_key`
8 | # by default. You can change it below and use your own secret key.
9 | # config.secret_key = 'cc63f334aa166ce6d35d9548928178981723a353e77e2b49380acab95ade391e2a5ecf3596712660a91461e6861e3921d0f9ffe0861f85bdc0aecf54c7ba13b3'
10 |
11 | # ==> Mailer Configuration
12 | # Configure the e-mail address which will be shown in Devise::Mailer,
13 | # note that it will be overwritten if you use your own mailer class
14 | # with default "from" parameter.
15 | config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
16 |
17 | # Configure the class responsible to send e-mails.
18 | # config.mailer = 'Devise::Mailer'
19 |
20 | # ==> ORM configuration
21 | # Load and configure the ORM. Supports :active_record (default) and
22 | # :mongoid (bson_ext recommended) by default. Other ORMs may be
23 | # available as additional gems.
24 | require 'devise/orm/active_record'
25 |
26 | # ==> Configuration for any authentication mechanism
27 | # Configure which keys are used when authenticating a user. The default is
28 | # just :email. You can configure it to use [:username, :subdomain], so for
29 | # authenticating a user, both parameters are required. Remember that those
30 | # parameters are used only when authenticating and not when retrieving from
31 | # session. If you need permissions, you should implement that in a before filter.
32 | # You can also supply a hash where the value is a boolean determining whether
33 | # or not authentication should be aborted when the value is not present.
34 | # config.authentication_keys = [:email]
35 |
36 | # Configure parameters from the request object used for authentication. Each entry
37 | # given should be a request method and it will automatically be passed to the
38 | # find_for_authentication method and considered in your model lookup. For instance,
39 | # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
40 | # The same considerations mentioned for authentication_keys also apply to request_keys.
41 | # config.request_keys = []
42 |
43 | # Configure which authentication keys should be case-insensitive.
44 | # These keys will be downcased upon creating or modifying a user and when used
45 | # to authenticate or find a user. Default is :email.
46 | config.case_insensitive_keys = [:email]
47 |
48 | # Configure which authentication keys should have whitespace stripped.
49 | # These keys will have whitespace before and after removed upon creating or
50 | # modifying a user and when used to authenticate or find a user. Default is :email.
51 | config.strip_whitespace_keys = [:email]
52 |
53 | # Tell if authentication through request.params is enabled. True by default.
54 | # It can be set to an array that will enable params authentication only for the
55 | # given strategies, for example, `config.params_authenticatable = [:database]` will
56 | # enable it only for database (email + password) authentication.
57 | # config.params_authenticatable = true
58 |
59 | # Tell if authentication through HTTP Auth is enabled. False by default.
60 | # It can be set to an array that will enable http authentication only for the
61 | # given strategies, for example, `config.http_authenticatable = [:database]` will
62 | # enable it only for database authentication. The supported strategies are:
63 | # :database = Support basic authentication with authentication key + password
64 | # config.http_authenticatable = false
65 |
66 | # If 401 status code should be returned for AJAX requests. True by default.
67 | # config.http_authenticatable_on_xhr = true
68 |
69 | # The realm used in Http Basic Authentication. 'Application' by default.
70 | # config.http_authentication_realm = 'Application'
71 |
72 | # It will change confirmation, password recovery and other workflows
73 | # to behave the same regardless if the e-mail provided was right or wrong.
74 | # Does not affect registerable.
75 | # config.paranoid = true
76 |
77 | # By default Devise will store the user in session. You can skip storage for
78 | # particular strategies by setting this option.
79 | # Notice that if you are skipping storage for all authentication paths, you
80 | # may want to disable generating routes to Devise's sessions controller by
81 | # passing skip: :sessions to `devise_for` in your config/routes.rb
82 | config.skip_session_storage = [:http_auth]
83 |
84 | # By default, Devise cleans up the CSRF token on authentication to
85 | # avoid CSRF token fixation attacks. This means that, when using AJAX
86 | # requests for sign in and sign up, you need to get a new CSRF token
87 | # from the server. You can disable this option at your own risk.
88 | # config.clean_up_csrf_token_on_authentication = true
89 |
90 | # ==> Configuration for :database_authenticatable
91 | # For bcrypt, this is the cost for hashing the password and defaults to 10. If
92 | # using other encryptors, it sets how many times you want the password re-encrypted.
93 | #
94 | # Limiting the stretches to just one in testing will increase the performance of
95 | # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
96 | # a value less than 10 in other environments. Note that, for bcrypt (the default
97 | # encryptor), the cost increases exponentially with the number of stretches (e.g.
98 | # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
99 | config.stretches = Rails.env.test? ? 1 : 10
100 |
101 | # Setup a pepper to generate the encrypted password.
102 | # config.pepper = '955cf137850726892dec0f03226431a8eda8c1c969d7f22716509581371adece89bf35ee1aba222f9095df439eae3b4764e2856cf2d44b78ef1ee43772a64368'
103 |
104 | # Send a notification email when the user's password is changed
105 | # config.send_password_change_notification = false
106 |
107 | # ==> Configuration for :confirmable
108 | # A period that the user is allowed to access the website even without
109 | # confirming their account. For instance, if set to 2.days, the user will be
110 | # able to access the website for two days without confirming their account,
111 | # access will be blocked just in the third day. Default is 0.days, meaning
112 | # the user cannot access the website without confirming their account.
113 | # config.allow_unconfirmed_access_for = 2.days
114 |
115 | # A period that the user is allowed to confirm their account before their
116 | # token becomes invalid. For example, if set to 3.days, the user can confirm
117 | # their account within 3 days after the mail was sent, but on the fourth day
118 | # their account can't be confirmed with the token any more.
119 | # Default is nil, meaning there is no restriction on how long a user can take
120 | # before confirming their account.
121 | # config.confirm_within = 3.days
122 |
123 | # If true, requires any email changes to be confirmed (exactly the same way as
124 | # initial account confirmation) to be applied. Requires additional unconfirmed_email
125 | # db field (see migrations). Until confirmed, new email is stored in
126 | # unconfirmed_email column, and copied to email column on successful confirmation.
127 | config.reconfirmable = true
128 |
129 | # Defines which key will be used when confirming an account
130 | # config.confirmation_keys = [:email]
131 |
132 | # ==> Configuration for :rememberable
133 | # The time the user will be remembered without asking for credentials again.
134 | # config.remember_for = 2.weeks
135 |
136 | # Invalidates all the remember me tokens when the user signs out.
137 | config.expire_all_remember_me_on_sign_out = true
138 |
139 | # If true, extends the user's remember period when remembered via cookie.
140 | # config.extend_remember_period = false
141 |
142 | # Options to be passed to the created cookie. For instance, you can set
143 | # secure: true in order to force SSL only cookies.
144 | # config.rememberable_options = {}
145 |
146 | # ==> Configuration for :validatable
147 | # Range for password length.
148 | config.password_length = 8..72
149 |
150 | # Email regex used to validate email formats. It simply asserts that
151 | # one (and only one) @ exists in the given string. This is mainly
152 | # to give user feedback and not to assert the e-mail validity.
153 | # config.email_regexp = /\A[^@]+@[^@]+\z/
154 |
155 | # ==> Configuration for :timeoutable
156 | # The time you want to timeout the user session without activity. After this
157 | # time the user will be asked for credentials again. Default is 30 minutes.
158 | # config.timeout_in = 30.minutes
159 |
160 | # ==> Configuration for :lockable
161 | # Defines which strategy will be used to lock an account.
162 | # :failed_attempts = Locks an account after a number of failed attempts to sign in.
163 | # :none = No lock strategy. You should handle locking by yourself.
164 | # config.lock_strategy = :failed_attempts
165 |
166 | # Defines which key will be used when locking and unlocking an account
167 | # config.unlock_keys = [:email]
168 |
169 | # Defines which strategy will be used to unlock an account.
170 | # :email = Sends an unlock link to the user email
171 | # :time = Re-enables login after a certain amount of time (see :unlock_in below)
172 | # :both = Enables both strategies
173 | # :none = No unlock strategy. You should handle unlocking by yourself.
174 | # config.unlock_strategy = :both
175 |
176 | # Number of authentication tries before locking an account if lock_strategy
177 | # is failed attempts.
178 | # config.maximum_attempts = 20
179 |
180 | # Time interval to unlock the account if :time is enabled as unlock_strategy.
181 | # config.unlock_in = 1.hour
182 |
183 | # Warn on the last attempt before the account is locked.
184 | # config.last_attempt_warning = true
185 |
186 | # ==> Configuration for :recoverable
187 | #
188 | # Defines which key will be used when recovering the password for an account
189 | # config.reset_password_keys = [:email]
190 |
191 | # Time interval you can reset your password with a reset password key.
192 | # Don't put a too small interval or your users won't have the time to
193 | # change their passwords.
194 | config.reset_password_within = 6.hours
195 |
196 | # When set to false, does not sign a user in automatically after their password is
197 | # reset. Defaults to true, so a user is signed in automatically after a reset.
198 | # config.sign_in_after_reset_password = true
199 |
200 | # ==> Configuration for :encryptable
201 | # Allow you to use another encryption algorithm besides bcrypt (default). You can use
202 | # :sha1, :sha512 or encryptors from others authentication tools as :clearance_sha1,
203 | # :authlogic_sha512 (then you should set stretches above to 20 for default behavior)
204 | # and :restful_authentication_sha1 (then you should set stretches to 10, and copy
205 | # REST_AUTH_SITE_KEY to pepper).
206 | #
207 | # Require the `devise-encryptable` gem when using anything other than bcrypt
208 | # config.encryptor = :sha512
209 |
210 | # ==> Scopes configuration
211 | # Turn scoped views on. Before rendering "sessions/new", it will first check for
212 | # "users/sessions/new". It's turned off by default because it's slower if you
213 | # are using only default views.
214 | # config.scoped_views = false
215 |
216 | # Configure the default scope given to Warden. By default it's the first
217 | # devise role declared in your routes (usually :user).
218 | # config.default_scope = :user
219 |
220 | # Set this configuration to false if you want /users/sign_out to sign out
221 | # only the current scope. By default, Devise signs out all scopes.
222 | # config.sign_out_all_scopes = true
223 |
224 | # ==> Navigation configuration
225 | # Lists the formats that should be treated as navigational. Formats like
226 | # :html, should redirect to the sign in page when the user does not have
227 | # access, but formats like :xml or :json, should return 401.
228 | #
229 | # If you have any extra navigational formats, like :iphone or :mobile, you
230 | # should add them to the navigational formats lists.
231 | #
232 | # The "*/*" below is required to match Internet Explorer requests.
233 | # config.navigational_formats = ['*/*', :html]
234 |
235 | # The default HTTP method used to sign out a resource. Default is :delete.
236 | config.sign_out_via = :delete
237 |
238 | # ==> OmniAuth
239 | # Add a new OmniAuth provider. Check the wiki for more information on setting
240 | # up on your models and hooks.
241 | # config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
242 |
243 | # ==> Warden configuration
244 | # If you want to use other strategies, that are not supported by Devise, or
245 | # change the failure app, you can configure them inside the config.warden block.
246 | #
247 | # config.warden do |manager|
248 | # manager.intercept_401 = false
249 | # manager.default_strategies(scope: :user).unshift :some_external_strategy
250 | # end
251 |
252 | # ==> Mountable engine configurations
253 | # When using Devise inside an engine, let's call it `MyEngine`, and this engine
254 | # is mountable, there are some extra configurations to be taken into account.
255 | # The following options are available, assuming the engine is mounted as:
256 | #
257 | # mount MyEngine, at: '/my_engine'
258 | #
259 | # The router that invoked `devise_for`, in the example above, would be:
260 | # config.router_name = :my_engine
261 | #
262 | # When using OmniAuth, Devise cannot automatically set OmniAuth path,
263 | # so you need to do it manually. For the users scope, it would be:
264 | # config.omniauth_path_prefix = '/my_engine/users/auth'
265 | end
266 |
--------------------------------------------------------------------------------
/.rubocop.yml:
--------------------------------------------------------------------------------
1 | AllCops:
2 | Include:
3 | - "**/*.rake"
4 | - "**/Gemfile"
5 | - "**/Rakefile"
6 | Exclude:
7 | - "vendor/**/*"
8 | - "db/**/*"
9 | - "bin/**/*"
10 | DisplayCopNames: false
11 | StyleGuideCopsOnly: false
12 | TargetRubyVersion: 2.3
13 | Layout/AccessModifierIndentation:
14 | Description: Check indentation of private/protected visibility modifiers.
15 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#indent-public-private-protected
16 | Enabled: true
17 | EnforcedStyle: indent
18 | SupportedStyles:
19 | - outdent
20 | - indent
21 | Layout/AlignHash:
22 | Description: Align the elements of a hash literal if they span more than one line.
23 | Enabled: true
24 | EnforcedHashRocketStyle: key
25 | EnforcedColonStyle: key
26 | EnforcedLastArgumentHashStyle: always_inspect
27 | SupportedLastArgumentHashStyles:
28 | - always_inspect
29 | - always_ignore
30 | - ignore_implicit
31 | - ignore_explicit
32 | Layout/AlignParameters:
33 | Description: Align the parameters of a method call if they span more than one line.
34 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-double-indent
35 | Enabled: true
36 | EnforcedStyle: with_fixed_indentation
37 | SupportedStyles:
38 | - with_first_parameter
39 | - with_fixed_indentation
40 | Style/AndOr:
41 | Description: Use &&/|| instead of and/or.
42 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-and-or-or
43 | Enabled: true
44 | EnforcedStyle: always
45 | SupportedStyles:
46 | - always
47 | - conditionals
48 | Style/BarePercentLiterals:
49 | Description: Checks if usage of %() or %Q() matches configuration.
50 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-q-shorthand
51 | Enabled: true
52 | EnforcedStyle: bare_percent
53 | SupportedStyles:
54 | - percent_q
55 | - bare_percent
56 | Metrics/BlockLength:
57 | Enabled: false
58 | Style/BracesAroundHashParameters:
59 | Description: Enforce braces style around hash parameters.
60 | Enabled: true
61 | EnforcedStyle: no_braces
62 | SupportedStyles:
63 | - braces
64 | - no_braces
65 | - context_dependent
66 | Layout/CaseIndentation:
67 | Description: Indentation of when in a case/when/[else/]end.
68 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#indent-when-to-case
69 | Enabled: true
70 | EnforcedStyle: case
71 | SupportedStyles:
72 | - case
73 | - end
74 | IndentOneStep: false
75 | Style/ClassAndModuleChildren:
76 | Description: Checks style of children classes and modules.
77 | Enabled: false
78 | EnforcedStyle: nested
79 | SupportedStyles:
80 | - nested
81 | - compact
82 | Style/ClassCheck:
83 | Description: Enforces consistent use of `Object#is_a?` or `Object#kind_of?`.
84 | Enabled: true
85 | EnforcedStyle: is_a?
86 | SupportedStyles:
87 | - is_a?
88 | - kind_of?
89 | Style/CollectionMethods:
90 | Description: Preferred collection methods.
91 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
92 | Enabled: false
93 | PreferredMethods:
94 | collect: map
95 | collect!: map!
96 | inject: reduce
97 | detect: find
98 | find_all: select
99 | find: detect
100 | Style/CommentAnnotation:
101 | Description: Checks formatting of special comments (TODO, FIXME, OPTIMIZE, HACK,
102 | REVIEW).
103 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#annotate-keywords
104 | Enabled: false
105 | Keywords:
106 | - TODO
107 | - FIXME
108 | - OPTIMIZE
109 | - HACK
110 | - REVIEW
111 | Layout/DotPosition:
112 | Description: Checks the position of the dot in multi-line method calls.
113 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
114 | Enabled: true
115 | EnforcedStyle: leading
116 | SupportedStyles:
117 | - leading
118 | - trailing
119 | Layout/EmptyLineBetweenDefs:
120 | Description: Use empty lines between defs.
121 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#empty-lines-between-methods
122 | Enabled: true
123 | AllowAdjacentOneLineDefs: false
124 | Layout/EmptyLinesAroundBlockBody:
125 | Description: Keeps track of empty lines around block bodies.
126 | Enabled: true
127 | EnforcedStyle: no_empty_lines
128 | SupportedStyles:
129 | - empty_lines
130 | - no_empty_lines
131 | Layout/EmptyLinesAroundClassBody:
132 | Description: Keeps track of empty lines around class bodies.
133 | Enabled: true
134 | EnforcedStyle: no_empty_lines
135 | SupportedStyles:
136 | - empty_lines
137 | - no_empty_lines
138 | Layout/EmptyLinesAroundModuleBody:
139 | Description: Keeps track of empty lines around module bodies.
140 | Enabled: true
141 | EnforcedStyle: no_empty_lines
142 | SupportedStyles:
143 | - empty_lines
144 | - no_empty_lines
145 | Style/Encoding:
146 | Description: Use UTF-8 as the source file encoding.
147 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#utf-8
148 | Enabled: false
149 | EnforcedStyle: always
150 | SupportedStyles:
151 | - when_needed
152 | - always
153 | Style/FileName:
154 | Description: Use snake_case for source file names.
155 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
156 | Enabled: false
157 | Exclude: []
158 | Layout/FirstParameterIndentation:
159 | Description: Checks the indentation of the first parameter in a method call.
160 | Enabled: true
161 | EnforcedStyle: special_for_inner_method_call_in_parentheses
162 | SupportedStyles:
163 | - consistent
164 | - special_for_inner_method_call
165 | - special_for_inner_method_call_in_parentheses
166 | Style/For:
167 | Description: Checks use of for or each in multiline loops.
168 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-for-loops
169 | Enabled: true
170 | EnforcedStyle: each
171 | SupportedStyles:
172 | - for
173 | - each
174 | Style/FormatString:
175 | Description: Enforce the use of Kernel#sprintf, Kernel#format or String#%.
176 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#sprintf
177 | Enabled: false
178 | EnforcedStyle: format
179 | SupportedStyles:
180 | - format
181 | - sprintf
182 | - percent
183 | Style/FrozenStringLiteralComment:
184 | Enabled: false
185 | Style/GlobalVars:
186 | Description: Do not introduce global variables.
187 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#instance-vars
188 | Enabled: false
189 | AllowedVariables: []
190 | Style/GuardClause:
191 | Description: Check for conditionals that can be replaced with guard clauses
192 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
193 | Enabled: false
194 | MinBodyLength: 1
195 | Style/HashSyntax:
196 | Description: 'Prefer Ruby 1.9 hash syntax { a: 1, b: 2 } over 1.8 syntax { :a =>
197 | 1, :b => 2 }.'
198 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-literals
199 | Enabled: true
200 | EnforcedStyle: ruby19
201 | SupportedStyles:
202 | - ruby19
203 | - hash_rockets
204 | Style/IfUnlessModifier:
205 | Description: Favor modifier if/unless usage when you have a single-line body.
206 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
207 | Enabled: false
208 | MaxLineLength: 80
209 | Layout/IndentationWidth:
210 | Description: Use 2 spaces for indentation.
211 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-indentation
212 | Enabled: true
213 | Width: 2
214 | Layout/IndentHash:
215 | Description: Checks the indentation of the first key in a hash literal.
216 | Enabled: true
217 | EnforcedStyle: special_inside_parentheses
218 | SupportedStyles:
219 | - special_inside_parentheses
220 | - consistent
221 | Style/LambdaCall:
222 | Description: Use lambda.call(...) instead of lambda.(...).
223 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#proc-call
224 | Enabled: false
225 | EnforcedStyle: call
226 | SupportedStyles:
227 | - call
228 | - braces
229 | Style/Next:
230 | Description: Use `next` to skip iteration instead of a condition at the end.
231 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
232 | Enabled: false
233 | EnforcedStyle: skip_modifier_ifs
234 | MinBodyLength: 3
235 | SupportedStyles:
236 | - skip_modifier_ifs
237 | - always
238 | Style/NonNilCheck:
239 | Description: Checks for redundant nil checks.
240 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-non-nil-checks
241 | Enabled: true
242 | IncludeSemanticChanges: false
243 | Style/MethodDefParentheses:
244 | Description: Checks if the method definitions have or don't have parentheses.
245 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#method-parens
246 | Enabled: true
247 | EnforcedStyle: require_parentheses
248 | SupportedStyles:
249 | - require_parentheses
250 | - require_no_parentheses
251 | Style/MethodName:
252 | Description: Use the configured style when naming methods.
253 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars
254 | Enabled: true
255 | EnforcedStyle: snake_case
256 | SupportedStyles:
257 | - snake_case
258 | - camelCase
259 | Layout/MultilineOperationIndentation:
260 | Description: Checks indentation of binary operations that span more than one line.
261 | Enabled: true
262 | EnforcedStyle: indented
263 | SupportedStyles:
264 | - aligned
265 | - indented
266 | Style/MutableConstant:
267 | Description: Do not assign mutable objects to constants.
268 | Enabled: false
269 | Style/NumericLiterals:
270 | Description: Add underscores to large numeric literals to improve their readability.
271 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics
272 | Enabled: false
273 | MinDigits: 5
274 | Style/ParenthesesAroundCondition:
275 | Description: Don't use parentheses around the condition of an if/unless/while.
276 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-parens-if
277 | Enabled: true
278 | AllowSafeAssignment: true
279 | Style/PercentLiteralDelimiters:
280 | Description: Use `%`-literal delimiters consistently
281 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
282 | Enabled: false
283 | PreferredDelimiters:
284 | "%": "()"
285 | "%i": "()"
286 | "%q": "()"
287 | "%Q": "()"
288 | "%r": "{}"
289 | "%s": "()"
290 | "%w": "()"
291 | "%W": "()"
292 | "%x": "()"
293 | Style/PercentQLiterals:
294 | Description: Checks if uses of %Q/%q match the configured preference.
295 | Enabled: true
296 | EnforcedStyle: lower_case_q
297 | SupportedStyles:
298 | - lower_case_q
299 | - upper_case_q
300 | Style/PredicateName:
301 | Description: Check the names of predicate methods.
302 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
303 | Enabled: true
304 | NamePrefix:
305 | - is_
306 | - has_
307 | - have_
308 | NamePrefixBlacklist:
309 | - is_
310 | Style/RaiseArgs:
311 | Description: Checks the arguments passed to raise/fail.
312 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
313 | Enabled: false
314 | EnforcedStyle: exploded
315 | SupportedStyles:
316 | - compact
317 | - exploded
318 | Style/RedundantReturn:
319 | Description: Don't use return where it's not required.
320 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-explicit-return
321 | Enabled: true
322 | AllowMultipleReturnValues: false
323 | Style/Semicolon:
324 | Description: Don't use semicolons to terminate expressions.
325 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-semicolon
326 | Enabled: true
327 | AllowAsExpressionSeparator: false
328 | Style/SignalException:
329 | Description: Checks for proper usage of fail and raise.
330 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
331 | Enabled: false
332 | EnforcedStyle: semantic
333 | SupportedStyles:
334 | - only_raise
335 | - only_fail
336 | - semantic
337 | Style/SingleLineBlockParams:
338 | Description: Enforces the names of some block params.
339 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
340 | Enabled: false
341 | Methods:
342 | - reduce:
343 | - a
344 | - e
345 | - inject:
346 | - a
347 | - e
348 | Style/SingleLineMethods:
349 | Description: Avoid single-line methods.
350 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
351 | Enabled: false
352 | AllowIfMethodIsEmpty: true
353 | Style/StringLiterals:
354 | Description: Checks if uses of quotes match the configured preference.
355 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
356 | Enabled: false
357 | EnforcedStyle: double_quotes
358 | SupportedStyles:
359 | - single_quotes
360 | - double_quotes
361 | Style/StringLiteralsInInterpolation:
362 | Description: Checks if uses of quotes inside expressions in interpolated strings
363 | match the configured preference.
364 | Enabled: true
365 | EnforcedStyle: single_quotes
366 | SupportedStyles:
367 | - single_quotes
368 | - double_quotes
369 | Layout/SpaceAroundBlockParameters:
370 | Description: Checks the spacing inside and after block parameters pipes.
371 | Enabled: true
372 | EnforcedStyleInsidePipes: no_space
373 | SupportedStylesInsidePipes:
374 | - space
375 | - no_space
376 | Layout/SpaceAroundEqualsInParameterDefault:
377 | Description: Checks that the equals signs in parameter default assignments have
378 | or don't have surrounding space depending on configuration.
379 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-around-equals
380 | Enabled: true
381 | EnforcedStyle: space
382 | SupportedStyles:
383 | - space
384 | - no_space
385 | Layout/SpaceBeforeBlockBraces:
386 | Description: Checks that the left block brace has or doesn't have space before it.
387 | Enabled: true
388 | EnforcedStyle: space
389 | SupportedStyles:
390 | - space
391 | - no_space
392 | Layout/SpaceInsideBlockBraces:
393 | Description: Checks that block braces have or don't have surrounding space. For
394 | blocks taking parameters, checks that the left brace has or doesn't have trailing
395 | space.
396 | Enabled: true
397 | EnforcedStyle: space
398 | SupportedStyles:
399 | - space
400 | - no_space
401 | EnforcedStyleForEmptyBraces: no_space
402 | SpaceBeforeBlockParameters: true
403 | Layout/SpaceInsideHashLiteralBraces:
404 | Description: Use spaces inside hash literal braces - or don't.
405 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
406 | Enabled: true
407 | EnforcedStyle: space
408 | EnforcedStyleForEmptyBraces: no_space
409 | SupportedStyles:
410 | - space
411 | - no_space
412 | Style/SymbolProc:
413 | Description: Use symbols as procs instead of blocks when possible.
414 | Enabled: true
415 | IgnoredMethods:
416 | - respond_to
417 | Layout/TrailingBlankLines:
418 | Description: Checks trailing blank lines and final newline.
419 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#newline-eof
420 | Enabled: true
421 | EnforcedStyle: final_newline
422 | SupportedStyles:
423 | - final_newline
424 | - final_blank_line
425 | Style/TrailingCommaInArguments:
426 | Description: Checks for trailing comma in argument lists.
427 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
428 | Enabled: true
429 | Style/TrailingCommaInLiteral:
430 | Description: Checks for trailing comma in array and hash literals.
431 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas
432 | Enabled: true
433 | Style/TrivialAccessors:
434 | Description: Prefer attr_* methods to trivial readers/writers.
435 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#attr_family
436 | Enabled: false
437 | ExactNameMatch: false
438 | AllowPredicates: false
439 | AllowDSLWriters: false
440 | Whitelist:
441 | - to_ary
442 | - to_a
443 | - to_c
444 | - to_enum
445 | - to_h
446 | - to_hash
447 | - to_i
448 | - to_int
449 | - to_io
450 | - to_open
451 | - to_path
452 | - to_proc
453 | - to_r
454 | - to_regexp
455 | - to_str
456 | - to_s
457 | - to_sym
458 | Style/VariableName:
459 | Description: Use the configured style when naming variables.
460 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-symbols-methods-vars
461 | Enabled: true
462 | EnforcedStyle: snake_case
463 | SupportedStyles:
464 | - snake_case
465 | - camelCase
466 | Style/WhileUntilModifier:
467 | Description: Favor modifier while/until usage when you have a single-line body.
468 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#while-as-a-modifier
469 | Enabled: false
470 | MaxLineLength: 80
471 | Style/WordArray:
472 | Description: Use %w or %W for arrays of words.
473 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-w
474 | Enabled: false
475 | MinSize: 0
476 | WordRegex: !ruby/regexp /\A[\p{Word}]+\z/
477 | Metrics/AbcSize:
478 | Description: A calculated magnitude based on number of assignments, branches, and
479 | conditions.
480 | Enabled: true
481 | Max: 25
482 | Metrics/BlockNesting:
483 | Description: Avoid excessive block nesting
484 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#three-is-the-number-thou-shalt-count
485 | Enabled: true
486 | Max: 3
487 | Metrics/ClassLength:
488 | Description: Avoid classes longer than 100 lines of code.
489 | Enabled: false
490 | CountComments: false
491 | Max: 100
492 | Metrics/CyclomaticComplexity:
493 | Description: A complexity metric that is strongly correlated to the number of test
494 | cases needed to validate a method.
495 | Enabled: true
496 | Max: 6
497 | Metrics/LineLength:
498 | Description: Limit lines to 100 characters.
499 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#100-character-limits
500 | Enabled: true
501 | Max: 100
502 | AllowURI: true
503 | URISchemes:
504 | - http
505 | - https
506 | Metrics/MethodLength:
507 | Description: Avoid methods longer than 15 lines of code.
508 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
509 | Enabled: true
510 | CountComments: true
511 | Max: 15
512 | Exclude:
513 | - "spec/**/*"
514 | Metrics/ParameterLists:
515 | Description: Avoid long parameter lists.
516 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
517 | Enabled: false
518 | Max: 5
519 | CountKeywordArgs: true
520 | Metrics/PerceivedComplexity:
521 | Description: A complexity metric geared towards measuring complexity for a human
522 | reader.
523 | Enabled: true
524 | Max: 7
525 | Lint/AssignmentInCondition:
526 | Description: Don't use assignment in conditions.
527 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
528 | Enabled: false
529 | AllowSafeAssignment: true
530 | Lint/EndAlignment:
531 | Description: Align ends correctly.
532 | Enabled: true
533 | EnforcedStyleAlignWith: keyword
534 | SupportedStylesAlignWith:
535 | - keyword
536 | - variable
537 | Lint/DefEndAlignment:
538 | Description: Align ends corresponding to defs correctly.
539 | Enabled: true
540 | EnforcedStyleAlignWith: start_of_line
541 | SupportedStylesAlignWith:
542 | - start_of_line
543 | - def
544 | Rails/ActionFilter:
545 | Description: Enforces consistent use of action filter methods.
546 | Enabled: true
547 | EnforcedStyle: action
548 | SupportedStyles:
549 | - action
550 | - filter
551 | Include:
552 | - app/controllers/**/*.rb
553 | Rails/HasAndBelongsToMany:
554 | Description: Prefer has_many :through to has_and_belongs_to_many.
555 | Enabled: true
556 | Include:
557 | - app/models/**/*.rb
558 | Rails/Output:
559 | Description: Checks for calls to puts, print, etc.
560 | Enabled: true
561 | Include:
562 | - app/**/*.rb
563 | - config/**/*.rb
564 | - db/**/*.rb
565 | - lib/**/*.rb
566 | Rails/ReadWriteAttribute:
567 | Description: Checks for read_attribute(:attr) and write_attribute(:attr, val).
568 | Enabled: true
569 | Include:
570 | - app/models/**/*.rb
571 | Rails/ScopeArgs:
572 | Description: Checks the arguments of ActiveRecord scopes.
573 | Enabled: true
574 | Include:
575 | - app/models/**/*.rb
576 | Rails/Validation:
577 | Description: Use validates :attribute, hash of validations.
578 | Enabled: true
579 | Include:
580 | - app/models/**/*.rb
581 | Style/InlineComment:
582 | Description: Avoid inline comments.
583 | Enabled: false
584 | Style/MethodCalledOnDoEndBlock:
585 | Description: Avoid chaining a method call on a do...end block.
586 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks
587 | Enabled: false
588 | Style/SymbolArray:
589 | Description: Use %i or %I for arrays of symbols.
590 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-i
591 | Enabled: false
592 | Layout/ExtraSpacing:
593 | Description: Do not use unnecessary spacing.
594 | Enabled: false
595 | Style/AccessorMethodName:
596 | Description: Check the naming of accessor methods for get_/set_.
597 | Enabled: false
598 | Style/Alias:
599 | Description: Use alias_method instead of alias.
600 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
601 | Enabled: false
602 | Layout/AlignArray:
603 | Description: Align the elements of an array literal if they span more than one line.
604 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#align-multiline-arrays
605 | Enabled: true
606 | Style/ArrayJoin:
607 | Description: Use Array#join instead of Array#*.
608 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#array-join
609 | Enabled: false
610 | Style/AsciiComments:
611 | Description: Use only ascii symbols in comments.
612 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#english-comments
613 | Enabled: false
614 | Style/AsciiIdentifiers:
615 | Description: Use only ascii symbols in identifiers.
616 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#english-identifiers
617 | Enabled: false
618 | Style/Attr:
619 | Description: Checks for uses of Module#attr.
620 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#attr
621 | Enabled: false
622 | Style/BeginBlock:
623 | Description: Avoid the use of BEGIN blocks.
624 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-BEGIN-blocks
625 | Enabled: true
626 | Style/BlockComments:
627 | Description: Do not use block comments.
628 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-block-comments
629 | Enabled: false
630 | Layout/BlockEndNewline:
631 | Description: Put end statement of multiline block on its own line.
632 | Enabled: true
633 | Style/CaseEquality:
634 | Description: Avoid explicit use of the case equality operator(===).
635 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-case-equality
636 | Enabled: false
637 | Style/CharacterLiteral:
638 | Description: Checks for uses of character literals.
639 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-character-literals
640 | Enabled: false
641 | Style/ClassAndModuleCamelCase:
642 | Description: Use CamelCase for classes and modules.
643 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#camelcase-classes
644 | Enabled: true
645 | Style/ClassMethods:
646 | Description: Use self when defining module/class methods.
647 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#def-self-singletons
648 | Enabled: true
649 | Style/ClassVars:
650 | Description: Avoid the use of class variables.
651 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-class-vars
652 | Enabled: false
653 | Style/ColonMethodCall:
654 | Description: 'Do not use :: for method call.'
655 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#double-colons
656 | Enabled: false
657 | Layout/CommentIndentation:
658 | Description: Indentation of comments.
659 | Enabled: true
660 | Style/ConstantName:
661 | Description: Constants should use SCREAMING_SNAKE_CASE.
662 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#screaming-snake-case
663 | Enabled: true
664 | Style/DefWithParentheses:
665 | Description: Use def with parentheses when there are arguments.
666 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#method-parens
667 | Enabled: true
668 | Style/PreferredHashMethods:
669 | Description: Checks for use of deprecated Hash methods.
670 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-key
671 | Enabled: false
672 | Style/Documentation:
673 | Description: Document classes and non-namespace modules.
674 | Enabled: false
675 | Style/DoubleNegation:
676 | Description: Checks for uses of double negation (!!).
677 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
678 | Enabled: false
679 | Style/EachWithObject:
680 | Description: Prefer `each_with_object` over `inject` or `reduce`.
681 | Enabled: false
682 | Layout/ElseAlignment:
683 | Description: Align elses and elsifs correctly.
684 | Enabled: true
685 | Style/EmptyElse:
686 | Description: Avoid empty else-clauses.
687 | Enabled: true
688 | Layout/EmptyLines:
689 | Description: Don't use several empty lines in a row.
690 | Enabled: true
691 | Layout/EmptyLinesAroundAccessModifier:
692 | Description: Keep blank lines around access modifiers.
693 | Enabled: true
694 | Layout/EmptyLinesAroundMethodBody:
695 | Description: Keeps track of empty lines around method bodies.
696 | Enabled: true
697 | Style/EmptyLiteral:
698 | Description: Prefer literals to Array.new/Hash.new/String.new.
699 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
700 | Enabled: false
701 | Style/EndBlock:
702 | Description: Avoid the use of END blocks.
703 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-END-blocks
704 | Enabled: true
705 | Layout/EndOfLine:
706 | Description: Use Unix-style line endings.
707 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#crlf
708 | Enabled: true
709 | Style/EvenOdd:
710 | Description: Favor the use of Fixnum#even? && Fixnum#odd?
711 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#predicate-methods
712 | Enabled: false
713 | Style/FlipFlop:
714 | Description: Checks for flip flops
715 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-flip-flops
716 | Enabled: false
717 | Style/IfWithSemicolon:
718 | Description: Do not use if x; .... Use the ternary operator instead.
719 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-semicolon-ifs
720 | Enabled: false
721 | Layout/IndentationConsistency:
722 | Description: Keep indentation straight.
723 | Enabled: true
724 | Layout/IndentArray:
725 | Description: Checks the indentation of the first element in an array literal.
726 | Enabled: true
727 | Style/InfiniteLoop:
728 | Description: Use Kernel#loop for infinite loops.
729 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#infinite-loop
730 | Enabled: true
731 | Style/Lambda:
732 | Description: Use the new lambda literal syntax for single-line blocks.
733 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#lambda-multi-line
734 | Enabled: false
735 | Layout/LeadingCommentSpace:
736 | Description: Comments should start with a space.
737 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#hash-space
738 | Enabled: true
739 | Style/LineEndConcatenation:
740 | Description: Use \ instead of + or << to concatenate two string literals at line
741 | end.
742 | Enabled: false
743 | Style/MethodCallWithoutArgsParentheses:
744 | Description: Do not use parentheses for method calls with no arguments.
745 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-args-no-parens
746 | Enabled: true
747 | Style/ModuleFunction:
748 | Description: Checks for usage of `extend self` in modules.
749 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
750 | Enabled: false
751 | Style/MultilineBlockChain:
752 | Description: Avoid multi-line chains of blocks.
753 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#single-line-blocks
754 | Enabled: false
755 | Layout/MultilineBlockLayout:
756 | Description: Ensures newlines after multiline block do statements.
757 | Enabled: false
758 | Style/MultilineIfThen:
759 | Description: Do not use then for multi-line if/unless.
760 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-then
761 | Enabled: true
762 | Style/MultilineTernaryOperator:
763 | Description: 'Avoid multi-line ?: (the ternary operator); use if/unless instead.'
764 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-multiline-ternary
765 | Enabled: true
766 | Style/NegatedIf:
767 | Description: Favor unless over if for negative conditions (or control flow or).
768 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#unless-for-negatives
769 | Enabled: false
770 | Style/NegatedWhile:
771 | Description: Favor until over while for negative conditions.
772 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#until-for-negatives
773 | Enabled: false
774 | Style/NestedTernaryOperator:
775 | Description: Use one expression per branch in a ternary operator.
776 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-ternary
777 | Enabled: true
778 | Style/NilComparison:
779 | Description: Prefer x.nil? to x == nil.
780 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#predicate-methods
781 | Enabled: false
782 | Style/Not:
783 | Description: Use ! instead of not.
784 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#bang-not-not
785 | Enabled: true
786 | Style/OneLineConditional:
787 | Description: Favor the ternary operator(?:) over if/then/else/end constructs.
788 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
789 | Enabled: false
790 | Style/OpMethod:
791 | Description: When defining binary operators, name the argument other.
792 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#other-arg
793 | Enabled: false
794 | Style/PerlBackrefs:
795 | Description: Avoid Perl-style regex back references.
796 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
797 | Enabled: false
798 | Style/Proc:
799 | Description: Use proc instead of Proc.new.
800 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#proc
801 | Enabled: false
802 | Style/RedundantBegin:
803 | Description: Don't use begin blocks when they are not needed.
804 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#begin-implicit
805 | Enabled: true
806 | Style/RedundantException:
807 | Description: Checks for an obsolete RuntimeException argument in raise/fail.
808 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-explicit-runtimeerror
809 | Enabled: true
810 | Style/RedundantSelf:
811 | Description: Don't use self where it's not needed.
812 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-self-unless-required
813 | Enabled: true
814 | Style/RescueModifier:
815 | Description: Avoid using rescue in its modifier form.
816 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-rescue-modifiers
817 | Enabled: true
818 | Style/SelfAssignment:
819 | Description: Checks for places where self-assignment shorthand should have been
820 | used.
821 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#self-assignment
822 | Enabled: false
823 | Layout/SpaceAfterColon:
824 | Description: Use spaces after colons.
825 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
826 | Enabled: true
827 | Layout/SpaceAfterComma:
828 | Description: Use spaces after commas.
829 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
830 | Enabled: true
831 | Layout/SpaceAroundKeyword:
832 | Description: Use a space around keywords if appropriate.
833 | Enabled: true
834 | Layout/SpaceAfterMethodName:
835 | Description: Do not put a space between a method name and the opening parenthesis
836 | in a method definition.
837 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#parens-no-spaces
838 | Enabled: true
839 | Layout/SpaceAfterNot:
840 | Description: Tracks redundant space after the ! operator.
841 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-space-bang
842 | Enabled: true
843 | Layout/SpaceAfterSemicolon:
844 | Description: Use spaces after semicolons.
845 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
846 | Enabled: true
847 | Layout/SpaceBeforeComma:
848 | Description: No spaces before commas.
849 | Enabled: true
850 | Layout/SpaceBeforeComment:
851 | Description: Checks for missing space between code and a comment on the same line.
852 | Enabled: true
853 | Layout/SpaceBeforeFirstArg:
854 | Description: Put a space between a method name and the first argument in a method
855 | call without parentheses.
856 | Enabled: true
857 | Layout/SpaceBeforeSemicolon:
858 | Description: No spaces before semicolons.
859 | Enabled: true
860 | Layout/SpaceAroundOperators:
861 | Description: Use spaces around operators.
862 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-operators
863 | Enabled: true
864 | Layout/SpaceInsideBrackets:
865 | Description: No spaces after [ or before ].
866 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-spaces-braces
867 | Enabled: true
868 | Layout/SpaceInsideParens:
869 | Description: No spaces after ( or before ).
870 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-spaces-braces
871 | Enabled: true
872 | Layout/SpaceInsideRangeLiteral:
873 | Description: No spaces inside range literals.
874 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-space-inside-range-literals
875 | Enabled: true
876 | Style/SpecialGlobalVars:
877 | Description: Avoid Perl-style global variables.
878 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
879 | Enabled: false
880 | Style/StructInheritance:
881 | Description: Checks for inheritance from Struct.new.
882 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-extend-struct-new
883 | Enabled: true
884 | Layout/Tab:
885 | Description: No hard tabs.
886 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#spaces-indentation
887 | Enabled: true
888 | Layout/TrailingWhitespace:
889 | Description: Avoid trailing whitespace.
890 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-trailing-whitespace
891 | Enabled: true
892 | Style/UnlessElse:
893 | Description: Do not use unless with else. Rewrite these with the positive case first.
894 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-else-with-unless
895 | Enabled: true
896 | Style/UnneededCapitalW:
897 | Description: Checks for %W when interpolation is not needed.
898 | Enabled: true
899 | Style/UnneededPercentQ:
900 | Description: Checks for %q/%Q when single quotes or double quotes would do.
901 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-q
902 | Enabled: true
903 | Style/VariableInterpolation:
904 | Description: Don't interpolate global, instance and class variables directly in
905 | strings.
906 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
907 | Enabled: false
908 | Style/WhenThen:
909 | Description: Use when x then ... for one-line cases.
910 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
911 | Enabled: false
912 | Style/WhileUntilDo:
913 | Description: Checks for redundant do after while or until.
914 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-multiline-while-do
915 | Enabled: true
916 | Lint/AmbiguousOperator:
917 | Description: Checks for ambiguous operators in the first argument of a method invocation
918 | without parentheses.
919 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#parens-as-args
920 | Enabled: false
921 | Lint/AmbiguousRegexpLiteral:
922 | Description: Checks for ambiguous regexp literals in the first argument of a method
923 | invocation without parenthesis.
924 | Enabled: false
925 | Lint/BlockAlignment:
926 | Description: Align block ends correctly.
927 | Enabled: true
928 | Lint/ConditionPosition:
929 | Description: Checks for condition placed in a confusing position relative to the
930 | keyword.
931 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#same-line-condition
932 | Enabled: false
933 | Lint/Debugger:
934 | Description: Check for debugger calls.
935 | Enabled: true
936 | Lint/DeprecatedClassMethods:
937 | Description: Check for deprecated class method calls.
938 | Enabled: false
939 | Lint/DuplicateMethods:
940 | Description: Check for duplicate methods calls.
941 | Enabled: true
942 | Lint/ElseLayout:
943 | Description: Check for odd code arrangement in an else block.
944 | Enabled: false
945 | Lint/EmptyEnsure:
946 | Description: Checks for empty ensure block.
947 | Enabled: true
948 | Lint/EmptyInterpolation:
949 | Description: Checks for empty string interpolation.
950 | Enabled: true
951 | Lint/EndInMethod:
952 | Description: END blocks should not be placed inside method definitions.
953 | Enabled: true
954 | Lint/EnsureReturn:
955 | Description: Do not use return in an ensure block.
956 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-return-ensure
957 | Enabled: true
958 | Security/Eval:
959 | Description: The use of eval represents a serious security risk.
960 | Enabled: true
961 | Lint/HandleExceptions:
962 | Description: Don't suppress exception.
963 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
964 | Enabled: false
965 | Lint/InvalidCharacterLiteral:
966 | Description: Checks for invalid character literals with a non-escaped whitespace
967 | character.
968 | Enabled: false
969 | Lint/LiteralInCondition:
970 | Description: Checks of literals used in conditions.
971 | Enabled: false
972 | Lint/LiteralInInterpolation:
973 | Description: Checks for literals used in interpolation.
974 | Enabled: false
975 | Lint/Loop:
976 | Description: Use Kernel#loop with break rather than begin/end/until or begin/end/while
977 | for post-loop tests.
978 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#loop-with-break
979 | Enabled: false
980 | Lint/ParenthesesAsGroupedExpression:
981 | Description: Checks for method calls with a space before the opening parenthesis.
982 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#parens-no-spaces
983 | Enabled: false
984 | Lint/RequireParentheses:
985 | Description: Use parentheses in the method call to avoid confusion about precedence.
986 | Enabled: false
987 | Lint/RescueException:
988 | Description: Avoid rescuing the Exception class.
989 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-blind-rescues
990 | Enabled: true
991 | Lint/ShadowingOuterLocalVariable:
992 | Description: Do not use the same name as outer local variable for block arguments
993 | or block local variables.
994 | Enabled: true
995 | Lint/StringConversionInInterpolation:
996 | Description: Checks for Object#to_s usage in string interpolation.
997 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-to-s
998 | Enabled: true
999 | Lint/UnderscorePrefixedVariableName:
1000 | Description: Do not use prefix `_` for a variable that is used.
1001 | Enabled: false
1002 | Lint/UnusedBlockArgument:
1003 | Description: Checks for unused block arguments.
1004 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars
1005 | Enabled: true
1006 | Lint/UnusedMethodArgument:
1007 | Description: Checks for unused method arguments.
1008 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars
1009 | Enabled: true
1010 | Lint/UnreachableCode:
1011 | Description: Unreachable code.
1012 | Enabled: true
1013 | Lint/UselessAccessModifier:
1014 | Description: Checks for useless access modifiers.
1015 | Enabled: true
1016 | Lint/UselessAssignment:
1017 | Description: Checks for useless assignment to a local variable.
1018 | StyleGuide: https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars
1019 | Enabled: true
1020 | Lint/UselessComparison:
1021 | Description: Checks for comparison of something with itself.
1022 | Enabled: true
1023 | Lint/UselessElseWithoutRescue:
1024 | Description: Checks for useless `else` in `begin..end` without `rescue`.
1025 | Enabled: true
1026 | Lint/UselessSetterCall:
1027 | Description: Checks for useless setter call to a local variable.
1028 | Enabled: true
1029 | Lint/Void:
1030 | Description: Possible use of operator/literal/variable in void context.
1031 | Enabled: false
1032 | Rails/Delegate:
1033 | Description: Prefer delegate method for delegations.
1034 | Enabled: false
1035 | Performance/RedundantBlockCall:
1036 | Description: Use `yield` instead of `block.call`.
1037 | Reference: https://github.com/JuanitoFatas/fast-ruby#proccall-vs-yield-code
1038 | Enabled: false
1039 |
--------------------------------------------------------------------------------