Merge pull request #7 from DannyBen/housekeeping

DannyBen · web-flow · commit cb0cb3f25555 · 2023-02-02T06:04:44.000+02:00
Housekeeping
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,3 @@
 /sample
 /spec/tmp
 /tmp
-/toc.txt
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,14 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+inherit_gem:
+  rentacop:
+    - rentacop.yml
+    - rspec.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - dev/**/*
+    - sample/**/*
diff --git a/Gemfile b/Gemfile
@@ -1,6 +1,7 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gem 'byebug'
+gem 'lp'
 gem 'rspec'
 gem 'rspec_approvals'
 gem 'runfile'
diff --git a/Runfile b/Runfile
@@ -1,17 +1,10 @@
-require "runfile-tasks"
 require "byebug"
-require_relative 'lib/recode'
+require 'recode'
 
 title   "Recode Developer Toolbelt"
 summary "Runfile tasks for building the Recode gem"
 version Recode::VERSION
 
-RunfileTasks::RubyGems.all 'recode'
-RunfileTasks::Testing.rspec
+import_gem 'runfile-tasks/gem', gemname: 'recode'
+import 'dev/debug'
 
-help   "Run interactive console"
-action :console, :c do
-  system "bundle exec bin/console"
-end
-
-require_relative 'debug.rb' if File.exist? 'debug.rb'
diff --git a/bin/console b/bin/console
@@ -1,9 +1,9 @@
 #!/usr/bin/env ruby
 
-require "irb"
-require "irb/completion" 
-require "recode"
+require 'irb'
+require 'irb/completion'
+require 'recode'
 
 include Recode
 
-IRB.start
+IRB.start
diff --git a/bin/recode b/bin/recode
@@ -13,4 +13,4 @@ rescue => e
   puts e.backtrace.reverse if ENV['DEBUG']
   say! "r`#{e.class}: #{e.message}`"
   exit 1
-end
+end
diff --git a/debug.rb b/debug.rb
diff --git a/demo/sample/people_controller.rb b/demo/sample/people_controller.rb
@@ -1,8 +1,7 @@
 class PeopleController
   def people
-    "we are the people to rule the world"
+    'we are the people to rule the world'
   end
 
-  def person
-  end
-end
+  def person; end
+end
diff --git a/lib/recode/change_variations.rb b/lib/recode/change_variations.rb
@@ -12,4 +12,4 @@ def change_variations(old_string, new_string)
       result.uniq
     end
   end
-end
+end
diff --git a/lib/recode/cli.rb b/lib/recode/cli.rb
@@ -1,6 +1,7 @@
 require 'mister_bin'
 require 'recode'
 require 'recode/command'
+require 'recode/version'
 
 module Recode
   class CLI
diff --git a/lib/recode/command.rb b/lib/recode/command.rb
@@ -1,26 +1,26 @@
 module Recode
   class Command < MisterBin::Command
-    help "Code Refactoring Utility"
+    help 'Code Refactoring Utility'
 
-    usage "recode OLD [to] NEW [in] EXTENSIONS... [options]"
-    usage "recode (-h|--help)"
+    usage 'recode OLD [to] NEW [in] EXTENSIONS... [options]'
+    usage 'recode (-h|--help)'
 
-    option "-a --apply", "Apply changes"
-    option "-p --prompt", "Apply changes interactively "
+    option '-a --apply', 'Apply changes'
+    option '-p --prompt', 'Apply changes interactively '
 
-    param "OLD", "Old string, singular and capitalized"
-    param "NEW", "New string, singular and capitalized"
-    param "EXTENSIONS", "Space delimited file extensions"
+    param 'OLD', 'Old string, singular and capitalized'
+    param 'NEW', 'New string, singular and capitalized'
+    param 'EXTENSIONS', 'Space delimited file extensions'
 
-    example "recode Member User rb"
-    example "recode Member to User in rb js"
-    example "recode Member to User in rb js --apply"
-    example "recode Member to User in rb js -p"
+    example 'recode Member User rb'
+    example 'recode Member to User in rb js'
+    example 'recode Member to User in rb js --apply'
+    example 'recode Member to User in rb js -p'
 
     def run
