Add non ASCII encoding schema support to RailsSchemaUpToDate hook (sd…

…s#786) * Add non ASCII encoding schema support to RailsSchemaUpToDate hook * Add guard to check presence of @config['encoding'] Co-authored-by: Paul Wilson <[email protected]>
zaratan · Jan 20, 2023 · 8bc2eec · 8bc2eec
1 parent 4d204bd
commit 8bc2eec
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 1 deletion.
diff --git a/lib/overcommit/hook/pre_commit/rails_schema_up_to_date.rb b/lib/overcommit/hook/pre_commit/rails_schema_up_to_date.rb
@@ -34,6 +34,12 @@ def run # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplex
 
  private
 
+ def encoding
+ return unless @config.key?('encoding')
+
+ { encoding: @config['encoding'] }.compact
+ end
+
  def migration_files
  @migration_files ||= applicable_files.select do |file|
  file.match %r{db/migrate/.*\.rb}
@@ -47,7 +53,7 @@ def schema_files
  end
 
  def schema
- @schema ||= schema_files.map { |file| File.read(file) }.join
+ @schema ||= schema_files.map { |file| File.read(file, encoding) }.join
  @schema.tr('_', '')
  end
 

diff --git a/spec/overcommit/hook/pre_commit/rails_schema_up_to_date_spec.rb b/spec/overcommit/hook/pre_commit/rails_schema_up_to_date_spec.rb
@@ -70,6 +70,33 @@
  end
 
  it { should fail_hook }
+
+ context 'when non ASCII encoding is required' do
+ let!(:config) do
+ super().merge(Overcommit::Configuration.new(
+ 'PreCommit' => {
+ 'RailsSchemaUpToDate' => {
+ 'encoding' => 'utf-8'
+ }
+ }
+ ))
+ end
+
+ before do
+ subject.stub(:applicable_files).and_return([sql_schema_file])
+ end
+
+ around do |example|
+ repo do
+ FileUtils.mkdir_p('db/migrate')
+ File.open(sql_schema_file, 'w') { |f| f.write("version: 12345678901234\nVALUES ('字')") }
+ `git add #{sql_schema_file}`
+ example.run
+ end
+ end
+
+ it { should fail_hook }
+ end
  end
 
  context 'when a Ruby schema file with the latest version and migrations are added' do