dotsync 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77103d8c8a478216d16d1dcafe30fb6e6db158df43da7749245b55b8066c2d8c
-  data.tar.gz: 87762883d28d5afa94020faec9f9fad6d681345872e8dfed92234ded3d0816a4
+  metadata.gz: 9b671284dfcdd29739df951c9656b8a0a9867619b57175ac62c5eb6f45137ed0
+  data.tar.gz: 26ee6f58257a4a556ea2a7f1eedc06660743fd47e1e073f1977b0a591a2db7f3
 SHA512:
-  metadata.gz: fc405ffb5b91817d04bd3cb956afa5072775ae8553ba52560e4c6a4cf769ad8d51c0e3a3a8b7b27b486b7f894cd305a6a2c35d6372c1f7a14fed838353a283cd
-  data.tar.gz: 809db157e89fd45045a80d75fe55775677efa9b7ebda413f4bfd5e95f765769a3447afbf7edd839f2a68d481e569fe33f59c06e2679ab08b4b097b423023cba3
+  metadata.gz: a0206e946ca9040ed97d5385c33fea54b0080e824fbe5c3844adac5bc37cdf452e75efd6ebc40ac1f40d66d1bfa52e9f60ec962ab5a247dda0a8acdea15c2235
+  data.tar.gz: 2902acbf3de208132ced6cde1b22f4f3a5a72eacacd6c9c048d3edbf8f20ebf636bf5e7549aec207aba07c642d0a54cf55a6684191a6cb259c66fd31878e32bc

data/.github/workflows/gem-push.yml

@@ -29,6 +29,10 @@ jobs:
         run: |
           bundle exec rake
 
+      - name: Run RuboCop
+        run: |
+          bundle exec rubocop
+
       - name: Publish to RubyGems
         if: matrix.ruby == '3.2'
         run: |

data/.rubocop.yml

@@ -0,0 +1,353 @@
+plugins:
+  - rubocop-rspec
+  - rubocop-performance
+  - rubocop-md
+  - rubocop-rake
+
+AllCops:
+  # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
+  # to ignore them, so only the ones explicitly set in this file are enabled.
+  DisabledByDefault: true
+
+Performance:
+  Exclude:
+    - '**/test/**/*'
+
+# Prefer &&/|| over and/or.
+Style/AndOr:
+  Enabled: true
+
+Layout/ClosingHeredocIndentation:
+  Enabled: true
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: true
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/DefEndAlignment:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+  AutoCorrect: true
+
+Layout/EndOfLine:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: only_before
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: either
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: indented_internal_methods
+  Exclude:
+    - '**/*.md'
+
+# Two spaces, no tabs (for indentation).
+Layout/IndentationWidth:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeComment:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+  Exclude:
+    - 'actionview/test/**/*.builder'
+    - 'actionview/test/**/*.ruby'
+    - 'actionpack/test/**/*.builder'
+    - 'actionpack/test/**/*.ruby'
+    - 'activestorage/db/migrate/**/*.rb'
+    - 'activestorage/db/update_migrate/**/*.rb'
+    - 'actionmailbox/db/migrate/**/*.rb'
+    - 'actiontext/db/migrate/**/*.rb'
+    - '**/*.md'
+
+Style/MapToHash:
+  Enabled: true
+
+Style/RedundantFreeze:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Check quotes usage according to lint rule below.
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Empty lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: true
+
+Lint/NestedMethodDefinition:
+  Enabled: true
+
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+  DebuggerRequires:
+    - debug
+
+Lint/DuplicateRequire:
+  Enabled: true
+
+Lint/DuplicateMagicComment:
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/ErbNewArguments:
+  Enabled: true
+
+Lint/EnsureReturn:
+  Enabled: true
+
+Lint/MissingCopEnableDirective:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/RedundantCopDisableDirective:
+  Enabled: true
+
+Lint/RedundantCopEnableDirective:
+  Enabled: true
+
+Lint/RedundantRequireStatement:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/RedundantSafeNavigation:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/InterpolationCheck:
+  Enabled: true
+  Exclude:
+    - '**/test/**/*'
+
+Lint/SafeNavigationChain:
+  Enabled: true
+
+Style/EvalWithLocation:
+  Enabled: true
+  Exclude:
+    - '**/test/**/*'
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/TrivialAccessors:
+  Enabled: true
+
+# Prefer a = b || c over a = b ? b : c
+Style/RedundantCondition:
+  Enabled: true
+
+Style/RedundantDoubleSplatHashBraces:
+  Enabled: true
+
+Style/OpenStructUse:
+  Enabled: true
+
+Style/ArrayIntersect:
+  Enabled: true
+
+Style/KeywordArgumentsMerging:
+  Enabled: true
+
+Performance/BindCall:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+Performance/MapCompact:
+  Enabled: true
+
+Performance/SelectMap:
+  Enabled: true
+
+Performance/RedundantMerge:
+  Enabled: true
+
+Performance/StartWith:
+  Enabled: true
+
+Performance/EndWith:
+  Enabled: true
+
+Performance/RegexpMatch:
+  Enabled: true
+
+Performance/ReverseEach:
+  Enabled: true
+
+Performance/StringReplacement:
+  Enabled: true
+
+Performance/DeletePrefix:
+  Enabled: true
+
+Performance/DeleteSuffix:
+  Enabled: true
+
+Performance/InefficientHashSearch:
+  Enabled: true
+
+Performance/ConstantRegexp:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Markdown:
+  # Whether to run RuboCop against non-valid snippets
+  WarnInvalid: true
+  # Whether to lint codeblocks without code attributes
+  Autodetect: false

