git_toolbox 0.4.1 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -18,7 +18,8 @@
18
18
  # frozen_string_literal: true
19
19
 
20
20
  require 'English'
21
- require 'get/common'
21
+ require 'get/commons/common'
22
+ require 'get/commons/git'
22
23
  require 'get/subcommand/command'
23
24
 
24
25
  # Class length is disabled as most of its length is given by formatting.
@@ -34,22 +35,21 @@ class Init < Command
34
35
 
35
36
  private
36
37
 
37
- include PromptHandler
38
-
39
38
  @@command = nil
40
39
 
41
40
  @@usage = 'init -h|(<subcommand> [<subcommand-options])'
42
- @@description = 'Initialize a new git repository with an initial empty commit'
41
+ @@description = 'Initialize a new git repository with an initial empty commit.'
43
42
  @@subcommands = {}
44
43
  # This block is Optimist configuration. It is as long as the number of options of the command.
45
44
  # rubocop:disable Metrics/BlockLength
46
- @@commit_parser = Optimist::Parser.new do
45
+ @@option_parser = Optimist::Parser.new do
47
46
  subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
48
- usage @@usage
49
- synopsis <<~SUBCOMMANDS unless @@subcommands.empty?
47
+ subcommand_section = <<~SUBCOMMANDS unless @@subcommands.empty?
50
48
  Subcommands:
51
49
  #{@@subcommands.keys.map { |k| " #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
52
50
  SUBCOMMANDS
51
+ usage @@usage
52
+ synopsis @@description + (subcommand_section.nil? ? '' : "\n") + subcommand_section.to_s
53
53
  opt :empty,
54
54
  'Do not create the first, empty commit.'
55
55
  educate_on_error
@@ -59,10 +59,10 @@ class Init < Command
59
59
 
60
60
  def initialize
61
61
  super(@@usage, @@description) do
62
- @options = Common.with_subcommand_exception_handling @@commit_parser do
63
- @@commit_parser.parse
62
+ @options = Common.with_subcommand_exception_handling @@option_parser do
63
+ @@option_parser.parse
64
64
  end
65
- Common.error 'The current directory is already a git repository' if Common.in_git_repo?
65
+ Common.error 'The current directory is already a git repository' if Git.in_repo?
66
66
 
67
67
  init_repository
68
68
  end
