dotsync 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08b051bb2f245604662fd3f8347c70152dffb43d243d96bef919c38433a53124'
-  data.tar.gz: 79c2af0084417ad7c8253deac085b0466bbfd5d3c7b0c20054e92899907921b9
+  metadata.gz: e8cf43f8c36d398e1f87c3dd0e84ec9e36a6b1da7de4b3002546f0bbacb3e4ff
+  data.tar.gz: b32a336b5a4e63983a4a6ee3a7bcc4f50cb70ccd268a0066f8343e05fa8cf5d7
 SHA512:
-  metadata.gz: 21107170e600b1649aebdf5c5b4a2b4750c796c6800684a3a9bf3bf32eac88c6ea3a55056c7bab5a910b4a244aa95bae56627d222f56756f376704992a3bbdd7
-  data.tar.gz: 4b920346a4a3dd410e35374678a957517a53d3dbcbe4fff737c7a0e88040c842e0a526728d923bd471b85c5660a5505ea0eeb4e5fe7dd22734b45e7b4c6d1d63
+  metadata.gz: 28e35c812f55e418525df64090b3b119f250561f209a1e2788218e4a0c41360824aaba93531cd6ad969d022795a0b7a92e046c26e62dad829d64535d7f7d995b
+  data.tar.gz: d8812f07850fa2823448e59a78471655735a9b7f78f6d9983ab8e5c83aa8adf887b47dd4e517901046666d85d412bbd5ea08e07656aee8186aceeaf4f2f441bd

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 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
+
 # 0.1.2
 
 Add gem version on usage banner

data/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: .
   specs:
-    dotsync (0.1.2)
+    dotsync (0.1.3)
       fileutils (~> 1.7.3)
       listen (~> 3.9.0)
       logger (~> 1.7.0)
-      ostruct (~> 0.6.3)
       toml-rb (~> 4.0.0)
 
 GEM
@@ -33,7 +32,6 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
-    ostruct (0.6.3)
     parallel (1.27.0)
     parser (3.3.9.0)
       ast (~> 2.4.1)

data/README.md

@@ -1,5 +1,7 @@
 # Dotsync
 
