Rubocop

Author: zealot128

.rubocop.yml

@@ -0,0 +1,35 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+
+Style:
+  Enabled: false
+Metrics:
+  Enabled: false
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - "lib/extract_i18n/adapters/slim_adapter_wip.rb"
+
+Naming/PredicateName:
+  Enabled: false
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Lint/MissingCopEnableDirective:
+  Enabled: false
+Lint/MixedRegexpCaptureTypes:
+  Enabled: false
+Layout/LineLength:
+  Exclude:
+    - "spec/**/*.rb"

Gemfile

@@ -1,10 +1,14 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in extract_i18n.gemspec
 gemspec
 
 gem 'pry'
+gem 'rake'
 gem 'rspec'
+gem 'rubocop'
 gem 'solargraph'

extract_i18n.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Stefan Wienert"]
   spec.email         = ["[email protected]"]
 
-  spec.summary       = %q{Extact i18n from RUBY Files using Ruby parser}
-  spec.description   = %q{Extact i18n from RUBY Files using Ruby parser}
+  spec.summary       = %q{Extact i18n from Ruby files using Ruby parser and slim files using regex}
+  spec.description   = %q{Extact i18n from Ruby files using Ruby parser and slim files using regex interactively}
   spec.homepage      = "https://github.com/pludoni/extract_i18n"
   spec.license       = "MIT"
 
@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'parser', '>= 2.6'
   spec.add_runtime_dependency 'slim'
-  spec.add_runtime_dependency 'zeitwerk'
   spec.add_runtime_dependency 'tty-prompt'
+  spec.add_runtime_dependency 'zeitwerk'
   spec.add_dependency "diff-lcs"
   spec.add_dependency "diffy"
 end

lib/extract_i18n/adapters/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExtractI18n::Adapters
   class Adapter
     def self.for(file_path)

lib/extract_i18n/adapters/ruby_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'parser/current'
 require 'tty-prompt'
 require 'pry'
@@ -58,7 +60,9 @@ def on_dstr(node)
 
       i18n_key = ExtractI18n.key(node.children.select { |i| i.type == :str }.map { |i| i.children[0] }.join(' '))
 
-      ask_and_continue(i18n_key: i18n_key, i18n_string: out_string, interpolate_arguments: interpolate_arguments, node: node)
+      ask_and_continue(
+        i18n_key: i18n_key, i18n_string: out_string, interpolate_arguments: interpolate_arguments, node: node,
+      )
     end
 
     def on_str(node)

lib/extract_i18n/adapters/slim_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExtractI18n::Adapters
   class SlimAdapter < Adapter
     def self.supports_relative_keys?

lib/extract_i18n/adapters/slim_adapter_wip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'slim'
 
 module ExtractI18n::Adapters
@@ -107,7 +109,6 @@ def indent
       #   binding.pry
       #   result = super
 
-
       #   change = ExtractI18n::SourceChange.new(
       #     i18n_key: "#{@file_key}.#{i18n_key}",
       #     i18n_string: i18n_string,

lib/extract_i18n/adapters/vue_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExtractI18n::Adapters
   class VueAdapter < SlimAdapter
     def process_line(old_line)

lib/extract_i18n/cli.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/LineLength
+
 require 'optparse'
 require 'extract_i18n'
 require 'extract_i18n/file_processor'

lib/extract_i18n/file_processor.rb

@@ -34,7 +34,7 @@ def run
 
     private
 
-    def read_and_transform(&block)
+    def read_and_transform(&_block)
       key = if @options[:namespace]
               "#{@options[:namespace]}.#{@file_key}"
             else

lib/extract_i18n/slimkeyfy/slim_transformer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExtractI18n
   class Slimkeyfy::SlimTransformer
     TRANSLATED = /t\s*\(?\s*(".*?"|'.*?')\s*\)?/.freeze
@@ -49,7 +51,7 @@ def initialize(word, file_key)
 
     private
 
-    def parse_html(&block)
+    def parse_html(&_block)
       return @word.line if @word.line.match(TRANSLATED)
 
       tagged_with_equals = Slimkeyfy::Whitespacer.convert_slim(@word.head)