@@ -0,0 +1,107 @@
1
+ # Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
2
+ # Copyright (C) 2023 Alex Speranza
3
+
4
+ # This program is free software: you can redistribute it and/or modify
5
+ # it under the terms of the GNU Lesser General Public License as published by
6
+ # the Free Software Foundation, either version 3 of the License, or
7
+ # (at your option) any later version.
8
+
9
+ # This program is distributed in the hope that it will be useful,
10
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
11
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
+ # GNU General Public License for more details.
13
+
14
+ # You should have received a copy of the GNU General Public License
15
+ # along with this program and the additional permissions granted by
16
+ # the Lesser GPL. If not, see <https://www.gnu.org/licenses/>.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ require 'get/commons/common'
21
+ require 'get/commons/git'
22
+ require 'get/subcommand/command'
23
+ require 'get/subcommand/license/license_retriever'
24
+
25
+ # Class length is disabled as most of its length is given by formatting.
26
+ # rubocop:disable Metrics/ClassLength
27
+ # Subcommand, it allow to choose a license.
28
+ class License < Command
29
+ def self.command
30
+ @@command ||= new
31
+ @@command
32
+ end
33
+
34
+ private_class_method :new
35
+
36
+ private
37
+
38
+ include Retriever
39
+
40
+ @@command = nil
41
+
42
+ @@usage = 'license -h|(<subcommand> [<subcommand-options])'
43
+ @@description = 'Create a new LICENSE file with the chosen license. ' \
44
+ 'Online licenses are retrieved from https://choosealicense.com/appendix/ . ' \
45
+ 'Head there for more information about the licences.'
46
+ @@subcommands = {}
47
+ # This block is Optimist configuration. It is as long as the number of options of the command.
48
+ # rubocop:disable Metrics/BlockLength
49
+ @@option_parser = Optimist::Parser.new do
50
+ subcommand_max_length = @@subcommands.keys.map { |k| k.to_s.length }.max
51
+ subcommand_section = <<~SUBCOMMANDS unless @@subcommands.empty?
52
+ Subcommands:
53
+ #{@@subcommands.keys.map { |k| " #{k.to_s.ljust(subcommand_max_length)} => #{@@subcommands[k].description}" }.join("\n")}
54
+ SUBCOMMANDS
55
+ usage @@usage
56
+ synopsis @@description + (subcommand_section.nil? ? '' : "\n") + subcommand_section.to_s
57
+ opt :offline,
58
+ 'Force the application to use the offline licenses.'
59
+ opt :create_commit,
60
+ 'Create a commit which adds the LICENSE file to the repository history.',
61
+ short: :none
62
+ opt :commit_type,
63
+ 'Select the type of the commit. No effect if "--create-commit" is not given.',
64
+ default: 'chore'
65
+ educate_on_error
66
+ stop_on @@subcommands.keys.map(&:to_s)
67
+ end
68
+ # rubocop:enable Metrics/BlockLength
69
+
70
+ def initialize
71
+ super(@@usage, @@description) do
72
+ @options = Common.with_subcommand_exception_handling @@option_parser do
73
+ @@option_parser.parse
74
+ end
75
+
76
+ @filename = 'LICENSE'
77
+
78
+ Common.error "The file '#{@filename}' already exists." if File.exist?(File.expand_path(@filename))
79
+
80
+ create_license_file
81
+
82
+ if @options[:create_commit]
83
+ Common.error 'Not in a git repository: a commit cannot be created.' unless Git.in_repo?
84
+
85
+ create_license_commit
86
+ end
87
+ end
88
+ end
89
+
90
+ def create_license_file
91
+ license_text = ask_for_license(@options[:offline])
92
+ File.write(File.expand_path(@filename), license_text)
93
+ puts 'License file created. You may need to modify it with the year and your name.'
94
+ end
95
+
96
+ def create_license_commit
97
+ `git stash push --staged`
98
+
99
+ # This block is given to at_exit to execute it in any case.
100
+ at_exit { `[ "$(git stash list | wc -l)" -gt "0" ] && git stash pop > /dev/null` }
101
+ `git add "#{@filename}" && git commit -m "chore: add license file"`
102
+ Common.error 'Failed to create license commit' if $CHILD_STATUS.exitstatus.positive?
103
+
104
+ puts 'License file committed.'
105
+ end
106
+ end
107
+ # rubocop:enable Metrics/ClassLength
@@ -0,0 +1,87 @@
1
+ # Get is a toolbox based on git which simplifies the adoption of conventions and some git commands.
2
+ # Copyright (C) 2023 Alex Speranza
3
+
4
+ # This program is free software: you can redistribute it and/or modify
5
+ # it under the terms of the GNU Lesser General Public License as published by
6
+ # the Free Software Foundation, either version 3 of the License, or
7
+ # (at your option) any later version.
8
+
9
+ # This program is distributed in the hope that it will be useful,
10
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
11
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
+ # GNU General Public License for more details.
13
+
14
+ # You should have received a copy of the GNU General Public License
15
+ # along with this program and the additional permissions granted by
16
+ # the Lesser GPL. If not, see <https://www.gnu.org/licenses/>.
17
+
18
+ # frozen_string_literal: true
19
+
20
+ require 'highline'
21
+
22
+ # The retrieving module for licenses. It can gather licenses online (from https://choosealicense.com/appendix/)
23
+ # or offline (from a predefined subset of licenses).
24
+ module Retriever
25
+ BASE_OFFLINE_LICENSE_PATH = "#{File.dirname(File.expand_path(__FILE__))}/offline_licenses".freeze
26
+ BASE_ONLINE_LICENSE_URI = 'https://choosealicense.com'
27
+
28
+ @@cli = HighLine.new
29
+
30
+ def ask_for_license(offline)
31
+ @@offline = offline
32
+ list = if @@offline
33
+ offline_license_list
34
+ else
35
+ online_license_list
36
+ end
37
+
38
+ @@cli.puts 'Choose which license you want to use:'
39
+ choice = @@cli.choose do |menu|
40
+ menu.flow = :column_down
41
+ menu.prompt = ''
42
+ list.each { |element| menu.choice(element) }
43
+ end
44
+
45
+ if @@offline
46
+ offline_license_text(choice)
47
+ else
48
+ online_license_text(choice)
49
+ end
50
+ end
51
+
52
+ private
53
+
54
+ def offline_license_list
55
+ Dir.children(BASE_OFFLINE_LICENSE_PATH)
56
+ end
57
+
58
+ def online_license_list
59
+ @@online_licenses = {}
60
+ text = `curl -fsL "#{BASE_ONLINE_LICENSE_URI}/appendix/" | grep '<th scope="row">'`.strip
61
+ if $CHILD_STATUS.exitstatus.positive?
62
+ puts 'WARNING: Unable to retrieve list of online licenses, falling back to offline ones.'
63
+ @@offline = true
64
+ offline_license_list
65
+ else
66
+ text.split("\n").each do |element|
67
+ match_result = element.match(%r{<a href="(.*)">(.*)</a>})
68
+ @@online_licenses[match_result[2]] = match_result[1]
69
+ end
70
+ @@online_licenses.keys
71
+ end
72
+ end
73
+
74
+ def offline_license_text(license)
75
+ File.read("#{BASE_OFFLINE_LICENSE_PATH}/#{license}/LICENSE")
76
+ end
77
+
78
+ def online_license_text(license)
79
+ page = `curl -fsL "#{BASE_ONLINE_LICENSE_URI}#{@@online_licenses[license]}"`
80
+ Common.error 'Failed to retrieve the license text.' if $CHILD_STATUS.exitstatus.positive?
81
+
82
+ match_result = page.match(%r{<pre id="license-text">(.*)</pre>}m)
83
+ Common.error 'Invalid license text' if match_result[1].nil?
84
+
85
+ match_result[1]
86
+ end
87
+ end
@@ -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 [yyyy] [name of copyright owner]
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.