-      runner = Runner.new path: path, 
-        extensions: extensions, 
-        old_string: old_string, 
+      runner = Runner.new path: path,
+        extensions: extensions,
+        old_string: old_string,
         new_string: new_string
 
       runner.execute handler
@@ -39,9 +39,9 @@ def handler
     end
 
     def path
-      "."
+      '.'
     end
-    
+
     def extensions
       args['EXTENSIONS']
     end
@@ -53,7 +53,5 @@ def old_string
     def new_string
       args['NEW']
     end
-
-
   end
 end
diff --git a/lib/recode/diffing.rb b/lib/recode/diffing.rb
@@ -15,5 +15,4 @@ def diffy!
       Diffy::Diff
     end
   end
-
-end
+end
diff --git a/lib/recode/exceptions.rb b/lib/recode/exceptions.rb
@@ -1,3 +1,3 @@
 module Recode
   Abort = Class.new Interrupt
-end
+end
diff --git a/lib/recode/handler/apply.rb b/lib/recode/handler/apply.rb
@@ -12,4 +12,4 @@ def edit(file:, before:, after:)
       end
     end
   end
-end
+end
diff --git a/lib/recode/handler/base.rb b/lib/recode/handler/base.rb
@@ -5,13 +5,13 @@ class Base
       include Colsole
 
       def show_rename(source:, target:)
-        say "\nm`" + ("_" * terminal_width) + '`'
-        say "m`rename:`"
+        say "\nm`#{'_' * terminal_width}`"
+        say 'm`rename:`'
         puts diff source, target
       end
 
       def show_edit(file:, before:, after:)
-        say "\nb`" + ("_" * terminal_width) + '`'
+        say "\nb`#{'_' * terminal_width}`"
         say "b`edit: #{file}`"
         puts diff before, after
       end
@@ -26,4 +26,4 @@ def save_file(file, content)
       end
     end
   end
-end
+end
diff --git a/lib/recode/handler/output.rb b/lib/recode/handler/output.rb
@@ -10,4 +10,4 @@ def edit(file:, before:, after:)
       end
     end
   end
-end
+end
diff --git a/lib/recode/handler/prompt.rb b/lib/recode/handler/prompt.rb
@@ -12,25 +12,24 @@ def edit(file:, before:, after:)
         super
         save_file file, after if apply?
       end
-    
+
     private
 
       def apply?
         say "\nApply? gu`Y`es, gu`n`o, gu`q`uit : "
-        answer = $stdin.getch.downcase
-        
-        if answer == 'q' or answer == "\u0003"
-          say "b`Quit`"
+
+        case $stdin.getch.downcase
+        when 'q', "\u0003"
+          say 'b`Quit`'
           raise Recode::Abort
-        elsif answer == 'n'
-          say "r`No`"
+        when 'n'
+          say 'r`No`'
           false
         else
-          say "g`Yes`"
+          say 'g`Yes`'
           true
         end
       end
-
     end
   end
-end
+end
diff --git a/lib/recode/refinements.rb b/lib/recode/refinements.rb
@@ -2,12 +2,12 @@ module Recode
   module Refinements
     refine String do
       def underscore
-        self.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-        gsub(/([a-z\d])([A-Z])/,'\1_\2').
-        tr("-", "_").
-        downcase
+        gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
       end
     end
   end
-end
+end
diff --git a/lib/recode/runner.rb b/lib/recode/runner.rb
@@ -3,12 +3,13 @@ class Runner
     include Colsole
     include ChangeVariations
 
-    attr_accessor :path, :extensions, :old_string, :new_string
-    attr_accessor :handler
+    attr_accessor :path, :extensions, :old_string, :new_string, :handler
 
     def initialize(path: nil, extensions: nil, old_string: nil, new_string: nil)
-      @path, @extensions = path, extensions
-      @old_string, @new_string = old_string, new_string
+      @path = path
+      @extensions = extensions
+      @old_string = old_string
+      @new_string = new_string
     end
 
     def execute(handler)