data/CHANGELOG.md

@@ -1,17 +1,27 @@
+# 0.1.6
+
+- Show diff changes on PushAction and PullAction.
+- Fixed load custom config (Icons, Colors)
+
+# 0.1.5
+
+- Fixes backup when destination folder does not exist
+- Add rubocop to Github Actions
+
 # 0.1.4
 
-Colorized environment variables
-Fixed colorized mapping entries
+- Colorized environment variables
+- Fixed colorized mapping entries
 
 # 0.1.3
 
-PushAction: Avoid error on missing destination
-Unify mappings print. Use icon for ignores presence.
-Extracted icons to its own module
-Reviewed icons
-Updated README with existing mapping entries icons
-Customizable icons
-Logger review
+- PushAction: Avoid error on missing destination
+- Unify mappings print. Use icon for ignores presence.
+- Extracted icons to its own module
+- Reviewed icons
+- Updated README with existing mapping entries icons
+- Customizable icons
+- Logger review
 
 # 0.1.2
 

data/Gemfile

@@ -4,10 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in dotsync.gemspec
 gemspec
-
-# gem "irb"
-# gem "rake", "~> 13.0"
-#
-# gem "rspec", "~> 3.0"
-#
-# gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    dotsync (0.1.4)
+    dotsync (0.1.6)
       fileutils (~> 1.7.3)
+      find (~> 0.2.0)
       listen (~> 3.9.0)
       logger (~> 1.7.0)
       ostruct (~> 0.6.3)
@@ -26,6 +27,7 @@ GEM
     ffi (1.17.2-x86_64-linux-gnu)
     ffi (1.17.2-x86_64-linux-musl)
     fileutils (1.7.3)
+    find (0.2.0)
     json (2.15.2)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