lib/extract_i18n/slimkeyfy/vue_transformer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ExtractI18n::Slimkeyfy::VueTransformer < ExtractI18n::Slimkeyfy::SlimTransformer
   BEFORE = /(?<before>.*[\( ^])/.freeze
   HTML_ARGUMENTS = {
@@ -15,7 +17,7 @@ def regex_list
     HTML_ARGUMENTS.map { |_, regex| /#{BEFORE}#{regex}#{TRANSLATION}#{AFTER}/ }
   end
 
-  def parse_html(&block)
+  def parse_html(&_block)
     return @word.line if @word.line.match(TRANSLATED)
     return @word.line if @word.tail.join(" ")[/^{{.*}}$/]
 

lib/extract_i18n/slimkeyfy/whitespacer.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 module ExtractI18n
   class Slimkeyfy::Whitespacer
     HTML = /([a-z\.]+[0-9\-]*)+/.freeze
     HTML_TAGS = /^(?<html_tag>'|\||#{HTML})/.freeze
 
-    def self.convert_slim(s)
-      m = s.match(HTML_TAGS)
+    def self.convert_slim(string)
+      m = string.match(HTML_TAGS)
 
-      return s if m.nil? or m[:html_tag].nil?
-      return s if has_equals_tag?(s, m[:html_tag])
+      return string if m.nil? or m[:html_tag].nil?
+      return string if has_equals_tag?(string, m[:html_tag])
       tag = m[:html_tag]
 
       case tag
       when /\|/
-        s.gsub("|", "=")
+        string.gsub("|", "=")
       when /\'/
-        s.gsub("'", "=>")
+        string.gsub("'", "=>")
       when HTML
-        s.gsub(s, "#{s} =")
-      else s end
+        string.gsub(string, "#{string} =")
+      else string end
     end
 
     def self.convert_nbsp(body, tag)
@@ -37,8 +39,8 @@ def self.trailing_nsbp(body, tag)
       return ">" if body.end_with?("&nbsp;")
     end
 
-    def self.has_equals_tag?(s, html_tag)
-      s.gsub(html_tag, "").strip.start_with?("=")
+    def self.has_equals_tag?(string, html_tag)
+      string.gsub(html_tag, "").strip.start_with?("=")
     end
   end
 end

lib/extract_i18n/slimkeyfy/word.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ExtractI18n::Slimkeyfy
   class Word
     attr_reader :line, :tokens, :indentation
@@ -20,9 +22,9 @@ def as_list
       has_html_form = !!@line[/^ *[\.#]?[a-z\.#-]+\(/]
       delimiter_items =
         @line.
-          sub(/^(\s*\|)(\w)/, "\\1 \\2"). # add a whitespace to support "|string"
-          split(has_html_form ? /(?<=[\(])| +/ : ' '). # split by whitespace or ( but keep (
-          drop_while { |i| i == "" } # .. but that leaves leading ""
+        sub(/^(\s*\|)(\w)/, "\\1 \\2"). # add a whitespace to support "|string"
+        split(has_html_form ? /(?<=[\(])| +/ : ' '). # split by whitespace or ( but keep (
+        drop_while { |i| i == "" } # .. but that leaves leading ""
       items = []
       # div: div
       delimiter_items.reverse_each do |item|

lib/extract_i18n/source_change.rb

@@ -1,4 +1,5 @@
-# rubocop:disable Metrics/ParameterLists
+# frozen_string_literal: true
+
 require 'pastel'
 
 module ExtractI18n
@@ -21,7 +22,15 @@ class SourceChange
     #   how to format the replacement translation, use 2 placeholder %s for the string and for the optional arguments
     # @param interpolation_type [Symbol]
     #   :ruby or :vue
-    def initialize(i18n_key:, i18n_string:, interpolate_arguments:, source_line:, remove:, t_template: %{I18n.t("%s"%s)}, interpolation_type: :ruby)
+    def initialize(
+      i18n_key:,
+      i18n_string:,
+      interpolate_arguments:,
+      source_line:,
+      remove:,
+      t_template: %{I18n.t("%s"%s)},
+      interpolation_type: :ruby
+    )
       @i18n_string = i18n_string
       @key = i18n_key
       @interpolate_arguments = interpolate_arguments
@@ -34,12 +43,12 @@ def initialize(i18n_key:, i18n_string:, interpolate_arguments:, source_line:, re
     def format
       s = ""
       s += PASTEL.cyan("replace:  ") + PASTEL.blue(@source_line).
-        gsub(@remove, PASTEL.red(@remove))
+           gsub(@remove, PASTEL.red(@remove))
       unless @source_line.include?("\n")
         s += "\n"
       end
       s += PASTEL.cyan("with:     ") + PASTEL.blue(@source_line).
-        gsub(@remove, PASTEL.green(i18n_t))
+           gsub(@remove, PASTEL.green(i18n_t))
       unless @source_line.include?("\n")
         s += "\n"
       end

spec/adapters/slim_adapter_spec.rb

@@ -6,7 +6,8 @@
       "div.foobar\n  p Hello World" => [
         "div.foobar\n  p = t('models.foo.hello_world')\n",
         { "models.foo.hello_world" => "Hello World" }
-      ])
+      ]
+    )
   end
 
   specify 'pipe' do

spec/adapters/vue_adapter_spec.rb

@@ -1,5 +1,3 @@
-# rubocop:disable Lint/InterpolationCheck
-
 RSpec.describe ExtractI18n::Adapters::VueAdapter do
   specify "block content" do
     view = template("div.foo\n  | Content\n")

spec/file_processor_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # rubocop:disable Lint/InterpolationCheck
 RSpec.describe ExtractI18n::FileProcessor do
   around(:each) do |ex|

spec/spec_helper.rb

@@ -1,18 +1,3 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 require 'extract_i18n'
 require 'pry'
 
@@ -66,59 +51,5 @@ def cmp!(hash)
   config.shared_context_metadata_behavior = :apply_to_host_groups
 
   config.example_status_persistence_file_path = "spec/.examples.txt"
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # This allows you to limit a spec run to individual examples or groups
-  # you care about by tagging them with `:focus` metadata. When nothing
-  # is tagged with `:focus`, all examples get run. RSpec also provides
-  # aliases for `it`, `describe`, and `context` that include `:focus`
-  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  config.filter_run_when_matching :focus
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = "doc"
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
-
-  config.include AdapterHelpers, file_path: /spec\/adapters/
+  config.include AdapterHelpers, file_path: %r{spec/adapters}
 end