@@ -31,14 +32,14 @@ def refactor_contents
     def refactor_filename(file)
       target = apply_changes file
       payload = { source: file, target: target }
-      handler.rename **payload unless target == file
+      handler.rename(**payload) unless target == file
     end
 
     def refactor_content(file)
       before = File.read file
       after = apply_changes before
       payload = { file: file, before: before, after: after }
-      handler.edit **payload unless before == after
+      handler.edit(**payload) unless before == after
     end
 
     def apply_changes(string)
diff --git a/lib/recode/version.rb b/lib/recode/version.rb
@@ -1,3 +1,3 @@
 module Recode
-  VERSION = "0.1.2"
-end
+  VERSION = '0.1.2'
+end
diff --git a/recode.gemspec b/recode.gemspec
@@ -1,23 +1,24 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'recode/version'
 
 Gem::Specification.new do |s|
   s.name        = 'recode'
   s.version     = Recode::VERSION
-  s.summary     = "Command line utility for refactoring code"
-  s.description = "Command line utility for refactoring code"
-  s.authors     = ["Danny Ben Shitrit"]
+  s.summary     = 'Command line utility for refactoring code'
+  s.description = 'Command line utility for refactoring code'
+  s.authors     = ['Danny Ben Shitrit']
   s.email       = 'db@dannyben.com'
   s.files       = Dir['README.md', 'lib/**/*.*']
   s.executables = ['recode']
   s.homepage    = 'https://github.com/dannyben/recode'
   s.license     = 'MIT'
 
-  s.required_ruby_version = ">= 2.7.0"
+  s.required_ruby_version = '>= 2.7.0'
 
-  s.add_runtime_dependency 'colsole', '~> 0.8', '>= 0.8.1'
+  s.add_runtime_dependency 'colsole', '>= 0.8.1', '< 2'
   s.add_runtime_dependency 'diffy', '~> 3.3'
   s.add_runtime_dependency 'mister_bin', '~> 0.7'
   s.add_runtime_dependency 'strings-inflection', '~> 0.1'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end
diff --git a/spec/approvals/cli/refactor/person-user b/spec/approvals/cli/refactor/person-user
@@ -13,15 +13,15 @@ ________________________________________________________________________________
 edit: ./people_controller.rb
 -class PeopleController
 -  def people
--    "we are the people to rule the world"
+-    'we are the people to rule the world'
 +class UsersController
 +  def users
-+    "we are the users to rule the world"
++    'we are the users to rule the world'
    end
  
--  def person
-+  def user
-   end
+-  def person; end
++  def user; end
+ end
 
 ________________________________________________________________________________
 edit: ./person/people.yml
diff --git a/spec/approvals/cli/refactor/person-user-apply b/spec/approvals/cli/refactor/person-user-apply
@@ -20,12 +20,12 @@ ________________________________________________________________________________
 edit: ./users_controller.rb
 -class PeopleController
 -  def people
--    "we are the people to rule the world"
+-    'we are the people to rule the world'
 +class UsersController
 +  def users
-+    "we are the users to rule the world"
++    'we are the users to rule the world'
    end
  
--  def person
-+  def user
-   end
+-  def person; end
++  def user; end
+ end
diff --git a/spec/approvals/cli/refactor/person-user-prompt b/spec/approvals/cli/refactor/person-user-prompt
diff --git a/spec/approvals/cli/refactor/person-user-prompt-no b/spec/approvals/cli/refactor/person-user-prompt-no
diff --git a/spec/fixtures/sample/people_controller.rb b/spec/fixtures/sample/people_controller.rb
diff --git a/spec/recode/bin_spec.rb b/spec/recode/bin_spec.rb
diff --git a/spec/recode/change_variations_spec.rb b/spec/recode/change_variations_spec.rb
diff --git a/spec/recode/command_spec.rb b/spec/recode/command_spec.rb
diff --git a/spec/recode/diffing_spec.rb b/spec/recode/diffing_spec.rb

-Original file line number
+Diff line change
       result.uniq
     end
   end
 -end
 +end