forked from mattbrictson/rails-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
template.rb
212 lines (177 loc) · 5.77 KB
/
template.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
RAILS_REQUIREMENT = "~> 5.2.0".freeze
def apply_template!
assert_minimum_rails_version
assert_valid_options
assert_postgresql
add_template_repository_to_source_path
template "Gemfile.tt", force: true
if apply_capistrano?
template "DEPLOYMENT.md.tt"
template "PROVISIONING.md.tt"
end
template "README.md.tt", force: true
remove_file "README.rdoc"
template "example.env.tt"
copy_file "editorconfig", ".editorconfig"
copy_file "gitignore", ".gitignore", force: true
copy_file "overcommit.yml", ".overcommit.yml"
template "ruby-version.tt", ".ruby-version", force: true
copy_file "simplecov", ".simplecov"
copy_file "Capfile" if apply_capistrano?
copy_file "Guardfile"
copy_file "Procfile"
apply "Rakefile.rb"
apply "config.ru.rb"
apply "app/template.rb"
apply "bin/template.rb"
apply "circleci/template.rb"
apply "config/template.rb"
apply "doc/template.rb"
apply "lib/template.rb"
apply "test/template.rb"
apply "variants/bootstrap/template.rb" if apply_bootstrap?
git :init unless preexisting_git_repo?
empty_directory ".git/safe"
run_with_clean_bundler_env "bin/setup"
create_initial_migration
generate_spring_binstubs
binstubs = %w[
annotate brakeman bundler bundler-audit guard rubocop sidekiq
terminal-notifier
]
binstubs.push("capistrano", "unicorn") if apply_capistrano?
run_with_clean_bundler_env "bundle binstubs #{binstubs.join(' ')} --force"
template "rubocop.yml.tt", ".rubocop.yml"
run_rubocop_autocorrections
unless any_local_git_commits?
git add: "-A ."
git commit: "-n -m 'Set up project'"
git checkout: "-b development" if apply_capistrano?
if git_repo_specified?
git remote: "add origin #{git_repo_url.shellescape}"
git push: "-u origin --all"
end
end
end
require "fileutils"
require "shellwords"
# Add this template directory to source_paths so that Thor actions like
# copy_file and template resolve against our source files. If this file was
# invoked remotely via HTTP, that means the files are not present locally.
# In that case, use `git clone` to download them to a local temporary dir.
def add_template_repository_to_source_path
if __FILE__ =~ %r{\Ahttps?://}
require "tmpdir"
source_paths.unshift(tempdir = Dir.mktmpdir("rails-template-"))
at_exit { FileUtils.remove_entry(tempdir) }
git clone: [
"--quiet",
"https://github.com/mattbrictson/rails-template.git",
tempdir
].map(&:shellescape).join(" ")
if (branch = __FILE__[%r{rails-template/(.+)/template.rb}, 1])
Dir.chdir(tempdir) { git checkout: branch }
end
else
source_paths.unshift(File.dirname(__FILE__))
end
end
def assert_minimum_rails_version
requirement = Gem::Requirement.new(RAILS_REQUIREMENT)
rails_version = Gem::Version.new(Rails::VERSION::STRING)
return if requirement.satisfied_by?(rails_version)
prompt = "This template requires Rails #{RAILS_REQUIREMENT}. "\
"You are using #{rails_version}. Continue anyway?"
exit 1 if no?(prompt)
end
# Bail out if user has passed in contradictory generator options.
def assert_valid_options
valid_options = {
skip_gemfile: false,
skip_bundle: false,
skip_git: false,
skip_test_unit: false,
edge: false
}
valid_options.each do |key, expected|
next unless options.key?(key)
actual = options[key]
unless actual == expected
fail Rails::Generators::Error, "Unsupported option: #{key}=#{actual}"
end
end
end
def assert_postgresql
return if IO.read("Gemfile") =~ /^\s*gem ['"]pg['"]/
fail Rails::Generators::Error,
"This template requires PostgreSQL, "\
"but the pg gem isn’t present in your Gemfile."
end
# Mimic the convention used by capistrano-mb in order to generate
# accurate deployment documentation.
def capistrano_app_name
app_name.gsub(/[^a-zA-Z0-9_]/, "_")
end
def git_repo_url
@git_repo_url ||=
ask_with_default("What is the git remote URL for this project?", :blue, "skip")
end
def production_hostname
@production_hostname ||=
ask_with_default("Production hostname?", :blue, "example.com")
end
def staging_hostname
@staging_hostname ||=
ask_with_default("Staging hostname?", :blue, "staging.example.com")
end
def gemfile_requirement(name)
@original_gemfile ||= IO.read("Gemfile")
req = @original_gemfile[/gem\s+['"]#{name}['"]\s*(,[><~= \t\d\.\w'"]*)?.*$/, 1]
req && req.gsub("'", %(")).strip.sub(/^,\s*"/, ', "')
end
def ask_with_default(question, color, default)
return default unless $stdin.tty?
question = (question.split("?") << " [#{default}]?").join
answer = ask(question, color)
answer.to_s.strip.empty? ? default : answer
end
def git_repo_specified?
git_repo_url != "skip" && !git_repo_url.strip.empty?
end
def preexisting_git_repo?
@preexisting_git_repo ||= (File.exist?(".git") || :nope)
@preexisting_git_repo == true
end
def any_local_git_commits?
system("git log &> /dev/null")
end
def apply_bootstrap?
ask_with_default("Use Bootstrap gems, layouts, views, etc.?", :blue, "no")\
=~ /^y(es)?/i
end
def apply_capistrano?
return @apply_capistrano if defined?(@apply_capistrano)
@apply_capistrano = \
ask_with_default("Use Capistrano for deployment?", :blue, "no") \
=~ /^y(es)?/i
end
def run_with_clean_bundler_env(cmd)
success = if defined?(Bundler)
Bundler.with_clean_env { run(cmd) }
else
run(cmd)
end
unless success
puts "Command failed, exiting: #{cmd}"
exit(1)
end
end
def run_rubocop_autocorrections
run_with_clean_bundler_env "bin/rubocop -a --fail-level A > /dev/null || true"
end
def create_initial_migration
return if Dir["db/migrate/**/*.rb"].any?
run_with_clean_bundler_env "bin/rails generate migration initial_migration"
run_with_clean_bundler_env "bin/rake db:migrate"
end
apply_template!