boxing 0.1.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: 716a6100d6aa32b77aa0ec152655d305a218e69810171bc3e8b6884c90ddbba0
4
+ data.tar.gz: 0a96c48d4cbbf0ecf5ce34e19955150576e2dca7b7a9841be40eb17f79c274bb
5
+ SHA512:
6
+ metadata.gz: 62c1a29292e5b511b57e58f4cf3d1659e16ffdb4da102f02dceb395a5d0bb77c73f2eeeafba8294a0ec57cc742bb18e6cc304b72b2032c97c0507cf19604597e
7
+ data.tar.gz: a177892ab763e676074a8e38fdbcfedb961b0076f61d891d0089324062ab128335e336a8f63c0367d3a269a4be02c53749a1f4a74403db1362217bc622e1f9c2
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,18 @@
1
+ # The behavior of RuboCop can be controlled via the .rubocop.yml
2
+ # configuration file. It makes it possible to enable/disable
3
+ # certain cops (checks) and to alter their behavior if they accept
4
+ # any parameters. The file can be placed either in your home
5
+ # directory or in some project directory.
6
+ #
7
+ # RuboCop will start looking for the configuration file in the directory
8
+ # where the inspected file is and continue its way up to the root directory.
9
+ #
10
+ # See https://docs.rubocop.org/rubocop/configuration
11
+
12
+ AllCops:
13
+ TargetRubyVersion: 2.5
14
+ NewCops: enable
15
+
16
+ Metrics/BlockLength:
17
+ Exclude:
18
+ - spec/**/*_spec.rb
@@ -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 elct9620@frost.tw. 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/Gemfile ADDED
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ source 'https://rubygems.org'
4
+
5
+ # Specify your gem's dependencies in boxing.gemspec
6
+ gemspec
7
+
8
+ gem 'rake', '~> 13.0'
9
+
10
+ gem 'rspec', '~> 3.0'
11
+
12
+ gem 'simplecov'
13
+
14
+ gem 'rubocop', '~> 1.22'
15
+ gem 'rubocop-rake'
16
+ gem 'rubocop-rspec'
17
+
18
+ gem 'bundler-audit'
19
+ gem 'overcommit'
data/Gemfile.lock ADDED
@@ -0,0 +1,85 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ boxing (0.1.0)
5
+ bundler (~> 2.0)
6
+ thor (~> 1.0)
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ ast (2.4.2)
12
+ bundler-audit (0.9.0.1)
13
+ bundler (>= 1.2.0, < 3)
14
+ thor (~> 1.0)
15
+ childprocess (4.1.0)
16
+ diff-lcs (1.4.4)
17
+ docile (1.4.0)
18
+ iniparse (1.5.0)
19
+ overcommit (0.58.0)
20
+ childprocess (>= 0.6.3, < 5)
21
+ iniparse (~> 1.4)
22
+ rexml (~> 3.2)
23
+ parallel (1.21.0)
24
+ parser (3.0.3.2)
25
+ ast (~> 2.4.1)
26
+ rainbow (3.0.0)
27
+ rake (13.0.6)
28
+ regexp_parser (2.2.0)
29
+ rexml (3.2.5)
30
+ rspec (3.10.0)
31
+ rspec-core (~> 3.10.0)
32
+ rspec-expectations (~> 3.10.0)
33
+ rspec-mocks (~> 3.10.0)
34
+ rspec-core (3.10.1)
35
+ rspec-support (~> 3.10.0)
36
+ rspec-expectations (3.10.1)
37
+ diff-lcs (>= 1.2.0, < 2.0)
38
+ rspec-support (~> 3.10.0)
39
+ rspec-mocks (3.10.2)
40
+ diff-lcs (>= 1.2.0, < 2.0)
41
+ rspec-support (~> 3.10.0)
42
+ rspec-support (3.10.3)
43
+ rubocop (1.23.0)
44
+ parallel (~> 1.10)
45
+ parser (>= 3.0.0.0)
46
+ rainbow (>= 2.2.2, < 4.0)
47
+ regexp_parser (>= 1.8, < 3.0)
48
+ rexml
49
+ rubocop-ast (>= 1.12.0, < 2.0)
50
+ ruby-progressbar (~> 1.7)
51
+ unicode-display_width (>= 1.4.0, < 3.0)
52
+ rubocop-ast (1.15.0)
53
+ parser (>= 3.0.1.1)
54
+ rubocop-rake (0.6.0)
55
+ rubocop (~> 1.0)
56
+ rubocop-rspec (2.6.0)
57
+ rubocop (~> 1.19)
58
+ ruby-progressbar (1.11.0)
59
+ simplecov (0.21.2)
60
+ docile (~> 1.1)
61
+ simplecov-html (~> 0.11)
62
+ simplecov_json_formatter (~> 0.1)
63
+ simplecov-html (0.12.3)
64
+ simplecov_json_formatter (0.1.3)
65
+ thor (1.1.0)
66
+ unicode-display_width (2.1.0)
67
+
68
+ PLATFORMS
69
+ x86_64-darwin-20
70
+ x86_64-darwin-21
71
+ x86_64-linux
72
+
73
+ DEPENDENCIES
74
+ boxing!
75
+ bundler-audit
76
+ overcommit
77
+ rake (~> 13.0)
78
+ rspec (~> 3.0)
79
+ rubocop (~> 1.22)
80
+ rubocop-rake
81
+ rubocop-rspec
82
+ simplecov
83
+
84
+ BUNDLED WITH
85
+ 2.2.32
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2021 ZhengXian Qiu
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,59 @@
1
+ # Boxing
2
+
3
+ The zero-configuration Dockerfile generator for Ruby.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile development group:
8
+
9
+ ```ruby
10
+ group :development do
11
+ gem 'boxing'
12
+ end
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle install
18
+
19
+ ## Usage
20
+
21
+ ### Generate
22
+
23
+ To generate `Dockerfile` for current project
24
+
25
+ ```ruby
26
+ bundle exec boxing generate
27
+ ```
28
+
29
+ ## Roadmap
30
+
31
+ * [x] `Dockerfile` generator
32
+ * [ ] Customize config file `config/boxing.rb`
33
+ * [ ] Entrypoint Detection
34
+ * [x] Openbox (Suggested)
35
+ * [x] Ruby on Rails
36
+ * [ ] Rack
37
+ * [ ] Ruby
38
+ * [ ] Package Database
39
+ * [x] Built-in (Move to standalone repoistory in future)
40
+ * [ ] Standalone Repoistory
41
+ * [ ] Customize Source
42
+ * [ ] Base Image
43
+ * [x] Alpine
44
+ * [ ] Ubuntu
45
+ * [ ] Ruby Version
46
+
47
+ ## Development
48
+
49
+ 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.
50
+
51
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
52
+
53
+ ## Contributing
54
+
55
+ Bug reports and pull requests are welcome on GitHub at https://github.com/elct9620/boxing. 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/elct9620/boxing/blob/main/CODE_OF_CONDUCT.md).
56
+
57
+ ## Code of Conduct
58
+
59
+ Everyone interacting in the Boxing project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/elct9620/boxing/blob/main/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,8 @@
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
+ task default: :spec
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 'boxing'
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
data/boxing.gemspec ADDED
@@ -0,0 +1,40 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'lib/boxing/version'
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = 'boxing'
7
+ spec.version = Boxing::VERSION
8
+ spec.authors = ['蒼時弦也']
9
+ spec.email = ['contact@frost.tw']
10
+
11
+ spec.summary = 'The zero-configuration Dockerfile generator for Ruby'
12
+ spec.description = 'The zero-configuration Dockerfile generator for Ruby'
13
+ spec.homepage = 'https://github.com/elct9620/boxing'
14
+ spec.required_ruby_version = '>= 2.5.0'
15
+
16
+ spec.metadata['homepage_uri'] = spec.homepage
17
+ spec.metadata['source_code_uri'] = 'https://github.com/elct9620/boxing'
18
+ # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
19
+
20
+ # Specify which files should be added to the gem when it is released.
21
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
22
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
23
+ `git ls-files -z`.split("\x0").reject do |f|
24
+ (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
25
+ end
26
+ end
27
+ spec.bindir = 'exe'
28
+ spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
29
+ spec.require_paths = ['lib']
30
+
31
+ # Uncomment to register a new dependency of your gem
32
+ spec.add_dependency 'bundler', '~> 2.0'
33
+ spec.add_dependency 'thor', '~> 1.0'
34
+
35
+ # For more information and examples about making a new gem, checkout our
36
+ # guide at: https://bundler.io/guides/creating_gem.html
37
+ spec.metadata = {
38
+ 'rubygems_mfa_required' => 'true'
39
+ }
40
+ end
@@ -0,0 +1,2 @@
1
+ name: postgresql-dev
2
+ build: yes
@@ -0,0 +1,2 @@
1
+ name: postgresql-libs
2
+ runtime: yes
@@ -0,0 +1,2 @@
1
+ name: shared-mime-info
2
+ runtime: yes
@@ -0,0 +1,2 @@
1
+ name: tzdata
2
+ runtime: yes
@@ -0,0 +1,2 @@
1
+ name: sqlite-dev
2
+ build: yes
@@ -0,0 +1,2 @@
1
+ name: sqlite-libs
2
+ runtime: true
data/exe/boxing ADDED
@@ -0,0 +1,6 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require 'boxing'
5
+
6
+ Boxing::Command.start(ARGV)
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'thor'
4
+
5
+ module Boxing
6
+ # The Main Command
7
+ #
8
+ # @since 0.1.0
9
+ class Command < Thor
10
+ # :nodoc:
11
+ def self.exit_on_failure?
12
+ true
13
+ end
14
+
15
+ require_relative 'commands/generate'
16
+ end
17
+ end
@@ -0,0 +1,39 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'pathname'
4
+ require 'set'
5
+
6
+ module Boxing
7
+ # :nodoc:
8
+ module Commands
9
+ # The Dockerfle Generator
10
+ #
11
+ # @since 0.1.0
12
+ class Generate < Thor::Group
13
+ include Thor::Actions
14
+
15
+ # :nodoc:
16
+ def self.source_root
17
+ Pathname.new(File.dirname(__FILE__)).join('../../..')
18
+ end
19
+
20
+ # Create Dockerfile
21
+ #
22
+ # @since 0.1.0
23
+ def execute
24
+ template('templates/Dockerfile.tt', 'Dockerfile', context: context.to_binding)
25
+ end
26
+
27
+ private
28
+
29
+ def context
30
+ @context = Context.new(
31
+ Database.new,
32
+ Boxing.dependencies
33
+ )
34
+ end
35
+ end
36
+
37
+ Boxing::Command.register(Generate, 'generate', 'generate', 'Generate Dockerfile')
38
+ end
39
+ end
@@ -0,0 +1,50 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Boxing
4
+ # The template context
5
+ #
6
+ # @since 0.1.0
7
+ class Context
8
+ # @param database [Boxing::Database]
9
+ # @param dependencies [Array<Bundler::Dependency>]
10
+ #
11
+ # @since 0.1.0
12
+ def initialize(database, dependencies = [])
13
+ @database = database
14
+ @dependencies = dependencies
15
+ end
16
+
17
+ # Return required packages
18
+ #
19
+ # @return [Set<Boxing::Package>] packages
20
+ #
21
+ # @since 0.1.0
22
+ def packages
23
+ @packages ||= Set.new(
24
+ @dependencies
25
+ .map(&:name)
26
+ .flat_map { |name| @database.package_for(name).to_a }
27
+ )
28
+ end
29
+
30
+ # Check rubygems exists
31
+ #
32
+ # @param names [Array<String>]
33
+ #
34
+ # @return [TrueClass|FalseClass]
35
+ #
36
+ # @since 0.1.0
37
+ def has?(*names)
38
+ @dependencies.any? { |dep| names.include?(dep.name) }
39
+ end
40
+
41
+ # Convert to binding
42
+ #
43
+ # @return [Binding]
44
+ #
45
+ # @since 0.1.0
46
+ def to_binding
47
+ binding
48
+ end
49
+ end
50
+ end
@@ -0,0 +1,47 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'pathname'
4
+ require 'boxing/package'
5
+
6
+ module Boxing
7
+ # The package and dependency mapping database
8
+ #
9
+ # @since 0.1.0
10
+ class Database
11
+ class << self
12
+ # The database root
13
+ #
14
+ # @since 0.1.0
15
+ def root
16
+ @root ||= Pathname.new(File.dirname(__FILE__)).join('../../database')
17
+ end
18
+ end
19
+
20
+ # Find packages for rubygems
21
+ #
22
+ # @param name [String] the gem name
23
+ #
24
+ # @yield [path] The given block will be passed each package path
25
+ # @yieldparam [Boxing::Package] The package related rubygem
26
+ #
27
+ # @since 0.1.0
28
+ def package_for(name)
29
+ return enum_for(__method__, name) unless block_given?
30
+
31
+ each_package_path_for(name.to_s) do |path|
32
+ yield Package.load(path)
33
+ end
34
+ end
35
+
36
+ # Enumerates over gems
37
+ #
38
+ # @param name [String] the gem name
39
+ # @yield [path] The given block will be passed each package path
40
+ # @yieldparam [String] A path to package `.yml` file
41
+ #
42
+ # @since 0.1.0
43
+ def each_package_path_for(name, &block)
44
+ Dir.glob(Database.root.join('gems', name, '*.yml'), &block)
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,90 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'yaml'
4
+
5
+ module Boxing
6
+ # The rubygems mapping for Linux package
7
+ #
8
+ # @since 0.1.0
9
+ class Package
10
+ class << self
11
+ # Load Required Packages
12
+ #
13
+ # @return [Boxing::Package]
14
+ #
15
+ # @since 0.1.0
16
+ def load(path)
17
+ data = YAML.safe_load(File.read(path))
18
+ mode = 0b00
19
+ mode |= Package::RUNTIME if data['runtime']
20
+ mode |= Package::BUILD if data['build']
21
+ new(data['name'], data['version'], mode: mode)
22
+ end
23
+ end
24
+
25
+ # @since 0.1.0
26
+ RUNTIME = 0b01
27
+
28
+ # @since 0.1.0
29
+ BUILD = 0b10
30
+
31
+ # @since 0.1.0
32
+ attr_reader :name, :version
33
+
34
+ # @param name [String] the package name
35
+ # @param version [String] the package version
36
+ # @param mode [Number] is runtime or build
37
+ #
38
+ # @since 0.1.0
39
+ def initialize(name, version = nil, mode: RUNTIME)
40
+ @name = name
41
+ @version = version
42
+ @mode = mode
43
+ end
44
+
45
+ # @return [TrueClass|FalseClass] is for build
46
+ #
47
+ # @since 0.1.0
48
+ def build?
49
+ @mode & BUILD == BUILD
50
+ end
51
+
52
+ # @return [TrueClass|FalseClass] is for runtime
53
+ #
54
+ # @since 0.1.0
55
+ def runtime?
56
+ @mode & RUNTIME == RUNTIME
57
+ end
58
+
59
+ # Compare is same package
60
+ #
61
+ # @return [TrueClass|FalseClass]
62
+ #
63
+ # @since 0.1.0
64
+ def eql?(other)
65
+ @name == other.name
66
+ end
67
+ alias == eql?
68
+
69
+ # Return Object#hash
70
+ #
71
+ # @return [Number]
72
+ #
73
+ # @since 0.1.0
74
+ def hash
75
+ @name.hash
76
+ end
77
+
78
+ # Convert to string
79
+ #
80
+ # @return [String] the package string
81
+ #
82
+ # @since 0.1.0
83
+ def to_s
84
+ return @name if @version.nil?
85
+
86
+ # NOTE: Alpine format only
87
+ "#{@name}=#{@version}"
88
+ end
89
+ end
90
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Boxing
4
+ VERSION = '0.1.0'
5
+ end
data/lib/boxing.rb ADDED
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'boxing/version'
4
+ require_relative 'boxing/package'
5
+ require_relative 'boxing/database'
6
+ require_relative 'boxing/context'
7
+ require_relative 'boxing/command'
8
+
9
+ # The tool to generate Dockerfile without config
10
+ #
11
+ # @since 0.1.0
12
+ module Boxing
13
+ module_function
14
+
15
+ # @return [Bundler::Dependency]
16
+ #
17
+ # @since 0.1.0
18
+ def dependencies(groups = %i[default production])
19
+ Bundler
20
+ .definition
21
+ .current_dependencies
22
+ .select { |dep| (dep.groups & groups).any? }
23
+ end
24
+ end
@@ -0,0 +1,69 @@
1
+ ARG APP_ROOT=/src/app
2
+ ARG RUBY_VERSION=<%= RUBY_VERSION %>
3
+
4
+ FROM ruby:${RUBY_VERSION}-alpine AS gem
5
+ ARG APP_ROOT
6
+
7
+ RUN apk add --no-cache build-base <%= packages.select(&:build?).join(' ') %>
8
+
9
+ RUN mkdir -p ${APP_ROOT}
10
+ COPY Gemfile Gemfile.lock ${APP_ROOT}/
11
+
12
+ WORKDIR ${APP_ROOT}
13
+ RUN gem install bundler:<%= Bundler::VERSION %> \
14
+ && bundle config --local deployment 'true' \
15
+ && bundle config --local frozen 'true' \
16
+ && bundle config --local no-cache 'true' \
17
+ && bundle config --local system 'true' \
18
+ && bundle config --local without 'development test' \
19
+ && bundle install -j "$(getconf _NPROCESSORS_ONLN)" \
20
+ && find /${APP_ROOT}/vendor/bundle -type f -name '*.c' -delete \
21
+ && find /${APP_ROOT}/vendor/bundle -type f -name '*.o' -delete \
22
+ && find /usr/local/bundle -type f -name '*.c' -delete \
23
+ && find /usr/local/bundle -type f -name '*.o' -delete \
24
+ && rm -rf /usr/local/bundle/cache/*.gem
25
+
26
+ FROM ruby:${RUBY_VERSION}-alpine
27
+ ARG APP_ROOT
28
+
29
+ <%- if packages.select(&:runtime?).any? -%>
30
+ RUN apk add --no-cache <%= packages.select(&:runtime?).join(' ') %>
31
+
32
+ <%- end -%>
33
+ COPY --from=gem /usr/local/bundle/config /usr/local/bundle/config
34
+ COPY --from=gem /usr/local/bundle /usr/local/bundle
35
+ COPY --from=gem /${APP_ROOT}/vendor/bundle /${APP_ROOT}/vendor/bundle
36
+
37
+ RUN mkdir -p ${APP_ROOT}
38
+
39
+ <%- if has?('rails') -%>
40
+ ENV RAILS_ENV=production
41
+ ENV RAILS_LOG_TO_STDOUT=true
42
+ <%- end -%>
43
+ ENV APP_ROOT=$APP_ROOT
44
+
45
+ COPY . ${APP_ROOT}
46
+
47
+ # Apply Execute Permission
48
+ RUN adduser -h ${APP_ROOT} -D -s /bin/nologin ruby ruby && \
49
+ chown ruby:ruby ${APP_ROOT} && \
50
+ <%- if has?('rails') -%>
51
+ chown -R ruby:ruby ${APP_ROOT}/log && \
52
+ chown -R ruby:ruby ${APP_ROOT}/tmp && \
53
+ <%- end -%>
54
+ chmod -R +r ${APP_ROOT}
55
+
56
+ USER ruby
57
+ WORKDIR ${APP_ROOT}
58
+
59
+ EXPOSE <%= has?('rails') ? '3000' : '9292' %>
60
+ <%- if has?('openbox') -%>
61
+ ENTRYPOINT ["bin/openbox"]
62
+ CMD ["server"]
63
+ <%- elsif has?('rails') -%>
64
+ ENTRYPOINT ["bin/rails"]
65
+ CMD ["server", "-b", "0.0.0.0"]
66
+ <%- else -%>
67
+ ENTRYPOINT ["bundle", "exec"]
68
+ CMD ["rackup", "-o", "0.0.0.0"]
69
+ <%- end -%>
metadata ADDED
@@ -0,0 +1,98 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: boxing
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - 蒼時弦也
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2021-12-18 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: thor
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.0'
41
+ description: The zero-configuration Dockerfile generator for Ruby
42
+ email:
43
+ - contact@frost.tw
44
+ executables:
45
+ - boxing
46
+ extensions: []
47
+ extra_rdoc_files: []
48
+ files:
49
+ - ".rspec"
50
+ - ".rubocop.yml"
51
+ - CODE_OF_CONDUCT.md
52
+ - Gemfile
53
+ - Gemfile.lock
54
+ - LICENSE
55
+ - README.md
56
+ - Rakefile
57
+ - bin/console
58
+ - bin/setup
59
+ - boxing.gemspec
60
+ - database/gems/pg/postgresql-dev.yml
61
+ - database/gems/pg/postgresql-libs.yml
62
+ - database/gems/rails/shared-mime-info.yml
63
+ - database/gems/rails/tzdata.yml
64
+ - database/gems/sqlite3/sqlite-dev.yml
65
+ - database/gems/sqlite3/sqlite-libs.yml
66
+ - exe/boxing
67
+ - lib/boxing.rb
68
+ - lib/boxing/command.rb
69
+ - lib/boxing/commands/generate.rb
70
+ - lib/boxing/context.rb
71
+ - lib/boxing/database.rb
72
+ - lib/boxing/package.rb
73
+ - lib/boxing/version.rb
74
+ - templates/Dockerfile.tt
75
+ homepage: https://github.com/elct9620/boxing
76
+ licenses: []
77
+ metadata:
78
+ rubygems_mfa_required: 'true'
79
+ post_install_message:
80
+ rdoc_options: []
81
+ require_paths:
82
+ - lib
83
+ required_ruby_version: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: 2.5.0
88
+ required_rubygems_version: !ruby/object:Gem::Requirement
89
+ requirements:
90
+ - - ">="
91
+ - !ruby/object:Gem::Version
92
+ version: '0'
93
+ requirements: []
94
+ rubygems_version: 3.2.26
95
+ signing_key:
96
+ specification_version: 4
97
+ summary: The zero-configuration Dockerfile generator for Ruby
98
+ test_files: []