standard 0.0.16

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of standard might be problematic. Click here for more details.

checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 560e88462741e3d75953bb7124406978e5b6b00819bf17483e2a275deaf892de
4
+ data.tar.gz: f0a16ceab3ab5f6ff653f4f0cde6bdc3adc2058832524e8ff63891f5b98d100b
5
+ SHA512:
6
+ metadata.gz: 39fa3bfd25aa8acdf9f010ca3010f5c893cdc36c6ac79dcbc90f45eb7ba1aaf7bd981bd3364beac7d75326b171b42c69115fa2054f6c2637cd57aa9fa05c00d0
7
+ data.tar.gz: 144a8065a830b1d219129808e428018b0e6f94ee017dd02d7f782affa6065c8cc44a784e0cc89afcec3f565cf3ebc2095c40fa7e77d5ed3795997e4dc2677608
@@ -0,0 +1,35 @@
1
+ # Ruby CircleCI 2.0 configuration file
2
+ #
3
+ # Check https://circleci.com/docs/2.0/language-ruby/ for more details
4
+ #
5
+ version: 2
6
+ jobs:
7
+ build:
8
+ docker:
9
+ - image: circleci/ruby:2.4.1-node-browsers
10
+ working_directory: ~/repo
11
+
12
+ steps:
13
+ - checkout
14
+ - restore_cache:
15
+ keys:
16
+ - v1-dependencies-{{ checksum "Gemfile.lock" }}
17
+ - v1-dependencies-
18
+
19
+ - run:
20
+ name: install dependencies
21
+ command: |
22
+ bundle install --jobs=4 --retry=3 --path vendor/bundle
23
+
24
+ - save_cache:
25
+ paths:
26
+ - ./vendor/bundle
27
+ key: v1-dependencies-{{ checksum "Gemfile.lock" }}
28
+
29
+ - run:
30
+ name: test
31
+ command: bundle exec rake test
32
+
33
+ - run:
34
+ name: lint
35
+ command: bundle exec rake standard:fix
data/.gitignore ADDED
@@ -0,0 +1,8 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
data/.standard.yml ADDED
@@ -0,0 +1,4 @@
1
+ ruby_version: 2.2.0
2
+ ignore:
3
+ - tmp/**/*
4
+ - test/fixture/**/*
data/Gemfile ADDED
@@ -0,0 +1,3 @@
1
+ source "https://rubygems.org"
2
+
3
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,54 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ standard (0.0.16)
5
+ rubocop (>= 0.60)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ ast (2.4.0)
11
+ coderay (1.1.2)
12
+ docile (1.3.1)
13
+ jaro_winkler (1.5.1)
14
+ json (2.1.0)
15
+ method_source (0.9.2)
16
+ minitest (5.11.3)
17
+ parallel (1.12.1)
18
+ parser (2.5.3.0)
19
+ ast (~> 2.4.0)
20
+ powerpack (0.1.2)
21
+ pry (0.12.2)
22
+ coderay (~> 1.1.0)
23
+ method_source (~> 0.9.0)
24
+ rainbow (3.0.0)
25
+ rake (10.5.0)
26
+ rubocop (0.61.1)
27
+ jaro_winkler (~> 1.5.1)
28
+ parallel (~> 1.10)
29
+ parser (>= 2.5, != 2.5.1.1)
30
+ powerpack (~> 0.1)
31
+ rainbow (>= 2.2.2, < 4.0)
32
+ ruby-progressbar (~> 1.7)
33
+ unicode-display_width (~> 1.4.0)
34
+ ruby-progressbar (1.10.0)
35
+ simplecov (0.16.1)
36
+ docile (~> 1.1)
37
+ json (>= 1.8, < 3)
38
+ simplecov-html (~> 0.10.0)
39
+ simplecov-html (0.10.2)
40
+ unicode-display_width (1.4.0)
41
+
42
+ PLATFORMS
43
+ ruby
44
+
45
+ DEPENDENCIES
46
+ bundler (~> 1.17)
47
+ minitest (~> 5.0)
48
+ pry
49
+ rake (~> 10.0)
50
+ simplecov
51
+ standard!
52
+
53
+ BUNDLED WITH
54
+ 1.17.1
data/LICENSE.txt ADDED
@@ -0,0 +1,24 @@
1
+ Copyright (c) 2018 Test Double, LLC
2
+
3
+ Portions of these files Copyright (c) 2012-18 Bozhidar Batsov:
4
+ - config/base.yml
5
+ - lib/standard/cop/semantic_blocks.rb
6
+
7
+ Permission is hereby granted, free of charge, to any person obtaining
8
+ a copy of this software and associated documentation files (the
9
+ "Software"), to deal in the Software without restriction, including
10
+ without limitation the rights to use, copy, modify, merge, publish,
11
+ distribute, sublicense, and/or sell copies of the Software, and to
12
+ permit persons to whom the Software is furnished to do so, subject to
13
+ the following conditions:
14
+
15
+ The above copyright notice and this permission notice shall be
16
+ included in all copies or substantial portions of the Software.
17
+
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,325 @@
1
+ ## Standard - Ruby style guide, linter, and formatter
2
+
3
+ [![CircleCI](https://circleci.com/gh/testdouble/standard.svg?style=svg)](https://circleci.com/gh/testdouble/standard)
4
+
5
+ This gem is a spiritual port of [StandardJS](https://standardjs.com) and aims
6
+ to save you (and others!) time in the same three ways:
7
+
8
+ * **No configuration.** The easiest way to enforce consistent style in your
9
+ project. Just drop it in.
10
+ * **Automatically format code.** Just run `standardrb --fix` and say goodbye to
11
+ messy or inconsistent code.
12
+ * **Catch style issues & programmer errors early.** Save precious code review
13
+ time by eliminating back-and-forth between reviewer & contributor.
14
+
15
+ No decisions to make. It just works. Here's a [⚡ lightning talk ⚡](https://www.youtube.com/watch?v=uLyV5hOqGQ8) about it.
16
+
17
+ Install by adding it to your Gemfile:
18
+
19
+ ```ruby
20
+ gem "standard", group: [:development, :test]
21
+ ```
22
+
23
+ And running `bundle install`.
24
+
25
+ Run Standard from the command line with:
26
+
27
+ ```ruby
28
+ $ bundle exec standardrb
29
+ ```
30
+
31
+ And if you'd like, Standard can autocorrect your code by tacking on a `--fix`
32
+ flag.
33
+
34
+ ## StandardRB — The Rules
35
+
36
+ - **2 spaces** – for indentation
37
+ - **Double quotes for string literals** - because pre-committing to whether
38
+ you'll need interpolation in a string slows people down
39
+ - **1.9 hash syntax** - When all the keys in a hash literal are symbols,
40
+ Standard enforces Ruby 1.9's `{hash: syntax}`
41
+ - **Semantic blocks** - `{`/`}` for functional blocks that return a value, and
42
+ `do`/`end` for procedural blocks that have side effects. More
43
+ [here](http://www.virtuouscode.com/2011/07/26/the-procedurefunction-block-convention-in-ruby/)
44
+ and [here](https://github.com/rubocop-hq/ruby-style-guide/issues/162)
45
+ - **Trailing dots on multi-line method chains** - chosen because it makes
46
+ copying lines into a REPL easier
47
+ - **And a good deal more**
48
+
49
+ If you're familiar with [RuboCop](https://github.com/rubocop-hq/rubocop), you
50
+ can look at Standard's current base configuration in
51
+ [config/base.yml](/config/base.yml).
52
+
53
+ **[NOTE: until StandardRB hits 1.0.0, we consider this configuration to be a
54
+ non-final work in progress and we encourage you to submit your opinions (and
55
+ reasoned arguments) for the addition, removal, or change to a rule by [opening
56
+ an issue](https://github.com/testdouble/standard/issues/new). If you start using
57
+ Standard, don't be shocked if things change a bit!]**
58
+
59
+ ## Usage
60
+
61
+ Once you've installed Standard, you should be able to use the `standardrb`
62
+ program. The simplest use case would be checking the style of all Ruby
63
+ files in the current working directory:
64
+
65
+ ```bash
66
+ $ bundle exec standardrb
67
+ standard: Use Ruby Standard Style (https://github.com/testdouble/standard)
68
+ standard: Run `standardrb --fix` to automatically fix some problems.
69
+ /Users/code/cli.rb:31:23: Style/Semicolon: Do not use semicolons to terminate expressions.
70
+ ```
71
+
72
+ You can optionally pass in a directory (or directories) using the glob pattern. Be
73
+ sure to quote paths containing glob patterns so that they are expanded by
74
+ `standardrb` instead of your shell:
75
+
76
+ ```bash
77
+ $ bundle exec standardrb "lib/**/*.rb" test
78
+ ```
79
+
80
+ **Note:** by default, StandardRB will look for all `*.rb` files (and some other
81
+ files typically associated with Ruby like `*.gemspec` and `Gemfile`)
82
+
83
+ ### Using with Rake
84
+
85
+ Standard also ships with Rake tasks. If you're using Rails, these should
86
+ autoload and be available after installing Standard. Otherwise, just require the
87
+ tasks in your `Rakefile`:
88
+
89
+ ```ruby
90
+ require "standard/rake"
91
+ ```
92
+
93
+ Here are the tasks bundled with Standard:
94
+
95
+ ```
96
+ $ rake standard # equivalent to running `standardrb`
97
+ $ rake standard:fix # equivalent to running `standardrb --fix`
98
+ ```
99
+
100
+ You may also pass command line options to Standard's Rake tasks by embedding
101
+ them in a `STANDARDOPTS` environment variable (similar to how the Minitest Rake
102
+ task accepts CLI options in `TESTOPTS`).
103
+
104
+ ```
105
+ # equivalent to `standardrb --format progress`:
106
+ $ rake standard STANDARDOPTS="--format progress"
107
+
108
+ # equivalent to `standardrb lib "app/**/*"`, to lint just certain paths:
109
+ $ rake standard STANDARDOPTS="lib \"app/**/*\""
110
+ ```
111
+
112
+ ## What you might do if you're clever
113
+
114
+ If you want or need to configure Standard, there are a _handful_ of options
115
+ are available creating a `.standard.yml` file in the root of your project.
116
+
117
+ Here's an example yaml file with every option set:
118
+
119
+ ```yaml
120
+ fix: true
121
+ parallel: true
122
+ format: progress
123
+ ruby_version: 2.3.3
124
+
125
+ ignore:
126
+ - 'db/schema.rb'
127
+ - 'vendor/bundle/**/*'
128
+ - 'test/**/*':
129
+ - Layout/AlignHash
130
+ ```
131
+
132
+ Note: If you're running Standard in a context where your `.standard.yml` file
133
+ cannot be found by ascending the current working directory (i.e. against a
134
+ temporary file buffer in your editor), you can specify the config location with
135
+ `--config path/to/.standard.yml`.
136
+
137
+ ## What you might do if you're REALLY clever
138
+
139
+ Because StandardRB is essentially a wrapper on top of
140
+ [RuboCop](https://github.com/rubocop-hq/rubocop), it will actually forward the
141
+ vast majority of CLI and ENV arguments forward to RuboCop.
142
+
143
+ You can see a list of
144
+ [RuboCop](https://docs.rubocop.org/en/latest/basic_usage/#other-useful-command-line-flags)'s
145
+ CLI flags here.
146
+
147
+ ## Why should I use Ruby Standard Style?
148
+
149
+ (This section will [look
150
+ familiar](https://github.com/standard/standard#why-should-i-use-javascript-standard-style)
151
+ if you've used StandardJS.)
152
+
153
+ The beauty of Ruby Standard Style is that it's simple. No one wants to
154
+ maintain multiple hundred-line style configuration files for every module/project
155
+ they work on. Enough of this madness!
156
+
157
+ This gem saves you (and others!) time in three ways:
158
+
159
+ - **No configuration.** The easiest way to enforce consistent style in your
160
+ project. Just drop it in.
161
+ - **Automatically format code.** Just run `standardrb --fix` and say goodbye to
162
+ messy or inconsistent code.
163
+ - **Catch style issues & programmer errors early.** Save precious code review
164
+ time by eliminating back-and-forth between reviewer & contributor.
165
+
166
+ Adopting Standard style means ranking the importance of code clarity and
167
+ community conventions higher than personal style. This might not make sense for
168
+ 100% of projects and development cultures, however open source can be a hostile
169
+ place for newbies. Setting up clear, automated contributor expectations makes a
170
+ project healthier.
171
+
172
+ ## Who uses Ruby Standard Style?
173
+
174
+ (This section will not [look very
175
+ familiar](https://github.com/standard/standard#who-uses-javascript-standard-style)
176
+ if you've used StandardJS.)
177
+
178
+ * [Test Double](https://testdouble.com/agency)
179
+ * And that's about it so far!
180
+
181
+ If your team starts using Standard, [send a pull
182
+ request](https://github.com/testdouble/standard/edit/master/README.md) to let us
183
+ know!
184
+
185
+ ## Is there a readme badge?
186
+
187
+ Yes! If you use Standard in your project, you can include one of these
188
+ badges in your readme to let people know that your code is using the StandardRB
189
+ style.
190
+
191
+ [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
192
+
193
+ ```md
194
+ [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
195
+ ```
196
+
197
+ ## I disagree with rule X, can you change it?
198
+
199
+ **[NOTE: until StandardRB hits 1.0.0, the answer is yes! It just requires
200
+ [opening an issue](https://github.com/testdouble/standard/issues/new) and
201
+ convincing [@searls](https://twitter.com/searls) (the BDFNow) to make the
202
+ change.]**
203
+
204
+ No. The whole point of Standard is to save you time by avoiding
205
+ [bikeshedding](https://www.freebsd.org/doc/en/books/faq/misc.html#bikeshed-painting)
206
+ about code style. There are lots of debates online about tabs vs. spaces, etc.
207
+ that will never be resolved. These debates just distract from getting stuff
208
+ done. At the end of the day you have to 'just pick something', and that's the
209
+ whole philosophy of Standard -- its a bunch of sensible 'just pick something'
210
+ opinions. Hopefully, users see the value in that over defending their own
211
+ opinions.
212
+
213
+ Pro tip: Just use Standard and move on. There are actual real problems that
214
+ you could spend your time solving! :P
215
+
216
+ ## Is there an automatic formatter?
217
+
218
+ Yes! You can use `standardrb --fix` to fix most issues automatically.
219
+
220
+ `standardrb --fix` is built into `standardrb` for maximum convenience. Most
221
+ problems are fixable, but some errors must be fixed manually.
222
+
223
+ ## How do I ignore files?
224
+
225
+ Sometimes you need to ignore additional folders or specific minified files. To
226
+ do that, add a `.standard.yml` file to the root of your project and specify a
227
+ list of files and globs that should be excluded:
228
+
229
+ ```yaml
230
+ ignore:
231
+ - 'db/schema.rb'
232
+ - 'vendor/bundle/**/*'
233
+ ```
234
+
235
+ ## How do I hide a certain warning?
236
+
237
+ In rare cases, you'll need to break a rule and hide the warning generated by
238
+ Standard.
239
+
240
+ Ruby Standard Style uses [RuboCop](https://github.com/rubocop-hq/rubocop)
241
+ under-the-hood and you can hide warnings as you normally would if you used
242
+ RuboCop directly.
243
+
244
+ To ignore only certain rules from certain globs (not recommended, but maybe your
245
+ test suite uses a non-standardable DSL, you can specify an array of RuboCop
246
+ rules to ignore for a particular glob:
247
+
248
+ ```yaml
249
+ ignore:
250
+ - 'test/**/*':
251
+ - Style/BlockDelimiters
252
+ ```
253
+
254
+ You can also use special comments to disable all or certain rules within your
255
+ source code. See [RuboCop's
256
+ docs](https://docs.rubocop.org/en/latest/configuration/#disabling-cops-within-source-code)
257
+ for details.
258
+
259
+ ## How do I specify a Ruby version? What is supported?
260
+
261
+ Because Standard wraps RuboCop, they share the same [runtime
262
+ requirements](https://github.com/rubocop-hq/rubocop#compatibility)—currently,
263
+ that's MRI 2.2 and newer. While Standard can't avoid this runtime requirement,
264
+ it does allow you to lint codebases that target Ruby versions older than 2.2 by
265
+ narrowing the ruleset somewhat.
266
+
267
+ Standard will default to telling RuboCop to target the currently running version
268
+ of Ruby (by inspecting `RUBY_VERSION` at runtime. But if you want to lock it
269
+ down, you can specify `ruby_version` in `.standard.yml`.
270
+
271
+ ```
272
+ ruby_version: 1.8.7
273
+ ```
274
+
275
+ See
276
+ [testdouble/suture](https://github.com/testdouble/suture/blob/master/.standard.yml)
277
+ for an example.
278
+
279
+ It's a little confusing to consider, but the targeted Ruby version for linting
280
+ may or may not match the version of the runtime (suppose you're on Ruby 2.5.1,
281
+ but your library supports Ruby 2.2.0). In this case, specify `ruby_version` and
282
+ you should be okay. However, note that if you target a _newer_ Ruby version than
283
+ the runtime, RuboCop may behave in surprising or inconsistent ways.
284
+
285
+ If you are targeting a Ruby older than 2.2 and run into an issue, check out
286
+ Standard's [version-specific RuboCop
287
+ configurations](https://github.com/testdouble/standard/tree/master/config) and
288
+ consider helping out by submitting a pull request if you find a rule that won't
289
+ work for older Rubies.
290
+
291
+ ## How do I change the output?
292
+
293
+ Standard's built-in formatter is intentionally minimal, printing only unfixed
294
+ failures or (when successful) printing nothing at all. If you'd like to use a
295
+ different formatter, you can specify any of RuboCop's built-in formatters or
296
+ write your own.
297
+
298
+ For example, if you'd like to see colorful progress dots, you can either run
299
+ Standard with:
300
+
301
+ ```
302
+ $ bundle exec standardrb --format progress
303
+ Inspecting 15 files
304
+ ...............
305
+
306
+ 15 files inspected, no offenses detected
307
+ ```
308
+
309
+ Or, in your project's `.standard.yml` file, specify:
310
+
311
+ ```yaml
312
+ format: progress
313
+ ```
314
+
315
+ Refer to RuboCop's [documentation on
316
+ formatters](https://rubocop.readthedocs.io/en/latest/formatters/) for more
317
+ information.
318
+
319
+ ## How do I run standard in my editor?
320
+
321
+ It can be very handy to know about failures while editing to shorten the
322
+ feedback loop. Some editors support asynchronously running linters.
323
+
324
+ * **Vim and ALE**: You can override the built-in rubocop with standard with `let g:ale_ruby_rubocop_executable = 'standardrb'`
325
+
data/Rakefile ADDED
@@ -0,0 +1,11 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+ require_relative "lib/standard/rake"
4
+
5
+ Rake::TestTask.new(:test) do |t|
6
+ t.libs << "test"
7
+ t.libs << "lib"
8
+ t.test_files = FileList["test/**/*_test.rb"]
9
+ end
10
+
11
+ task default: ["standard:fix", :test]
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "standard"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here