pronto-bigfiles 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +7 -0
  2. data/.circleci/config.yml +20 -0
  3. data/.gitignore +15 -0
  4. data/.pronto.yml +5 -0
  5. data/.rspec +3 -0
  6. data/.rubocop.yml +74 -0
  7. data/.ruby-version +1 -0
  8. data/.travis.yml +16 -0
  9. data/CODE_OF_CONDUCT.md +76 -0
  10. data/Gemfile +6 -0
  11. data/Gemfile.lock +234 -0
  12. data/LICENSE.txt +21 -0
  13. data/Makefile +16 -0
  14. data/README.md +78 -0
  15. data/Rakefile +0 -0
  16. data/bin/console +15 -0
  17. data/bin/setup +8 -0
  18. data/coverage/.last_run.json +5 -0
  19. data/exe/pronto-bigfiles +4 -0
  20. data/feature/pronto/big_files_cli_spec.rb +88 -0
  21. data/feature/spec_helper.rb +0 -0
  22. data/lib/pronto/bigfiles/message_creator.rb +31 -0
  23. data/lib/pronto/bigfiles/patch_inspector.rb +45 -0
  24. data/lib/pronto/bigfiles/patch_wrapper.rb +28 -0
  25. data/lib/pronto/bigfiles/version.rb +7 -0
  26. data/lib/pronto/bigfiles.rb +35 -0
  27. data/metrics/bigfiles_high_water_mark +1 -0
  28. data/metrics/brakeman_high_water_mark +1 -0
  29. data/metrics/bundle-audit_high_water_mark +1 -0
  30. data/metrics/cane_high_water_mark +1 -0
  31. data/metrics/eslint_high_water_mark +1 -0
  32. data/metrics/flake8_high_water_mark +1 -0
  33. data/metrics/flay_high_water_mark +1 -0
  34. data/metrics/flog_high_water_mark +1 -0
  35. data/metrics/jscs_high_water_mark +1 -0
  36. data/metrics/mdl_high_water_mark +1 -0
  37. data/metrics/punchlist_high_water_mark +1 -0
  38. data/metrics/pycodestyle_high_water_mark +1 -0
  39. data/metrics/rails_best_practices_high_water_mark +1 -0
  40. data/metrics/rubocop_high_water_mark +1 -0
  41. data/metrics/scalastyle_high_water_mark +1 -0
  42. data/metrics/shellcheck_high_water_mark +1 -0
  43. data/pronto-bigfiles.gemspec +49 -0
  44. data/rakelib/ci.rake +4 -0
  45. data/rakelib/clear_metrics.rake +8 -0
  46. data/rakelib/default.rake +3 -0
  47. data/rakelib/feature.rake +9 -0
  48. data/rakelib/gem_tasks.rake +3 -0
  49. data/rakelib/localtest.rake +4 -0
  50. data/rakelib/pronto.rake +15 -0
  51. data/rakelib/quality.rake +23 -0
  52. data/rakelib/spec.rake +9 -0
  53. data/rakelib/update_bundle_audit.rake +6 -0
  54. metadata +243 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 547b8555928cb6ec3cf06fcace116f15147787a9