+**⚠️ Warning: This gem is under active development. You can expect new changes that may not be backward-compatible.**
+
 [![Ruby Gem Test Status](https://github.com/dsaenztagarro/dotsync/actions/workflows/gem-push.yml/badge.svg)](https://github.com/dsaenztagarro/dotsync/actions)
 
 Welcome to Dotsync! This gem helps you manage and synchronize your dotfiles effortlessly. Below you'll find information on installation, usage, and some tips for getting started.
@@ -72,6 +74,40 @@ mappings = [
 ]
 ```
 
+#### `force` and `ignore` Options in Mappings
+
+Each mapping entry supports the following options:
+
+- **`force`**: A boolean (true/false) value. When set to `true`, it forces deletion of the destination folder before transferring files from the source. This is particularly useful when you need to ensure that the destination is clean before a transfer.
+- **`ignore`**: An array of patterns or file names to exclude during the transfer. This allows you to specify files or folders that should not be copied from the source to the destination.
+
+These options apply when the source is a directory and are relevant for both `push` and `pull` operations.
+
+### Rendering Mappings with Icons
+
+When running `push` or `pull` actions, the mappings are rendered in the console with relevant icons to provide visual feedback on the status of each mapping. To correctly view these icons, ensure you are using a terminal that supports a patched [Nerd Font](https://www.nerdfonts.com). Below are some examples of how the mappings are displayed:
+
+- **Force Icon**:
+  ```
+  Mappings:
+    $DOTFILES_DIR/config/ → $XDG_CONFIG_HOME ⚡
+  ```
+  The ⚡ icon (`Dotsync::Icons::FORCE`) indicates that the `force` option is enabled and the destination folder will be cleared before the transfer.
+
+- **Ignore Icon**:
+  ```
+  Mappings:
+    $DOTFILES_DIR/home/.zshenv → $HOME 🚫
+  ```
+  The 🚫 icon (`Dotsync::Icons::IGNORE`) indicates that certain files or patterns are being ignored during the transfer.
+
+- **Invalid Icon**:
+  ```
+  Mappings:
+    $DOTFILES_DIR/home/.vimrc → $HOME ❌
+  ```
+  The ❌ icon (`Dotsync::Icons::INVALID`) indicates that the mapping is invalid due to missing source or destination paths.
+
 ### Pro Tips
 
 - **Using rbenv**: To ensure the gem uses the correct Ruby version managed by rbenv, you can run:

data/dotsync.gemspec

@@ -29,7 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "listen", "~> 3.9.0"
   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_development_dependency "rake", "~> 13.3.0"
   spec.add_development_dependency "rspec", "~> 3.13.1"
   spec.add_development_dependency "rubocop", "~> 1.81.1"

data/lib/dotsync/actions/base_action.rb

@@ -9,35 +9,12 @@ module Dotsync
     def_delegator :logger, :action
 
     def initialize(config, logger)
-      @log_queue = Queue.new
       @config = config
       @logger = logger
-      setup_logger_thread
-      setup_signal_trap
     end
 
     def execute
       raise NotImplementedError
     end
-
-    private
-
-      def setup_signal_trap
-        Signal.trap("INT") do
-          @log_queue << { type: :info, message: "Shutting down gracefully...", icon: :bell }
-          exit
-        end
-      end
-
-      def setup_logger_thread
-        return if ENV['TEST_ENV'] == 'true'
-
-        Thread.new do
-          loop do
-            log_entry = @log_queue.pop
-            @logger.info(log_entry[:message], icon: log_entry[:icon])
-          end
-        end
-      end
   end
 end

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

@@ -0,0 +1,25 @@
+module Dotsync
+  module MappingsTransfer
+    extend Forwardable # def_delegator
+
+    def_delegator :@config, :mappings
+
+    def show_mappings
+      info("Mappings:", icon: :config, )
+
+      mappings.each do |mapping|
+        info("  #{mapping}")
+      end
+    end
+
+    def transfer_mappings
+      valid_mappings.each do |mapping|
+        Dotsync::FileTransfer.new(mapping).transfer
+      end
+    end
+
+    def valid_mappings
+      mappings.select(&:valid?)
+    end
+  end
+end

data/lib/dotsync/actions/config/mapping_entry.rb

@@ -32,12 +32,15 @@ module Dotsync
     end
 
     def valid?
-      File.exist?(@sanitized_src) && File.exist?(@sanitized_dest)
+      File.exist?(@sanitized_src) && File.exist?(File.dirname(@sanitized_dest))
     end
 
     def to_s
-      force_icon = force? ? "  #{icon_delete}" : ""
-      "#{original_src} → #{original_dest}#{force_icon}"
+      msg = ["#{original_src} → #{original_dest}"]
+      msg << Icons.force if force?
+      msg << Icons.ignore if ignores?
+      msg << Icons.invalid unless valid?
+      msg.join(" ")
     end
 
     def applied_to(path)
@@ -57,8 +60,8 @@ module Dotsync
 
     private
 
-    def icon_delete
-      Dotsync::Logger::ICONS[:delete]
+    def ignores?
+      @original_ignores.any?
     end
   end
 end

data/lib/dotsync/actions/pull_action.rb

@@ -1,6 +1,7 @@
 module Dotsync
   class PullAction < BaseAction
-    def_delegator :@config, :mappings
+    include MappingsTransfer
+
     def_delegator :@config, :backups_root
 
     def execute
@@ -15,12 +16,13 @@ module Dotsync
     private
 
       def show_config
-        info("Mappings:", icon: :source_dest)
-        mappings.each do |mapping|
-          force_icon = mapping.force? ? " #{icon_delete}" : ""
-          info("  src: #{mapping.original_src} -> dest: #{mapping.original_dest}#{force_icon}", icon: :copy)
-          info("    ignores: #{mapping.ignores.join(', ')}", icon: :exclude) if mapping.ignores.any?
-        end
+        show_mappings
+      end
+
+      def pull_dotfiles
+        transfer_mappings
+
+        action("Dotfiles pulled", icon: :copy)
       end
 
       def show_backup
@@ -37,7 +39,7 @@ module Dotsync
       end
 
       def create_backup
-        return false unless mappings.any? { |mapping| File.exist?(mapping.dest) }
+        return false unless valid_mappings.any?
         FileUtils.mkdir_p(backup_path)
         mappings.each do |mapping|
           next unless File.exist?(mapping.dest)
@@ -61,14 +63,5 @@ module Dotsync
           end
         end
       end
-
-      def pull_dotfiles
-        mappings.each { |mapping| Dotsync::FileTransfer.new(mapping).transfer }
-        action("Dotfiles pulled", icon: :copy)
-      end
-
-      def icon_delete
-        Dotsync::Logger::ICONS[:delete]
-      end
   end
 end

data/lib/dotsync/actions/push_action.rb

@@ -1,6 +1,6 @@
 module Dotsync
   class PushAction < BaseAction
-    def_delegator :@config, :mappings
+    include MappingsTransfer
 
     def execute
       show_config
@@ -10,21 +10,13 @@ module Dotsync
     private
 
     def show_config
-      info("Mappings:", icon: :source_dest)
-      mappings.each do |mapping|
-        force_icon = mapping.force? ? " #{icon_delete}" : ""
-        info("  src: #{mapping.original_src} -> dest: #{mapping.original_dest}#{force_icon}", icon: :copy)
-        info("    ignores: #{mapping.original_ignores.join(', ')}", icon: :exclude) if mapping.ignores.any?
-      end
+      show_mappings
     end
 
     def push_dotfiles
-      mappings.each { |mapping| Dotsync::FileTransfer.new(mapping).transfer }
-      action("Dotfiles pushed", icon: :copy)
-    end
+      transfer_mappings
 
-    def icon_delete
-      Dotsync::Logger::ICONS[:delete]
+      action("Dotfiles pushed", icon: :copy)
     end
   end
 end

data/lib/dotsync/actions/watch_action.rb

@@ -5,7 +5,6 @@ module Dotsync
     def initialize(config, logger)
       super
       setup_listeners
-      setup_logger_thread
       setup_signal_trap
     end
 
@@ -14,19 +13,16 @@ module Dotsync
 
       @listeners.each(&:start)
 
-      logger.action("Listening for changes...", icon: :listen)
-      info("Press Ctrl+C to exit.")
+      logger.action("Listening for changes...")
+      logger.action("Press Ctrl+C to exit.")
       sleep
     end
 
     private
 
       def show_config
-        info("Mappings:", icon: :watch)
-        mappings.each do |mapping|
-          info("  #{mapping}", icon: :copy)
-          info("    Excludes: #{mapping.ignores.join(', ')}", icon: :exclude) if mapping.ignores.any?
-        end
+        logger.info("Mappings:", icon: :config)
+        mappings.each { |mapping| logger.log("  #{mapping}") }
       end
 
       def setup_listeners
@@ -51,22 +47,22 @@ module Dotsync
       def handle_file_changes(mapping, modified, added, removed)
         (modified + added).each do |path|
           new_mapping = mapping.applied_to(path)
-          logger.info("Copied file: #{new_mapping.original_src}", icon: :copy)
+          logger.info("Copied file: #{new_mapping}", icon: :copy)
           Dotsync::FileTransfer.new(new_mapping).transfer
         end
         removed.each do |path|
-          logger.info("File removed: #{path}", icon: :delete)
+          logger.info("File removed: #{path}", icon: :delete, bold: false)
         end
       end
 
       def setup_signal_trap
-        listeners = @listeners.dup
         Signal.trap("INT") do
           # Using a new thread to handle the signal trap context,
           # as Signal.trap runs in a more restrictive environment
           Thread.new do
-            logger.action("Shutting down listeners...", icon: :bell)
-            listeners.each(&:stop)
+            logger.log("")
+            logger.action("Shutting down listeners...")
+            @listeners.each(&:stop)
             exit
           end
         end

data/lib/dotsync/icons.rb

@@ -0,0 +1,74 @@
+module Dotsync
+  module Icons
+    # Log level icons
+    INFO = " "
+    ERROR = " "
+
+    # Configuration icon
+    CONFIG = " "
+
+    # Default MappingEntry icons
+    DEFAULT_FORCE = "󰁪 "
+    DEFAULT_IGNORE = "󰈉 "
+    DEFAULT_INVALID = "󱏏 "
+
+    # Action icons
+    PULL = " "
+    PUSH = " "
+    WATCH = "󰛐 "
+
+    # TODO: review icons needed
+    CONSOLE = "󰆍 "
+    LISTEN = " "
+    SOURCE = " " #  "
+    DEST = " " # " "
+    BELL = " "
+    COPY = " "
+    SKIP = " "
+    DONE = " "
+    BACKUP = " "
+
+    @custom_icons = {}
+
+    def self.load_custom_icons(config)
+      @custom_icons = {
+        force: config.dig("icons", "force") || DEFAULT_FORCE,
+        ignore: config.dig("icons", "ignore") || DEFAULT_IGNORE,
+        invalid: config.dig("icons", "invalid") || DEFAULT_INVALID
+      }
+    end
+
+    def self.force
+      @custom_icons[:force] || DEFAULT_FORCE
+    end
+
+    def self.ignore
+      @custom_icons[:ignore] || DEFAULT_IGNORE
+    end
+
+    def self.invalid
+      @custom_icons[:invalid] || DEFAULT_INVALID
+    end
+
+    # https://www.nerdfonts.com
+    MAPPINGS = {
+      info: INFO,
+      error: ERROR,
+      config: CONFIG,
+      force: -> { force },
+      ignore: -> { ignore },
+      pull: PULL,
+      push: PUSH,
+      watch: WATCH,
+      console: CONSOLE,
+      listen: LISTEN,
+      source: SOURCE,
+      dest: DEST,
+      bell: BELL,
+      copy: COPY,
+      skip: SKIP,
+      done: DONE,
+      backup: BACKUP
+    }
+  end
+end

data/lib/dotsync/logger.rb

@@ -2,60 +2,36 @@ module Dotsync
   class Logger
     attr_accessor :output
 
-    # 🎨 Nerd Font Icons
-    ICONS = {
-      info:    " ",
-      listen:  " ",
-      error:   " ",
-      watch:   " ",
-      source:  " ", #  ",
-      dest:    " ", # " ",
-      delete:  " ",
-      bell:    " ",
-      copy:    " ",
-      skip:    " ",
-      done:    " ",
-      backup:  " ",
-      clean:   " ",
-    }
+    # NOTE: use Rake tasks "palette:fg" and "palette:bg" to select a proper ASCII color code
 
     def initialize(output = $stdout)
       @output = output
     end
 
-    def info(message, options = {})
-      log(:info, message, options)
+    def action(message, color: 153, bold: true, icon: :console)
+      log(message, color: color, bold: bold, icon: icon)
     end
 
-    def action(message, options = {})
-      log(:action, message, options)
+    def info(message, color: 103, bold: true, icon: :info)
+      log(message, color: color, bold: bold, icon: icon)
     end
 
-    def success(message)
-      log(:success, message, icon: :done)
+    def error(message, color: 196, bold: true, icon: :error)
+      log(message, color: color, bold: bold, icon: icon)
     end
 
-    def error(message)
-      log(:error, message, icon: :error)
-    end
+    def log(message, color: 0, bold: false, icon: nil)
+      mapped_icon = Dotsync::Icons::MAPPINGS[icon] if icon
 
-    def warning(message, options = {})
-      log(:warning, message, options)
-    end
+      msg = []
+      msg << "\e[38;5;#{color}m" if color > 0
+      msg << "\e[1m" if bold
+      msg << mapped_icon if mapped_icon
+      msg << message
+      msg << "\e[0m" if color > 0 # reset color
+      msg = msg.join("")
 
-    def log(type, message, options = {})
-      icon = options[:icon]
-      color = {
-        info: 103, action: 153, error: 196, event: 141, warning: 31, copy: 32,
-        skip: 33, done: 32, backup: 35,
-        clean: 34
-      }[type] || 0
-
-      if icon.nil?
-        @output.puts message
-      else
-        @output.puts "\e[38;5;#{color}m\e[1m#{ICONS[icon]}#{message}\e[0m"
-      end
+      @output.puts msg
     end
   end
 end

data/lib/dotsync/version.rb

@@ -1,3 +1,3 @@
 module Dotsync
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/dotsync.rb

@@ -10,6 +10,7 @@ require 'ostruct'
 require_relative "dotsync/errors"
 
 # Utils
+require_relative 'dotsync/icons'
 require_relative 'dotsync/logger'
 require_relative 'dotsync/file_transfer'
 require_relative 'dotsync/path_utils'
@@ -22,6 +23,9 @@ require_relative "dotsync/actions/config/pull_action_config"
 require_relative "dotsync/actions/config/push_action_config"
 require_relative "dotsync/actions/config/watch_action_config"
 
+# Concerns
+require_relative "dotsync/actions/concerns/mappings_transfer"
+
 # Actions
 require_relative "dotsync/actions/base_action"
 require_relative "dotsync/actions/pull_action"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dotsync
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - David Sáenz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-10-22 00:00:00.000000000 Z
+date: 2025-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toml-rb
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.7.0
-- !ruby/object:Gem::Dependency
-  name: ostruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +165,7 @@ files:
 - exe/setup
 - lib/dotsync.rb
 - lib/dotsync/actions/base_action.rb
+- lib/dotsync/actions/concerns/mappings_transfer.rb
 - lib/dotsync/actions/config/base_config.rb
 - lib/dotsync/actions/config/mapping_entry.rb
 - lib/dotsync/actions/config/pull_action_config.rb
@@ -190,6 +177,7 @@ files:
 - lib/dotsync/actions/watch_action.rb
 - lib/dotsync/errors.rb
 - lib/dotsync/file_transfer.rb
+- lib/dotsync/icons.rb
 - lib/dotsync/logger.rb
 - lib/dotsync/path_utils.rb
 - lib/dotsync/runner.rb