unarchiver 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 4efe04b7322e5f69f53055a73d464ec2c29eca02ea2824eaeb9e25af54977540
4
+ data.tar.gz: a9d81fd255552dc09c674781ee9c1114fa1eeb3d45a0c5e7c1de324cc4ae5acf
5
+ SHA512:
6
+ metadata.gz: 50b7adb65c2e98ba7382e1cf5e0586db1ab10cb81b49f494dd12ebc813728b955ab832ed72600737270b81baa172596d61da25e3069cf7f28fd30c12762f2860
7
+ data.tar.gz: 47ce91d6b9cea57ec96d661a87b1dc2be02425991cbac96637fc07765d3d77716826426492c87eab1548aed91b1658a9d8437d512be50dfbeec0f1d94a58a987
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,234 @@
1
+ require:
2
+ - rubocop-rspec
3
+
4
+ AllCops:
5
+ NewCops: enable
6
+ TargetRubyVersion: 3.3
7
+ SuggestExtensions: false
8
+ Include:
9
+ - '.github/**/*.rb'
10
+ - '**/*.rb'
11
+ - '**/*.gemfile'
12
+ - '**/*.gemspec'
13
+ - '**/*.rake'
14
+ - '**/*.ru'
15
+ - '**/Gemfile'
16
+ - '**/Rakefile'
17
+
18
+ Exclude:
19
+ <% `git status --ignored --porcelain`.lines.grep(/^!! /).each do |path| %>
20
+ - <%= path.sub(/^!! /, '').sub(/\/$/, '/**/*') %>
21
+ <% end %>
22
+ - bin/*
23
+ - Rakefile
24
+
25
+ # Disabled because this requires comments at the top of every file
26
+ Style/FrozenStringLiteralComment:
27
+ Enabled: false
28
+
29
+ # Disabled because this requires comments for every class
30
+ Style/Documentation:
31
+ Enabled: false
32
+
33
+ Layout/LineLength:
34
+ AllowedPatterns:
35
+ - !ruby/regexp /\A#/
36
+
37
+ RSpec/MultipleExpectations:
38
+ Enabled: false
39
+
40
+ RSpec/ExampleLength:
41
+ Max: 50
42
+ CountAsOne:
43
+ - array
44
+ - hash
45
+ - heredoc
46
+
47
+ Style/BlockDelimiters:
48
+ EnforcedStyle: semantic
49
+ AllowBracesOnProceduralOneLiners: true
50
+
51
+ RSpec/NamedSubject:
52
+ EnforcedStyle: named_only
53
+
54
+ RSpec/Focus:
55
+ AutoCorrect: false
56
+
57
+ RSpec/MultipleMemoizedHelpers:
58
+ Enabled: false
59
+
60
+ Naming/MethodParameterName:
61
+ Enabled: false
62
+
63
+ Metrics/AbcSize:
64
+ Max: 30
65
+
66
+ Metrics/BlockLength:
67
+ Max: 30
68
+ CountAsOne:
69
+ - array
70
+ - hash
71
+ - heredoc
72
+ - method_call
73
+
74
+ Metrics/ClassLength:
75
+ Max: 200
76
+ CountAsOne:
77
+ - array
78
+ - hash
79
+ - heredoc
80
+ - method_call
81
+
82
+ Metrics/ModuleLength:
83
+ Max: 200
84
+ CountAsOne:
85
+ - array
86
+ - hash
87
+ - heredoc
88
+ - method_call
89
+
90
+ Metrics/CyclomaticComplexity:
91
+ Max: 15
92
+
93
+ Metrics/MethodLength:
94
+ CountAsOne:
95
+ - array
96
+ - hash
97
+ - heredoc
98
+ - method_call
99
+ Max: 30
100
+
101
+ Metrics/PerceivedComplexity:
102
+ Max: 15
103
+
104
+ Style/MultilineBlockChain:
105
+ Enabled: false
106
+
107
+ Style/ParallelAssignment:
108
+ Enabled: false
109
+
110
+ Style/RedundantReturn:
111
+ AllowMultipleReturnValues: true
112
+
113
+ Lint/UnusedMethodArgument:
114
+ AutoCorrect: false
115
+
116
+ RSpec/EmptyExampleGroup:
117
+ AutoCorrect: false
118
+
119
+ Lint/UnusedBlockArgument:
120
+ AutoCorrect: false
121
+
122
+ RSpec/NestedGroups:
123
+ Enabled: false
124
+
125
+ RSpec/ContextWording:
126
+ Enabled: false
127
+
128
+ # Intended to avoid this situation:
129
+ # ```
130
+ # aggregate_yearly_allowance = calculator(month1,
131
+ # month2: fetch_grouped_month_data_for_month(2))
132
+ # ```
133
+ # where we
134
+ # a) dangle code way out there
135
+ # b) sometimes wind up with an odd number of spaces in the indent
136
+ # c) eat up valuable line length
137
+ Layout/ArgumentAlignment:
138
+ EnforcedStyle: with_fixed_indentation
139
+
140
+ # Intended to avoid this situation:
141
+ # ```
142
+ # aggregate_yearly_allowance = case month
143
+ # when "feb"
144
+ # fetch_grouped_month_data_for_month(2)
145
+ # end
146
+ # ```
147
+ # where we
148
+ # a) dangle code way out there
149
+ # b) sometimes wind up with an odd number of spaces in the indent
150
+ # c) eat up valuable line length
151
+ # d) what's with that `end` way off to the left
152
+ Layout/CaseIndentation:
153
+ EnforcedStyle: end
154
+
155
+ # Intended to avoid this situation:
156
+ # ```
157
+ # aggregate_yearly_allowance = if month == "feb"
158
+ # fetch_grouped_month_data_for_month(2)
159
+ # end
160
+ # ```
161
+ # where we
162
+ # a) dangle code way out there
163
+ # b) sometimes wind up with an odd number of spaces in the indent
164
+ # c) eat up valuable line length
165
+ # d) what's with that `end` way off to the left (for `start_of_line` setting)
166
+ Layout/EndAlignment:
167
+ EnforcedStyleAlignWith: variable
168
+
169
+ # Intended to avoid this situation:
170
+ # ```
171
+ # aggregate_yearly_allowance = AllowanceCalculator
172
+ # .calculate
173
+ # .month("feb")
174
+ # .add(fetch_grouped_month_data_for_month(2))
175
+ # ```
176
+ # where we
177
+ # a) dangle code way out there
178
+ # b) sometimes wind up with an odd number of spaces in the indent
179
+ # c) eat up valuable line length
180
+ Layout/MultilineMethodCallIndentation:
181
+ EnforcedStyle: indented
182
+
183
+ # Intended to avoid enforcing this:
184
+ # ```
185
+ # scan = create(:scan,
186
+ # started_at: "2023-01-01 12:00",)
187
+ # ```
188
+ # and allow this:
189
+ # ```
190
+ # scan = create(:scan,
191
+ # started_at: "2023-01-01 12:00",
192
+ # )
193
+ # ```
194
+ #
195
+ # There unfortunately isn't a good setting I can find
196
+ # to stop rubocop -A doing weird things.
197
+ Layout/MultilineMethodCallBraceLayout:
198
+ Enabled: false
199
+
200
+ # Double-quotes preferred as default to avoid
201
+ # having to stop and switch between quote types
202
+ # as and when we decide to put an apostrophe in a sentence
203
+ # (especially common when writing test names).
204
+ #
205
+ # There is no performance penalty for using double quotes
206
+ # when there's no interpolation being used.
207
+ Style/StringLiterals:
208
+ EnforcedStyle: double_quotes
209
+
210
+ # Enforcing trailing commas in multiline helps keep
211
+ # our github history clean as we don't end up with
212
+ # changes recorded for lines that have only had a
213
+ # comma added or removed.
214
+ #
215
+ # Also makes it easier to reorder lines without having
216
+ # to add or delete commas.
217
+ Style/TrailingCommaInArguments:
218
+ EnforcedStyleForMultiline: comma
219
+ Style/TrailingCommaInArrayLiteral:
220
+ EnforcedStyleForMultiline: comma
221
+ Style/TrailingCommaInHashLiteral:
222
+ EnforcedStyleForMultiline: comma
223
+
224
+ Style/EmptyCaseCondition:
225
+ Enabled: false
226
+
227
+ Style/Lambda:
228
+ Enabled: false
229
+
230
+ # By default rubocop forbids use of any capybara aliases
231
+ # for RSpec methods, and wants you to enable them as desired per-team.
232
+ RSpec/Capybara/FeatureMethods:
233
+ EnabledMethods:
234
+ - scenario
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at elliot@dexory.com. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/LICENCE.txt ADDED
@@ -0,0 +1,177 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
data/README.md ADDED
@@ -0,0 +1,44 @@
1
+ # Unarchiver
2
+
3
+ A simple utility for consistently extracting and filtering the contents of zip files.
4
+
5
+ ## Installation
6
+
7
+ TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
8
+
9
+ Install the gem and add to the application's Gemfile by executing:
10
+
11
+ $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
12
+
13
+ If bundler is not being used to manage dependencies, install the gem by executing:
14
+
15
+ $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
16
+
17
+ ## Usage
18
+
19
+ Initialize the unarchiver with a handle for the zip file and call
20
+ `expand` with an optional list of valid extensions to extract.
21
+
22
+ ```ruby
23
+ Unarchiver.new(Rails.root.join("data/documents.zip")).expand(["pdf", "docx"])
24
+ ```
25
+
26
+ Returns an array of tempfiles. If passed a file which is not a zip,
27
+ it returns an array containing a new tempfile which wraps that file,
28
+ for consistency.
29
+
30
+ ## Development
31
+
32
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
33
+
34
+ ## Contributing
35
+
36
+ Bug reports and pull requests are welcome on GitHub at https://github.com/botsandus/unarchiver. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/botsandus/unarchiver/blob/main/CODE_OF_CONDUCT.md).
37
+
38
+ ## Licence
39
+
40
+ The gem is available as open source under the terms of the [Apache 2.0 licence](https://www.apache.org/licenses/LICENSE-2.0).
41
+
42
+ ## Code of Conduct
43
+
44
+ Everyone interacting in the Unarchiver project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/botsandus/unarchiver/blob/main/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require "rubocop/rake_task"
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ class Unarchiver
4
+ VERSION = "1.0.0"
5
+ end
data/lib/unarchiver.rb ADDED
@@ -0,0 +1,91 @@
1
+ require "zip"
2
+
3
+ class Unarchiver
4
+ def self.temp_file(contents, name, extension)
5
+ Tempfile.new([name, extension]).tap do |temp_file|
6
+ temp_file.binmode
7
+ temp_file.write(contents)
8
+ temp_file.flush
9
+ temp_file.rewind
10
+ end
11
+ end
12
+
13
+ def initialize(file)
14
+ @file = file
15
+ end
16
+
17
+ # The dataset importer supports ZIP files which contain multiple underlying
18
+ # dataset files. This method will either return the original file if it is not
19
+ # a ZIP file, or will expand the ZIP file and return each of the potential
20
+ # dataset files included in it.
21
+ def expand(valid_extensions: nil)
22
+ return [] unless file
23
+
24
+ if (extension = File.extname(file.path)) == ".zip"
25
+ expand_zip(valid_extensions:)
26
+ else
27
+ # Ensure we're consistently returning an array of new tempfiles
28
+ [self.class.temp_file(file.read, File.basename(file.path), extension)]
29
+ end
30
+ end
31
+
32
+ private
33
+
34
+ attr_reader :file
35
+
36
+ # This is a ZIP upload, so expand it
37
+ def expand_zip(valid_extensions: nil)
38
+ Zip::File.open(file) do |zip_file|
39
+ zip_file.each_with_object([]) do |entry, files|
40
+ zip_entry = ZipEntry.new(entry, valid_extensions:)
41
+ files << zip_entry.to_file if zip_entry.valid?
42
+ end
43
+ end
44
+ end
45
+
46
+ class ZipEntry
47
+ def initialize(entry, valid_extensions: nil)
48
+ @entry = entry
49
+ @valid_extensions = valid_extensions
50
+ end
51
+
52
+ def valid?
53
+ entry.file? && visible? && valid_extension?
54
+ end
55
+
56
+ # Create a temporary file and add it to the list of files. We need to
57
+ # ensure we keep the extension so that the parser can determine the
58
+ # correct file format; that's what the second argument to Tempfile.new
59
+ # is for.
60
+ def to_file
61
+ Unarchiver.temp_file(read, entry.name, extension)
62
+ end
63
+
64
+ private
65
+
66
+ attr_reader :entry, :valid_extensions
67
+
68
+ def extension
69
+ @extension ||= File.extname(entry.name)
70
+ end
71
+
72
+ def read
73
+ entry.get_input_stream.read
74
+ end
75
+
76
+ def basename
77
+ @basename ||= File.basename(entry.name, extension)
78
+ end
79
+
80
+ def visible?
81
+ !basename.start_with?(".")
82
+ end
83
+
84
+ def valid_extension?
85
+ return true if valid_extensions.nil?
86
+ return true if valid_extensions.empty?
87
+
88
+ valid_extensions.include?(extension[1..])
89
+ end
90
+ end
91
+ end
@@ -0,0 +1,4 @@
1
+ module Unarchiver
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,69 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: unarchiver
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Elliot Crosby-McCullough
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2024-04-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rubyzip
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.3'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.3'
27
+ description:
28
+ email:
29
+ - elliot@dexory.com
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - ".rspec"
35
+ - ".rubocop.yml"
36
+ - CODE_OF_CONDUCT.md
37
+ - LICENCE.txt
38
+ - README.md
39
+ - Rakefile
40
+ - lib/unarchiver.rb
41
+ - lib/unarchiver/version.rb
42
+ - sig/unarchiver.rbs
43
+ homepage: https://github.com/botsandus/unarchiver
44
+ licenses:
45
+ - Apache-2.0
46
+ metadata:
47
+ homepage_uri: https://github.com/botsandus/unarchiver
48
+ source_code_uri: https://github.com/botsandus/unarchiver
49
+ rubygems_mfa_required: 'true'
50
+ post_install_message:
51
+ rdoc_options: []
52
+ require_paths:
53
+ - lib
54
+ required_ruby_version: !ruby/object:Gem::Requirement
55
+ requirements:
56
+ - - ">="
57
+ - !ruby/object:Gem::Version
58
+ version: 3.3.0
59
+ required_rubygems_version: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: '0'
64
+ requirements: []
65
+ rubygems_version: 3.5.7
66
+ signing_key:
67
+ specification_version: 4
68
+ summary: A small gem for extracting and filtering files from ZIPs
69
+ test_files: []