@@ -75,6 +77,19 @@ GEM
     rubocop-ast (1.47.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
+    rubocop-md (2.0.3)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rake (0.7.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
+    rubocop-rspec (3.7.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
     ruby-lsp (0.26.1)
       language_server-protocol (~> 3.17.0)
       prism (>= 1.2, < 2.0)
@@ -106,6 +121,10 @@ DEPENDENCIES
   rake (~> 13.3.0)
   rspec (~> 3.13.1)
   rubocop (~> 1.81.1)
+  rubocop-md (~> 2.0.3)
+  rubocop-performance (~> 1.26.1)
+  rubocop-rake (~> 0.7.1)
+  rubocop-rspec (~> 3.7.0)
   ruby-lsp (~> 0.26.1)
   timecop (~> 0.9.10)
 

data/README.md

@@ -11,7 +11,7 @@ Welcome to Dotsync! This gem helps you manage and synchronize your dotfiles effo
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'dotsync'
+gem "dotsync"
 ```
 
 And then execute:

data/Rakefile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-require 'dotsync'
+require "dotsync"
 
 # Load all tasks
-Dir.glob(File.join(Gem.loaded_specs['dotsync'].full_gem_path, 'lib', 'dotsync', 'tasks', '**/*.rake')).each { |f| load f }
+Dir.glob(File.join(Gem.loaded_specs["dotsync"].full_gem_path, "lib", "dotsync", "tasks", "**/*.rake")).each { |f| load f }
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   # ENV['TEST_ENV'] = 'true'

data/dotsync.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/dotsync/version"
 
 Gem::Specification.new do |spec|
@@ -18,7 +20,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
@@ -30,9 +32,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency "fileutils", "~> 1.7.3"
   spec.add_dependency "logger", "~> 1.7.0" # No longer part of default gems from Ruby 3.5
   spec.add_dependency "ostruct", "~> 0.6.3" # No longer part of default gems from Ruby 3.5
+  spec.add_dependency "find", "~> 0.2.0"
   spec.add_development_dependency "rake", "~> 13.3.0"
   spec.add_development_dependency "rspec", "~> 3.13.1"
   spec.add_development_dependency "rubocop", "~> 1.81.1"
+  spec.add_development_dependency "rubocop-rspec", "~> 3.7.0"
+  spec.add_development_dependency "rubocop-performance", "~> 1.26.1"
+  spec.add_development_dependency "rubocop-rake", "~> 0.7.1"
+  spec.add_development_dependency "rubocop-md", "~> 2.0.3"
   spec.add_development_dependency "timecop", "~> 0.9.10"
   spec.add_development_dependency "ruby-lsp", "~> 0.26.1"
 end

data/exe/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "dotsync"

data/exe/dotsync

@@ -1,9 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require_relative '../lib/dotsync'
-require 'optparse'
+require_relative "../lib/dotsync"
+require "optparse"
 
-options = {}
+{}
 
 opt_parser = OptionParser.new do |opts|
   opts.banner = <<~BANNER
@@ -44,4 +45,3 @@ else
   end
   exit 1
 end
-

data/lib/dotsync/actions/base_action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dotsync
   class BaseAction
     include Dotsync::PathUtils

data/lib/dotsync/actions/concerns/mappings_transfer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dotsync
   module MappingsTransfer
     extend Forwardable # def_delegator
@@ -5,13 +7,28 @@ module Dotsync
     def_delegator :@config, :mappings
 
     def show_mappings
-      info("Mappings:", icon: :config, )
+      info("Mappings:", icon: :config,)
 
       mappings.each do |mapping|
         logger.log("  #{mapping}")
       end
     end
 
+    def show_changes
+      diffs = valid_mappings.map do |mapping|
+        Dotsync::DirectoryDiffer.new(mapping).diff
+      end
+      diffs.flat_map(&:additions).sort.each do |path|
+        logger.log("  #{path}", color: Dotsync::Colors.diff_additions)
+      end
+      diffs.flat_map(&:modifications).sort.each do |path|
+        logger.log("  #{path}", color: Dotsync::Colors.diff_modifications)
+      end
+      diffs.flat_map(&:removals).sort.each do |path|
+        logger.log("  #{path}", color: Dotsync::Colors.diff_removals)
+      end
+    end
+
     def transfer_mappings
       valid_mappings.each do |mapping|
         Dotsync::FileTransfer.new(mapping).transfer

data/lib/dotsync/actions/pull_action.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dotsync
   class PullAction < BaseAction
     include MappingsTransfer
@@ -6,6 +8,7 @@ module Dotsync
 
     def execute
       show_config
+      show_changes
       if create_backup
         show_backup
         purge_old_backups
@@ -14,7 +17,6 @@ module Dotsync
     end
 
     private
-
       def show_config
         show_mappings
       end
@@ -22,44 +24,46 @@ module Dotsync
       def pull_dotfiles
         transfer_mappings
 
-        action("Dotfiles pulled", icon: :copy)
+        action("Dotfiles pulled")
       end
 
       def show_backup
-        action("Backup created:", icon: :backup)
-        logger.log("  #{backup_path}")
+        action("Backup created:")
+        logger.log("  #{backup_root_path}")
       end
 
       def timestamp
-        Time.now.strftime('%Y%m%d%H%M%S')
+        Time.now.strftime("%Y%m%d%H%M%S")
       end
 
-      def backup_path
-        @backup_path ||= File.join(backups_root, timestamp)
+      def backup_root_path
+        @backup_root_path ||= File.join(backups_root, timestamp)
       end
 
       def create_backup
         return false unless valid_mappings.any?
-        FileUtils.mkdir_p(backup_path)
-        mappings.each do |mapping|
-          next unless File.exist?(mapping.dest)
+        FileUtils.mkdir_p(backup_root_path)
+        valid_mappings.each do |mapping|
+          next unless mapping.backup_possible?
+          backup_path = File.join(backup_root_path, mapping.backup_basename)
           if File.file?(mapping.src)
-            FileUtils.cp(mapping.dest, File.join(backup_path, File.basename(mapping.dest)))
+            FileUtils.cp(mapping.dest, backup_path)
           else
-            FileUtils.cp_r(mapping.dest, File.join(backup_path, File.basename(mapping.dest)))
+            FileUtils.cp_r(mapping.dest, backup_path)
           end
         end
         true
       end
 
       def purge_old_backups
-        backups = Dir[File.join(backups_root, '*')].sort.reverse
+        backups = Dir[File.join(backups_root, "*")].sort.reverse
         if backups.size > 10
-          info("Maximum of 10 backups retained")
+          logger.log("Maximum of 10 backups retained")
 
+          action("Backup deleted:")
           backups[10..].each do |path|
             FileUtils.rm_rf(path)
-            info("Old backup deleted: #{path}", icon: :delete)
+            logger.log("  #{path}")
           end
         end
       end