4
+ data.tar.gz: d2061ef52d8cc509886d973c6b05b27bc34001f1
5
+ SHA512:
6
+ metadata.gz: dc83abd9583ab1ac3ad6f3f7469c4ba6b91584f010a05c14da898b813e552ee5057bc618b6d1b50ada604c2190c6060eead256c08818a8d701602b07c216fd30
7
+ data.tar.gz: b8a5e64683dab462145ff1adaf3bdaa66bd55a43a53baa7154daba706f99fe2fd3faba1aaee4ed5dd1c56a08d652e9e61e3f1a3b0509bf3aa6c244e7025e7972
@@ -0,0 +1,20 @@
1
+ version: 2
2
+ jobs:
3
+ build:
4
+ working_directory: ~/pronto-bigfiles
5
+ docker:
6
+ - image: apiology/circleci-ruby:latest
7
+ steps:
8
+ - checkout
9
+ - type: cache-restore
10
+ key: pronto-bigfiles-{{ checksum "pronto-bigfiles.gemspec" }}-{{ checksum "Gemfile" }}
11
+ # https://bundler.io/blog/2019/05/14/
12
+ # solutions-for-cant-find-gem-bundler-with-executable-bundle.html
13
+ - run: sudo gem update --system
14
+ - run: gem install bundler
15
+ - run: bundle install --path vendor/bundle --jobs=4
16
+ - run: bundle exec rake --jobs=4 ci
17
+ - type: cache-save
18
+ key: pronto-bigfiles-{{ checksum "pronto-bigfiles.gemspec" }}-{{ checksum "Gemfile" }}
19
+ paths:
20
+ - "vendor/bundle"
data/.gitignore ADDED
@@ -0,0 +1,15 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /doc/
5
+ /pkg/
6
+ /spec/reports/
7
+ /tmp/
8
+
9
+ # rspec failure tracking
10
+ .rspec_status
11
+ /coverage/.resultset.json
12
+ /coverage/.resultset.json.lock
13
+ /coverage/assets/
14
+ /coverage/index.html
15
+ /pkg
data/.pronto.yml ADDED
@@ -0,0 +1,5 @@
1
+ text:
2
+ format: "%{color_location}: [%{runner}] %{msg}"
3
+
4
+ github_pr:
5
+ format: "[%{runner}] %{msg}"
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,74 @@
1
+ # I like trailing commas in hashes. They let me insert new elements and
2
+ # see them as one line in a diff, not two.
3
+ Style/TrailingCommaInHashLiteral:
4
+ EnforcedStyleForMultiline: comma
5
+
6
+ Style/TrailingCommaInArrayLiteral:
7
+ EnforcedStyleForMultiline: comma
8
+
9
+ # I use keyword arguments for a poor man's dependency injection to cut
10
+ # down on the magic in my tests.
11
+ Metrics/ParameterLists:
12
+ CountKeywordArgs: false
13
+
14
+ # If i'm using one function name and returning the contents of an
15
+ # attribute, that's OK. The alternative would be this, which I find
16
+ # confusing and often not really what I mean:
17
+ #
18
+ # attr_reader :something_else
19
+ # alias_method :something, :something_else
20
+ Style/TrivialAccessors:
21
+ ExactNameMatch: true
22
+
23
+ #
24
+ # Add 'XX X' to the standard list
25
+ #
26
+ Style/CommentAnnotation:
27
+ Keywords:
28
+ - "TOD\
29
+ O"
30
+ - "FIXM\
31
+ E"
32
+ - "OPTIMIZ\
33
+ E"
34
+ - "HAC\
35
+ K"
36
+ - "REVIE\
37
+ W"
38
+ - "XX\
39
+ X"
40
+
41
+ # https://stackoverflow.com/questions/40934345/rubocop-25-line-block-size-and-rspec-tests
42
+ Metrics/BlockLength:
43
+ # Exclude DSLs
44
+ Exclude:
45
+ - 'Rakefile'
46
+ - '*.gemspec'
47
+ - '**/*.rake'
48
+ - 'spec/**/*.rb'
49
+ - 'feature/**/*.rb'
50
+
51
+ # http://www.betterspecs.org/#single
52
+ #
53
+ # > in tests that are not isolated (e.g. ones that integrate with a
54
+ # > DB, an external webservice, or end-to-end-tests), you take a
55
+ # > massive performance hit to do the same setup over and over again,
56
+ # > just to set a different expectation in each test. In these sorts
57
+ # > of slower tests, I think it's fine to specify more than one
58
+ # > isolated behavior.
59
+ RSpec/MultipleExpectations:
60
+ Exclude:
61
+ - 'feature/**/*.rb'
62
+
63
+ Style/StringLiterals:
64
+ EnforcedStyle: single_quotes
65
+ SupportedStyles:
66
+ - single_quotes
67
+ - double_quotes
68
+ ConsistentQuotesInMultiline: true
69
+
70
+ AllCops:
71
+ TargetRubyVersion: 2.4
72
+
73
+
74
+ require: rubocop-rspec
data/.ruby-version ADDED
@@ -0,0 +1 @@
1
+ ruby-2.4.9
data/.travis.yml ADDED
@@ -0,0 +1,16 @@
1
+ language: ruby
2
+ before_install:
3
+ # https://bundler.io/blog/2019/05/14/
4
+ # solutions-for-cant-find-gem-bundler-with-executable-bundle.html
5
+ - gem update --system
6
+ - gem install bundler
7
+ rvm:
8
+ # JRuby error with native code build - possibly can be overcome?
9
+ # checking for main() in -lstdc++... RuntimeError: The compiler failed to generate
10
+ # https://travis-ci.com/apiology/pronto-punchlist/jobs/264907931
11
+ # - jruby-head
12
+ - ruby-head
13
+ - ruby-2.7
14
+ - ruby-2.6
15
+ - ruby-2.5
16
+ - ruby-2.4
@@ -0,0 +1,76 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual
26
+ attention or advances
27
+ * Trolling, insulting/derogatory comments, and personal or political
28
+ attacks
29
+ * Public or private harassment
30
+ * Publishing others' private information, such as a physical or electronic
31
+ address, without explicit permission
32
+ * Other conduct which could reasonably be considered inappropriate in a
33
+ professional setting
34
+
35
+ ## Our Responsibilities
36
+
37
+ Project maintainers are responsible for clarifying the standards of acceptable
38
+ behavior and are expected to take appropriate and fair corrective action in
39
+ response to any instances of unacceptable behavior.
40
+
41
+ Project maintainers have the right and responsibility to remove, edit, or
42
+ reject comments, commits, code, wiki edits, issues, and other contributions
43
+ that are not aligned to this Code of Conduct, or to ban temporarily or
44
+ permanently any contributor for other behaviors that they deem inappropriate,
45
+ threatening, offensive, or harmful.
46
+
47
+ ## Scope
48
+
49
+ This Code of Conduct applies both within project spaces and in public spaces
50
+ when an individual is representing the project or its community. Examples of
51
+ representing a project or community include using an official project e-mail
52
+ address, posting via an official social media account, or acting as an appointed
53
+ representative at an online or offline event. Representation of a project may be
54
+ further defined and clarified by project maintainers.
55
+
56
+ ## Enforcement
57
+
58
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
59
+ reported by contacting the project team at vince@broz.cc. All
60
+ complaints will be reviewed and investigated and will result in a response that
61
+ is deemed necessary and appropriate to the circumstances. The project team is
62
+ obligated to maintain confidentiality with regard to the reporter of an incident.
63
+ Further details of specific enforcement policies may be posted separately.
64
+
65
+ Project maintainers who do not follow or enforce the Code of Conduct in good
66
+ faith may face temporary or permanent repercussions as determined by other
67
+ members of the project's leadership.
68
+
69
+ ## Attribution
70
+
71
+ This Code of Conduct is adapted from the
72
+ [Contributor Covenant][homepage], version 1.4, available at
73
+ [https://contributor-covenant.org/version/1/4][version]
74
+
75
+ [homepage]: https://contributor-covenant.org
76
+ [version]: https://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ # Specify your gem's dependencies in pronto-bigfiles.gemspec
6
+ gemspec
data/Gemfile.lock ADDED
@@ -0,0 +1,234 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ pronto-bigfiles (0.1.0)
5
+ bigfiles (>= 0.2.0)
6
+ pronto
7
+ quality (>= 37)
8
+
9
+ GEM
10
+ remote: https://rubygems.org/
11
+ specs:
12
+ activesupport (5.2.4.1)
13
+ concurrent-ruby (~> 1.0, >= 1.0.2)
14
+ i18n (>= 0.7, < 2)
15
+ minitest (~> 5.1)
16
+ tzinfo (~> 1.1)
17
+ addressable (2.7.0)
18
+ public_suffix (>= 2.0.2, < 5.0)
19
+ ast (2.4.0)
20
+ axiom-types (0.1.1)
21
+ descendants_tracker (~> 0.0.4)
22
+ ice_nine (~> 0.11.0)
23
+ thread_safe (~> 0.3, >= 0.3.1)
24
+ bigfiles (0.2.0)
25
+ source_finder (>= 2)
26
+ brakeman (4.7.2)
27
+ bundler-audit (0.6.1)
28
+ bundler (>= 1.2.0, < 3)
29
+ thor (~> 0.18)
30
+ cane (3.0.0)
31
+ parallel
32
+ charlock_holmes (0.7.7)
33
+ code_analyzer (0.5.1)
34
+ sexp_processor
35
+ codeclimate-engine-rb (0.3.1)
36
+ virtus (~> 1.0)
37
+ coercible (1.0.0)
38
+ descendants_tracker (~> 0.0.1)
39
+ concurrent-ruby (1.1.5)
40
+ descendants_tracker (0.0.4)
41
+ thread_safe (~> 0.3, >= 0.3.1)
42
+ diff-lcs (1.3)
43
+ docile (1.3.2)
44
+ domain_name (0.5.20190701)
45
+ unf (>= 0.0.5, < 1.0.0)
46
+ equalizer (0.0.11)
47
+ erubis (2.7.0)
48
+ escape_utils (1.2.1)
49
+ faraday (0.17.3)
50
+ multipart-post (>= 1.2, < 3)
51
+ flay (2.12.1)
52
+ erubis (~> 2.7.0)
53
+ path_expander (~> 1.0)
54
+ ruby_parser (~> 3.0)
55
+ sexp_processor (~> 4.0)
56
+ flog (4.6.4)
57
+ path_expander (~> 1.0)
58
+ ruby_parser (~> 3.1, > 3.1.0)
59
+ sexp_processor (~> 4.8)
60
+ github-linguist (7.7.0)
61
+ charlock_holmes (~> 0.7.6)
62
+ escape_utils (~> 1.2.0)
63
+ mini_mime (~> 1.0)
64
+ rugged (>= 0.25.1)
65
+ gitlab (4.13.1)
66
+ httparty (~> 0.14, >= 0.14.0)
67
+ terminal-table (~> 1.5, >= 1.5.1)
68
+ http-accept (1.7.0)
69
+ http-cookie (1.0.3)
70
+ domain_name (~> 0.5)
71
+ httparty (0.17.3)
72
+ mime-types (~> 3.0)
73
+ multi_xml (>= 0.5.2)
74
+ i18n (1.7.0)
75
+ concurrent-ruby (~> 1.0)
76
+ ice_nine (0.11.2)
77
+ jaro_winkler (1.5.4)
78
+ json (2.3.0)
79
+ kramdown (2.1.0)
80
+ kramdown-parser-gfm (1.1.0)
81
+ kramdown (~> 2.0)
82
+ mdl (0.8.0)
83
+ kramdown (~> 2.0)
84
+ kramdown-parser-gfm (~> 1.0)
85
+ mixlib-cli (~> 2.1, >= 2.1.1)
86
+ mixlib-config (>= 2.2.1, < 4)
87
+ mime-types (3.3.1)
88
+ mime-types-data (~> 3.2015)
89
+ mime-types-data (3.2019.1009)
90
+ mini_mime (1.0.2)
91
+ minitest (5.13.0)
92
+ mixlib-cli (2.1.5)
93
+ mixlib-config (3.0.6)
94
+ tomlrb
95
+ multi_xml (0.6.0)
96
+ multipart-post (2.1.1)
97
+ netrc (0.11.0)
98
+ octokit (4.15.0)
99
+ faraday (>= 0.9)
100
+ sawyer (~> 0.8.0, >= 0.5.3)
101
+ parallel (1.19.1)
102
+ parser (2.7.0.1)
103
+ ast (~> 2.4.0)
104
+ path_expander (1.1.0)
105
+ pronto (0.10.0)
106
+ gitlab (~> 4.0, >= 4.0.0)
107
+ httparty (>= 0.13.7)
108
+ octokit (~> 4.7, >= 4.7.0)
109
+ rainbow (>= 2.2, < 4.0)
110
+ rugged (~> 0.24, >= 0.23.0)
111
+ thor (~> 0.20.0)
112
+ pronto-punchlist (0.1.1)
113
+ pronto
114
+ punchlist (>= 1.3.0)
115
+ pronto-rubocop (0.10.0)
116
+ pronto (~> 0.10.0)
117
+ rubocop (~> 0.50, >= 0.49.1)
118
+ public_suffix (4.0.2)
119
+ punchlist (1.3.0)
120
+ source_finder (>= 2)
121
+ quality (37.0.0)
122
+ activesupport
123
+ bigfiles (>= 0.1)
124
+ brakeman
125
+ bundler-audit
126
+ cane (>= 2.6)
127
+ faraday (< 1)
128
+ flay (>= 2.4, != 2.6.0)
129
+ flog (>= 4.1.1)
130
+ github-linguist
131
+ json
132
+ mdl
133
+ punchlist (>= 1.1)
134
+ rails_best_practices
135
+ reek (>= 1.3.4)
136
+ rest-client (>= 1.8.0)
137
+ rubocop (~> 0.78.0)
138
+ rubocop-minitest
139
+ rubocop-rake
140
+ rubocop-rspec (>= 1.19.0)
141
+ ruby_parser (>= 3.2.2, != 3.6.6)
142
+ rails_best_practices (1.19.5)
143
+ activesupport
144
+ code_analyzer (>= 0.5.1)
145
+ erubis
146
+ i18n
147
+ json
148
+ require_all (~> 3.0)
149
+ ruby-progressbar
150
+ rainbow (2.2.2)
151
+ rake
152
+ rake (13.0.1)
153
+ reek (4.0.3)
154
+ codeclimate-engine-rb (~> 0.3.1)
155
+ parser (~> 2.3, >= 2.3.0.6)
156
+ rainbow (~> 2.0)
157
+ require_all (3.0.0)
158
+ rest-client (2.1.0)
159
+ http-accept (>= 1.7.0, < 2.0)
160
+ http-cookie (>= 1.0.2, < 2.0)
161
+ mime-types (>= 1.16, < 4.0)
162
+ netrc (~> 0.8)
163
+ rspec (3.9.0)
164
+ rspec-core (~> 3.9.0)
165
+ rspec-expectations (~> 3.9.0)
166
+ rspec-mocks (~> 3.9.0)
167
+ rspec-core (3.9.1)
168
+ rspec-support (~> 3.9.1)
169
+ rspec-expectations (3.9.0)
170
+ diff-lcs (>= 1.2.0, < 2.0)
171
+ rspec-support (~> 3.9.0)
172
+ rspec-mocks (3.9.1)
173
+ diff-lcs (>= 1.2.0, < 2.0)
174
+ rspec-support (~> 3.9.0)
175
+ rspec-support (3.9.2)
176
+ rubocop (0.78.0)
177
+ jaro_winkler (~> 1.5.1)
178
+ parallel (~> 1.10)
179
+ parser (>= 2.6)
180
+ rainbow (>= 2.2.2, < 4.0)
181
+ ruby-progressbar (~> 1.7)
182
+ unicode-display_width (>= 1.4.0, < 1.7)
183
+ rubocop-minitest (0.5.1)
184
+ rubocop (>= 0.74)
185
+ rubocop-rake (0.5.0)
186
+ rubocop
187
+ rubocop-rspec (1.37.1)
188
+ rubocop (>= 0.68.1)
189
+ ruby-progressbar (1.10.1)
190
+ ruby_parser (3.14.1)
191
+ sexp_processor (~> 4.9)
192
+ rugged (0.28.4.1)
193
+ sawyer (0.8.2)
194
+ addressable (>= 2.3.5)
195
+ faraday (> 0.8, < 2.0)
196
+ sexp_processor (4.13.0)
197
+ simplecov (0.17.1)
198
+ docile (~> 1.1)
199
+ json (>= 1.8, < 3)
200
+ simplecov-html (~> 0.10.0)
201
+ simplecov-html (0.10.2)
202
+ source_finder (3.2.1)
203
+ terminal-table (1.8.0)
204
+ unicode-display_width (~> 1.1, >= 1.1.1)
205
+ thor (0.20.3)
206
+ thread_safe (0.3.6)
207
+ tomlrb (1.2.9)
208
+ tzinfo (1.2.6)
209
+ thread_safe (~> 0.1)
210
+ unf (0.1.4)
211
+ unf_ext
212
+ unf_ext (0.0.7.6)
213
+ unicode-display_width (1.6.0)
214
+ virtus (1.0.5)
215
+ axiom-types (~> 0.1)
216
+ coercible (~> 1.0)
217
+ descendants_tracker (~> 0.0, >= 0.0.3)
218
+ equalizer (~> 0.0, >= 0.0.9)
219
+
220
+ PLATFORMS
221
+ ruby
222
+
223
+ DEPENDENCIES
224
+ bundler (~> 2.0)
225
+ pronto-bigfiles!
226
+ pronto-punchlist
227
+ pronto-rubocop
228
+ quality (~> 37)
229
+ rake
230
+ rspec
231
+ simplecov
232
+
233
+ BUNDLED WITH
234
+ 2.1.2
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019 Vince Broz
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/Makefile ADDED
@@ -0,0 +1,16 @@
1
+ .PHONY: spec feature
2
+
3
+ all:
4
+ @bundle exec rake localtest
5
+
6
+ feature:
7
+ @bundle exec rake feature
8
+
9
+ spec:
10
+ @bundle exec rake spec
11
+
12
+ rubocop:
13
+ @bundle exec rake rubocop
14
+
15
+ punchlist:
16
+ @bundle exec rake punchlist
data/README.md ADDED
@@ -0,0 +1,78 @@
1
+ # Pronto::BigFiles
2
+
3
+ [![CircleCI](https://circleci.com/gh/apiology/pronto-bigfiles.svg?style=svg)](https://circleci.com/gh/apiology/pronto-bigfiles)
4
+
5
+ [![Build Status](https://travis-ci.com/apiology/pronto-bigfiles.svg?branch=master)](https://travis-ci.com/apiology/pronto-bigfiles)
6
+
7
+ Performs incremental quality reporting for the bigfiles gem.
8
+ BigFiles is a simple tool to find the largest source files in your
9
+ project; this gem plugs in with the 'pronto' gem, which does
10
+ incremental reporting using a variety of quality tools.
11
+
12
+ If you add text to a file in the top three largest files, and the
13
+ total number of lines for those three is under 300, you'll get an
14
+ alert.
15
+
16
+ If you've already configured a different threshold using the
17
+ `metrics/bigfiles_high_water_mark` (e.g., using the
18
+ [quality gem](http://github.com/apiology/quality)), pronto-bigfiles will use
19
+ that threshold instead of 300.
20
+
21
+ ## Installation
22
+
23
+ Add this line to your application's Gemfile:
24
+
25
+ ```ruby
26
+ gem 'pronto-bigfiles'
27
+ ```
28
+
29
+ And then execute:
30
+
31
+ ```sh
32
+ bundle install
33
+ ```
34
+
35
+ Or install it yourself as:
36
+
37
+ ```sh
38
+ gem install pronto-bigfiles
39
+ ```
40
+
41
+ ## Usage
42
+
43
+ This is typically used either as part a custom
44
+ [pronto](https://github.com/prontolabs/pronto) rigging, sometimes as
45
+ part of general use of the
46
+ [quality](https://github.com/apiology/quality) gem.
47
+
48
+ ## Development
49
+
50
+ After checking out the repo, run `bin/setup` to install
51
+ dependencies. Then, run `rake spec` to run the tests. You can also run
52
+ `bin/console` for an interactive prompt that will allow you to
53
+ experiment.
54
+
55
+ To install this gem onto your local machine, run `bundle exec rake
56
+ install`. To release a new version, update the version number in
57
+ `version.rb`, and then run `bundle exec rake release`, which will
58
+ create a git tag for the version, push git commits and tags, and push
59
+ the `.gem` file to [rubygems.org](https://rubygems.org).
60
+
61
+ ## Contributing
62
+
63
+ Bug reports and pull requests are welcome
64
+ [on GitHub](https://github.com/apiology/pronto-bigfiles). This project is
65
+ intended to be a safe, welcoming space for collaboration, and
66
+ contributors are expected to adhere to the
67
+ [code of conduct](https://github.com/apiology/pronto-bigfiles/blob/master/CODE_OF_CONDUCT.md).
68
+
69
+ ## License
70
+
71
+ The gem is available as open source under the terms of the
72
+ [MIT License](https://opensource.org/licenses/MIT).
73
+
74
+ ## Code of Conduct
75
+
76
+ Everyone interacting in the Pronto::BigFiles project's codebases,
77
+ issue trackers, chat rooms and mailing lists is expected to follow the
78
+ [code of conduct](https://github.com/apiology/pronto-bigfiles/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
File without changes
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'bundler/setup'
5
+ require 'pronto/bigfiles'
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ # (If you use this, don't forget to add pry to your Gemfile!)
11
+ # require "pry"
12
+ # Pry.start
13
+
14
+ require 'irb'
15
+ 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
@@ -0,0 +1,5 @@
1
+ {
2
+ "result": {
3
+ "covered_percent": 100.0
4
+ }
5
+ }
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'pronto/bigfiles'